Skip to content

Commit 5493b75

Browse files
author
LaunchDarklyCI
committed
Version 5.3.0 automatically generated from ld-openapi@6ae0543.
1 parent 601370c commit 5493b75

File tree

309 files changed

+825
-705
lines changed

Some content is hidden

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

309 files changed

+825
-705
lines changed

README.md

Lines changed: 242 additions & 242 deletions
Large diffs are not rendered by default.

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
**serviceKind** | **String** | The approvals system used. | [optional]
7-
**required** | **Boolean** | Whether any changes to flags in this environment will require approval. | [optional]
7+
**required** | **Boolean** | Whether any changes to flags in this environment will require approval. You may only set required or requiredApprovalTags, not both. | [optional]
88
**canReviewOwnRequest** | **Boolean** | Whether requesters can approve or decline their own request. They may always comment. | [optional]
99
**minNumApprovals** | **Number** | The number of approvals required before an approval request can be applied. | [optional]
1010
**canApplyDeclinedChanges** | **Boolean** | Whether changes can be applied as long as minNumApprovals is met, regardless of if any reviewers have declined a request. | [optional]
11+
**requiredApprovalTags** | **[String]** | 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

1314
<a name="ServiceKindEnum"></a>

docs/EnvironmentsApi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Method | HTTP request | Description
66
------------- | ------------- | -------------
77
[**deleteEnvironment**](EnvironmentsApi.md#deleteEnvironment) | **DELETE** /projects/{projectKey}/environments/{environmentKey} | Delete an environment in a specific project.
88
[**getEnvironment**](EnvironmentsApi.md#getEnvironment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
9-
[**patchEnvironment**](EnvironmentsApi.md#patchEnvironment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
9+
[**patchEnvironment**](EnvironmentsApi.md#patchEnvironment) | **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
[**postEnvironment**](EnvironmentsApi.md#postEnvironment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
1111
[**resetEnvironmentMobileKey**](EnvironmentsApi.md#resetEnvironmentMobileKey) | **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
[**resetEnvironmentSDKKey**](EnvironmentsApi.md#resetEnvironmentSDKKey) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.
@@ -124,7 +124,7 @@ Name | Type | Description | Notes
124124
# **patchEnvironment**
125125
> Environment patchEnvironment(projectKey, environmentKey, patchDelta)
126126
127-
Modify an environment by ID.
127+
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.
128128

129129
### Example
130130
```javascript

openapi.yml

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ info:
1010
license:
1111
name: Apache 2.0
1212
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
13-
version: 5.1.0
13+
version: 5.3.0
1414
host: app.launchdarkly.com
1515
basePath: /api/v2
1616
schemes:
@@ -145,7 +145,13 @@ paths:
145145
tags:
146146
- Environments
147147
patch:
148-
summary: Modify an environment by ID.
148+
summary: >-
149+
Modify an environment by ID. If you try to patch the environment by
150+
setting both required and requiredApprovalTags, it will result in an
151+
error. Users can specify either required approvals for all flags in an
152+
environment or those with specific tags, but not both. Only customers on
153+
an Enterprise plan can require approval for flag updates with either
154+
mechanism.
149155
operationId: patchEnvironment
150156
parameters:
151157
- $ref: '#/parameters/ProjectKey'
@@ -2997,7 +3003,8 @@ definitions:
29973003
type: boolean
29983004
description: >-
29993005
Whether any changes to flags in this environment will require
3000-
approval.
3006+
approval. You may only set required or requiredApprovalTags, not
3007+
both.
30013008
canReviewOwnRequest:
30023009
type: boolean
30033010
description: >-
@@ -3015,6 +3022,14 @@ definitions:
30153022
description: >-
30163023
Whether changes can be applied as long as minNumApprovals is met,
30173024
regardless of if any reviewers have declined a request.
3025+
requiredApprovalTags:
3026+
type: array
3027+
items:
3028+
type: string
3029+
description: >-
3030+
An array of tags used to specify which flags with those tags
3031+
require approval. You may only set requiredApprovalTags or
3032+
required, not both.
30183033
EnvironmentPost:
30193034
type: object
30203035
properties:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "launchdarkly-api",
3-
"version": "5.1.0",
3+
"version": "5.3.0",
44
"description": "Build custom integrations with the LaunchDarkly REST API",
55
"license": "Apache 2.0",
66
"main": "src/index.js",

src/ApiClient.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -33,7 +33,7 @@
3333

3434
/**
3535
* @module ApiClient
36-
* @version 5.1.0
36+
* @version 5.3.0
3737
*/
3838

3939
/**

src/api/AccessTokensApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* AccessTokens service.
3636
* @module api/AccessTokensApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/AuditLogApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* AuditLog service.
3636
* @module api/AuditLogApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/CustomRolesApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* CustomRoles service.
3636
* @module api/CustomRolesApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/CustomerMetricsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* CustomerMetrics service.
3636
* @module api/CustomerMetricsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/DataExportDestinationsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* DataExportDestinations service.
3636
* @module api/DataExportDestinationsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/EnvironmentsApi.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* Environments service.
3636
* @module api/EnvironmentsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**
@@ -164,7 +164,7 @@
164164
*/
165165

166166
/**
167-
* Modify an environment by ID.
167+
* 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.
168168
* @param {String} projectKey The project key, used to tie the flags together under one project so they can be managed together.
169169
* @param {String} environmentKey The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
170170
* @param {Array.<module:model/PatchOperation>} patchDelta Requires a JSON Patch representation of the desired changes to the project. 'http://jsonpatch.com/'

src/api/FeatureFlagsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* FeatureFlags service.
3636
* @module api/FeatureFlagsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/IntegrationsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* Integrations service.
3636
* @module api/IntegrationsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/ProjectsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* Projects service.
3636
* @module api/ProjectsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/RelayProxyConfigurationsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* RelayProxyConfigurations service.
3636
* @module api/RelayProxyConfigurationsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/RootApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* Root service.
3636
* @module api/RootApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/TeamMembersApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* TeamMembers service.
3636
* @module api/TeamMembersApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/UserSegmentsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* UserSegments service.
3636
* @module api/UserSegmentsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/UserSettingsApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* UserSettings service.
3636
* @module api/UserSettingsApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

src/api/UsersApi.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* LaunchDarkly REST API
33
* Build custom integrations with the LaunchDarkly REST API
44
*
5-
* OpenAPI spec version: 5.1.0
5+
* OpenAPI spec version: 5.3.0
66
* Contact: [email protected]
77
*
88
* NOTE: This class is auto generated by the swagger code generator program.
@@ -34,7 +34,7 @@
3434
/**
3535
* Users service.
3636
* @module api/UsersApi
37-
* @version 5.1.0
37+
* @version 5.3.0
3838
*/
3939

4040
/**

0 commit comments

Comments
 (0)