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
|
@@ -19,6 +19,87 @@ module LaunchDarklyApi
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
+
# Delete agent graph
|
|
23
|
+
# Delete an existing agent graph and all of its edges.
|
|
24
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
25
|
+
# @param project_key [String]
|
|
26
|
+
# @param graph_key [String]
|
|
27
|
+
# @param [Hash] opts the optional parameters
|
|
28
|
+
# @return [nil]
|
|
29
|
+
def delete_agent_graph(ld_api_version, project_key, graph_key, opts = {})
|
|
30
|
+
delete_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts)
|
|
31
|
+
nil
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Delete agent graph
|
|
35
|
+
# Delete an existing agent graph and all of its edges.
|
|
36
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
37
|
+
# @param project_key [String]
|
|
38
|
+
# @param graph_key [String]
|
|
39
|
+
# @param [Hash] opts the optional parameters
|
|
40
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
41
|
+
def delete_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: AIConfigsBetaApi.delete_agent_graph ...'
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'ld_api_version' is set
|
|
46
|
+
if @api_client.config.client_side_validation && ld_api_version.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling AIConfigsBetaApi.delete_agent_graph"
|
|
48
|
+
end
|
|
49
|
+
# verify enum value
|
|
50
|
+
allowable_values = ["beta"]
|
|
51
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
|
|
52
|
+
fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
|
|
53
|
+
end
|
|
54
|
+
# verify the required parameter 'project_key' is set
|
|
55
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
56
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling AIConfigsBetaApi.delete_agent_graph"
|
|
57
|
+
end
|
|
58
|
+
# verify the required parameter 'graph_key' is set
|
|
59
|
+
if @api_client.config.client_side_validation && graph_key.nil?
|
|
60
|
+
fail ArgumentError, "Missing the required parameter 'graph_key' when calling AIConfigsBetaApi.delete_agent_graph"
|
|
61
|
+
end
|
|
62
|
+
# resource path
|
|
63
|
+
local_var_path = '/api/v2/projects/{projectKey}/agent-graphs/{graphKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'graphKey' + '}', CGI.escape(graph_key.to_s))
|
|
64
|
+
|
|
65
|
+
# query parameters
|
|
66
|
+
query_params = opts[:query_params] || {}
|
|
67
|
+
|
|
68
|
+
# header parameters
|
|
69
|
+
header_params = opts[:header_params] || {}
|
|
70
|
+
# HTTP header 'Accept' (if needed)
|
|
71
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
72
|
+
header_params[:'LD-API-Version'] = ld_api_version
|
|
73
|
+
|
|
74
|
+
# form parameters
|
|
75
|
+
form_params = opts[:form_params] || {}
|
|
76
|
+
|
|
77
|
+
# http body (model)
|
|
78
|
+
post_body = opts[:debug_body]
|
|
79
|
+
|
|
80
|
+
# return_type
|
|
81
|
+
return_type = opts[:debug_return_type]
|
|
82
|
+
|
|
83
|
+
# auth_names
|
|
84
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
85
|
+
|
|
86
|
+
new_options = opts.merge(
|
|
87
|
+
:operation => :"AIConfigsBetaApi.delete_agent_graph",
|
|
88
|
+
:header_params => header_params,
|
|
89
|
+
:query_params => query_params,
|
|
90
|
+
:form_params => form_params,
|
|
91
|
+
:body => post_body,
|
|
92
|
+
:auth_names => auth_names,
|
|
93
|
+
:return_type => return_type
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
97
|
+
if @api_client.config.debugging
|
|
98
|
+
@api_client.config.logger.debug "API called: AIConfigsBetaApi#delete_agent_graph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
99
|
+
end
|
|
100
|
+
return data, status_code, headers
|
|
101
|
+
end
|
|
102
|
+
|
|
22
103
|
# Delete AI Config
|
|
23
104
|
# Delete an existing AI Config.
|
|
24
105
|
# @param ld_api_version [String] Version of the endpoint.
|
|
@@ -435,6 +516,87 @@ module LaunchDarklyApi
|
|
|
435
516
|
return data, status_code, headers
|
|
436
517
|
end
|
|
437
518
|
|
|
519
|
+
# Get agent graph
|
|
520
|
+
# Retrieve a specific agent graph by its key, including its edges.
|
|
521
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
522
|
+
# @param project_key [String]
|
|
523
|
+
# @param graph_key [String]
|
|
524
|
+
# @param [Hash] opts the optional parameters
|
|
525
|
+
# @return [AgentGraph]
|
|
526
|
+
def get_agent_graph(ld_api_version, project_key, graph_key, opts = {})
|
|
527
|
+
data, _status_code, _headers = get_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts)
|
|
528
|
+
data
|
|
529
|
+
end
|
|
530
|
+
|
|
531
|
+
# Get agent graph
|
|
532
|
+
# Retrieve a specific agent graph by its key, including its edges.
|
|
533
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
534
|
+
# @param project_key [String]
|
|
535
|
+
# @param graph_key [String]
|
|
536
|
+
# @param [Hash] opts the optional parameters
|
|
537
|
+
# @return [Array<(AgentGraph, Integer, Hash)>] AgentGraph data, response status code and response headers
|
|
538
|
+
def get_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts = {})
|
|
539
|
+
if @api_client.config.debugging
|
|
540
|
+
@api_client.config.logger.debug 'Calling API: AIConfigsBetaApi.get_agent_graph ...'
|
|
541
|
+
end
|
|
542
|
+
# verify the required parameter 'ld_api_version' is set
|
|
543
|
+
if @api_client.config.client_side_validation && ld_api_version.nil?
|
|
544
|
+
fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling AIConfigsBetaApi.get_agent_graph"
|
|
545
|
+
end
|
|
546
|
+
# verify enum value
|
|
547
|
+
allowable_values = ["beta"]
|
|
548
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
|
|
549
|
+
fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
|
|
550
|
+
end
|
|
551
|
+
# verify the required parameter 'project_key' is set
|
|
552
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
553
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling AIConfigsBetaApi.get_agent_graph"
|
|
554
|
+
end
|
|
555
|
+
# verify the required parameter 'graph_key' is set
|
|
556
|
+
if @api_client.config.client_side_validation && graph_key.nil?
|
|
557
|
+
fail ArgumentError, "Missing the required parameter 'graph_key' when calling AIConfigsBetaApi.get_agent_graph"
|
|
558
|
+
end
|
|
559
|
+
# resource path
|
|
560
|
+
local_var_path = '/api/v2/projects/{projectKey}/agent-graphs/{graphKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'graphKey' + '}', CGI.escape(graph_key.to_s))
|
|
561
|
+
|
|
562
|
+
# query parameters
|
|
563
|
+
query_params = opts[:query_params] || {}
|
|
564
|
+
|
|
565
|
+
# header parameters
|
|
566
|
+
header_params = opts[:header_params] || {}
|
|
567
|
+
# HTTP header 'Accept' (if needed)
|
|
568
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
569
|
+
header_params[:'LD-API-Version'] = ld_api_version
|
|
570
|
+
|
|
571
|
+
# form parameters
|
|
572
|
+
form_params = opts[:form_params] || {}
|
|
573
|
+
|
|
574
|
+
# http body (model)
|
|
575
|
+
post_body = opts[:debug_body]
|
|
576
|
+
|
|
577
|
+
# return_type
|
|
578
|
+
return_type = opts[:debug_return_type] || 'AgentGraph'
|
|
579
|
+
|
|
580
|
+
# auth_names
|
|
581
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
582
|
+
|
|
583
|
+
new_options = opts.merge(
|
|
584
|
+
:operation => :"AIConfigsBetaApi.get_agent_graph",
|
|
585
|
+
:header_params => header_params,
|
|
586
|
+
:query_params => query_params,
|
|
587
|
+
:form_params => form_params,
|
|
588
|
+
:body => post_body,
|
|
589
|
+
:auth_names => auth_names,
|
|
590
|
+
:return_type => return_type
|
|
591
|
+
)
|
|
592
|
+
|
|
593
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
594
|
+
if @api_client.config.debugging
|
|
595
|
+
@api_client.config.logger.debug "API called: AIConfigsBetaApi#get_agent_graph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
596
|
+
end
|
|
597
|
+
return data, status_code, headers
|
|
598
|
+
end
|
|
599
|
+
|
|
438
600
|
# Get AI Config
|
|
439
601
|
# Retrieve a specific AI Config by its key.
|
|
440
602
|
# @param ld_api_version [String] Version of the endpoint.
|
|
@@ -1137,6 +1299,87 @@ module LaunchDarklyApi
|
|
|
1137
1299
|
return data, status_code, headers
|
|
1138
1300
|
end
|
|
1139
1301
|
|
|
1302
|
+
# List agent graphs
|
|
1303
|
+
# Get a list of all agent graphs in the given project. Returns metadata only, without edge data.
|
|
1304
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
1305
|
+
# @param project_key [String]
|
|
1306
|
+
# @param [Hash] opts the optional parameters
|
|
1307
|
+
# @option opts [Integer] :limit The number of AI Configs to return.
|
|
1308
|
+
# @option opts [Integer] :offset 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`.
|
|
1309
|
+
# @return [AgentGraphs]
|
|
1310
|
+
def list_agent_graphs(ld_api_version, project_key, opts = {})
|
|
1311
|
+
data, _status_code, _headers = list_agent_graphs_with_http_info(ld_api_version, project_key, opts)
|
|
1312
|
+
data
|
|
1313
|
+
end
|
|
1314
|
+
|
|
1315
|
+
# List agent graphs
|
|
1316
|
+
# Get a list of all agent graphs in the given project. Returns metadata only, without edge data.
|
|
1317
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
1318
|
+
# @param project_key [String]
|
|
1319
|
+
# @param [Hash] opts the optional parameters
|
|
1320
|
+
# @option opts [Integer] :limit The number of AI Configs to return.
|
|
1321
|
+
# @option opts [Integer] :offset 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`.
|
|
1322
|
+
# @return [Array<(AgentGraphs, Integer, Hash)>] AgentGraphs data, response status code and response headers
|
|
1323
|
+
def list_agent_graphs_with_http_info(ld_api_version, project_key, opts = {})
|
|
1324
|
+
if @api_client.config.debugging
|
|
1325
|
+
@api_client.config.logger.debug 'Calling API: AIConfigsBetaApi.list_agent_graphs ...'
|
|
1326
|
+
end
|
|
1327
|
+
# verify the required parameter 'ld_api_version' is set
|
|
1328
|
+
if @api_client.config.client_side_validation && ld_api_version.nil?
|
|
1329
|
+
fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling AIConfigsBetaApi.list_agent_graphs"
|
|
1330
|
+
end
|
|
1331
|
+
# verify enum value
|
|
1332
|
+
allowable_values = ["beta"]
|
|
1333
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
|
|
1334
|
+
fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
|
|
1335
|
+
end
|
|
1336
|
+
# verify the required parameter 'project_key' is set
|
|
1337
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
1338
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling AIConfigsBetaApi.list_agent_graphs"
|
|
1339
|
+
end
|
|
1340
|
+
# resource path
|
|
1341
|
+
local_var_path = '/api/v2/projects/{projectKey}/agent-graphs'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
|
|
1342
|
+
|
|
1343
|
+
# query parameters
|
|
1344
|
+
query_params = opts[:query_params] || {}
|
|
1345
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1346
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
1347
|
+
|
|
1348
|
+
# header parameters
|
|
1349
|
+
header_params = opts[:header_params] || {}
|
|
1350
|
+
# HTTP header 'Accept' (if needed)
|
|
1351
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1352
|
+
header_params[:'LD-API-Version'] = ld_api_version
|
|
1353
|
+
|
|
1354
|
+
# form parameters
|
|
1355
|
+
form_params = opts[:form_params] || {}
|
|
1356
|
+
|
|
1357
|
+
# http body (model)
|
|
1358
|
+
post_body = opts[:debug_body]
|
|
1359
|
+
|
|
1360
|
+
# return_type
|
|
1361
|
+
return_type = opts[:debug_return_type] || 'AgentGraphs'
|
|
1362
|
+
|
|
1363
|
+
# auth_names
|
|
1364
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
1365
|
+
|
|
1366
|
+
new_options = opts.merge(
|
|
1367
|
+
:operation => :"AIConfigsBetaApi.list_agent_graphs",
|
|
1368
|
+
:header_params => header_params,
|
|
1369
|
+
:query_params => query_params,
|
|
1370
|
+
:form_params => form_params,
|
|
1371
|
+
:body => post_body,
|
|
1372
|
+
:auth_names => auth_names,
|
|
1373
|
+
:return_type => return_type
|
|
1374
|
+
)
|
|
1375
|
+
|
|
1376
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1377
|
+
if @api_client.config.debugging
|
|
1378
|
+
@api_client.config.logger.debug "API called: AIConfigsBetaApi#list_agent_graphs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1379
|
+
end
|
|
1380
|
+
return data, status_code, headers
|
|
1381
|
+
end
|
|
1382
|
+
|
|
1140
1383
|
# List AI tool versions
|
|
1141
1384
|
# Get a list of all versions of an AI tool in the given project.
|
|
1142
1385
|
# @param ld_api_version [String] Version of the endpoint.
|
|
@@ -1392,6 +1635,94 @@ module LaunchDarklyApi
|
|
|
1392
1635
|
return data, status_code, headers
|
|
1393
1636
|
end
|
|
1394
1637
|
|
|
1638
|
+
# Update agent graph
|
|
1639
|
+
# Edit an existing agent graph. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the update includes `rootConfigKey` or `edges`, both must be present and will be treated as full replacements.
|
|
1640
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
1641
|
+
# @param project_key [String]
|
|
1642
|
+
# @param graph_key [String]
|
|
1643
|
+
# @param [Hash] opts the optional parameters
|
|
1644
|
+
# @option opts [AgentGraphPatch] :agent_graph_patch Agent graph object to update
|
|
1645
|
+
# @return [AgentGraph]
|
|
1646
|
+
def patch_agent_graph(ld_api_version, project_key, graph_key, opts = {})
|
|
1647
|
+
data, _status_code, _headers = patch_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts)
|
|
1648
|
+
data
|
|
1649
|
+
end
|
|
1650
|
+
|
|
1651
|
+
# Update agent graph
|
|
1652
|
+
# Edit an existing agent graph. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. If the update includes `rootConfigKey` or `edges`, both must be present and will be treated as full replacements.
|
|
1653
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
1654
|
+
# @param project_key [String]
|
|
1655
|
+
# @param graph_key [String]
|
|
1656
|
+
# @param [Hash] opts the optional parameters
|
|
1657
|
+
# @option opts [AgentGraphPatch] :agent_graph_patch Agent graph object to update
|
|
1658
|
+
# @return [Array<(AgentGraph, Integer, Hash)>] AgentGraph data, response status code and response headers
|
|
1659
|
+
def patch_agent_graph_with_http_info(ld_api_version, project_key, graph_key, opts = {})
|
|
1660
|
+
if @api_client.config.debugging
|
|
1661
|
+
@api_client.config.logger.debug 'Calling API: AIConfigsBetaApi.patch_agent_graph ...'
|
|
1662
|
+
end
|
|
1663
|
+
# verify the required parameter 'ld_api_version' is set
|
|
1664
|
+
if @api_client.config.client_side_validation && ld_api_version.nil?
|
|
1665
|
+
fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling AIConfigsBetaApi.patch_agent_graph"
|
|
1666
|
+
end
|
|
1667
|
+
# verify enum value
|
|
1668
|
+
allowable_values = ["beta"]
|
|
1669
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
|
|
1670
|
+
fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
|
|
1671
|
+
end
|
|
1672
|
+
# verify the required parameter 'project_key' is set
|
|
1673
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
1674
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling AIConfigsBetaApi.patch_agent_graph"
|
|
1675
|
+
end
|
|
1676
|
+
# verify the required parameter 'graph_key' is set
|
|
1677
|
+
if @api_client.config.client_side_validation && graph_key.nil?
|
|
1678
|
+
fail ArgumentError, "Missing the required parameter 'graph_key' when calling AIConfigsBetaApi.patch_agent_graph"
|
|
1679
|
+
end
|
|
1680
|
+
# resource path
|
|
1681
|
+
local_var_path = '/api/v2/projects/{projectKey}/agent-graphs/{graphKey}'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s)).sub('{' + 'graphKey' + '}', CGI.escape(graph_key.to_s))
|
|
1682
|
+
|
|
1683
|
+
# query parameters
|
|
1684
|
+
query_params = opts[:query_params] || {}
|
|
1685
|
+
|
|
1686
|
+
# header parameters
|
|
1687
|
+
header_params = opts[:header_params] || {}
|
|
1688
|
+
# HTTP header 'Accept' (if needed)
|
|
1689
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1690
|
+
# HTTP header 'Content-Type'
|
|
1691
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1692
|
+
if !content_type.nil?
|
|
1693
|
+
header_params['Content-Type'] = content_type
|
|
1694
|
+
end
|
|
1695
|
+
header_params[:'LD-API-Version'] = ld_api_version
|
|
1696
|
+
|
|
1697
|
+
# form parameters
|
|
1698
|
+
form_params = opts[:form_params] || {}
|
|
1699
|
+
|
|
1700
|
+
# http body (model)
|
|
1701
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'agent_graph_patch'])
|
|
1702
|
+
|
|
1703
|
+
# return_type
|
|
1704
|
+
return_type = opts[:debug_return_type] || 'AgentGraph'
|
|
1705
|
+
|
|
1706
|
+
# auth_names
|
|
1707
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
1708
|
+
|
|
1709
|
+
new_options = opts.merge(
|
|
1710
|
+
:operation => :"AIConfigsBetaApi.patch_agent_graph",
|
|
1711
|
+
:header_params => header_params,
|
|
1712
|
+
:query_params => query_params,
|
|
1713
|
+
:form_params => form_params,
|
|
1714
|
+
:body => post_body,
|
|
1715
|
+
:auth_names => auth_names,
|
|
1716
|
+
:return_type => return_type
|
|
1717
|
+
)
|
|
1718
|
+
|
|
1719
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
1720
|
+
if @api_client.config.debugging
|
|
1721
|
+
@api_client.config.logger.debug "API called: AIConfigsBetaApi#patch_agent_graph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1722
|
+
end
|
|
1723
|
+
return data, status_code, headers
|
|
1724
|
+
end
|
|
1725
|
+
|
|
1395
1726
|
# Update AI Config
|
|
1396
1727
|
# Edit an existing AI Config. The request body must be a JSON object of the fields to update. The values you include replace the existing values for the fields. Here's an example: ``` { \"description\": \"Example updated description\", \"tags\": [\"new-tag\"] } ```
|
|
1397
1728
|
# @param ld_api_version [String] Version of the endpoint.
|
|
@@ -1750,6 +2081,92 @@ module LaunchDarklyApi
|
|
|
1750
2081
|
return data, status_code, headers
|
|
1751
2082
|
end
|
|
1752
2083
|
|
|
2084
|
+
# Create new agent graph
|
|
2085
|
+
# Create a new agent graph within the given project.
|
|
2086
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
2087
|
+
# @param project_key [String]
|
|
2088
|
+
# @param agent_graph_post [AgentGraphPost] Agent graph object to create
|
|
2089
|
+
# @param [Hash] opts the optional parameters
|
|
2090
|
+
# @return [AgentGraph]
|
|
2091
|
+
def post_agent_graph(ld_api_version, project_key, agent_graph_post, opts = {})
|
|
2092
|
+
data, _status_code, _headers = post_agent_graph_with_http_info(ld_api_version, project_key, agent_graph_post, opts)
|
|
2093
|
+
data
|
|
2094
|
+
end
|
|
2095
|
+
|
|
2096
|
+
# Create new agent graph
|
|
2097
|
+
# Create a new agent graph within the given project.
|
|
2098
|
+
# @param ld_api_version [String] Version of the endpoint.
|
|
2099
|
+
# @param project_key [String]
|
|
2100
|
+
# @param agent_graph_post [AgentGraphPost] Agent graph object to create
|
|
2101
|
+
# @param [Hash] opts the optional parameters
|
|
2102
|
+
# @return [Array<(AgentGraph, Integer, Hash)>] AgentGraph data, response status code and response headers
|
|
2103
|
+
def post_agent_graph_with_http_info(ld_api_version, project_key, agent_graph_post, opts = {})
|
|
2104
|
+
if @api_client.config.debugging
|
|
2105
|
+
@api_client.config.logger.debug 'Calling API: AIConfigsBetaApi.post_agent_graph ...'
|
|
2106
|
+
end
|
|
2107
|
+
# verify the required parameter 'ld_api_version' is set
|
|
2108
|
+
if @api_client.config.client_side_validation && ld_api_version.nil?
|
|
2109
|
+
fail ArgumentError, "Missing the required parameter 'ld_api_version' when calling AIConfigsBetaApi.post_agent_graph"
|
|
2110
|
+
end
|
|
2111
|
+
# verify enum value
|
|
2112
|
+
allowable_values = ["beta"]
|
|
2113
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(ld_api_version)
|
|
2114
|
+
fail ArgumentError, "invalid value for \"ld_api_version\", must be one of #{allowable_values}"
|
|
2115
|
+
end
|
|
2116
|
+
# verify the required parameter 'project_key' is set
|
|
2117
|
+
if @api_client.config.client_side_validation && project_key.nil?
|
|
2118
|
+
fail ArgumentError, "Missing the required parameter 'project_key' when calling AIConfigsBetaApi.post_agent_graph"
|
|
2119
|
+
end
|
|
2120
|
+
# verify the required parameter 'agent_graph_post' is set
|
|
2121
|
+
if @api_client.config.client_side_validation && agent_graph_post.nil?
|
|
2122
|
+
fail ArgumentError, "Missing the required parameter 'agent_graph_post' when calling AIConfigsBetaApi.post_agent_graph"
|
|
2123
|
+
end
|
|
2124
|
+
# resource path
|
|
2125
|
+
local_var_path = '/api/v2/projects/{projectKey}/agent-graphs'.sub('{' + 'projectKey' + '}', CGI.escape(project_key.to_s))
|
|
2126
|
+
|
|
2127
|
+
# query parameters
|
|
2128
|
+
query_params = opts[:query_params] || {}
|
|
2129
|
+
|
|
2130
|
+
# header parameters
|
|
2131
|
+
header_params = opts[:header_params] || {}
|
|
2132
|
+
# HTTP header 'Accept' (if needed)
|
|
2133
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2134
|
+
# HTTP header 'Content-Type'
|
|
2135
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2136
|
+
if !content_type.nil?
|
|
2137
|
+
header_params['Content-Type'] = content_type
|
|
2138
|
+
end
|
|
2139
|
+
header_params[:'LD-API-Version'] = ld_api_version
|
|
2140
|
+
|
|
2141
|
+
# form parameters
|
|
2142
|
+
form_params = opts[:form_params] || {}
|
|
2143
|
+
|
|
2144
|
+
# http body (model)
|
|
2145
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(agent_graph_post)
|
|
2146
|
+
|
|
2147
|
+
# return_type
|
|
2148
|
+
return_type = opts[:debug_return_type] || 'AgentGraph'
|
|
2149
|
+
|
|
2150
|
+
# auth_names
|
|
2151
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
2152
|
+
|
|
2153
|
+
new_options = opts.merge(
|
|
2154
|
+
:operation => :"AIConfigsBetaApi.post_agent_graph",
|
|
2155
|
+
:header_params => header_params,
|
|
2156
|
+
:query_params => query_params,
|
|
2157
|
+
:form_params => form_params,
|
|
2158
|
+
:body => post_body,
|
|
2159
|
+
:auth_names => auth_names,
|
|
2160
|
+
:return_type => return_type
|
|
2161
|
+
)
|
|
2162
|
+
|
|
2163
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2164
|
+
if @api_client.config.debugging
|
|
2165
|
+
@api_client.config.logger.debug "API called: AIConfigsBetaApi#post_agent_graph\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2166
|
+
end
|
|
2167
|
+
return data, status_code, headers
|
|
2168
|
+
end
|
|
2169
|
+
|
|
1753
2170
|
# Create new AI Config
|
|
1754
2171
|
# Create a new AI Config within the given project.
|
|
1755
2172
|
# @param ld_api_version [String] Version of the endpoint.
|
|
@@ -392,6 +392,75 @@ module LaunchDarklyApi
|
|
|
392
392
|
return data, status_code, headers
|
|
393
393
|
end
|
|
394
394
|
|
|
395
|
+
# Generate trust policy
|
|
396
|
+
# Trust policy to allow Data Export to assume the role and perform operations on AWS resources
|
|
397
|
+
# @param proj_key [String] The project key
|
|
398
|
+
# @param env_key [String] The environment key
|
|
399
|
+
# @param [Hash] opts the optional parameters
|
|
400
|
+
# @return [GenerateTrustPolicyPostRep]
|
|
401
|
+
def post_generate_trust_policy(proj_key, env_key, opts = {})
|
|
402
|
+
data, _status_code, _headers = post_generate_trust_policy_with_http_info(proj_key, env_key, opts)
|
|
403
|
+
data
|
|
404
|
+
end
|
|
405
|
+
|
|
406
|
+
# Generate trust policy
|
|
407
|
+
# Trust policy to allow Data Export to assume the role and perform operations on AWS resources
|
|
408
|
+
# @param proj_key [String] The project key
|
|
409
|
+
# @param env_key [String] The environment key
|
|
410
|
+
# @param [Hash] opts the optional parameters
|
|
411
|
+
# @return [Array<(GenerateTrustPolicyPostRep, Integer, Hash)>] GenerateTrustPolicyPostRep data, response status code and response headers
|
|
412
|
+
def post_generate_trust_policy_with_http_info(proj_key, env_key, opts = {})
|
|
413
|
+
if @api_client.config.debugging
|
|
414
|
+
@api_client.config.logger.debug 'Calling API: DataExportDestinationsApi.post_generate_trust_policy ...'
|
|
415
|
+
end
|
|
416
|
+
# verify the required parameter 'proj_key' is set
|
|
417
|
+
if @api_client.config.client_side_validation && proj_key.nil?
|
|
418
|
+
fail ArgumentError, "Missing the required parameter 'proj_key' when calling DataExportDestinationsApi.post_generate_trust_policy"
|
|
419
|
+
end
|
|
420
|
+
# verify the required parameter 'env_key' is set
|
|
421
|
+
if @api_client.config.client_side_validation && env_key.nil?
|
|
422
|
+
fail ArgumentError, "Missing the required parameter 'env_key' when calling DataExportDestinationsApi.post_generate_trust_policy"
|
|
423
|
+
end
|
|
424
|
+
# resource path
|
|
425
|
+
local_var_path = '/api/v2/destinations/projects/{projKey}/environments/{envKey}/generate-trust-policy'.sub('{' + 'projKey' + '}', CGI.escape(proj_key.to_s)).sub('{' + 'envKey' + '}', CGI.escape(env_key.to_s))
|
|
426
|
+
|
|
427
|
+
# query parameters
|
|
428
|
+
query_params = opts[:query_params] || {}
|
|
429
|
+
|
|
430
|
+
# header parameters
|
|
431
|
+
header_params = opts[:header_params] || {}
|
|
432
|
+
# HTTP header 'Accept' (if needed)
|
|
433
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
434
|
+
|
|
435
|
+
# form parameters
|
|
436
|
+
form_params = opts[:form_params] || {}
|
|
437
|
+
|
|
438
|
+
# http body (model)
|
|
439
|
+
post_body = opts[:debug_body]
|
|
440
|
+
|
|
441
|
+
# return_type
|
|
442
|
+
return_type = opts[:debug_return_type] || 'GenerateTrustPolicyPostRep'
|
|
443
|
+
|
|
444
|
+
# auth_names
|
|
445
|
+
auth_names = opts[:debug_auth_names] || ['ApiKey']
|
|
446
|
+
|
|
447
|
+
new_options = opts.merge(
|
|
448
|
+
:operation => :"DataExportDestinationsApi.post_generate_trust_policy",
|
|
449
|
+
:header_params => header_params,
|
|
450
|
+
:query_params => query_params,
|
|
451
|
+
:form_params => form_params,
|
|
452
|
+
:body => post_body,
|
|
453
|
+
:auth_names => auth_names,
|
|
454
|
+
:return_type => return_type
|
|
455
|
+
)
|
|
456
|
+
|
|
457
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
458
|
+
if @api_client.config.debugging
|
|
459
|
+
@api_client.config.logger.debug "API called: DataExportDestinationsApi#post_generate_trust_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
460
|
+
end
|
|
461
|
+
return data, status_code, headers
|
|
462
|
+
end
|
|
463
|
+
|
|
395
464
|
# Generate Snowflake destination key pair
|
|
396
465
|
# Generate key pair to allow Data Export to authenticate into a Snowflake warehouse destination
|
|
397
466
|
# @param [Hash] opts the optional parameters
|
|
@@ -618,7 +618,7 @@ module LaunchDarklyApi
|
|
|
618
618
|
# @option opts [Integer] :limit The number of feature flags to return. Defaults to 20.
|
|
619
619
|
# @option opts [Integer] :offset 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`.
|
|
620
620
|
# @option opts [Boolean] :archived 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
|
|
621
|
-
# @option opts [Boolean] :summary 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.
|
|
621
|
+
# @option opts [Boolean] :summary 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.
|
|
622
622
|
# @option opts [String] :filter 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.
|
|
623
623
|
# @option opts [String] :sort 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.
|
|
624
624
|
# @option opts [Boolean] :compare Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments.
|
|
@@ -638,7 +638,7 @@ module LaunchDarklyApi
|
|
|
638
638
|
# @option opts [Integer] :limit The number of feature flags to return. Defaults to 20.
|
|
639
639
|
# @option opts [Integer] :offset 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`.
|
|
640
640
|
# @option opts [Boolean] :archived 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
|
|
641
|
-
# @option opts [Boolean] :summary 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.
|
|
641
|
+
# @option opts [Boolean] :summary 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.
|
|
642
642
|
# @option opts [String] :filter 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.
|
|
643
643
|
# @option opts [String] :sort 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.
|
|
644
644
|
# @option opts [Boolean] :compare Deprecated, unavailable in API version `20240415`. A boolean to filter results by only flags that have differences between environments.
|
|
@@ -881,6 +881,7 @@ module LaunchDarklyApi
|
|
|
881
881
|
# @param patch_with_comment [PatchWithComment]
|
|
882
882
|
# @param [Hash] opts the optional parameters
|
|
883
883
|
# @option opts [Boolean] :ignore_conflicts If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
|
|
884
|
+
# @option opts [Boolean] :dry_run If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied.
|
|
884
885
|
# @return [FeatureFlag]
|
|
885
886
|
def patch_feature_flag(project_key, feature_flag_key, patch_with_comment, opts = {})
|
|
886
887
|
data, _status_code, _headers = patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment, opts)
|
|
@@ -894,6 +895,7 @@ module LaunchDarklyApi
|
|
|
894
895
|
# @param patch_with_comment [PatchWithComment]
|
|
895
896
|
# @param [Hash] opts the optional parameters
|
|
896
897
|
# @option opts [Boolean] :ignore_conflicts If true, the patch will be applied even if it causes a pending scheduled change or approval request to fail.
|
|
898
|
+
# @option opts [Boolean] :dry_run If true, the patch will be validated but not persisted. Returns a preview of the flag after the patch is applied.
|
|
897
899
|
# @return [Array<(FeatureFlag, Integer, Hash)>] FeatureFlag data, response status code and response headers
|
|
898
900
|
def patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment, opts = {})
|
|
899
901
|
if @api_client.config.debugging
|
|
@@ -917,6 +919,7 @@ module LaunchDarklyApi
|
|
|
917
919
|
# query parameters
|
|
918
920
|
query_params = opts[:query_params] || {}
|
|
919
921
|
query_params[:'ignoreConflicts'] = opts[:'ignore_conflicts'] if !opts[:'ignore_conflicts'].nil?
|
|
922
|
+
query_params[:'dryRun'] = opts[:'dry_run'] if !opts[:'dry_run'].nil?
|
|
920
923
|
|
|
921
924
|
# header parameters
|
|
922
925
|
header_params = opts[:header_params] || {}
|
|
@@ -164,14 +164,14 @@ module LaunchDarklyApi
|
|
|
164
164
|
end
|
|
165
165
|
|
|
166
166
|
# List metrics
|
|
167
|
-
# Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.
|
|
167
|
+
# Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `metricUsedIn` | Filter by where the metric is used. One of `experiments`, `guarded_rollouts`, `any`, `none`. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.
|
|
168
168
|
# @param project_key [String] The project key
|
|
169
169
|
# @param [Hash] opts the optional parameters
|
|
170
170
|
# @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
|
|
171
171
|
# @option opts [Integer] :limit The number of metrics to return in the response. Defaults to 20. Maximum limit is 50.
|
|
172
172
|
# @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
|
|
173
173
|
# @option opts [String] :sort A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`.
|
|
174
|
-
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey`, `view`, and `
|
|
174
|
+
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey`, `view`, `dataSourceKeys`, and `metricUsedIn`. To learn more about the filter syntax, read the 'Filtering metrics' section above.
|
|
175
175
|
# @return [MetricCollectionRep]
|
|
176
176
|
def get_metrics(project_key, opts = {})
|
|
177
177
|
data, _status_code, _headers = get_metrics_with_http_info(project_key, opts)
|
|
@@ -179,14 +179,14 @@ module LaunchDarklyApi
|
|
|
179
179
|
end
|
|
180
180
|
|
|
181
181
|
# List metrics
|
|
182
|
-
# Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.
|
|
182
|
+
# Get a list of all metrics for the specified project. ### Filtering metrics The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `eventKind` | The metric event kind. One of `custom`, `pageview`, `click`. | `equals` | | `hasConnections` | Whether the metric has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `isNumeric` | Whether the metric is numeric. One of `true`, `false`. | `equals` | | `maintainerIds` | A comma-separated list of metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `metricUsedIn` | Filter by where the metric is used. One of `experiments`, `guarded_rollouts`, `any`, `none`. | `equals` | | `query` | A \"fuzzy\" search across metric key and name. Supply a string or list of strings to the operator. | `equals` | | `tags` | The metric tags. | `contains` | | `unitAggregationType` | The metric's unit aggregation type. One of `sum`, `average`. | `equals` | For example, the filter `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` matches metrics that have all three tags. The documented values for `filter` query parameters are prior to URL encoding. For example, the `[` in `?filter=tags contains [\"tag1\", \"tag2\", \"tag3\"]` must be encoded to `%5B`. ### Expanding the metric list response LaunchDarkly supports expanding the \"List metrics\" response. By default, the expandable field is **not** included in the response. To expand the response, append the `expand` query parameter and add the following supported field: - `experimentCount` includes the number of experiments from the specific project that use the metric For example, `expand=experimentCount` includes the `experimentCount` field for each metric in the response.
|
|
183
183
|
# @param project_key [String] The project key
|
|
184
184
|
# @param [Hash] opts the optional parameters
|
|
185
185
|
# @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
|
|
186
186
|
# @option opts [Integer] :limit The number of metrics to return in the response. Defaults to 20. Maximum limit is 50.
|
|
187
187
|
# @option opts [Integer] :offset Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
|
|
188
188
|
# @option opts [String] :sort A field to sort the items by. Prefix field by a dash ( - ) to sort in descending order. This endpoint supports sorting by `createdAt` or `name`.
|
|
189
|
-
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey`, `view`, and `
|
|
189
|
+
# @option opts [String] :filter A comma-separated list of filters. This endpoint accepts filtering by `query`, `tags`, 'eventKind', 'isNumeric', 'unitAggregationType`, `hasConnections`, `maintainerIds`, `maintainerTeamKey`, `view`, `dataSourceKeys`, and `metricUsedIn`. To learn more about the filter syntax, read the 'Filtering metrics' section above.
|
|
190
190
|
# @return [Array<(MetricCollectionRep, Integer, Hash)>] MetricCollectionRep data, response status code and response headers
|
|
191
191
|
def get_metrics_with_http_info(project_key, opts = {})
|
|
192
192
|
if @api_client.config.debugging
|
|
@@ -352,7 +352,7 @@ module LaunchDarklyApi
|
|
|
352
352
|
end
|
|
353
353
|
|
|
354
354
|
# Create scheduled changes workflow
|
|
355
|
-
# Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when [updating a feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag#using-semantic-patches-on-a-feature-flag). If the `
|
|
355
|
+
# Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when [updating a feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag#using-semantic-patches-on-a-feature-flag). If the `ignoreConflicts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.
|
|
356
356
|
# @param project_key [String] The project key
|
|
357
357
|
# @param feature_flag_key [String] The feature flag key
|
|
358
358
|
# @param environment_key [String] The environment key
|
|
@@ -366,7 +366,7 @@ module LaunchDarklyApi
|
|
|
366
366
|
end
|
|
367
367
|
|
|
368
368
|
# Create scheduled changes workflow
|
|
369
|
-
# Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when [updating a feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag#using-semantic-patches-on-a-feature-flag). If the `
|
|
369
|
+
# Create scheduled changes for a feature flag. The changes you schedule may include any semantic patch instructions available when [updating a feature flag](https://launchdarkly.com/docs/api/feature-flags/patch-feature-flag#using-semantic-patches-on-a-feature-flag). If the `ignoreConflicts` query parameter is false and there are conflicts between these instructions and existing scheduled changes, the request will fail. If the parameter is true and there are conflicts, the request will succeed.
|
|
370
370
|
# @param project_key [String] The project key
|
|
371
371
|
# @param feature_flag_key [String] The feature flag key
|
|
372
372
|
# @param environment_key [String] The environment key
|