Skip to content

Commit 601370c

Browse files
author
LaunchDarklyCI
committed
Version 5.1.0 automatically generated from ld-openapi@c4d960a.
1 parent 5a42825 commit 601370c

File tree

318 files changed

+2534
-703
lines changed

Some content is hidden

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

318 files changed

+2534
-703
lines changed

README.md

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

docs/DependentFlag.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LaunchDarklyApi.DependentFlag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | | [optional]
7+
**key** | **String** | | [optional]
8+
**links** | [**DependentFlagLinks**](DependentFlagLinks.md) | | [optional]
9+
**site** | [**Site**](Site.md) | | [optional]
10+
11+

docs/DependentFlagEnvironment.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# LaunchDarklyApi.DependentFlagEnvironment
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | | [optional]
7+
**key** | **String** | | [optional]
8+
**links** | [**DependentFlagEnvironmentLinks**](DependentFlagEnvironmentLinks.md) | | [optional]
9+
**site** | [**Site**](Site.md) | | [optional]
10+
11+

docs/DependentFlagEnvironmentLinks.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LaunchDarklyApi.DependentFlagEnvironmentLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**self** | [**Link**](Link.md) | | [optional]
7+
**flagLink** | [**Link**](Link.md) | | [optional]
8+
9+

docs/DependentFlagLinks.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# LaunchDarklyApi.DependentFlagLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**self** | [**Link**](Link.md) | | [optional]
7+
8+

docs/DependentFlagsByEnvironment.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# LaunchDarklyApi.DependentFlagsByEnvironment
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**items** | [**[DependentFlag]**](DependentFlag.md) | | [optional]
7+
**links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
8+
**site** | [**Site**](Site.md) | | [optional]
9+
10+

docs/DependentFlagsLinks.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# LaunchDarklyApi.DependentFlagsLinks
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**parent** | [**Link**](Link.md) | | [optional]
7+
**self** | [**Link**](Link.md) | | [optional]
8+
9+

