Skip to content

Commit d51323b

Browse files
author
LaunchDarklyCI
committed
Version 5.3.0 automatically generated from ld-openapi@6ae0543.
1 parent d5e5bbf commit d51323b

File tree

312 files changed

+374
-333
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

312 files changed

+374
-333
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Build custom integrations with the LaunchDarkly REST API
88

99
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1010

11-
- API version: 5.1.0
12-
- Package version: 5.1.0
11+
- API version: 5.3.0
12+
- Package version: 5.3.0
1313
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1414
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
1515

@@ -25,9 +25,6 @@ If the python package is hosted on Github, you can install directly from Github
2525
```sh
2626
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2727
```
28-
```sh
29-
pip3 install git+https://github.com/launchdarkly/api-client-python.git
30-
```
3128
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
3229

3330
Then import the package:
@@ -114,7 +111,7 @@ Class | Method | HTTP request | Description
114111
*DataExportDestinationsApi* | [**post_destination**](docs/DataExportDestinationsApi.md#post_destination) | **POST** /destinations/{projectKey}/{environmentKey} | Create a new data export destination
115112
*EnvironmentsApi* | [**delete_environment**](docs/EnvironmentsApi.md#delete_environment) | **DELETE** /projects/{projectKey}/environments/{environmentKey} | Delete an environment in a specific project.
116113
*EnvironmentsApi* | [**get_environment**](docs/EnvironmentsApi.md#get_environment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
117-
*EnvironmentsApi* | [**patch_environment**](docs/EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
114+
*EnvironmentsApi* | [**patch_environment**](docs/EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.
118115
*EnvironmentsApi* | [**post_environment**](docs/EnvironmentsApi.md#post_environment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
119116
*EnvironmentsApi* | [**reset_environment_mobile_key**](docs/EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
120117
*EnvironmentsApi* | [**reset_environment_sdk_key**](docs/EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.

docs/EnvironmentApprovalSettings.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**service_kind** | **str** | The approvals system used. | [optional]
7-
**required** | **bool** | Whether any changes to flags in this environment will require approval. | [optional]
7+
**required** | **bool** | Whether any changes to flags in this environment will require approval. You may only set required or requiredApprovalTags, not both. | [optional]
88
**can_review_own_request** | **bool** | Whether requesters can approve or decline their own request. They may always comment. | [optional]
99
**min_num_approvals** | **int** | The number of approvals required before an approval request can be applied. | [optional]
1010
**can_apply_declined_changes** | **bool** | Whether changes can be applied as long as minNumApprovals is met, regardless of if any reviewers have declined a request. | [optional]
11+
**required_approval_tags** | **list[str]** | An array of tags used to specify which flags with those tags require approval. You may only set requiredApprovalTags or required, not both. | [optional]
1112

1213
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1314

docs/EnvironmentsApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**delete_environment**](EnvironmentsApi.md#delete_environment) | **DELETE** /projects/{projectKey}/environments/{environmentKey} | Delete an environment in a specific project.
88
[**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
9-
[**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
9+
[**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.
1010
[**post_environment**](EnvironmentsApi.md#post_environment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
1111
[**reset_environment_mobile_key**](EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
1212
[**reset_environment_sdk_key**](EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.
@@ -122,7 +122,7 @@ Name | Type | Description | Notes
122122
# **patch_environment**
123123
> Environment patch_environment(project_key, environment_key, patch_delta)
124124
125-
Modify an environment by ID.
125+
Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.
126126

127127
### Example
128128
```python
@@ -145,7 +145,7 @@ environment_key = 'environment_key_example' # str | The environment key, used to
145145
patch_delta = [launchdarkly_api.PatchOperation()] # list[PatchOperation] | Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'
146146

147147
try:
148-
# Modify an environment by ID.
148+
# Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism.
149149
api_response = api_instance.patch_environment(project_key, environment_key, patch_delta)
150150
pprint(api_response)
151151
except ApiException as e:

launchdarkly_api/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
88
Build custom integrations with the LaunchDarkly REST API # noqa: E501
99
10-
OpenAPI spec version: 5.1.0
10+
OpenAPI spec version: 5.3.0
1111
1212
Generated by: https://github.com/swagger-api/swagger-codegen.git
1313
"""

launchdarkly_api/api/access_tokens_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/audit_log_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/custom_roles_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/customer_metrics_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/data_export_destinations_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""

launchdarkly_api/api/environments_api.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
66
Build custom integrations with the LaunchDarkly REST API # noqa: E501
77
8-
OpenAPI spec version: 5.1.0
8+
OpenAPI spec version: 5.3.0
99
1010
Generated by: https://github.com/swagger-api/swagger-codegen.git
1111
"""
@@ -244,7 +244,7 @@ def get_environment_with_http_info(self, project_key, environment_key, **kwargs)
244244
collection_formats=collection_formats)
245245

246246
def patch_environment(self, project_key, environment_key, patch_delta, **kwargs): # noqa: E501
247-
"""Modify an environment by ID. # noqa: E501
247+
"""Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism. # noqa: E501
248248
249249
This method makes a synchronous HTTP request by default. To make an
250250
asynchronous HTTP request, please pass async_req=True
@@ -267,7 +267,7 @@ def patch_environment(self, project_key, environment_key, patch_delta, **kwargs)
267267
return data
268268

269269
def patch_environment_with_http_info(self, project_key, environment_key, patch_delta, **kwargs): # noqa: E501
270-
"""Modify an environment by ID. # noqa: E501
270+
"""Modify an environment by ID. If you try to patch the environment by setting both required and requiredApprovalTags, it will result in an error. Users can specify either required approvals for all flags in an environment or those with specific tags, but not both. Only customers on an Enterprise plan can require approval for flag updates with either mechanism. # noqa: E501
271271
272272
This method makes a synchronous HTTP request by default. To make an
273273
asynchronous HTTP request, please pass async_req=True

0 commit comments

Comments
 (0)