launchdarkly_api 18.1.0 → 20.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +28 -10
- data/docs/AIConfig.md +3 -1
- data/docs/AIConfigPost.md +3 -1
- data/docs/AIConfigsBetaApi.md +387 -0
- data/docs/AccountUsageBetaApi.md +182 -0
- data/docs/AgentGraph.md +30 -0
- data/docs/AgentGraphEdge.md +24 -0
- data/docs/AgentGraphEdgePost.md +24 -0
- data/docs/AgentGraphPatch.md +24 -0
- data/docs/AgentGraphPost.md +26 -0
- data/docs/AgentGraphs.md +22 -0
- data/docs/AiConfigsMetricDataSourceRefRep.md +1 -1
- data/docs/AiConfigsMetricListingRep.md +1 -1
- data/docs/DataExportDestinationsApi.md +74 -0
- data/docs/FeatureFlagsApi.md +5 -3
- data/docs/GenerateTrustPolicyPostRep.md +18 -0
- data/docs/GuardedReleaseConfig.md +10 -2
- data/docs/IterationInput.md +0 -2
- data/docs/IterationRep.md +1 -3
- data/docs/MetricDataSourceRefRep.md +1 -1
- data/docs/MetricGroupRep.md +1 -5
- data/docs/MetricListingRep.md +1 -1
- data/docs/MetricRep.md +1 -1
- data/docs/Metrics.md +7 -1
- data/docs/MetricsApi.md +3 -3
- data/docs/PostReleasePolicyRequest.md +2 -2
- data/docs/ProgressiveReleaseConfig.md +20 -0
- data/docs/PutReleasePolicyRequest.md +2 -2
- data/docs/RelayAutoConfigRep.md +1 -1
- data/docs/ReleasePolicy.md +2 -2
- data/docs/ReleasePolicyScope.md +3 -1
- data/docs/ReleasePolicyStage.md +20 -0
- data/docs/Rule.md +2 -0
- data/docs/ScheduledChangesApi.md +1 -1
- data/docs/SegmentsApi.md +9 -5
- data/docs/TagsApi.md +2 -2
- data/docs/TrustPolicyDetails.md +20 -0
- data/docs/TrustPolicyStatement.md +24 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +171 -0
- data/lib/launchdarkly_api/api/ai_configs_beta_api.rb +417 -0
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +69 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +5 -2
- data/lib/launchdarkly_api/api/metrics_api.rb +4 -4
- data/lib/launchdarkly_api/api/scheduled_changes_api.rb +2 -2
- data/lib/launchdarkly_api/api/segments_api.rb +5 -2
- data/lib/launchdarkly_api/api/tags_api.rb +2 -2
- data/lib/launchdarkly_api/models/agent_graph.rb +350 -0
- data/lib/launchdarkly_api/models/agent_graph_edge.rb +303 -0
- data/lib/launchdarkly_api/models/agent_graph_edge_post.rb +303 -0
- data/lib/launchdarkly_api/models/agent_graph_patch.rb +254 -0
- data/lib/launchdarkly_api/models/agent_graph_post.rb +298 -0
- data/lib/launchdarkly_api/models/{covariance_info_rep.rb → agent_graphs.rb} +43 -59
- data/lib/launchdarkly_api/models/ai_config.rb +16 -4
- data/lib/launchdarkly_api/models/ai_config_post.rb +13 -4
- data/lib/launchdarkly_api/models/ai_configs_metric_data_source_ref_rep.rb +17 -0
- data/lib/launchdarkly_api/models/ai_configs_metric_listing_rep.rb +17 -0
- data/lib/launchdarkly_api/models/destination.rb +2 -2
- data/lib/launchdarkly_api/models/destination_post.rb +2 -2
- data/lib/launchdarkly_api/models/generate_trust_policy_post_rep.rb +220 -0
- data/lib/launchdarkly_api/models/guarded_release_config.rb +50 -21
- data/lib/launchdarkly_api/models/iteration_input.rb +1 -11
- data/lib/launchdarkly_api/models/iteration_rep.rb +32 -17
- data/lib/launchdarkly_api/models/metric_data_source_ref_rep.rb +17 -0
- data/lib/launchdarkly_api/models/metric_group_rep.rb +4 -24
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +17 -0
- data/lib/launchdarkly_api/models/metric_rep.rb +17 -0
- data/lib/launchdarkly_api/models/metrics.rb +118 -4
- data/lib/launchdarkly_api/models/naming_convention.rb +2 -2
- data/lib/launchdarkly_api/models/post_release_policy_request.rb +1 -2
- data/lib/launchdarkly_api/models/progressive_release_config.rb +234 -0
- data/lib/launchdarkly_api/models/put_release_policy_request.rb +1 -2
- data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +0 -17
- data/lib/launchdarkly_api/models/release_policy.rb +1 -2
- data/lib/launchdarkly_api/models/release_policy_scope.rb +16 -4
- data/lib/launchdarkly_api/models/release_policy_stage.rb +263 -0
- data/lib/launchdarkly_api/models/rule.rb +11 -1
- data/lib/launchdarkly_api/models/trust_policy_details.rb +233 -0
- data/lib/launchdarkly_api/models/trust_policy_statement.rb +255 -0
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +11 -1
- data/spec/api/account_usage_beta_api_spec.rb +41 -0
- data/spec/api/ai_configs_beta_api_spec.rb +72 -0
- data/spec/api/data_export_destinations_api_spec.rb +13 -0
- data/spec/api/feature_flags_api_spec.rb +2 -1
- data/spec/api/metrics_api_spec.rb +2 -2
- data/spec/api/scheduled_changes_api_spec.rb +1 -1
- data/spec/api/segments_api_spec.rb +2 -1
- data/spec/api/tags_api_spec.rb +1 -1
- data/spec/models/agent_graph_edge_post_spec.rb +54 -0
- data/spec/models/agent_graph_edge_spec.rb +54 -0
- data/spec/models/agent_graph_patch_spec.rb +54 -0
- data/spec/models/agent_graph_post_spec.rb +60 -0
- data/spec/models/agent_graph_spec.rb +72 -0
- data/spec/models/{covariance_info_rep_spec.rb → agent_graphs_spec.rb} +9 -9
- data/spec/models/ai_config_post_spec.rb +6 -0
- data/spec/models/ai_config_spec.rb +6 -0
- data/spec/models/destination_post_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/generate_trust_policy_post_rep_spec.rb +36 -0
- data/spec/models/guarded_release_config_spec.rb +24 -0
- data/spec/models/iteration_input_spec.rb +0 -6
- data/spec/models/iteration_rep_spec.rb +4 -6
- data/spec/models/metric_group_rep_spec.rb +0 -12
- data/spec/models/metrics_spec.rb +18 -0
- data/spec/models/naming_convention_spec.rb +1 -1
- data/spec/models/progressive_release_config_spec.rb +42 -0
- data/spec/models/release_policy_scope_spec.rb +6 -0
- data/spec/models/release_policy_stage_spec.rb +42 -0
- data/spec/models/rule_spec.rb +6 -0
- data/spec/models/trust_policy_details_spec.rb +42 -0
- data/spec/models/trust_policy_statement_spec.rb +54 -0
- metadata +46 -6
- data/docs/CovarianceInfoRep.md +0 -22
data/docs/AccountUsageBetaApi.md
CHANGED
|
@@ -12,7 +12,9 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
12
12
|
| [**get_events_usage**](AccountUsageBetaApi.md#get_events_usage) | **GET** /api/v2/usage/events/{type} | Get events usage |
|
|
13
13
|
| [**get_experimentation_events_usage**](AccountUsageBetaApi.md#get_experimentation_events_usage) | **GET** /api/v2/usage/experimentation-events | Get experimentation events usage |
|
|
14
14
|
| [**get_experimentation_keys_usage**](AccountUsageBetaApi.md#get_experimentation_keys_usage) | **GET** /api/v2/usage/experimentation-keys | Get experimentation keys usage |
|
|
15
|
+
| [**get_mau_clientside_usage**](AccountUsageBetaApi.md#get_mau_clientside_usage) | **GET** /api/v2/usage/clientside-mau | Get MAU clientside usage |
|
|
15
16
|
| [**get_mau_sdks_by_type**](AccountUsageBetaApi.md#get_mau_sdks_by_type) | **GET** /api/v2/usage/mau/sdks | Get MAU SDKs by type |
|
|
17
|
+
| [**get_mau_total_usage**](AccountUsageBetaApi.md#get_mau_total_usage) | **GET** /api/v2/usage/total-mau | Get MAU total usage |
|
|
16
18
|
| [**get_mau_usage**](AccountUsageBetaApi.md#get_mau_usage) | **GET** /api/v2/usage/mau | Get MAU usage |
|
|
17
19
|
| [**get_mau_usage_by_category**](AccountUsageBetaApi.md#get_mau_usage_by_category) | **GET** /api/v2/usage/mau/bycategory | Get MAU usage by category |
|
|
18
20
|
| [**get_observability_errors_usage**](AccountUsageBetaApi.md#get_observability_errors_usage) | **GET** /api/v2/usage/observability/errors | Get observability errors usage |
|
|
@@ -723,6 +725,95 @@ end
|
|
|
723
725
|
- **Accept**: application/json
|
|
724
726
|
|
|
725
727
|
|
|
728
|
+
## get_mau_clientside_usage
|
|
729
|
+
|
|
730
|
+
> <SeriesListRep> get_mau_clientside_usage(opts)
|
|
731
|
+
|
|
732
|
+
Get MAU clientside usage
|
|
733
|
+
|
|
734
|
+
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only. The counts reflect data reported from client-side SDKs.<br/><br/>For past months, the primary context kind is fixed and reflects the last known primary kind for that month. For the current month, it may vary as new primary context kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
|
|
735
|
+
|
|
736
|
+
### Examples
|
|
737
|
+
|
|
738
|
+
```ruby
|
|
739
|
+
require 'time'
|
|
740
|
+
require 'launchdarkly_api'
|
|
741
|
+
# setup authorization
|
|
742
|
+
LaunchDarklyApi.configure do |config|
|
|
743
|
+
# Configure API key authorization: ApiKey
|
|
744
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
745
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
746
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
747
|
+
end
|
|
748
|
+
|
|
749
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
|
750
|
+
opts = {
|
|
751
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
|
|
752
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
|
|
753
|
+
project_key: 'project_key_example', # String | A project key to filter results by. Can be specified multiple times, one query parameter per project key.
|
|
754
|
+
environment_key: 'environment_key_example', # String | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
|
|
755
|
+
sdk_name: 'sdk_name_example', # String | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
|
|
756
|
+
anonymous: 'anonymous_example', # String | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
|
|
757
|
+
group_by: 'group_by_example', # String | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`.
|
|
758
|
+
aggregation_type: 'aggregation_type_example', # String | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
|
|
759
|
+
granularity: 'granularity_example' # String | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
|
|
760
|
+
}
|
|
761
|
+
|
|
762
|
+
begin
|
|
763
|
+
# Get MAU clientside usage
|
|
764
|
+
result = api_instance.get_mau_clientside_usage(opts)
|
|
765
|
+
p result
|
|
766
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
767
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_clientside_usage: #{e}"
|
|
768
|
+
end
|
|
769
|
+
```
|
|
770
|
+
|
|
771
|
+
#### Using the get_mau_clientside_usage_with_http_info variant
|
|
772
|
+
|
|
773
|
+
This returns an Array which contains the response data, status code and headers.
|
|
774
|
+
|
|
775
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_mau_clientside_usage_with_http_info(opts)
|
|
776
|
+
|
|
777
|
+
```ruby
|
|
778
|
+
begin
|
|
779
|
+
# Get MAU clientside usage
|
|
780
|
+
data, status_code, headers = api_instance.get_mau_clientside_usage_with_http_info(opts)
|
|
781
|
+
p status_code # => 2xx
|
|
782
|
+
p headers # => { ... }
|
|
783
|
+
p data # => <SeriesListRep>
|
|
784
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
785
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_clientside_usage_with_http_info: #{e}"
|
|
786
|
+
end
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
### Parameters
|
|
790
|
+
|
|
791
|
+
| Name | Type | Description | Notes |
|
|
792
|
+
| ---- | ---- | ----------- | ----- |
|
|
793
|
+
| **from** | **String** | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | [optional] |
|
|
794
|
+
| **to** | **String** | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | [optional] |
|
|
795
|
+
| **project_key** | **String** | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | [optional] |
|
|
796
|
+
| **environment_key** | **String** | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key. | [optional] |
|
|
797
|
+
| **sdk_name** | **String** | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | [optional] |
|
|
798
|
+
| **anonymous** | **String** | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | [optional] |
|
|
799
|
+
| **group_by** | **String** | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkAppId`, `anonymousV2`. | [optional] |
|
|
800
|
+
| **aggregation_type** | **String** | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | [optional] |
|
|
801
|
+
| **granularity** | **String** | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only. | [optional] |
|
|
802
|
+
|
|
803
|
+
### Return type
|
|
804
|
+
|
|
805
|
+
[**SeriesListRep**](SeriesListRep.md)
|
|
806
|
+
|
|
807
|
+
### Authorization
|
|
808
|
+
|
|
809
|
+
[ApiKey](../README.md#ApiKey)
|
|
810
|
+
|
|
811
|
+
### HTTP request headers
|
|
812
|
+
|
|
813
|
+
- **Content-Type**: Not defined
|
|
814
|
+
- **Accept**: application/json
|
|
815
|
+
|
|
816
|
+
|
|
726
817
|
## get_mau_sdks_by_type
|
|
727
818
|
|
|
728
819
|
> <SdkListRep> get_mau_sdks_by_type(opts)
|
|
@@ -800,6 +891,97 @@ end
|
|
|
800
891
|
- **Accept**: application/json
|
|
801
892
|
|
|
802
893
|
|
|
894
|
+
## get_mau_total_usage
|
|
895
|
+
|
|
896
|
+
> <SeriesListRep> get_mau_total_usage(opts)
|
|
897
|
+
|
|
898
|
+
Get MAU total usage
|
|
899
|
+
|
|
900
|
+
Get a time series of the number of context key usages observed by LaunchDarkly in your account, for the primary context kind only.<br/><br/>For past months, this reflects the context kind that was most recently marked as primary for that month. For the current month, the context kind may vary as new primary kinds are observed.<br/><br/>The supported granularity varies by aggregation type. The maximum time range is 365 days.
|
|
901
|
+
|
|
902
|
+
### Examples
|
|
903
|
+
|
|
904
|
+
```ruby
|
|
905
|
+
require 'time'
|
|
906
|
+
require 'launchdarkly_api'
|
|
907
|
+
# setup authorization
|
|
908
|
+
LaunchDarklyApi.configure do |config|
|
|
909
|
+
# Configure API key authorization: ApiKey
|
|
910
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
911
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
912
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
913
|
+
end
|
|
914
|
+
|
|
915
|
+
api_instance = LaunchDarklyApi::AccountUsageBetaApi.new
|
|
916
|
+
opts = {
|
|
917
|
+
from: 'from_example', # String | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month.
|
|
918
|
+
to: 'to_example', # String | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time.
|
|
919
|
+
project_key: 'project_key_example', # String | A project key to filter results by. Can be specified multiple times, one query parameter per project key.
|
|
920
|
+
environment_key: 'environment_key_example', # String | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key.
|
|
921
|
+
sdk_name: 'sdk_name_example', # String | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name.
|
|
922
|
+
sdk_type: 'sdk_type_example', # String | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type.
|
|
923
|
+
anonymous: 'anonymous_example', # String | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`.
|
|
924
|
+
group_by: 'group_by_example', # String | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`.
|
|
925
|
+
aggregation_type: 'aggregation_type_example', # String | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`.
|
|
926
|
+
granularity: 'granularity_example' # String | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only.
|
|
927
|
+
}
|
|
928
|
+
|
|
929
|
+
begin
|
|
930
|
+
# Get MAU total usage
|
|
931
|
+
result = api_instance.get_mau_total_usage(opts)
|
|
932
|
+
p result
|
|
933
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
934
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_total_usage: #{e}"
|
|
935
|
+
end
|
|
936
|
+
```
|
|
937
|
+
|
|
938
|
+
#### Using the get_mau_total_usage_with_http_info variant
|
|
939
|
+
|
|
940
|
+
This returns an Array which contains the response data, status code and headers.
|
|
941
|
+
|
|
942
|
+
> <Array(<SeriesListRep>, Integer, Hash)> get_mau_total_usage_with_http_info(opts)
|
|
943
|
+
|
|
944
|
+
```ruby
|
|
945
|
+
begin
|
|
946
|
+
# Get MAU total usage
|
|
947
|
+
data, status_code, headers = api_instance.get_mau_total_usage_with_http_info(opts)
|
|
948
|
+
p status_code # => 2xx
|
|
949
|
+
p headers # => { ... }
|
|
950
|
+
p data # => <SeriesListRep>
|
|
951
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
952
|
+
puts "Error when calling AccountUsageBetaApi->get_mau_total_usage_with_http_info: #{e}"
|
|
953
|
+
end
|
|
954
|
+
```
|
|
955
|
+
|
|
956
|
+
### Parameters
|
|
957
|
+
|
|
958
|
+
| Name | Type | Description | Notes |
|
|
959
|
+
| ---- | ---- | ----------- | ----- |
|
|
960
|
+
| **from** | **String** | The series of data returned starts from this timestamp (Unix milliseconds). Defaults to the beginning of the current month. | [optional] |
|
|
961
|
+
| **to** | **String** | The series of data returned ends at this timestamp (Unix milliseconds). Defaults to the current time. | [optional] |
|
|
962
|
+
| **project_key** | **String** | A project key to filter results by. Can be specified multiple times, one query parameter per project key. | [optional] |
|
|
963
|
+
| **environment_key** | **String** | An environment key to filter results by. If specified, exactly one `projectKey` must be provided. Can be specified multiple times, one query parameter per environment key. | [optional] |
|
|
964
|
+
| **sdk_name** | **String** | An SDK name to filter results by. Can be specified multiple times, one query parameter per SDK name. | [optional] |
|
|
965
|
+
| **sdk_type** | **String** | An SDK type to filter results by. Can be specified multiple times, one query parameter per SDK type. | [optional] |
|
|
966
|
+
| **anonymous** | **String** | An anonymous value to filter results by. Can be specified multiple times, one query parameter per anonymous value.<br/>Valid values: `true`, `false`. | [optional] |
|
|
967
|
+
| **group_by** | **String** | If specified, returns data for each distinct value of the given field. Can be specified multiple times to group data by multiple dimensions, one query parameter per dimension.<br/>Valid values: `projectId`, `environmentId`, `sdkName`, `sdkType`, `sdkAppId`, `anonymousV2`. | [optional] |
|
|
968
|
+
| **aggregation_type** | **String** | Specifies the aggregation method. Defaults to `month_to_date`.<br/>Valid values: `month_to_date`, `incremental`, `rolling_30d`. | [optional] |
|
|
969
|
+
| **granularity** | **String** | Specifies the data granularity. Defaults to `daily`. Valid values depend on `aggregationType`: **month_to_date** supports `daily` and `monthly`; **incremental** and **rolling_30d** support `daily` only. | [optional] |
|
|
970
|
+
|
|
971
|
+
### Return type
|
|
972
|
+
|
|
973
|
+
[**SeriesListRep**](SeriesListRep.md)
|
|
974
|
+
|
|
975
|
+
### Authorization
|
|
976
|
+
|
|
977
|
+
[ApiKey](../README.md#ApiKey)
|
|
978
|
+
|
|
979
|
+
### HTTP request headers
|
|
980
|
+
|
|
981
|
+
- **Content-Type**: Not defined
|
|
982
|
+
- **Accept**: application/json
|
|
983
|
+
|
|
984
|
+
|
|
803
985
|
## get_mau_usage
|
|
804
986
|
|
|
805
987
|
> <SeriesListRep> get_mau_usage(opts)
|
data/docs/AgentGraph.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraph
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | A unique key for the agent graph | |
|
|
8
|
+
| **name** | **String** | A human-readable name for the agent graph | |
|
|
9
|
+
| **description** | **String** | A description of the agent graph | [optional] |
|
|
10
|
+
| **root_config_key** | **String** | The AI Config key of the root node | [optional] |
|
|
11
|
+
| **edges** | [**Array<AgentGraphEdge>**](AgentGraphEdge.md) | The edges in the graph | [optional] |
|
|
12
|
+
| **created_at** | **Integer** | | |
|
|
13
|
+
| **updated_at** | **Integer** | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'launchdarkly_api'
|
|
19
|
+
|
|
20
|
+
instance = LaunchDarklyApi::AgentGraph.new(
|
|
21
|
+
key: null,
|
|
22
|
+
name: null,
|
|
23
|
+
description: null,
|
|
24
|
+
root_config_key: null,
|
|
25
|
+
edges: null,
|
|
26
|
+
created_at: null,
|
|
27
|
+
updated_at: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraphEdge
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | A unique key for this edge within the graph | |
|
|
8
|
+
| **source_config** | **String** | The AI Config key that is the source of this edge | |
|
|
9
|
+
| **target_config** | **String** | The AI Config key that is the target of this edge | |
|
|
10
|
+
| **handoff** | **Object** | The handoff options from the source AI Config to the target AI Config | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::AgentGraphEdge.new(
|
|
18
|
+
key: null,
|
|
19
|
+
source_config: null,
|
|
20
|
+
target_config: null,
|
|
21
|
+
handoff: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraphEdgePost
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | A unique key for this edge within the graph | |
|
|
8
|
+
| **source_config** | **String** | The AI Config key that is the source of this edge | |
|
|
9
|
+
| **target_config** | **String** | The AI Config key that is the target of this edge | |
|
|
10
|
+
| **handoff** | **Object** | The handoff options from the source AI Config to the target AI Config | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::AgentGraphEdgePost.new(
|
|
18
|
+
key: null,
|
|
19
|
+
source_config: null,
|
|
20
|
+
target_config: null,
|
|
21
|
+
handoff: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraphPatch
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | A human-readable name for the agent graph | [optional] |
|
|
8
|
+
| **description** | **String** | A description of the agent graph | [optional] |
|
|
9
|
+
| **root_config_key** | **String** | The AI Config key of the root node. If present, edges must also be present. | [optional] |
|
|
10
|
+
| **edges** | [**Array<AgentGraphEdge>**](AgentGraphEdge.md) | The edges in the graph. If present, rootConfigKey must also be present. Replaces all existing edges. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::AgentGraphPatch.new(
|
|
18
|
+
name: null,
|
|
19
|
+
description: null,
|
|
20
|
+
root_config_key: null,
|
|
21
|
+
edges: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraphPost
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | A unique key for the agent graph | |
|
|
8
|
+
| **name** | **String** | A human-readable name for the agent graph | |
|
|
9
|
+
| **description** | **String** | A description of the agent graph | [optional] |
|
|
10
|
+
| **root_config_key** | **String** | The AI Config key of the root node. A missing root implies a newly created graph with metadata only. | [optional] |
|
|
11
|
+
| **edges** | [**Array<AgentGraphEdgePost>**](AgentGraphEdgePost.md) | The edges in the graph. If edges or rootConfigKey is present, both must be present. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'launchdarkly_api'
|
|
17
|
+
|
|
18
|
+
instance = LaunchDarklyApi::AgentGraphPost.new(
|
|
19
|
+
key: null,
|
|
20
|
+
name: null,
|
|
21
|
+
description: null,
|
|
22
|
+
root_config_key: null,
|
|
23
|
+
edges: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/AgentGraphs.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::AgentGraphs
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**PaginatedLinks**](PaginatedLinks.md) | | [optional] |
|
|
8
|
+
| **items** | [**Array<AgentGraph>**](AgentGraph.md) | | |
|
|
9
|
+
| **total_count** | **Integer** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::AgentGraphs.new(
|
|
17
|
+
_links: null,
|
|
18
|
+
items: null,
|
|
19
|
+
total_count: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **key** | **String** | |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
8
|
| **environment_key** | **String** | | [optional] |
|
|
9
9
|
| **_name** | **String** | | [optional] |
|
|
10
10
|
| **_integration_key** | **String** | | [optional] |
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
|
37
37
|
| **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] |
|
|
38
38
|
| **event_default** | [**AiConfigsMetricEventDefaultRep**](AiConfigsMetricEventDefaultRep.md) | | [optional] |
|
|
39
|
-
| **data_source** | [**AiConfigsMetricDataSourceRefRep**](AiConfigsMetricDataSourceRefRep.md) | |
|
|
39
|
+
| **data_source** | [**AiConfigsMetricDataSourceRefRep**](AiConfigsMetricDataSourceRefRep.md) | | |
|
|
40
40
|
| **archived** | **Boolean** | Whether the metric version is archived | [optional] |
|
|
41
41
|
| **archived_at** | **Integer** | | [optional] |
|
|
42
42
|
| **selector** | **String** | For click metrics, the CSS selectors | [optional] |
|
|
@@ -9,6 +9,7 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
|
9
9
|
| [**get_destinations**](DataExportDestinationsApi.md#get_destinations) | **GET** /api/v2/destinations | List destinations |
|
|
10
10
|
| [**patch_destination**](DataExportDestinationsApi.md#patch_destination) | **PATCH** /api/v2/destinations/{projectKey}/{environmentKey}/{id} | Update Data Export destination |
|
|
11
11
|
| [**post_destination**](DataExportDestinationsApi.md#post_destination) | **POST** /api/v2/destinations/{projectKey}/{environmentKey} | Create Data Export destination |
|
|
12
|
+
| [**post_generate_trust_policy**](DataExportDestinationsApi.md#post_generate_trust_policy) | **POST** /api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy | Generate trust policy |
|
|
12
13
|
| [**post_generate_warehouse_destination_key_pair**](DataExportDestinationsApi.md#post_generate_warehouse_destination_key_pair) | **POST** /api/v2/destinations/generate-warehouse-destination-key-pair | Generate Snowflake destination key pair |
|
|
13
14
|
|
|
14
15
|
|
|
@@ -381,6 +382,79 @@ end
|
|
|
381
382
|
- **Accept**: application/json
|
|
382
383
|
|
|
383
384
|
|
|
385
|
+
## post_generate_trust_policy
|
|
386
|
+
|
|
387
|
+
> <GenerateTrustPolicyPostRep> post_generate_trust_policy(proj_key, env_key)
|
|
388
|
+
|
|
389
|
+
Generate trust policy
|
|
390
|
+
|
|
391
|
+
Trust policy to allow Data Export to assume the role and perform operations on AWS resources
|
|
392
|
+
|
|
393
|
+
### Examples
|
|
394
|
+
|
|
395
|
+
```ruby
|
|
396
|
+
require 'time'
|
|
397
|
+
require 'launchdarkly_api'
|
|
398
|
+
# setup authorization
|
|
399
|
+
LaunchDarklyApi.configure do |config|
|
|
400
|
+
# Configure API key authorization: ApiKey
|
|
401
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
402
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
403
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
api_instance = LaunchDarklyApi::DataExportDestinationsApi.new
|
|
407
|
+
proj_key = 'proj_key_example' # String | The project key
|
|
408
|
+
env_key = 'env_key_example' # String | The environment key
|
|
409
|
+
|
|
410
|
+
begin
|
|
411
|
+
# Generate trust policy
|
|
412
|
+
result = api_instance.post_generate_trust_policy(proj_key, env_key)
|
|
413
|
+
p result
|
|
414
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
415
|
+
puts "Error when calling DataExportDestinationsApi->post_generate_trust_policy: #{e}"
|
|
416
|
+
end
|
|
417
|
+
```
|
|
418
|
+
|
|
419
|
+
#### Using the post_generate_trust_policy_with_http_info variant
|
|
420
|
+
|
|
421
|
+
This returns an Array which contains the response data, status code and headers.
|
|
422
|
+
|
|
423
|
+
> <Array(<GenerateTrustPolicyPostRep>, Integer, Hash)> post_generate_trust_policy_with_http_info(proj_key, env_key)
|
|
424
|
+
|
|
425
|
+
```ruby
|
|
426
|
+
begin
|
|
427
|
+
# Generate trust policy
|
|
428
|
+
data, status_code, headers = api_instance.post_generate_trust_policy_with_http_info(proj_key, env_key)
|
|
429
|
+
p status_code # => 2xx
|
|
430
|
+
p headers # => { ... }
|
|
431
|
+
p data # => <GenerateTrustPolicyPostRep>
|
|
432
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
433
|
+
puts "Error when calling DataExportDestinationsApi->post_generate_trust_policy_with_http_info: #{e}"
|
|
434
|
+
end
|
|
435
|
+
```
|
|
436
|
+
|
|
437
|
+
### Parameters
|
|
438
|
+
|
|
439
|
+
| Name | Type | Description | Notes |
|
|
440
|
+
| ---- | ---- | ----------- | ----- |
|
|
441
|
+
| **proj_key** | **String** | The project key | |
|
|
442
|
+
| **env_key** | **String** | The environment key | |
|
|
443
|
+
|
|
444
|
+
### Return type
|
|
445
|
+
|
|
446
|
+
[**GenerateTrustPolicyPostRep**](GenerateTrustPolicyPostRep.md)
|
|
447
|
+
|
|
448
|
+
### Authorization
|
|
449
|
+
|
|
450
|
+
[ApiKey](../README.md#ApiKey)
|
|
451
|
+
|
|
452
|
+
### HTTP request headers
|
|
453
|
+
|
|
454
|
+
- **Content-Type**: Not defined
|
|
455
|
+
- **Accept**: application/json
|
|
456
|
+
|
|
457
|
+
|
|
384
458
|
## post_generate_warehouse_destination_key_pair
|
|
385
459
|
|
|
386
460
|
> <GenerateWarehouseDestinationKeyPairPostRep> post_generate_warehouse_destination_key_pair
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -650,7 +650,7 @@ opts = {
|
|
|
650
650
|
limit: 789, # Integer | The number of feature flags to return. Defaults to 20.
|
|
651
651
|
offset: 789, # Integer | Where to start in the list. 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`.
|
|
652
652
|
archived: true, # Boolean | Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
|
|
653
|
-
summary: true, # Boolean | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned.
|
|
653
|
+
summary: true, # Boolean | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` and include the `env` query parameter to include these fields for each flag returned.
|
|
654
654
|
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields.
|
|
655
655
|
sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
|
|
656
656
|
compare: true, # Boolean | Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments.
|
|
@@ -694,7 +694,7 @@ end
|
|
|
694
694
|
| **limit** | **Integer** | The number of feature flags to return. Defaults to 20. | [optional] |
|
|
695
695
|
| **offset** | **Integer** | Where to start in the list. 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] |
|
|
696
696
|
| **archived** | **Boolean** | Deprecated, use `filter=archived:true` instead. A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned | [optional] |
|
|
697
|
-
| **summary** | **Boolean** | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` to include these fields for each flag returned. | [optional] |
|
|
697
|
+
| **summary** | **Boolean** | By default, flags do _not_ include their lists of prerequisites, targets, or rules for each environment. Set `summary=0` and include the `env` query parameter to include these fields for each flag returned. | [optional] |
|
|
698
698
|
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form field:value. Read the endpoint description for a full list of available filter fields. | [optional] |
|
|
699
699
|
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. | [optional] |
|
|
700
700
|
| **compare** | **Boolean** | Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments. | [optional] |
|
|
@@ -894,7 +894,8 @@ project_key = 'project_key_example' # String | The project key
|
|
|
894
894
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
|
|
895
895
|
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField'})]}) # PatchWithComment |
|
|
896
896
|
opts = {
|
|
897
|
-
ignore_conflicts: true # Boolean | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
|
|
897
|
+
ignore_conflicts: true, # Boolean | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
|
|
898
|
+
dry_run: true # Boolean | If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied.
|
|
898
899
|
}
|
|
899
900
|
|
|
900
901
|
begin
|
|
@@ -932,6 +933,7 @@ end
|
|
|
932
933
|
| **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
|
|
933
934
|
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
|
934
935
|
| **ignore_conflicts** | **Boolean** | If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail. | [optional] |
|
|
936
|
+
| **dry_run** | **Boolean** | If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied. | [optional] |
|
|
935
937
|
|
|
936
938
|
### Return type
|
|
937
939
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# LaunchDarklyApi::GenerateTrustPolicyPostRep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **aws_trust_policy** | [**TrustPolicyDetails**](TrustPolicyDetails.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'launchdarkly_api'
|
|
13
|
+
|
|
14
|
+
instance = LaunchDarklyApi::GenerateTrustPolicyPostRep.new(
|
|
15
|
+
aws_trust_policy: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -4,8 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rollout_context_kind_key** | **String** | Context kind key to use as the randomization unit for the rollout | [optional] |
|
|
7
8
|
| **min_sample_size** | **Integer** | The minimum number of samples required to make a decision | [optional] |
|
|
8
|
-
| **rollback_on_regression** | **Boolean** | Whether to roll back on regression |
|
|
9
|
+
| **rollback_on_regression** | **Boolean** | Whether to roll back on regression | [optional] |
|
|
10
|
+
| **metric_keys** | **Array<String>** | List of metric keys | [optional] |
|
|
11
|
+
| **metric_group_keys** | **Array<String>** | List of metric group keys | [optional] |
|
|
12
|
+
| **stages** | [**Array<ReleasePolicyStage>**](ReleasePolicyStage.md) | List of stages | [optional] |
|
|
9
13
|
|
|
10
14
|
## Example
|
|
11
15
|
|
|
@@ -13,8 +17,12 @@
|
|
|
13
17
|
require 'launchdarkly_api'
|
|
14
18
|
|
|
15
19
|
instance = LaunchDarklyApi::GuardedReleaseConfig.new(
|
|
20
|
+
rollout_context_kind_key: user,
|
|
16
21
|
min_sample_size: 100,
|
|
17
|
-
rollback_on_regression: true
|
|
22
|
+
rollback_on_regression: true,
|
|
23
|
+
metric_keys: ["http-errors","latency"],
|
|
24
|
+
metric_group_keys: ["frontend-metrics","backend-metrics"],
|
|
25
|
+
stages: null
|
|
18
26
|
)
|
|
19
27
|
```
|
|
20
28
|
|
data/docs/IterationInput.md
CHANGED
|
@@ -12,7 +12,6 @@
|
|
|
12
12
|
| **treatments** | [**Array<TreatmentInput>**](TreatmentInput.md) | | |
|
|
13
13
|
| **flags** | [**Hash<String, FlagInput>**](FlagInput.md) | | |
|
|
14
14
|
| **randomization_unit** | **String** | The unit of randomization for this iteration. Defaults to user. | [optional] |
|
|
15
|
-
| **covariance_id** | **String** | The ID of the covariance CSV | [optional] |
|
|
16
15
|
| **attributes** | **Array<String>** | The attributes that this iteration's results can be sliced by | [optional] |
|
|
17
16
|
|
|
18
17
|
## Example
|
|
@@ -29,7 +28,6 @@ instance = LaunchDarklyApi::IterationInput.new(
|
|
|
29
28
|
treatments: null,
|
|
30
29
|
flags: null,
|
|
31
30
|
randomization_unit: user,
|
|
32
|
-
covariance_id: null,
|
|
33
31
|
attributes: ["country","device","os"]
|
|
34
32
|
)
|
|
35
33
|
```
|
data/docs/IterationRep.md
CHANGED
|
@@ -25,7 +25,6 @@
|
|
|
25
25
|
| **secondary_metrics** | [**Array<MetricV2Rep>**](MetricV2Rep.md) | Deprecated, use <code>metrics</code> instead. Details on the secondary metrics for this experiment. | [optional] |
|
|
26
26
|
| **metrics** | [**Array<DependentMetricOrMetricGroupRep>**](DependentMetricOrMetricGroupRep.md) | Details on the metrics for this experiment | [optional] |
|
|
27
27
|
| **layer_snapshot** | [**LayerSnapshotRep**](LayerSnapshotRep.md) | | [optional] |
|
|
28
|
-
| **covariance_info** | [**CovarianceInfoRep**](CovarianceInfoRep.md) | | [optional] |
|
|
29
28
|
|
|
30
29
|
## Example
|
|
31
30
|
|
|
@@ -53,8 +52,7 @@ instance = LaunchDarklyApi::IterationRep.new(
|
|
|
53
52
|
treatments: null,
|
|
54
53
|
secondary_metrics: null,
|
|
55
54
|
metrics: null,
|
|
56
|
-
layer_snapshot: null
|
|
57
|
-
covariance_info: null
|
|
55
|
+
layer_snapshot: null
|
|
58
56
|
)
|
|
59
57
|
```
|
|
60
58
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **key** | **String** | |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
8
|
| **environment_key** | **String** | | [optional] |
|
|
9
9
|
| **_name** | **String** | | [optional] |
|
|
10
10
|
| **_integration_key** | **String** | | [optional] |
|
data/docs/MetricGroupRep.md
CHANGED
|
@@ -21,8 +21,6 @@
|
|
|
21
21
|
| **experiment_count** | **Integer** | The number of experiments using this metric group | [optional] |
|
|
22
22
|
| **active_experiment_count** | **Integer** | The number of active experiments using this metric group | [optional] |
|
|
23
23
|
| **active_guarded_rollout_count** | **Integer** | The number of active guarded rollouts using this metric group | [optional] |
|
|
24
|
-
| **total_connections_count** | **Integer** | The total number of connections using this metric group | [optional] |
|
|
25
|
-
| **total_active_connections_count** | **Integer** | The total number of active connections using this metric group | [optional] |
|
|
26
24
|
|
|
27
25
|
## Example
|
|
28
26
|
|
|
@@ -46,9 +44,7 @@ instance = LaunchDarklyApi::MetricGroupRep.new(
|
|
|
46
44
|
experiments: null,
|
|
47
45
|
experiment_count: 0,
|
|
48
46
|
active_experiment_count: 0,
|
|
49
|
-
active_guarded_rollout_count: 0
|
|
50
|
-
total_connections_count: 0,
|
|
51
|
-
total_active_connections_count: 0
|
|
47
|
+
active_guarded_rollout_count: 0
|
|
52
48
|
)
|
|
53
49
|
```
|
|
54
50
|
|
data/docs/MetricListingRep.md
CHANGED
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
|
36
36
|
| **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] |
|
|
37
37
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
|
38
|
-
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | |
|
|
38
|
+
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | | |
|
|
39
39
|
| **archived** | **Boolean** | Whether the metric version is archived | [optional] |
|
|
40
40
|
| **archived_at** | **Integer** | | [optional] |
|
|
41
41
|
| **selector** | **String** | For click metrics, the CSS selectors | [optional] |
|
data/docs/MetricRep.md
CHANGED
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
| **analysis_type** | **String** | The method for analyzing metric events | [optional] |
|
|
36
36
|
| **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] |
|
|
37
37
|
| **event_default** | [**MetricEventDefaultRep**](MetricEventDefaultRep.md) | | [optional] |
|
|
38
|
-
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | |
|
|
38
|
+
| **data_source** | [**MetricDataSourceRefRep**](MetricDataSourceRefRep.md) | | |
|
|
39
39
|
| **archived** | **Boolean** | Whether the metric version is archived | [optional] |
|
|
40
40
|
| **archived_at** | **Integer** | | [optional] |
|
|
41
41
|
| **selector** | **String** | For click metrics, the CSS selectors | [optional] |
|