launchdarkly_api 15.0.0 → 15.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +8 -5
- data/docs/AccountUsageBetaApi.md +152 -0
- data/docs/FeatureFlagBody.md +5 -1
- data/docs/FeatureFlagsApi.md +2 -2
- data/docs/InsightsChartsBetaApi.md +6 -6
- data/docs/InsightsFlagEventsBetaApi.md +2 -2
- data/docs/MetricListingRep.md +3 -3
- data/docs/MetricPost.md +8 -2
- data/docs/MetricRep.md +3 -3
- data/docs/Project.md +2 -0
- data/docs/ProjectRep.md +2 -0
- data/docs/ReleaseAudience.md +20 -0
- data/docs/ReleasePhase.md +1 -1
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +126 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +4 -4
- data/lib/launchdarkly_api/api/insights_charts_beta_api.rb +4 -4
- data/lib/launchdarkly_api/api/insights_flag_events_beta_api.rb +2 -2
- data/lib/launchdarkly_api/models/feature_flag_body.rb +24 -4
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +3 -3
- data/lib/launchdarkly_api/models/metric_post.rb +34 -5
- data/lib/launchdarkly_api/models/metric_rep.rb +3 -3
- data/lib/launchdarkly_api/models/project.rb +10 -1
- data/lib/launchdarkly_api/models/project_rep.rb +10 -1
- data/lib/launchdarkly_api/models/release_audience.rb +239 -0
- data/lib/launchdarkly_api/models/release_phase.rb +1 -1
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +1 -0
- data/spec/api/account_usage_beta_api_spec.rb +26 -0
- data/spec/api/feature_flags_api_spec.rb +2 -2
- data/spec/api/insights_charts_beta_api_spec.rb +2 -2
- data/spec/api/insights_flag_events_beta_api_spec.rb +1 -1
- data/spec/models/feature_flag_body_spec.rb +12 -0
- data/spec/models/metric_post_spec.rb +18 -0
- data/spec/models/project_rep_spec.rb +6 -0
- data/spec/models/project_spec.rb +6 -0
- data/spec/models/release_audience_spec.rb +40 -0
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e77a0e6e34b970eb62aad201c32e34644aefb1ccaef60c4880ecef99f32e1b68
|
4
|
+
data.tar.gz: 20ddc6ed8005af56aba34475718cb10d13a712514cd3ca6af088612304b1dfe4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9a12e0ce914c7f41d5276080c93c7b6d2a0dd4a4743e38e739f267acc5c38c5fbcf3cc67f7e997f96ee9c4d2af0b3faa937ab43ad5fdb1e26632a5891a954c74
|
7
|
+
data.tar.gz: 8f6035355cb0b5951f37b057980e60f18acf7dced0a8a722084c81e75ac7d4fbd646da4d1a4ba96e58b5c37effb2406c4983fdbd59ed40256cb490812871c265
|
data/README.md
CHANGED
@@ -396,7 +396,7 @@ If you would like to upgrade your integration to use a new API version, you can
|
|
396
396
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
397
397
|
|
398
398
|
- API version: 2.0
|
399
|
-
- Package version: 15.
|
399
|
+
- Package version: 15.1.0
|
400
400
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
401
401
|
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
|
402
402
|
|
@@ -413,16 +413,16 @@ gem build launchdarkly_api.gemspec
|
|
413
413
|
Then either install the gem locally:
|
414
414
|
|
415
415
|
```shell
|
416
|
-
gem install ./launchdarkly_api-15.
|
416
|
+
gem install ./launchdarkly_api-15.1.0.gem
|
417
417
|
```
|
418
418
|
|
419
|
-
(for development, run `gem install --dev ./launchdarkly_api-15.
|
419
|
+
(for development, run `gem install --dev ./launchdarkly_api-15.1.0.gem` to install the development dependencies)
|
420
420
|
|
421
421
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
422
422
|
|
423
423
|
Finally add this to the Gemfile:
|
424
424
|
|
425
|
-
gem 'launchdarkly_api', '~> 15.
|
425
|
+
gem 'launchdarkly_api', '~> 15.1.0'
|
426
426
|
|
427
427
|
### Install from Git
|
428
428
|
|
@@ -485,6 +485,7 @@ Class | Method | HTTP request | Description
|
|
485
485
|
*LaunchDarklyApi::AccountMembersApi* | [**post_member_teams**](docs/AccountMembersApi.md#post_member_teams) | **POST** /api/v2/members/{id}/teams | Add a member to teams
|
486
486
|
*LaunchDarklyApi::AccountMembersApi* | [**post_members**](docs/AccountMembersApi.md#post_members) | **POST** /api/v2/members | Invite new members
|
487
487
|
*LaunchDarklyApi::AccountMembersBetaApi* | [**patch_members**](docs/AccountMembersBetaApi.md#patch_members) | **PATCH** /api/v2/members | Modify account members
|
488
|
+
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_data_export_events_usage**](docs/AccountUsageBetaApi.md#get_data_export_events_usage) | **GET** /api/v2/usage/data-export-events | Get data export events usage
|
488
489
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_evaluations_usage**](docs/AccountUsageBetaApi.md#get_evaluations_usage) | **GET** /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} | Get evaluations usage
|
489
490
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_events_usage**](docs/AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage
|
490
491
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_experimentation_keys_usage**](docs/AccountUsageBetaApi.md#get_experimentation_keys_usage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage
|
@@ -492,6 +493,7 @@ Class | Method | HTTP request | Description
|
|
492
493
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_mau_sdks_by_type**](docs/AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type
|
493
494
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_mau_usage**](docs/AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage
|
494
495
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_mau_usage_by_category**](docs/AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category
|
496
|
+
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_service_connection_usage**](docs/AccountUsageBetaApi.md#get_service_connection_usage) | **GET** /api/v2/usage/service-connections | Get service connection usage
|
495
497
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_stream_usage**](docs/AccountUsageBetaApi.md#get_stream_usage) | **GET** /api/v2/usage/streams/{source} | Get stream usage
|
496
498
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_stream_usage_by_sdk_version**](docs/AccountUsageBetaApi.md#get_stream_usage_by_sdk_version) | **GET** /api/v2/usage/streams/{source}/bysdkversion | Get stream usage by SDK version
|
497
499
|
*LaunchDarklyApi::AccountUsageBetaApi* | [**get_stream_usage_sdkversion**](docs/AccountUsageBetaApi.md#get_stream_usage_sdkversion) | **GET** /api/v2/usage/streams/{source}/sdkversions | Get stream usage SDK versions
|
@@ -600,7 +602,7 @@ Class | Method | HTTP request | Description
|
|
600
602
|
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_deployment_frequency_chart**](docs/InsightsChartsBetaApi.md#get_deployment_frequency_chart) | **GET** /api/v2/engineering-insights/charts/deployments/frequency | Get deployment frequency chart data
|
601
603
|
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_flag_status_chart**](docs/InsightsChartsBetaApi.md#get_flag_status_chart) | **GET** /api/v2/engineering-insights/charts/flags/status | Get flag status chart data
|
602
604
|
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_lead_time_chart**](docs/InsightsChartsBetaApi.md#get_lead_time_chart) | **GET** /api/v2/engineering-insights/charts/lead-time | Get lead time chart data
|
603
|
-
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_release_frequency_chart**](docs/InsightsChartsBetaApi.md#get_release_frequency_chart) | **GET** /api/v2/engineering-insights/charts/releases/frequency | Get
|
605
|
+
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_release_frequency_chart**](docs/InsightsChartsBetaApi.md#get_release_frequency_chart) | **GET** /api/v2/engineering-insights/charts/releases/frequency | Get release frequency chart data
|
604
606
|
*LaunchDarklyApi::InsightsChartsBetaApi* | [**get_stale_flags_chart**](docs/InsightsChartsBetaApi.md#get_stale_flags_chart) | **GET** /api/v2/engineering-insights/charts/flags/stale | Get stale flags chart data
|
605
607
|
*LaunchDarklyApi::InsightsDeploymentsBetaApi* | [**create_deployment_event**](docs/InsightsDeploymentsBetaApi.md#create_deployment_event) | **POST** /api/v2/engineering-insights/deployment-events | Create deployment event
|
606
608
|
*LaunchDarklyApi::InsightsDeploymentsBetaApi* | [**get_deployment**](docs/InsightsDeploymentsBetaApi.md#get_deployment) | **GET** /api/v2/engineering-insights/deployments/{deploymentID} | Get deployment
|
@@ -1034,6 +1036,7 @@ Class | Method | HTTP request | Description
|
|
1034
1036
|
- [LaunchDarklyApi::RelayAutoConfigPost](docs/RelayAutoConfigPost.md)
|
1035
1037
|
- [LaunchDarklyApi::RelayAutoConfigRep](docs/RelayAutoConfigRep.md)
|
1036
1038
|
- [LaunchDarklyApi::Release](docs/Release.md)
|
1039
|
+
- [LaunchDarklyApi::ReleaseAudience](docs/ReleaseAudience.md)
|
1037
1040
|
- [LaunchDarklyApi::ReleasePhase](docs/ReleasePhase.md)
|
1038
1041
|
- [LaunchDarklyApi::ReleasePipeline](docs/ReleasePipeline.md)
|
1039
1042
|
- [LaunchDarklyApi::ReleasePipelineCollection](docs/ReleasePipelineCollection.md)
|
data/docs/AccountUsageBetaApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_data_export_events_usage**](AccountUsageBetaApi.md#get_data_export_events_usage) | **GET** /api/v2/usage/data-export-events | Get data export events usage |
|
7
8
|
| [**get_evaluations_usage**](AccountUsageBetaApi.md#get_evaluations_usage) | **GET** /api/v2/usage/evaluations/{projectKey}/{environmentKey}/{featureFlagKey} | Get evaluations usage |
|
8
9
|
| [**get_events_usage**](AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage |
|
9
10
|
| [**get_experimentation_keys_usage**](AccountUsageBetaApi.md#get_experimentation_keys_usage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage |
|
@@ -11,11 +12,87 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
11
12
|
| [**get_mau_sdks_by_type**](AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type |
|
12
13
|
| [**get_mau_usage**](AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage |
|
13
14
|
| [**get_mau_usage_by_category**](AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category |
|
15
|
+
| [**get_service_connection_usage**](AccountUsageBetaApi.md#get_service_connection_usage) | **GET** /api/v2/usage/service-connections | Get service connection usage |
|
14
16
|
| [**get_stream_usage**](AccountUsageBetaApi.md#get_stream_usage) | **GET** /api/v2/usage/streams/{source} | Get stream usage |
|
15
17
|
| [**get_stream_usage_by_sdk_version**](AccountUsageBetaApi.md#get_stream_usage_by_sdk_version) | **GET** /api/v2/usage/streams/{source}/bysdkversion | Get stream usage by SDK version |
|
16
18
|
| [**get_stream_usage_sdkversion**](AccountUsageBetaApi.md#get_stream_usage_sdkversion) | **GET** /api/v2/usage/streams/{source}/sdkversions | Get stream usage SDK versions |
|
17
19
|
|
18
20
|
|
21
|
+
## get_data_export_events_usage
|
22
|
+
|
23
|
+
> <SeriesIntervalsRep> get_data_export_events_usage(opts)
|
24
|
+
|
25
|
+
Get data export events usage
|
26
|
+
|
27
|
+
Get a time-series array of the number of monthly data export events from your account. The granularity is always daily, with a maximum of 31 days.
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
require 'time'
|
33
|
+
require 'launchdarkly_api'
|
34
|
+
# setup authorization
|
35
|
+
LaunchDarklyApi.configure do |config|
|
36
|
+
# Configure API key authorization: ApiKey
|
37
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
38
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
40
|
+
end
|
41
|
+
|
42
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
43
|
+
opts = {
|
44
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
|
45
|
+
to: 'to_example' # String | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
|
46
|
+
}
|
47
|
+
|
48
|
+
begin
|
49
|
+
# Get data export events usage
|
50
|
+
result = api_instance.get_data_export_events_usage(opts)
|
51
|
+
p result
|
52
|
+
rescue LaunchDarklyApi::ApiError => e
|
53
|
+
puts "Error when calling AccountUsageBetaApi->get_data_export_events_usage: #{e}"
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
#### Using the get_data_export_events_usage_with_http_info variant
|
58
|
+
|
59
|
+
This returns an Array which contains the response data, status code and headers.
|
60
|
+
|
61
|
+
> <Array(<SeriesIntervalsRep>, Integer, Hash)> get_data_export_events_usage_with_http_info(opts)
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
begin
|
65
|
+
# Get data export events usage
|
66
|
+
data, status_code, headers = api_instance.get_data_export_events_usage_with_http_info(opts)
|
67
|
+
p status_code # => 2xx
|
68
|
+
p headers # => { ... }
|
69
|
+
p data # => <SeriesIntervalsRep>
|
70
|
+
rescue LaunchDarklyApi::ApiError => e
|
71
|
+
puts "Error when calling AccountUsageBetaApi->get_data_export_events_usage_with_http_info: #{e}"
|
72
|
+
end
|
73
|
+
```
|
74
|
+
|
75
|
+
### Parameters
|
76
|
+
|
77
|
+
| Name | Type | Description | Notes |
|
78
|
+
| ---- | ---- | ----------- | ----- |
|
79
|
+
| **from** | **String** | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional] |
|
80
|
+
| **to** | **String** | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional] |
|
81
|
+
|
82
|
+
### Return type
|
83
|
+
|
84
|
+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
|
85
|
+
|
86
|
+
### Authorization
|
87
|
+
|
88
|
+
[ApiKey](../README.md#ApiKey)
|
89
|
+
|
90
|
+
### HTTP request headers
|
91
|
+
|
92
|
+
- **Content-Type**: Not defined
|
93
|
+
- **Accept**: application/json
|
94
|
+
|
95
|
+
|
19
96
|
## get_evaluations_usage
|
20
97
|
|
21
98
|
> <SeriesListRep> get_evaluations_usage(project_key, environment_key, feature_flag_key, opts)
|
@@ -565,6 +642,81 @@ end
|
|
565
642
|
- **Accept**: application/json
|
566
643
|
|
567
644
|
|
645
|
+
## get_service_connection_usage
|
646
|
+
|
647
|
+
> <SeriesIntervalsRep> get_service_connection_usage(opts)
|
648
|
+
|
649
|
+
Get service connection usage
|
650
|
+
|
651
|
+
Get a time-series array of the number of monthly service connections from your account. The granularity is always daily, with a maximum of 31 days.
|
652
|
+
|
653
|
+
### Examples
|
654
|
+
|
655
|
+
```ruby
|
656
|
+
require 'time'
|
657
|
+
require 'launchdarkly_api'
|
658
|
+
# setup authorization
|
659
|
+
LaunchDarklyApi.configure do |config|
|
660
|
+
# Configure API key authorization: ApiKey
|
661
|
+
config.api_key['ApiKey'] = 'YOUR API KEY'
|
662
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
663
|
+
# config.api_key_prefix['ApiKey'] = 'Bearer'
|
664
|
+
end
|
665
|
+
|
666
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
667
|
+
opts = {
|
668
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month.
|
669
|
+
to: 'to_example' # String | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time.
|
670
|
+
}
|
671
|
+
|
672
|
+
begin
|
673
|
+
# Get service connection usage
|
674
|
+
result = api_instance.get_service_connection_usage(opts)
|
675
|
+
p result
|
676
|
+
rescue LaunchDarklyApi::ApiError => e
|
677
|
+
puts "Error when calling AccountUsageBetaApi->get_service_connection_usage: #{e}"
|
678
|
+
end
|
679
|
+
```
|
680
|
+
|
681
|
+
#### Using the get_service_connection_usage_with_http_info variant
|
682
|
+
|
683
|
+
This returns an Array which contains the response data, status code and headers.
|
684
|
+
|
685
|
+
> <Array(<SeriesIntervalsRep>, Integer, Hash)> get_service_connection_usage_with_http_info(opts)
|
686
|
+
|
687
|
+
```ruby
|
688
|
+
begin
|
689
|
+
# Get service connection usage
|
690
|
+
data, status_code, headers = api_instance.get_service_connection_usage_with_http_info(opts)
|
691
|
+
p status_code # => 2xx
|
692
|
+
p headers # => { ... }
|
693
|
+
p data # => <SeriesIntervalsRep>
|
694
|
+
rescue LaunchDarklyApi::ApiError => e
|
695
|
+
puts "Error when calling AccountUsageBetaApi->get_service_connection_usage_with_http_info: #{e}"
|
696
|
+
end
|
697
|
+
```
|
698
|
+
|
699
|
+
### Parameters
|
700
|
+
|
701
|
+
| Name | Type | Description | Notes |
|
702
|
+
| ---- | ---- | ----------- | ----- |
|
703
|
+
| **from** | **String** | The series of data returned starts from this timestamp (Unix seconds). Defaults to the beginning of the current month. | [optional] |
|
704
|
+
| **to** | **String** | The series of data returned ends at this timestamp (Unix seconds). Defaults to the current time. | [optional] |
|
705
|
+
|
706
|
+
### Return type
|
707
|
+
|
708
|
+
[**SeriesIntervalsRep**](SeriesIntervalsRep.md)
|
709
|
+
|
710
|
+
### Authorization
|
711
|
+
|
712
|
+
[ApiKey](../README.md#ApiKey)
|
713
|
+
|
714
|
+
### HTTP request headers
|
715
|
+
|
716
|
+
- **Content-Type**: Not defined
|
717
|
+
- **Accept**: application/json
|
718
|
+
|
719
|
+
|
568
720
|
## get_stream_usage
|
569
721
|
|
570
722
|
> <SeriesListRep> get_stream_usage(source, opts)
|
data/docs/FeatureFlagBody.md
CHANGED
@@ -16,6 +16,8 @@
|
|
16
16
|
| **defaults** | [**Defaults**](Defaults.md) | | [optional] |
|
17
17
|
| **purpose** | **String** | Purpose of the flag | [optional] |
|
18
18
|
| **migration_settings** | [**MigrationSettingsPost**](MigrationSettingsPost.md) | | [optional] |
|
19
|
+
| **maintainer_id** | **String** | The ID of the member who maintains this feature flag | [optional] |
|
20
|
+
| **maintainer_team_key** | **String** | The key of the team that maintains this feature flag | [optional] |
|
19
21
|
|
20
22
|
## Example
|
21
23
|
|
@@ -34,7 +36,9 @@ instance = LaunchDarklyApi::FeatureFlagBody.new(
|
|
34
36
|
custom_properties: null,
|
35
37
|
defaults: null,
|
36
38
|
purpose: migration,
|
37
|
-
migration_settings: null
|
39
|
+
migration_settings: null,
|
40
|
+
maintainer_id: 12ab3c45de678910fgh12345,
|
41
|
+
maintainer_team_key: team-1
|
38
42
|
)
|
39
43
|
```
|
40
44
|
|
data/docs/FeatureFlagsApi.md
CHANGED
@@ -626,7 +626,7 @@ end
|
|
626
626
|
|
627
627
|
List feature flags
|
628
628
|
|
629
|
-
Get a list of all feature flags in the given project. By default, each flag includes configurations for each environment. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `
|
629
|
+
Get a list of all feature flags in the given project. By default, each flag includes configurations for each environment. You can filter environments with the `env` query parameter. For example, setting `env=production` restricts the returned configurations to just your production environment. You can also filter feature flags by tag with the `tag` query parameter. > #### Recommended use > > This endpoint can return a large amount of information. We recommend using some or all of these query parameters to decrease response time and overall payload size: `limit`, `env`, `query`, and `filter=creationDate`. ### Filtering flags You can filter on certain fields using the `filter` query parameter. For example, setting `filter=query:dark-mode,tags:beta+test` matches flags with the string `dark-mode` in their key or name, ignoring case, which also have the tags `beta` and `test`. The `filter` query parameter supports the following arguments: | Filter argument | Description | Example | |-----------------------|-------------|----------------------| | `applicationEvaluated` | A string. It filters the list to flags that are evaluated in the application with the given key. | `filter=applicationEvaluated:com.launchdarkly.cafe` | | `archived` | (deprecated) A boolean value. It filters the list to archived flags. | Use `filter=state:archived` instead | | `contextKindsEvaluated` | A `+`-separated list of context kind keys. It filters the list to flags which have been evaluated in the past 30 days for all of the context kinds in the list. | `filter=contextKindsEvaluated:user+application` | | `contextKindTargeted` | A string. It filters the list to flags that are targeting the given context kind key. | `filter=contextKindTargeted:user` | | `codeReferences.max` | An integer value. Use `0` to return flags that do not have code references. | `filter=codeReferences.max:0` | | `codeReferences.min` | An integer value. Use `1` to return flags that do have code references. | `filter=codeReferences.min:1` | | `creationDate` | An object with an optional `before` field whose value is Unix time in milliseconds. It filters the list to flags created before the date. | `filter=creationDate:{\"before\":1690527600000}` | | `evaluated` | An object that contains a key of `after` and a value in Unix time in milliseconds. It filters the list to all flags that have been evaluated since the time you specify, in the environment provided. This filter requires the `filterEnv` filter. | `filter=evaluation:{\"after\":1690527600000}` | | `filterEnv` | A string with the key of a valid environment. You must use this field for filters that are environment-specific. If there are multiple environment-specific filters, you only need to include this field once. | `filter=evaluated:{\"after\": 1590768455282},filterEnv:production,status:active` | | `followerId` | A valid member ID. It filters the list to flags that are being followed by this member. | `filter=followerId:12ab3c45de678910abc12345` | | `hasDataExport` | A boolean value. It filters the list to flags that are exporting data in the specified environment. This includes flags that are exporting data from Experimentation. This filter requires the `filterEnv` filter. | `filter=hasDataExport:true,filterEnv:production` | | `hasExperiment` | A boolean value. It filters the list to flags that are used in an experiment. | `filter=hasExperiment:true` | | `maintainerId` | A valid member ID. It filters the list to flags that are maintained by this member. | `filter=maintainerId:12ab3c45de678910abc12345` | | `maintainerTeamKey` | A string. It filters the list to flags that are maintained by the team with this key. | `filter=maintainerTeamKey:example-team-key` | | `query` | A string. It filters the list to flags that include the specified string in their key or name. It is not case sensitive. | `filter=query:example` | | `state` | A string, either `live`, `deprecated`, or `archived`. It filters the list to flags in this state. | `filter=state:archived` | | `sdkAvailability` | A string, one of `client`, `mobile`, `anyClient`, `server`. Using `client` filters the list to flags whose client-side SDK availability is set to use the client-side ID. Using `mobile` filters to flags set to use the mobile key. Using `anyClient` filters to flags set to use either the client-side ID or the mobile key. Using `server` filters to flags set to use neither, that is, to flags only available in server-side SDKs. | `filter=sdkAvailability:client` | | `segmentTargeted` | A string. It filters the list to flags that target the segment with this key. This filter requires the `filterEnv` filter. | `filter=segmentTargeted:example-segment-key,filterEnv:production` | | `status` | A string, either `new`, `inactive`, `active`, or `launched`. It filters the list to flags with the specified status in the specified environment. This filter requires the `filterEnv` filter. | `filter=status:active,filterEnv:production` | | `tags` | A `+`-separated list of tags. It filters the list to flags that have all of the tags in the list. | `filter=tags:beta+test` | | `type` | A string, either `temporary` or `permanent`. It filters the list to flags with the specified type. | `filter=type:permanent` | The documented values for the `filter` query are prior to URL encoding. For example, the `+` in `filter=tags:beta+test` must be encoded to `%2B`. By default, this endpoint returns all flags. You can page through the list with the `limit` parameter and by following the `first`, `prev`, `next`, and `last` links in the returned `_links` field. These links will not be present if the pages they refer to don't exist. For example, the `first` and `prev` links will be missing from the response on the first page. ### Sorting flags You can sort flags based on the following fields: - `creationDate` sorts by the creation date of the flag. - `key` sorts by the key of the flag. - `maintainerId` sorts by the flag maintainer. - `name` sorts by flag name. - `tags` sorts by tags. - `targetingModifiedDate` sorts by the date that the flag's targeting rules were last modified in a given environment. It must be used with `env` parameter and it can not be combined with any other sort. If multiple `env` values are provided, it will perform sort using the first one. For example, `sort=-targetingModifiedDate&env=production&env=staging` returns results sorted by `targetingModifiedDate` for the `production` environment. - `type` sorts by flag type All fields are sorted in ascending order by default. To sort in descending order, prefix the field with a dash ( - ). For example, `sort=-name` sorts the response by flag name in descending order. ### Expanding response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `codeReferences` includes code references for the feature flag - `evaluation` includes evaluation information within returned environments, including which context kinds the flag has been evaluated for in the past 30 days - `migrationSettings` includes migration settings information within the flag and within returned environments. These settings are only included for migration flags, that is, where `purpose` is `migration`. For example, `expand=evaluation` includes the `evaluation` field in the response. ### Migration flags For migration flags, the cohort information is included in the `rules` property of a flag's response, and default cohort information is included in the `fallthrough` property of a flag's response. To learn more, read [Migration Flags](https://docs.launchdarkly.com/home/flag-types/migration-flags).
|
630
630
|
|
631
631
|
### Examples
|
632
632
|
|
@@ -948,7 +948,7 @@ end
|
|
948
948
|
|
949
949
|
Create a feature flag
|
950
950
|
|
951
|
-
Create a feature flag with the given name, key, and variations. ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration.
|
951
|
+
Create a feature flag with the given name, key, and variations. <details> <summary>Click to expand instructions for <strong>creating a migration flag</strong></summary> ### Creating a migration flag When you create a migration flag, the variations are pre-determined based on the number of stages in the migration. To create a migration flag, omit the `variations` and `defaults` information. Instead, provide a `purpose` of `migration`, and `migrationSettings`. If you create a migration flag with six stages, `contextKind` is required. Otherwise, it should be omitted. Here's an example: ```json { \"key\": \"flag-key-123\", \"purpose\": \"migration\", \"migrationSettings\": { \"stageCount\": 6, \"contextKind\": \"account\" } } ``` To learn more, read [Migration Flags](https://docs.launchdarkly.com/home/flag-types/migration-flags). </details>
|
952
952
|
|
953
953
|
### Examples
|
954
954
|
|
@@ -7,7 +7,7 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
7
7
|
| [**get_deployment_frequency_chart**](InsightsChartsBetaApi.md#get_deployment_frequency_chart) | **GET** /api/v2/engineering-insights/charts/deployments/frequency | Get deployment frequency chart data |
|
8
8
|
| [**get_flag_status_chart**](InsightsChartsBetaApi.md#get_flag_status_chart) | **GET** /api/v2/engineering-insights/charts/flags/status | Get flag status chart data |
|
9
9
|
| [**get_lead_time_chart**](InsightsChartsBetaApi.md#get_lead_time_chart) | **GET** /api/v2/engineering-insights/charts/lead-time | Get lead time chart data |
|
10
|
-
| [**get_release_frequency_chart**](InsightsChartsBetaApi.md#get_release_frequency_chart) | **GET** /api/v2/engineering-insights/charts/releases/frequency | Get
|
10
|
+
| [**get_release_frequency_chart**](InsightsChartsBetaApi.md#get_release_frequency_chart) | **GET** /api/v2/engineering-insights/charts/releases/frequency | Get release frequency chart data |
|
11
11
|
| [**get_stale_flags_chart**](InsightsChartsBetaApi.md#get_stale_flags_chart) | **GET** /api/v2/engineering-insights/charts/flags/stale | Get stale flags chart data |
|
12
12
|
|
13
13
|
|
@@ -270,7 +270,7 @@ end
|
|
270
270
|
|
271
271
|
> <InsightsChart> get_release_frequency_chart(project_key, environment_key, opts)
|
272
272
|
|
273
|
-
Get
|
273
|
+
Get release frequency chart data
|
274
274
|
|
275
275
|
Get release frequency chart data. Engineering insights displays release frequency data in the [release frequency metric view](https://docs.launchdarkly.com/home/engineering-insights/metrics/release).
|
276
276
|
|
@@ -292,7 +292,7 @@ project_key = 'project_key_example' # String | The project key
|
|
292
292
|
environment_key = 'environment_key_example' # String | The environment key
|
293
293
|
opts = {
|
294
294
|
application_key: 'application_key_example', # String | Comma separated list of application keys
|
295
|
-
has_experiments: true, # Boolean | Filter events to those associated with an experiment
|
295
|
+
has_experiments: true, # Boolean | Filter events to those associated with an experiment (`true`) or without an experiment (`false`)
|
296
296
|
global: 'global_example', # String | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`
|
297
297
|
group_by: 'group_by_example', # String | Property to group results by. Options: `impact`
|
298
298
|
from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Unix timestamp in milliseconds. Default value is 7 days ago.
|
@@ -303,7 +303,7 @@ opts = {
|
|
303
303
|
}
|
304
304
|
|
305
305
|
begin
|
306
|
-
# Get
|
306
|
+
# Get release frequency chart data
|
307
307
|
result = api_instance.get_release_frequency_chart(project_key, environment_key, opts)
|
308
308
|
p result
|
309
309
|
rescue LaunchDarklyApi::ApiError => e
|
@@ -319,7 +319,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
319
319
|
|
320
320
|
```ruby
|
321
321
|
begin
|
322
|
-
# Get
|
322
|
+
# Get release frequency chart data
|
323
323
|
data, status_code, headers = api_instance.get_release_frequency_chart_with_http_info(project_key, environment_key, opts)
|
324
324
|
p status_code # => 2xx
|
325
325
|
p headers # => { ... }
|
@@ -336,7 +336,7 @@ end
|
|
336
336
|
| **project_key** | **String** | The project key | |
|
337
337
|
| **environment_key** | **String** | The environment key | |
|
338
338
|
| **application_key** | **String** | Comma separated list of application keys | [optional] |
|
339
|
-
| **has_experiments** | **Boolean** | Filter events to those associated with an experiment | [optional] |
|
339
|
+
| **has_experiments** | **Boolean** | Filter events to those associated with an experiment (`true`) or without an experiment (`false`) | [optional] |
|
340
340
|
| **global** | **String** | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` | [optional] |
|
341
341
|
| **group_by** | **String** | Property to group results by. Options: `impact` | [optional] |
|
342
342
|
| **from** | **Time** | Unix timestamp in milliseconds. Default value is 7 days ago. | [optional] |
|
@@ -35,7 +35,7 @@ opts = {
|
|
35
35
|
application_key: 'application_key_example', # String | Comma separated list of application keys
|
36
36
|
query: 'query_example', # String | Filter events by flag key
|
37
37
|
impact_size: 'impact_size_example', # String | Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large`
|
38
|
-
has_experiments: true, # Boolean | Filter events to those associated with an experiment
|
38
|
+
has_experiments: true, # Boolean | Filter events to those associated with an experiment (`true`) or without an experiment (`false`)
|
39
39
|
global: 'global_example', # String | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude`
|
40
40
|
expand: 'expand_example', # String | Expand properties in response. Options: `experiments`
|
41
41
|
limit: 789, # Integer | The number of deployments to return. Default is 20. Maximum allowed is 100.
|
@@ -81,7 +81,7 @@ end
|
|
81
81
|
| **application_key** | **String** | Comma separated list of application keys | [optional] |
|
82
82
|
| **query** | **String** | Filter events by flag key | [optional] |
|
83
83
|
| **impact_size** | **String** | Filter events by impact size. A small impact created a less than 20% change in the proportion of end users receiving one or more flag variations. A medium impact created between a 20%-80% change. A large impact created a more than 80% change. Options: `none`, `small`, `medium`, `large` | [optional] |
|
84
|
-
| **has_experiments** | **Boolean** | Filter events to those associated with an experiment | [optional] |
|
84
|
+
| **has_experiments** | **Boolean** | Filter events to those associated with an experiment (`true`) or without an experiment (`false`) | [optional] |
|
85
85
|
| **global** | **String** | Filter to include or exclude global events. Default value is `include`. Options: `include`, `exclude` | [optional] |
|
86
86
|
| **expand** | **String** | Expand properties in response. Options: `experiments` | [optional] |
|
87
87
|
| **limit** | **Integer** | The number of deployments to return. Default is 20. Maximum allowed is 100. | [optional] |
|
data/docs/MetricListingRep.md
CHANGED
@@ -26,9 +26,9 @@
|
|
26
26
|
| **unit** | **String** | For numeric custom metrics, the unit of measure | [optional] |
|
27
27
|
| **event_key** | **String** | For custom metrics, the event key to use in your code | [optional] |
|
28
28
|
| **randomization_units** | **Array<String>** | An array of randomization units allowed for this metric | [optional] |
|
29
|
-
| **unit_aggregation_type** | **String** | The method
|
30
|
-
| **analysis_type** | **String** | The
|
31
|
-
| **percentile_value** | **Integer** | The percentile
|
29
|
+
| **unit_aggregation_type** | **String** | The method by which multiple unit event values are aggregated | [optional] |
|
30
|
+
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
31
|
+
| **percentile_value** | **Integer** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] |
|
32
32
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
33
33
|
|
34
34
|
## Example
|
data/docs/MetricPost.md
CHANGED
@@ -17,7 +17,10 @@
|
|
17
17
|
| **success_criteria** | **String** | Success criteria. Required for custom numeric metrics, optional for custom conversion metrics. | [optional] |
|
18
18
|
| **tags** | **Array<String>** | Tags for the metric | [optional] |
|
19
19
|
| **randomization_units** | **Array<String>** | An array of randomization units allowed for this metric | [optional] |
|
20
|
-
| **unit_aggregation_type** | **String** | The method
|
20
|
+
| **unit_aggregation_type** | **String** | The method by which multiple unit event values are aggregated | [optional] |
|
21
|
+
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
22
|
+
| **percentile_value** | **Integer** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] |
|
23
|
+
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
21
24
|
|
22
25
|
## Example
|
23
26
|
|
@@ -38,7 +41,10 @@ instance = LaunchDarklyApi::MetricPost.new(
|
|
38
41
|
success_criteria: HigherThanBaseline,
|
39
42
|
tags: ["example-tag"],
|
40
43
|
randomization_units: ["user"],
|
41
|
-
unit_aggregation_type: average
|
44
|
+
unit_aggregation_type: average,
|
45
|
+
analysis_type: mean,
|
46
|
+
percentile_value: 95,
|
47
|
+
event_default: null
|
42
48
|
)
|
43
49
|
```
|
44
50
|
|
data/docs/MetricRep.md
CHANGED
@@ -26,9 +26,9 @@
|
|
26
26
|
| **unit** | **String** | For numeric custom metrics, the unit of measure | [optional] |
|
27
27
|
| **event_key** | **String** | For custom metrics, the event key to use in your code | [optional] |
|
28
28
|
| **randomization_units** | **Array<String>** | An array of randomization units allowed for this metric | [optional] |
|
29
|
-
| **unit_aggregation_type** | **String** | The method
|
30
|
-
| **analysis_type** | **String** | The
|
31
|
-
| **percentile_value** | **Integer** | The percentile
|
29
|
+
| **unit_aggregation_type** | **String** | The method by which multiple unit event values are aggregated | [optional] |
|
30
|
+
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
31
|
+
| **percentile_value** | **Integer** | The percentile for the analysis method. An integer denoting the target percentile between 0 and 100. Required when <code>analysisType</code> is <code>percentile</code>. | [optional] |
|
32
32
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
33
33
|
| **experiments** | [**Array<DependentExperimentRep>**](DependentExperimentRep.md) | | [optional] |
|
34
34
|
| **metric_groups** | [**Array<DependentMetricGroupRep>**](DependentMetricGroupRep.md) | Metric groups that use this metric | [optional] |
|
data/docs/Project.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **include_in_snippet_by_default** | **Boolean** | Whether or not flags created in this project are made available to the client-side JavaScript SDK by default | |
|
11
11
|
| **default_client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional] |
|
12
12
|
| **name** | **String** | A human-friendly name for the project | |
|
13
|
+
| **_access** | [**Access**](Access.md) | | [optional] |
|
13
14
|
| **tags** | **Array<String>** | A list of tags for the project | |
|
14
15
|
| **default_release_pipeline_key** | **String** | The key of the default release pipeline for this project | [optional] |
|
15
16
|
| **environments** | [**Environments**](Environments.md) | | [optional] |
|
@@ -26,6 +27,7 @@ instance = LaunchDarklyApi::Project.new(
|
|
26
27
|
include_in_snippet_by_default: true,
|
27
28
|
default_client_side_availability: null,
|
28
29
|
name: My Project,
|
30
|
+
_access: null,
|
29
31
|
tags: ["ops"],
|
30
32
|
default_release_pipeline_key: null,
|
31
33
|
environments: null
|
data/docs/ProjectRep.md
CHANGED
@@ -10,6 +10,7 @@
|
|
10
10
|
| **include_in_snippet_by_default** | **Boolean** | Whether or not flags created in this project are made available to the client-side JavaScript SDK by default | |
|
11
11
|
| **default_client_side_availability** | [**ClientSideAvailability**](ClientSideAvailability.md) | | [optional] |
|
12
12
|
| **name** | **String** | A human-friendly name for the project | |
|
13
|
+
| **_access** | [**Access**](Access.md) | | [optional] |
|
13
14
|
| **tags** | **Array<String>** | A list of tags for the project | |
|
14
15
|
| **default_release_pipeline_key** | **String** | The key of the default release pipeline for this project | [optional] |
|
15
16
|
| **environments** | [**Array<Environment>**](Environment.md) | A list of environments for the project | |
|
@@ -26,6 +27,7 @@ instance = LaunchDarklyApi::ProjectRep.new(
|
|
26
27
|
include_in_snippet_by_default: true,
|
27
28
|
default_client_side_availability: null,
|
28
29
|
name: My Project,
|
30
|
+
_access: null,
|
29
31
|
tags: ["ops"],
|
30
32
|
default_release_pipeline_key: null,
|
31
33
|
environments: null
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# LaunchDarklyApi::ReleaseAudience
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **environment** | [**EnvironmentSummary**](EnvironmentSummary.md) | | |
|
8
|
+
| **name** | **String** | The release phase name | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'launchdarkly_api'
|
14
|
+
|
15
|
+
instance = LaunchDarklyApi::ReleaseAudience.new(
|
16
|
+
environment: null,
|
17
|
+
name: Phase 1 - Testing
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/ReleasePhase.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **_creation_date** | **Integer** | | |
|
11
11
|
| **_completion_date** | **Integer** | | [optional] |
|
12
12
|
| **_completed_by** | [**CompletedBy**](CompletedBy.md) | | [optional] |
|
13
|
-
| **_audiences** | [**Array<
|
13
|
+
| **_audiences** | [**Array<ReleaseAudience>**](ReleaseAudience.md) | A logical grouping of one or more environments that share attributes for rolling out changes | |
|
14
14
|
|
15
15
|
## Example
|
16
16
|
|