Skip to content

Commit f03bf8b

Browse files
committed
docs: update CHANGELOG.md
1 parent 14d7ce9 commit f03bf8b

File tree

3 files changed

+41
-8
lines changed

3 files changed

+41
-8
lines changed

CHANGELOG.md

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

3+
### Breaking Changes
4+
5+
This release introduces a support for new version of InfluxDB OSS API definitions - [oss.yml](https://github.com/influxdata/openapi/blob/master/contracts/oss.yml). The following breaking changes are in underlying API services and doesn't affect common apis such as - `WriteApi`, `QueryApi`, `BucketsApi`, `OrganizationsApi`...
6+
- Add `LegacyAuthorizationsService` to deal with legacy authorizations
7+
- Add `ResourceService` to retrieve all knows resources
8+
- Add `BackupService` to represents the data backup functions of InfluxDB
9+
- Add `ReplicationsService` to represents the replication functions of InfluxDB
10+
- Add `RestoreService` to represents the data restore functions of InfluxDB
11+
- Add `ConfigService` to retrieve InfluxDB's runtime configuration
12+
- Add `RemoteConnectionsService` to deal with registered remote InfluxDB connections
13+
- Add `TelegrafPluginsService` to retrieve all Telegraf's plugins
14+
- Update `TemplatesService` to deal with `Stack` and `Template` API
15+
- `DBRPsService`:
16+
- doesn't requires `org_id` parameter for operations
17+
- `get_dbr_ps_id` operation uses `DBRPGet` as a type of result
18+
- `patch_dbrpid` operation uses `DBRPGet` as a type of result
19+
- `post_dbrp` operation uses `DBRPCreate` as a type of request
20+
- `DefaultService`:
21+
- `get_routes` operation is moved to `RoutesService`
22+
- `get_telegraf_plugin` operation is moved to `TelegrafsService`
23+
- `post_signin` operation is moved to `SigninService`
24+
- `post_signout` operation is moved to `SignoutService`
25+
- `OrganizationsService`:
26+
- `get_orgs_id_secrets` operation is moved to `SecretsService`
27+
- `patch_orgs_id_secrets` operation is moved to `SecretsService`
28+
- `post_orgs_id_secrets` operation is moved to `SecretsService`
29+
- Remove `DocumentApi` in favour of [InfluxDB Community Templates](https://github.com/influxdata/community-templates). For more info see - [influxdb#19300](https://github.com/influxdata/influxdb/pull/19300), [openapi#192](https://github.com/influxdata/openapi/pull/192)
30+
- `TelegrafsService` uses `TelegrafPluginRequest` to create `Telegraf` configuration
31+
- `TelegrafsService` uses `TelegrafPluginRequest` to update `Telegraf` configuration
32+
33+
### API
34+
1. [#399](https://github.com/influxdata/influxdb-client-python/pull/399): Use the latest InfluxDB OSS API definitions to generated APIs
35+
336
## 1.25.0 [2022-01-20]
437

538
### Features

influxdb_client/service/restore_service.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ def post_restore_kv(self, body, **kwargs): # noqa: E501,D401,D403
271271
:param async_req bool
272272
:param file body: Full KV snapshot. (required)
273273
:param str zap_trace_span: OpenTracing span context
274-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
274+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
275275
:param str content_type:
276276
:return: PostRestoreKVResponse
277277
If the method is called asynchronously,
@@ -295,7 +295,7 @@ def post_restore_kv_with_http_info(self, body, **kwargs): # noqa: E501,D401,D40
295295
:param async_req bool
296296
:param file body: Full KV snapshot. (required)
297297
:param str zap_trace_span: OpenTracing span context
298-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
298+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
299299
:param str content_type:
300300
:return: PostRestoreKVResponse
301301
If the method is called asynchronously,
@@ -388,7 +388,7 @@ def post_restore_shard_id(self, shard_id, body, **kwargs): # noqa: E501,D401,D4
388388
:param str shard_id: The shard ID. (required)
389389
:param file body: TSM snapshot. (required)
390390
:param str zap_trace_span: OpenTracing span context
391-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
391+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
392392
:param str content_type:
393393
:return: None
394394
If the method is called asynchronously,
@@ -413,7 +413,7 @@ def post_restore_shard_id_with_http_info(self, shard_id, body, **kwargs): # noq
413413
:param str shard_id: The shard ID. (required)
414414
:param file body: TSM snapshot. (required)
415415
:param str zap_trace_span: OpenTracing span context
416-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
416+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
417417
:param str content_type:
418418
:return: None
419419
If the method is called asynchronously,
@@ -511,7 +511,7 @@ def post_restore_sql(self, body, **kwargs): # noqa: E501,D401,D403
511511
:param async_req bool
512512
:param file body: Full SQL snapshot. (required)
513513
:param str zap_trace_span: OpenTracing span context
514-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
514+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
515515
:param str content_type:
516516
:return: None
517517
If the method is called asynchronously,
@@ -535,7 +535,7 @@ def post_restore_sql_with_http_info(self, body, **kwargs): # noqa: E501,D401,D4
535535
:param async_req bool
536536
:param file body: Full SQL snapshot. (required)
537537
:param str zap_trace_span: OpenTracing span context
538-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
538+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
539539
:param str content_type:
540540
:return: None
541541
If the method is called asynchronously,

influxdb_client/service/write_service.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ def post_write(self, org, bucket, body, **kwargs): # noqa: E501,D401,D403
4646
:param str bucket: The destination bucket for writes. (required)
4747
:param str body: Data in line protocol format. (required)
4848
:param str zap_trace_span: OpenTracing span context
49-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
49+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
5050
:param str content_type: The header value indicates the format of the data in the request body.
5151
:param int content_length: The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's `max body` configuration option, the server responds with status code `413`.
5252
:param str accept: The header value specifies the response format.
@@ -77,7 +77,7 @@ def post_write_with_http_info(self, org, bucket, body, **kwargs): # noqa: E501,
7777
:param str bucket: The destination bucket for writes. (required)
7878
:param str body: Data in line protocol format. (required)
7979
:param str zap_trace_span: OpenTracing span context
80-
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
80+
:param str content_encoding: The value tells InfluxDB what compression is applied to the line protocol in the request payload. To make an API request with a GZIP payload, send `Content-Encoding: gzip` as a request header.
8181
:param str content_type: The header value indicates the format of the data in the request body.
8282
:param int content_length: The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's `max body` configuration option, the server responds with status code `413`.
8383
:param str accept: The header value specifies the response format.

0 commit comments

Comments
 (0)