Skip to content

Commit 6526f05

Browse files
authored
chore: update generated PingAPI (#60)
1 parent c015f6c commit 6526f05

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## 1.6.0 [unreleased]
22

3+
### Others
4+
1. [#60](https://github.com/influxdata/influxdb-client-swift/pull/60): Update generated `PingAPI`
5+
36
## 1.5.0 [2022-10-27]
47

58
### Features

Sources/InfluxDBSwiftApis/Generated/APIs/PingAPI.swift

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class PingAPI {
1919
}
2020

2121
/**
22-
Checks the status of InfluxDB instance and version of InfluxDB.
22+
Get the status of the instance
2323

2424
- parameter apiResponseQueue: The queue on which api response is dispatched.
2525
- parameter completion: completion handler to receive the data and the error objects
@@ -37,7 +37,7 @@ public class PingAPI {
3737

3838
#if swift(>=5.5)
3939
/**
40-
Checks the status of InfluxDB instance and version of InfluxDB.
40+
Get the status of the instance
4141

4242
- parameter apiResponseQueue: The queue on which api response is dispatched.
4343
- parameter completion: completion handler to receive the data and the error objects
@@ -58,8 +58,9 @@ public class PingAPI {
5858
#endif
5959

6060
/**
61-
Checks the status of InfluxDB instance and version of InfluxDB.
61+
Get the status of the instance
6262
- GET /ping
63+
- Retrieves the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP `204` status code to inform you the instance is available. #### InfluxDB Cloud - Isn't versioned and doesn't return `X-Influxdb-Version` in the headers. #### Related guides - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/)
6364
- responseHeaders: [X-Influxdb-Build(String), X-Influxdb-Version(Int)]
6465
- returns: RequestBuilder<Void>
6566
*/
@@ -76,7 +77,7 @@ public class PingAPI {
7677
}
7778

7879
/**
79-
Checks the status of InfluxDB instance and version of InfluxDB.
80+
Get the status of the instance
8081

8182
- parameter apiResponseQueue: The queue on which api response is dispatched.
8283
- parameter completion: completion handler to receive the data and the error objects
@@ -94,7 +95,7 @@ public class PingAPI {
9495

9596
#if swift(>=5.5)
9697
/**
97-
Checks the status of InfluxDB instance and version of InfluxDB.
98+
Get the status of the instance
9899

99100
- parameter apiResponseQueue: The queue on which api response is dispatched.
100101
- parameter completion: completion handler to receive the data and the error objects
@@ -115,8 +116,9 @@ public class PingAPI {
115116
#endif
116117

117118
/**
118-
Checks the status of InfluxDB instance and version of InfluxDB.
119+
Get the status of the instance
119120
- HEAD /ping
121+
- Returns the status and InfluxDB version of the instance. Use this endpoint to monitor uptime for the InfluxDB instance. The response returns a HTTP `204` status code to inform you the instance is available. #### InfluxDB Cloud - Isn't versioned and doesn't return `X-Influxdb-Version` in the headers. #### Related guides - [Influx ping](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/ping/)
120122
- responseHeaders: [X-Influxdb-Build(String), X-Influxdb-Version(Int)]
121123
- returns: RequestBuilder<Void>
122124
*/

0 commit comments

Comments
 (0)