docs/FeatureFlagsApi.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Method | HTTP request | Description
88
[**deleteApprovalRequest**](FeatureFlagsApi.md#deleteApprovalRequest) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
99
[**deleteFeatureFlag**](FeatureFlagsApi.md#deleteFeatureFlag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
1010
[**deleteFlagConfigScheduledChanges**](FeatureFlagsApi.md#deleteFlagConfigScheduledChanges) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
11+
[**flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet**](FeatureFlagsApi.md#flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet) | **GET** /flags/{projectKey}/{environmentKey}/{featureFlagKey}/dependent-flags | Get dependent flags for the flag in the environment specified in path parameters
12+
[**flagsProjectKeyFeatureFlagKeyDependentFlagsGet**](FeatureFlagsApi.md#flagsProjectKeyFeatureFlagKeyDependentFlagsGet) | **GET** /flags/{projectKey}/{featureFlagKey}/dependent-flags | Get dependent flags across all environments for the flag specified in the path parameters
1113
[**getApprovalRequest**](FeatureFlagsApi.md#getApprovalRequest) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
1214
[**getApprovalRequests**](FeatureFlagsApi.md#getApprovalRequests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
1315
[**getExpiringUserTargets**](FeatureFlagsApi.md#getExpiringUserTargets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
@@ -259,6 +261,117 @@ null (empty response body)
259261

260262
[Token](../README.md#Token)
261263

264+
### HTTP request headers
265+
266+
- **Content-Type**: application/json
267+
- **Accept**: application/json
268+
269+
<a name="flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet"></a>
270+
# **flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet**
271+
> DependentFlagsByEnvironment flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet(projectKey, environmentKey, featureFlagKey, )
272+
273+
Get dependent flags for the flag in the environment specified in path parameters
274+
275+
### Example
276+
```javascript
277+
var LaunchDarklyApi = require('launchdarkly-api');
278+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
279+
280+
// Configure API key authorization: Token
281+
var Token = defaultClient.authentications['Token'];
282+
Token.apiKey = 'YOUR API KEY';
283+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
284+
//Token.apiKeyPrefix = 'Token';
285+
286+
var apiInstance = new LaunchDarklyApi.FeatureFlagsApi();
287+
288+
var projectKey = "projectKey_example"; // String | The project key, used to tie the flags together under one project so they can be managed together.
289+
290+
var environmentKey = "environmentKey_example"; // String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
291+
292+
var featureFlagKey = "featureFlagKey_example"; // String | The feature flag's key. The key identifies the flag in your code.
293+
294+
295+
var callback = function(error, data, response) {
296+
if (error) {
297+
console.error(error);
298+
} else {
299+
console.log('API called successfully. Returned data: ' + data);
300+
}
301+
};
302+
apiInstance.flagsProjectKeyEnvironmentKeyFeatureFlagKeyDependentFlagsGet(projectKey, environmentKey, featureFlagKey, , callback);
303+
```
304+
305+
### Parameters
306+
307+
Name | Type | Description | Notes
308+
------------- | ------------- | ------------- | -------------
309+
**projectKey** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
310+
**environmentKey** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
311+
**featureFlagKey** | **String**| The feature flag's key. The key identifies the flag in your code. |
312+
313+
### Return type
314+
315+
[**DependentFlagsByEnvironment**](DependentFlagsByEnvironment.md)
316+
317+
### Authorization
318+
319+
[Token](../README.md#Token)
320+
321+
### HTTP request headers
322+
323+
- **Content-Type**: application/json
324+
- **Accept**: application/json
325+
326+
<a name="flagsProjectKeyFeatureFlagKeyDependentFlagsGet"></a>
327+
# **flagsProjectKeyFeatureFlagKeyDependentFlagsGet**
328+
> MultiEnvironmentDependentFlags flagsProjectKeyFeatureFlagKeyDependentFlagsGet(projectKey, featureFlagKey, )
329+
330+
Get dependent flags across all environments for the flag specified in the path parameters
331+
332+
### Example
333+
```javascript
334+
var LaunchDarklyApi = require('launchdarkly-api');
335+
var defaultClient = LaunchDarklyApi.ApiClient.instance;
336+
337+
// Configure API key authorization: Token
338+
var Token = defaultClient.authentications['Token'];
339+
Token.apiKey = 'YOUR API KEY';
340+
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
341+
//Token.apiKeyPrefix = 'Token';
342+
343+
var apiInstance = new LaunchDarklyApi.FeatureFlagsApi();
344+
345+
var projectKey = "projectKey_example"; // String | The project key, used to tie the flags together under one project so they can be managed together.
346+
347+
var featureFlagKey = "featureFlagKey_example"; // String | The feature flag's key. The key identifies the flag in your code.
348+
349+
350+
var callback = function(error, data, response) {
351+
if (error) {
352+
console.error(error);
353+
} else {
354+
console.log('API called successfully. Returned data: ' + data);
355+
}
356+
};
357+
apiInstance.flagsProjectKeyFeatureFlagKeyDependentFlagsGet(projectKey, featureFlagKey, , callback);
358+
```
359+
360+
### Parameters
361+
362+
Name | Type | Description | Notes
363+
------------- | ------------- | ------------- | -------------
364+
**projectKey** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
365+
**featureFlagKey** | **String**| The feature flag's key. The key identifies the flag in your code. |
366+
367+
### Return type
368+
369+
[**MultiEnvironmentDependentFlags**](MultiEnvironmentDependentFlags.md)
370+
371+
### Authorization
372+
373+
[Token](../README.md#Token)
374+
262375
### HTTP request headers
263376

264377
- **Content-Type**: application/json

docs/Integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**links** | [**IntegrationLinks**](IntegrationLinks.md) | | [optional]
6+
**links** | [**DependentFlagLinks**](DependentFlagLinks.md) | | [optional]
77
**items** | [**[IntegrationSubscription]**](IntegrationSubscription.md) | | [optional]
88

99

docs/MultiEnvironmentDependentFlag.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# LaunchDarklyApi.MultiEnvironmentDependentFlag
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | | [optional]
7+
**key** | **String** | | [optional]
8+
**environments** | [**[DependentFlagEnvironment]**](DependentFlagEnvironment.md) | | [optional]
9+
**links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
10+
**site** | [**Site**](Site.md) | | [optional]
11+
12+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# LaunchDarklyApi.MultiEnvironmentDependentFlags
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**items** | [**[MultiEnvironmentDependentFlag]**](MultiEnvironmentDependentFlag.md) | | [optional]
7+
**links** | [**DependentFlagsLinks**](DependentFlagsLinks.md) | | [optional]
8+
**site** | [**Site**](Site.md) | | [optional]
9+
10+

docs/UserSegmentsApi.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Method | HTTP request | Description
1111
[**patchExpiringUserTargetsOnSegment**](UserSegmentsApi.md#patchExpiringUserTargetsOnSegment) | **PATCH** /segments/{projectKey}/{userSegmentKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on user segment
1212
[**patchUserSegment**](UserSegmentsApi.md#patchUserSegment) | **PATCH** /segments/{projectKey}/{environmentKey}/{userSegmentKey} | Perform a partial update to a user segment.
1313
[**postUserSegment**](UserSegmentsApi.md#postUserSegment) | **POST** /segments/{projectKey}/{environmentKey} | Creates a new user segment.
14-
[**updatedBigSegmentTargets**](UserSegmentsApi.md#updatedBigSegmentTargets) | **POST** /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users | Update targets included or excluded in a big segment
14+
[**updateBigSegmentTargets**](UserSegmentsApi.md#updateBigSegmentTargets) | **POST** /segments/{projectKey}/{environmentKey}/{userSegmentKey}/users | Update targets included or excluded in a big segment
1515

1616

1717
<a name="deleteUserSegment"></a>
@@ -420,9 +420,9 @@ Name | Type | Description | Notes
420420
- **Content-Type**: application/json
421421
- **Accept**: application/json
422422

423-
<a name="updatedBigSegmentTargets"></a>
424-
# **updatedBigSegmentTargets**
425-
> updatedBigSegmentTargets(projectKey, environmentKey, userSegmentKey, bigSegmentTargetsBody)
423+
<a name="updateBigSegmentTargets"></a>
424+
# **updateBigSegmentTargets**
425+
> updateBigSegmentTargets(projectKey, environmentKey, userSegmentKey, bigSegmentTargetsBody)
426426
427427
Update targets included or excluded in a big segment
428428

@@ -455,7 +455,7 @@ var callback = function(error, data, response) {
455455
console.log('API called successfully.');
456456
}
457457
};
458-
apiInstance.updatedBigSegmentTargets(projectKey, environmentKey, userSegmentKey, bigSegmentTargetsBody, callback);
458+
apiInstance.updateBigSegmentTargets(projectKey, environmentKey, userSegmentKey, bigSegmentTargetsBody, callback);
459459
```
460460

461461
### Parameters

0 commit comments

Comments
 (0)