Skip to content

Commit ad74785

Browse files
author
LaunchDarklyReleaseBot
committed
Version 16.0.0 automatically generated from ld-openapi.
1 parent 9ef522d commit ad74785

File tree

906 files changed

+1567
-1506
lines changed

Some content is hidden

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

906 files changed

+1567
-1506
lines changed

README.md

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

365365
```
366-
LD-API-Version: 20220603
366+
LD-API-Version: 20240415
367367
```
368368

369-
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.
369+
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.
370370

371371
### Setting the API version per access token
372372

@@ -386,15 +386,18 @@ If you would like to upgrade your integration to use a new API version, you can
386386

387387
|<div style=\"width:75px\">Version</div> | Changes | End of life (EOL)
388388
|---|---|---|
389-
| `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 |
389+
| `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 |
390+
| `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 |
390391
| `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 |
391392
| `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 |
392393
| `20160426` | <ul><li>Initial versioning of API. Tokens created before versioning have their version set to this.</li></ul> | 2020-12-12 |
393394

395+
To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL) Policy](https://launchdarkly.com/policies/end-of-life-policy/).
396+
394397
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
395398

396399
- API version: 2.0
397-
- Package version: 15.1.0
400+
- Package version: 16.0.0
398401
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
399402
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
400403

@@ -627,9 +630,9 @@ Class | Method | HTTP request | Description
627630
*LaunchDarklyApi.FeatureFlagsApi* | [**patchExpiringUserTargets**](docs/FeatureFlagsApi.md#patchExpiringUserTargets) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update expiring user targets on feature flag
628631
*LaunchDarklyApi.FeatureFlagsApi* | [**patchFeatureFlag**](docs/FeatureFlagsApi.md#patchFeatureFlag) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey} | Update feature flag
629632
*LaunchDarklyApi.FeatureFlagsApi* | [**postFeatureFlag**](docs/FeatureFlagsApi.md#postFeatureFlag) | **POST** /api/v2/flags/{projectKey} | Create a feature flag
633+
*LaunchDarklyApi.FeatureFlagsApi* | [**postMigrationSafetyIssues**](docs/FeatureFlagsApi.md#postMigrationSafetyIssues) | **POST** /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues | Get migration safety issues
630634
*LaunchDarklyApi.FeatureFlagsBetaApi* | [**getDependentFlags**](docs/FeatureFlagsBetaApi.md#getDependentFlags) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/dependent-flags | List dependent feature flags
631635
*LaunchDarklyApi.FeatureFlagsBetaApi* | [**getDependentFlagsByEnv**](docs/FeatureFlagsBetaApi.md#getDependentFlagsByEnv) | **GET** /api/v2/flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | List dependent feature flags by environment
632-
*LaunchDarklyApi.FeatureFlagsBetaApi* | [**postMigrationSafetyIssues**](docs/FeatureFlagsBetaApi.md#postMigrationSafetyIssues) | **POST** /api/v2/projects/{projectKey}/flags/{flagKey}/environments/{environmentKey}/migration-safety-issues | Get migration safety issues
633636
*LaunchDarklyApi.FlagLinksBetaApi* | [**createFlagLink**](docs/FlagLinksBetaApi.md#createFlagLink) | **POST** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | Create flag link
634637
*LaunchDarklyApi.FlagLinksBetaApi* | [**deleteFlagLink**](docs/FlagLinksBetaApi.md#deleteFlagLink) | **DELETE** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey}/{id} | Delete flag link
635638
*LaunchDarklyApi.FlagLinksBetaApi* | [**getFlagLinks**](docs/FlagLinksBetaApi.md#getFlagLinks) | **GET** /api/v2/flag-links/projects/{projectKey}/flags/{featureFlagKey} | List flag links

docs/CustomRolesApi.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ Name | Type | Description | Notes
116116

117117
## getCustomRoles
118118

119-
> CustomRoles getCustomRoles()
119+
> CustomRoles getCustomRoles(opts)
120120
121121
List custom roles
122122

@@ -134,7 +134,11 @@ ApiKey.apiKey = 'YOUR API KEY';
134134
//ApiKey.apiKeyPrefix = 'Token';
135135

136136
let apiInstance = new LaunchDarklyApi.CustomRolesApi();
137-
apiInstance.getCustomRoles((error, data, response) => {
137+
let opts = {
138+
'limit': 789, // Number | The maximum number of custom roles to return. Defaults to 20.
139+
'offset': 789 // Number | 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`.
140+
};
141+
apiInstance.getCustomRoles(opts, (error, data, response) => {
138142
if (error) {
139143
console.error(error);
140144
} else {
@@ -145,7 +149,11 @@ apiInstance.getCustomRoles((error, data, response) => {
145149

146150
### Parameters
147151

148-
This endpoint does not need any parameter.
152+
153+
Name | Type | Description | Notes
154+
------------- | ------------- | ------------- | -------------
155+
**limit** | **Number**| The maximum number of custom roles to return. Defaults to 20. | [optional]
156+
**offset** | **Number**| 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]
149157

150158
### Return type
151159

docs/CustomWorkflowsListingOutput.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,7 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**items** | [**[CustomWorkflowOutput]**](CustomWorkflowOutput.md) | An array of workflows |
8+
**totalCount** | **Number** | Total number of workflows |
9+
**links** | [**{String: Link}**](Link.md) | The location and content type of related resources |
810

911

docs/FeatureFlag.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
3030
**defaults** | [**Defaults**](Defaults.md) | | [optional]
3131
**purpose** | **String** | | [optional]
3232
**migrationSettings** | [**FlagMigrationSettingsRep**](FlagMigrationSettingsRep.md) | | [optional]
33-
**environments** | [**{String: FeatureFlagConfig}**](FeatureFlagConfig.md) | Details on the environments for this flag |
33+
**environments** | [**{String: 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. |
3434

3535

3636

0 commit comments

Comments
 (0)