Skip to content

Commit 616dd82

Browse files
author
LaunchDarklyReleaseBot
committed
Version 16.0.0 automatically generated from ld-openapi.
1 parent ebe9067 commit 616dd82

File tree

954 files changed

+1311
-1256
lines changed

Some content is hidden

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

954 files changed

+1311
-1256
lines changed

Diff for: README.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -361,10 +361,10 @@ Updates to our REST API include support for the latest features in LaunchDarkly.
361361
You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below:
362362

363363
```
364-
LD-API-Version: 20220603
364+
LD-API-Version: 20240415
365365
```
366366

367-
The header value is the version number of the API version you would like to request. The number for each version corresponds to the date the version was released in `yyyymmdd` format. In the example above the version `20220603` corresponds to June 03, 2022.
367+
The header value is the version number of the API version you would like to request. The number for each version corresponds to the date the version was released in `yyyymmdd` format. In the example above the version `20240415` corresponds to April 15, 2024.
368368

369369
### Setting the API version per access token
370370

@@ -384,16 +384,19 @@ If you would like to upgrade your integration to use a new API version, you can
384384

385385
|<div style=\"width:75px\">Version</div> | Changes | End of life (EOL)
386386
|---|---|---|
387-
| `20220603` | <ul><li>Changed the [list projects](/tag/Projects#operation/getProjects) return value:<ul><li>Response is now paginated with a default limit of `20`.</li><li>Added support for filter and sort.</li><li>The project `environments` field is now expandable. This field is omitted by default.</li></ul></li><li>Changed the [get project](/tag/Projects#operation/getProject) return value:<ul><li>The `environments` field is now expandable. This field is omitted by default.</li></ul></li></ul> | Current |
387+
| `20240415` | <ul><li>Changed several endpoints from unpaginated to paginated. Use the `limit` and `offset` query parameters to page through the results.</li> <li>Changed the [list access tokens](/tag/Access-tokens#operation/getTokens) endpoint: <ul><li>Response is now paginated with a default limit of `25`</li></ul></li> <li>Changed the [list account members](/tag/Account-members#operation/getMembers) endpoint: <ul><li>The `accessCheck` filter is no longer available</li></ul></li> <li>Changed the [list custom roles](/tag/Custom-roles#operation/getCustomRoles) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li></ul></li> <li>Changed the [list feature flags](/tag/Feature-flags#operation/getFeatureFlags) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li><li>The `environments` field is now only returned if the request is filtered by environment, using the `filterEnv` query parameter</li><li>The `filterEnv` query parameter supports a maximum of three environments</li><li>The `followerId`, `hasDataExport`, `status`, `contextKindTargeted`, and `segmentTargeted` filters are no longer available</li></ul></li> <li>Changed the [list segments](/tag/Segments#operation/getSegments) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li></ul></li> <li>Changed the [list teams](/tag/Teams#operation/getTeams) endpoint: <ul><li>The `expand` parameter no longer supports including `projects` or `roles`</li><li>In paginated results, the maximum page size is now 100</li></ul></li> <li>Changed the [get workflows](/tag/Workflows#operation/getWorkflows) endpoint: <ul><li>Response is now paginated with a default limit of `20`</li><li>The `_conflicts` field in the response is no longer available</li></ul></li> </ul> | Current |
388+
| `20220603` | <ul><li>Changed the [list projects](/tag/Projects#operation/getProjects) return value:<ul><li>Response is now paginated with a default limit of `20`.</li><li>Added support for filter and sort.</li><li>The project `environments` field is now expandable. This field is omitted by default.</li></ul></li><li>Changed the [get project](/tag/Projects#operation/getProject) return value:<ul><li>The `environments` field is now expandable. This field is omitted by default.</li></ul></li></ul> | 2025-04-15 |
388389
| `20210729` | <ul><li>Changed the [create approval request](/tag/Approvals#operation/postApprovalRequest) return value. It now returns HTTP Status Code `201` instead of `200`.</li><li> Changed the [get users](/tag/Users#operation/getUser) return value. It now returns a user record, not a user. </li><li>Added additional optional fields to environment, segments, flags, members, and segments, including the ability to create big segments. </li><li> Added default values for flag variations when new environments are created. </li><li>Added filtering and pagination for getting flags and members, including `limit`, `number`, `filter`, and `sort` query parameters. </li><li>Added endpoints for expiring user targets for flags and segments, scheduled changes, access tokens, Relay Proxy configuration, integrations and subscriptions, and approvals. </li></ul> | 2023-06-03 |
389390
| `20191212` | <ul><li>[List feature flags](/tag/Feature-flags#operation/getFeatureFlags) now defaults to sending summaries of feature flag configurations, equivalent to setting the query parameter `summary=true`. Summaries omit flag targeting rules and individual user targets from the payload. </li><li> Added endpoints for flags, flag status, projects, environments, audit logs, members, users, custom roles, segments, usage, streams, events, and data export. </li></ul> | 2022-07-29 |
390391
| `20160426` | <ul><li>Initial versioning of API. Tokens created before versioning have their version set to this.</li></ul> | 2020-12-12 |
391392

393+
To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL) Policy](https://launchdarkly.com/policies/end-of-life-policy/).
394+
392395

393396
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
394397

395398
- API version: 2.0
396-
- Package version: 15.1.0
399+
- Package version: 16.0.0
397400
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
398401
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
399402

@@ -599,9 +602,9 @@ Class | Method | HTTP request | Description
599602
*FeatureFlagsApi* | [**patch_expiring_user_targets**](docs/FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update expiring user targets on feature flag
600603
*FeatureFlagsApi* | [**patch_feature_flag**](docs/FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey} | Update feature flag
601604
*FeatureFlagsApi* | [**post_feature_flag**](docs/FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{projectKey} | Create a feature flag
605+
*FeatureFlagsApi* | [**post_migration_safety_issues**](docs/FeatureFlagsApi.md#post_migration_safety_issues) | **POST** /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues | Get migration safety issues
602606
*FeatureFlagsBetaApi* | [**get_dependent_flags**](docs/FeatureFlagsBetaApi.md#get_dependent_flags) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags | List dependent feature flags
603607
*FeatureFlagsBetaApi* | [**get_dependent_flags_by_env**](docs/FeatureFlagsBetaApi.md#get_dependent_flags_by_env) | **GET** /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | List dependent feature flags by environment
604-
*FeatureFlagsBetaApi* | [**post_migration_safety_issues**](docs/FeatureFlagsBetaApi.md#post_migration_safety_issues) | **POST** /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues | Get migration safety issues
605608
*FlagLinksBetaApi* | [**create_flag_link**](docs/FlagLinksBetaApi.md#create_flag_link) | **POST** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | Create flag link
606609
*FlagLinksBetaApi* | [**delete_flag_link**](docs/FlagLinksBetaApi.md#delete_flag_link) | **DELETE** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} | Delete flag link
607610
*FlagLinksBetaApi* | [**get_flag_links**](docs/FlagLinksBetaApi.md#get_flag_links) | **GET** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | List flag links

Diff for: docs/CustomRolesApi.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -220,19 +220,26 @@ configuration.api_key['ApiKey'] = 'YOUR_API_KEY'
220220
with launchdarkly_api.ApiClient(configuration) as api_client:
221221
# Create an instance of the API class
222222
api_instance = custom_roles_api.CustomRolesApi(api_client)
223+
limit = 1 # int | The maximum number of custom roles to return. Defaults to 20. (optional)
224+
offset = 1 # int | Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query `limit`. (optional)
223225

224-
# example, this endpoint has no required or optional parameters
226+
# example passing only required values which don't have defaults set
227+
# and optional values
225228
try:
226229
# List custom roles
227-
api_response = api_instance.get_custom_roles()
230+
api_response = api_instance.get_custom_roles(limit=limit, offset=offset)
228231
pprint(api_response)
229232
except launchdarkly_api.ApiException as e:
230233
print("Exception when calling CustomRolesApi->get_custom_roles: %s\n" % e)
231234
```
232235

233236

234237
### Parameters
235-
This endpoint does not need any parameter.
238+
239+
Name | Type | Description | Notes
240+
------------- | ------------- | ------------- | -------------
241+
**limit** | **int**| The maximum number of custom roles to return. Defaults to 20. | [optional]
242+
**offset** | **int**| Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query &#x60;limit&#x60;. | [optional]
236243

237244
### Return type
238245

Diff for: docs/CustomWorkflowsListingOutput.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**items** | [**[CustomWorkflowOutput]**](CustomWorkflowOutput.md) | An array of workflows |
8+
**total_count** | **int** | Total number of workflows |
9+
**links** | [**{str: (Link,)}**](Link.md) | The location and content type of related resources |
810
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
911

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

Diff for: docs/FeatureFlag.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
1717
**custom_properties** | [**CustomProperties**](CustomProperties.md) | |
1818
**archived** | **bool** | Boolean indicating if the feature flag is archived |
1919
**deprecated** | **bool** | Boolean indicating if the feature flag is deprecated |
20-
**environments** | [**{str: (FeatureFlagConfig,)}**](FeatureFlagConfig.md) | Details on the environments for this flag |
20+
**environments** | [**{str: (FeatureFlagConfig,)}**](FeatureFlagConfig.md) | Details on the environments for this flag. Only returned if the request is filtered by environment, using the &lt;code&gt;filterEnv&lt;/code&gt; query parameter. |
2121
**description** | **str** | Description of the feature flag | [optional]
2222
**include_in_snippet** | **bool** | Deprecated, use &lt;code&gt;clientSideAvailability&lt;/code&gt;. Whether this flag should be made available to the client-side JavaScript SDK | [optional]
2323
**client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional]

0 commit comments

Comments
 (0)