launchdarkly_api 25.2.0 → 25.3.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 +64 -39
- data/docs/AIConfig.md +7 -5
- data/docs/AIConfigPatch.md +8 -4
- data/docs/AIConfigPost.md +8 -6
- data/docs/AIConfigTargeting.md +3 -3
- data/docs/AIConfigTargetingEnvironmentRule.md +8 -0
- data/docs/AIConfigTargetingEnvironmentRuleClause.md +2 -0
- data/docs/AIConfigVariation.md +1 -1
- data/docs/AIConfigVariationPatch.md +1 -1
- data/docs/AgentControlApi.md +110 -110
- data/docs/AgentOptimization.md +1 -1
- data/docs/AgentOptimizationJudge.md +1 -1
- data/docs/AgentOptimizationPost.md +1 -1
- data/docs/AgentSkill.md +3 -1
- data/docs/AgentSkillPatch.md +3 -1
- data/docs/AgentSkillPost.md +3 -1
- data/docs/AiConfigsMetricListingRep.md +2 -0
- data/docs/ApprovalsApi.md +1 -1
- data/docs/CreateFlagReleasePlanRequest.md +32 -0
- data/docs/EnvironmentReleasePlan.md +38 -0
- data/docs/EnvironmentReleasePlanClause.md +28 -0
- data/docs/EnvironmentReleasePlanMetric.md +20 -0
- data/docs/EnvironmentReleasePlanPhase.md +24 -0
- data/docs/EnvironmentReleasePlanProgressiveRelease.md +26 -0
- data/docs/EnvironmentReleasePlanProgressiveReleaseRep.md +26 -0
- data/docs/EnvironmentReleasePlanStep.md +22 -0
- data/docs/EnvironmentReleasePlans.md +22 -0
- data/docs/EnvironmentReleasePlansBetaApi.md +633 -0
- data/docs/EnvironmentReleasePlansLink.md +20 -0
- data/docs/EnvironmentReleasePlansPaginatedLinks.md +26 -0
- data/docs/EnvironmentReleasesMetricListingRep.md +2 -0
- data/docs/{ReleaseMethod.md → ExecutionMode.md} +2 -2
- data/docs/FeatureFlagsApi.md +1 -1
- data/docs/FlagReleasePlan.md +36 -0
- data/docs/FlagReleasePlanEnvironment.md +24 -0
- data/docs/FlagReleasePlanRequest.md +30 -0
- data/docs/FlagReleasePlansBetaApi.md +392 -0
- data/docs/FlagReleasePlansError.md +20 -0
- data/docs/FlagReleasePlansLink.md +20 -0
- data/docs/FlagReleasePlansPaginatedLinks.md +26 -0
- data/docs/ListFlagReleasePlansResponse.md +22 -0
- data/docs/MaintainerIdentifier.md +79 -0
- data/docs/MaintainerIdentifierMember.md +20 -0
- data/docs/MaintainerIdentifierTeam.md +20 -0
- data/docs/MaintainerResponse.md +79 -0
- data/docs/MaintainerResponseMember.md +26 -0
- data/docs/MaintainerResponseTeam.md +22 -0
- data/docs/PinnedSkillToolRef.md +20 -0
- data/docs/PostEnvironmentReleasePlanRequest.md +26 -0
- data/docs/PutDefaultEnvironmentReleasePlanRequest.md +18 -0
- data/docs/PutEnvironmentReleasePlanRequest.md +26 -0
- data/docs/PutFlagReleasePlanRequest.md +32 -0
- data/docs/QuickStats.md +2 -2
- data/docs/SkillToolRef.md +20 -0
- data/docs/ToolReferences.md +5 -1
- data/docs/ToolSkillReference.md +22 -0
- data/docs/TriggerType.md +15 -0
- data/lib/launchdarkly_api/api/agent_control_api.rb +98 -98
- data/lib/launchdarkly_api/api/approvals_api.rb +2 -2
- data/lib/launchdarkly_api/api/environment_release_plans_beta_api.rb +730 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +2 -2
- data/lib/launchdarkly_api/api/{release_policies_beta_api.rb → flag_release_plans_beta_api.rb} +173 -212
- data/lib/launchdarkly_api/models/agent_optimization.rb +1 -1
- data/lib/launchdarkly_api/models/agent_optimization_judge.rb +1 -1
- data/lib/launchdarkly_api/models/agent_optimization_post.rb +1 -1
- data/lib/launchdarkly_api/models/agent_skill.rb +14 -2
- data/lib/launchdarkly_api/models/agent_skill_patch.rb +16 -4
- data/lib/launchdarkly_api/models/agent_skill_post.rb +16 -4
- data/lib/launchdarkly_api/models/ai_config.rb +16 -6
- data/lib/launchdarkly_api/models/ai_config_patch.rb +27 -7
- data/lib/launchdarkly_api/models/ai_config_post.rb +19 -9
- data/lib/launchdarkly_api/models/ai_config_targeting.rb +3 -3
- data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule.rb +40 -1
- data/lib/launchdarkly_api/models/ai_config_targeting_environment_rule_clause.rb +11 -1
- data/lib/launchdarkly_api/models/ai_config_variation.rb +1 -1
- data/lib/launchdarkly_api/models/ai_config_variation_patch.rb +1 -1
- data/lib/launchdarkly_api/models/ai_configs_metric_listing_rep.rb +11 -1
- data/lib/launchdarkly_api/models/create_flag_release_plan_request.rb +335 -0
- data/lib/launchdarkly_api/models/environment_release_plan.rb +426 -0
- data/lib/launchdarkly_api/models/{release_policies_access_allowed_reason.rb → environment_release_plan_clause.rb} +98 -65
- data/lib/launchdarkly_api/models/{release_policies_access_allowed_rep.rb → environment_release_plan_metric.rb} +28 -41
- data/lib/launchdarkly_api/models/environment_release_plan_phase.rb +208 -0
- data/lib/launchdarkly_api/models/environment_release_plan_progressive_release.rb +285 -0
- data/lib/launchdarkly_api/models/{release_policies_access_denied_reason.rb → environment_release_plan_progressive_release_rep.rb} +85 -67
- data/lib/launchdarkly_api/models/{release_policy_stage.rb → environment_release_plan_step.rb} +43 -4
- data/lib/launchdarkly_api/models/{release_policies_response.rb → environment_release_plans.rb} +16 -7
- data/lib/launchdarkly_api/models/{release_policies_access_denied.rb → environment_release_plans_link.rb} +16 -50
- data/lib/launchdarkly_api/models/environment_release_plans_paginated_links.rb +200 -0
- data/lib/launchdarkly_api/models/environment_releases_metric_listing_rep.rb +11 -1
- data/lib/launchdarkly_api/models/{release_method.rb → execution_mode.rb} +6 -7
- data/lib/launchdarkly_api/models/expanded_ai_config.rb +1 -1
- data/lib/launchdarkly_api/models/flag_release_plan.rb +359 -0
- data/lib/launchdarkly_api/models/{put_release_policy_request.rb → flag_release_plan_environment.rb} +47 -65
- data/lib/launchdarkly_api/models/{post_release_policy_request.rb → flag_release_plan_request.rb} +64 -67
- data/lib/launchdarkly_api/models/flag_release_plans_error.rb +208 -0
- data/lib/launchdarkly_api/models/flag_release_plans_link.rb +156 -0
- data/lib/launchdarkly_api/models/flag_release_plans_paginated_links.rb +200 -0
- data/lib/launchdarkly_api/models/list_flag_release_plans_response.rb +202 -0
- data/lib/launchdarkly_api/models/maintainer_identifier.rb +56 -0
- data/lib/launchdarkly_api/models/maintainer_identifier_member.rb +214 -0
- data/lib/launchdarkly_api/models/{progressive_release_config.rb → maintainer_identifier_team.rb} +66 -32
- data/lib/launchdarkly_api/models/maintainer_response.rb +56 -0
- data/lib/launchdarkly_api/models/maintainer_response_member.rb +225 -0
- data/lib/launchdarkly_api/models/maintainer_response_team.rb +206 -0
- data/lib/launchdarkly_api/models/{release_policies_access_rep.rb → pinned_skill_tool_ref.rb} +46 -45
- data/lib/launchdarkly_api/models/{release_policy.rb → post_environment_release_plan_request.rb} +93 -120
- data/lib/launchdarkly_api/models/{release_policies_access.rb → put_default_environment_release_plan_request.rb} +33 -44
- data/lib/launchdarkly_api/models/put_environment_release_plan_request.rb +285 -0
- data/lib/launchdarkly_api/models/put_flag_release_plan_request.rb +309 -0
- data/lib/launchdarkly_api/models/quick_stats.rb +2 -2
- data/lib/launchdarkly_api/models/skill_tool_ref.rb +195 -0
- data/lib/launchdarkly_api/models/tool_references.rb +26 -4
- data/lib/launchdarkly_api/models/tool_skill_reference.rb +220 -0
- data/lib/launchdarkly_api/models/trigger_type.rb +42 -0
- data/lib/launchdarkly_api/version.rb +1 -1
- data/lib/launchdarkly_api.rb +35 -16
- data/spec/api/agent_control_api_spec.rb +49 -49
- data/spec/api/approvals_api_spec.rb +1 -1
- data/spec/api/environment_release_plans_beta_api_spec.rb +156 -0
- data/spec/api/feature_flags_api_spec.rb +1 -1
- data/spec/api/{release_policies_beta_api_spec.rb → flag_release_plans_beta_api_spec.rb} +43 -56
- data/spec/models/agent_skill_patch_spec.rb +6 -0
- data/spec/models/agent_skill_post_spec.rb +6 -0
- data/spec/models/agent_skill_spec.rb +6 -0
- data/spec/models/ai_config_patch_spec.rb +12 -0
- data/spec/models/ai_config_post_spec.rb +6 -0
- data/spec/models/ai_config_spec.rb +6 -0
- data/spec/models/ai_config_targeting_environment_rule_clause_spec.rb +6 -0
- data/spec/models/ai_config_targeting_environment_rule_spec.rb +24 -0
- data/spec/models/ai_configs_metric_listing_rep_spec.rb +6 -0
- data/spec/models/{release_policy_spec.rb → create_flag_release_plan_request_spec.rb} +13 -19
- data/spec/models/{release_policies_access_allowed_reason_spec.rb → environment_release_plan_clause_spec.rb} +16 -16
- data/spec/models/{release_policies_access_rep_spec.rb → environment_release_plan_metric_spec.rb} +8 -8
- data/spec/models/environment_release_plan_phase_spec.rb +54 -0
- data/spec/models/environment_release_plan_progressive_release_rep_spec.rb +68 -0
- data/spec/models/environment_release_plan_progressive_release_spec.rb +68 -0
- data/spec/models/environment_release_plan_spec.rb +100 -0
- data/spec/models/{release_policies_access_allowed_rep_spec.rb → environment_release_plan_step_spec.rb} +14 -8
- data/spec/models/{release_policies_access_denied_spec.rb → environment_release_plans_link_spec.rb} +8 -8
- data/spec/models/{guarded_release_config_spec.rb → environment_release_plans_paginated_links_spec.rb} +11 -17
- data/spec/models/environment_release_plans_spec.rb +48 -0
- data/spec/models/environment_releases_metric_listing_rep_spec.rb +6 -0
- data/spec/models/{release_method_spec.rb → execution_mode_spec.rb} +6 -6
- data/spec/models/flag_release_plan_environment_spec.rb +54 -0
- data/spec/models/{release_policies_access_denied_reason_spec.rb → flag_release_plan_request_spec.rb} +18 -16
- data/spec/models/flag_release_plan_spec.rb +90 -0
- data/spec/models/{release_policy_scope_spec.rb → flag_release_plans_error_spec.rb} +8 -8
- data/spec/models/{release_policy_stage_spec.rb → flag_release_plans_link_spec.rb} +8 -8
- data/spec/models/{put_release_policy_request_spec.rb → flag_release_plans_paginated_links_spec.rb} +11 -11
- data/spec/models/list_flag_release_plans_response_spec.rb +48 -0
- data/spec/models/maintainer_identifier_member_spec.rb +46 -0
- data/spec/models/maintainer_identifier_spec.rb +44 -0
- data/spec/models/{progressive_release_config_spec.rb → maintainer_identifier_team_spec.rb} +12 -8
- data/spec/models/maintainer_response_member_spec.rb +64 -0
- data/spec/models/maintainer_response_spec.rb +44 -0
- data/spec/models/maintainer_response_team_spec.rb +52 -0
- data/spec/models/{release_policies_access_spec.rb → pinned_skill_tool_ref_spec.rb} +8 -8
- data/spec/models/{post_release_policy_request_spec.rb → post_environment_release_plan_request_spec.rb} +15 -17
- data/spec/models/put_default_environment_release_plan_request_spec.rb +36 -0
- data/spec/models/put_environment_release_plan_request_spec.rb +64 -0
- data/spec/models/put_flag_release_plan_request_spec.rb +78 -0
- data/spec/models/{release_policies_response_spec.rb → skill_tool_ref_spec.rb} +8 -8
- data/spec/models/tool_references_spec.rb +12 -0
- data/spec/models/tool_skill_reference_spec.rb +48 -0
- data/spec/models/trigger_type_spec.rb +30 -0
- metadata +141 -65
- data/docs/GuardedReleaseConfig.md +0 -28
- data/docs/PostReleasePolicyRequest.md +0 -28
- data/docs/ProgressiveReleaseConfig.md +0 -20
- data/docs/PutReleasePolicyRequest.md +0 -26
- data/docs/ReleasePoliciesAccess.md +0 -20
- data/docs/ReleasePoliciesAccessAllowedReason.md +0 -28
- data/docs/ReleasePoliciesAccessAllowedRep.md +0 -20
- data/docs/ReleasePoliciesAccessDenied.md +0 -20
- data/docs/ReleasePoliciesAccessDeniedReason.md +0 -28
- data/docs/ReleasePoliciesAccessRep.md +0 -20
- data/docs/ReleasePoliciesBetaApi.md +0 -466
- data/docs/ReleasePoliciesResponse.md +0 -20
- data/docs/ReleasePolicy.md +0 -34
- data/docs/ReleasePolicyScope.md +0 -20
- data/docs/ReleasePolicyStage.md +0 -20
- data/lib/launchdarkly_api/models/guarded_release_config.rb +0 -224
- data/lib/launchdarkly_api/models/release_policy_scope.rb +0 -181
|
@@ -1,466 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::ReleasePoliciesBetaApi
|
|
2
|
-
|
|
3
|
-
All URIs are relative to *https://app.launchdarkly.com*
|
|
4
|
-
|
|
5
|
-
| Method | HTTP request | Description |
|
|
6
|
-
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**delete_release_policy**](ReleasePoliciesBetaApi.md#delete_release_policy) | **DELETE** /api/v2/projects/{projectKey}/release-policies/{policyKey} | Delete a release policy |
|
|
8
|
-
| [**get_release_policies**](ReleasePoliciesBetaApi.md#get_release_policies) | **GET** /api/v2/projects/{projectKey}/release-policies | List release policies |
|
|
9
|
-
| [**get_release_policy**](ReleasePoliciesBetaApi.md#get_release_policy) | **GET** /api/v2/projects/{projectKey}/release-policies/{policyKey} | Get a release policy by key |
|
|
10
|
-
| [**post_release_policies_order**](ReleasePoliciesBetaApi.md#post_release_policies_order) | **POST** /api/v2/projects/{projectKey}/release-policies/order | Update the order of existing release policies |
|
|
11
|
-
| [**post_release_policy**](ReleasePoliciesBetaApi.md#post_release_policy) | **POST** /api/v2/projects/{projectKey}/release-policies | Create a release policy |
|
|
12
|
-
| [**put_release_policy**](ReleasePoliciesBetaApi.md#put_release_policy) | **PUT** /api/v2/projects/{projectKey}/release-policies/{policyKey} | Update a release policy |
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
## delete_release_policy
|
|
16
|
-
|
|
17
|
-
> delete_release_policy(ld_api_version, project_key, policy_key)
|
|
18
|
-
|
|
19
|
-
Delete a release policy
|
|
20
|
-
|
|
21
|
-
Delete an existing release policy for the specified project.
|
|
22
|
-
|
|
23
|
-
### Examples
|
|
24
|
-
|
|
25
|
-
```ruby
|
|
26
|
-
require 'time'
|
|
27
|
-
require 'launchdarkly_api'
|
|
28
|
-
# setup authorization
|
|
29
|
-
LaunchDarklyApi.configure do |config|
|
|
30
|
-
# Configure API key authorization: ApiKey
|
|
31
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
32
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
34
|
-
end
|
|
35
|
-
|
|
36
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
37
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
38
|
-
project_key = 'default' # String | The project key
|
|
39
|
-
policy_key = 'production-release' # String | The human-readable key of the release policy
|
|
40
|
-
|
|
41
|
-
begin
|
|
42
|
-
# Delete a release policy
|
|
43
|
-
api_instance.delete_release_policy(ld_api_version, project_key, policy_key)
|
|
44
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
45
|
-
puts "Error when calling ReleasePoliciesBetaApi->delete_release_policy: #{e}"
|
|
46
|
-
end
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
#### Using the delete_release_policy_with_http_info variant
|
|
50
|
-
|
|
51
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
52
|
-
|
|
53
|
-
> <Array(nil, Integer, Hash)> delete_release_policy_with_http_info(ld_api_version, project_key, policy_key)
|
|
54
|
-
|
|
55
|
-
```ruby
|
|
56
|
-
begin
|
|
57
|
-
# Delete a release policy
|
|
58
|
-
data, status_code, headers = api_instance.delete_release_policy_with_http_info(ld_api_version, project_key, policy_key)
|
|
59
|
-
p status_code # => 2xx
|
|
60
|
-
p headers # => { ... }
|
|
61
|
-
p data # => nil
|
|
62
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
63
|
-
puts "Error when calling ReleasePoliciesBetaApi->delete_release_policy_with_http_info: #{e}"
|
|
64
|
-
end
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Parameters
|
|
68
|
-
|
|
69
|
-
| Name | Type | Description | Notes |
|
|
70
|
-
| ---- | ---- | ----------- | ----- |
|
|
71
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
72
|
-
| **project_key** | **String** | The project key | |
|
|
73
|
-
| **policy_key** | **String** | The human-readable key of the release policy | |
|
|
74
|
-
|
|
75
|
-
### Return type
|
|
76
|
-
|
|
77
|
-
nil (empty response body)
|
|
78
|
-
|
|
79
|
-
### Authorization
|
|
80
|
-
|
|
81
|
-
[ApiKey](../README.md#ApiKey)
|
|
82
|
-
|
|
83
|
-
### HTTP request headers
|
|
84
|
-
|
|
85
|
-
- **Content-Type**: Not defined
|
|
86
|
-
- **Accept**: application/json
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
## get_release_policies
|
|
90
|
-
|
|
91
|
-
> <ReleasePoliciesResponse> get_release_policies(ld_api_version, project_key, opts)
|
|
92
|
-
|
|
93
|
-
List release policies
|
|
94
|
-
|
|
95
|
-
Get a list of release policies for the specified project with optional filtering.
|
|
96
|
-
|
|
97
|
-
### Examples
|
|
98
|
-
|
|
99
|
-
```ruby
|
|
100
|
-
require 'time'
|
|
101
|
-
require 'launchdarkly_api'
|
|
102
|
-
# setup authorization
|
|
103
|
-
LaunchDarklyApi.configure do |config|
|
|
104
|
-
# Configure API key authorization: ApiKey
|
|
105
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
106
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
107
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
108
|
-
end
|
|
109
|
-
|
|
110
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
111
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
112
|
-
project_key = 'default' # String | The project key
|
|
113
|
-
opts = {
|
|
114
|
-
exclude_default: false # Boolean | When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present.
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
begin
|
|
118
|
-
# List release policies
|
|
119
|
-
result = api_instance.get_release_policies(ld_api_version, project_key, opts)
|
|
120
|
-
p result
|
|
121
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
122
|
-
puts "Error when calling ReleasePoliciesBetaApi->get_release_policies: #{e}"
|
|
123
|
-
end
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
#### Using the get_release_policies_with_http_info variant
|
|
127
|
-
|
|
128
|
-
This returns an Array which contains the response data, status code and headers.
|
|
129
|
-
|
|
130
|
-
> <Array(<ReleasePoliciesResponse>, Integer, Hash)> get_release_policies_with_http_info(ld_api_version, project_key, opts)
|
|
131
|
-
|
|
132
|
-
```ruby
|
|
133
|
-
begin
|
|
134
|
-
# List release policies
|
|
135
|
-
data, status_code, headers = api_instance.get_release_policies_with_http_info(ld_api_version, project_key, opts)
|
|
136
|
-
p status_code # => 2xx
|
|
137
|
-
p headers # => { ... }
|
|
138
|
-
p data # => <ReleasePoliciesResponse>
|
|
139
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
140
|
-
puts "Error when calling ReleasePoliciesBetaApi->get_release_policies_with_http_info: #{e}"
|
|
141
|
-
end
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
### Parameters
|
|
145
|
-
|
|
146
|
-
| Name | Type | Description | Notes |
|
|
147
|
-
| ---- | ---- | ----------- | ----- |
|
|
148
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
149
|
-
| **project_key** | **String** | The project key | |
|
|
150
|
-
| **exclude_default** | **Boolean** | When true, exclude the default release policy from the response. When false or omitted, include the default policy if an environment filter is present. | [optional][default to false] |
|
|
151
|
-
|
|
152
|
-
### Return type
|
|
153
|
-
|
|
154
|
-
[**ReleasePoliciesResponse**](ReleasePoliciesResponse.md)
|
|
155
|
-
|
|
156
|
-
### Authorization
|
|
157
|
-
|
|
158
|
-
[ApiKey](../README.md#ApiKey)
|
|
159
|
-
|
|
160
|
-
### HTTP request headers
|
|
161
|
-
|
|
162
|
-
- **Content-Type**: Not defined
|
|
163
|
-
- **Accept**: application/json
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
## get_release_policy
|
|
167
|
-
|
|
168
|
-
> <ReleasePolicy> get_release_policy(ld_api_version, project_key, policy_key)
|
|
169
|
-
|
|
170
|
-
Get a release policy by key
|
|
171
|
-
|
|
172
|
-
Retrieve a single release policy by its key for the specified project.
|
|
173
|
-
|
|
174
|
-
### Examples
|
|
175
|
-
|
|
176
|
-
```ruby
|
|
177
|
-
require 'time'
|
|
178
|
-
require 'launchdarkly_api'
|
|
179
|
-
# setup authorization
|
|
180
|
-
LaunchDarklyApi.configure do |config|
|
|
181
|
-
# Configure API key authorization: ApiKey
|
|
182
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
183
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
184
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
185
|
-
end
|
|
186
|
-
|
|
187
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
188
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
189
|
-
project_key = 'default' # String | The project key
|
|
190
|
-
policy_key = 'production-release' # String | The release policy key
|
|
191
|
-
|
|
192
|
-
begin
|
|
193
|
-
# Get a release policy by key
|
|
194
|
-
result = api_instance.get_release_policy(ld_api_version, project_key, policy_key)
|
|
195
|
-
p result
|
|
196
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
197
|
-
puts "Error when calling ReleasePoliciesBetaApi->get_release_policy: #{e}"
|
|
198
|
-
end
|
|
199
|
-
```
|
|
200
|
-
|
|
201
|
-
#### Using the get_release_policy_with_http_info variant
|
|
202
|
-
|
|
203
|
-
This returns an Array which contains the response data, status code and headers.
|
|
204
|
-
|
|
205
|
-
> <Array(<ReleasePolicy>, Integer, Hash)> get_release_policy_with_http_info(ld_api_version, project_key, policy_key)
|
|
206
|
-
|
|
207
|
-
```ruby
|
|
208
|
-
begin
|
|
209
|
-
# Get a release policy by key
|
|
210
|
-
data, status_code, headers = api_instance.get_release_policy_with_http_info(ld_api_version, project_key, policy_key)
|
|
211
|
-
p status_code # => 2xx
|
|
212
|
-
p headers # => { ... }
|
|
213
|
-
p data # => <ReleasePolicy>
|
|
214
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
215
|
-
puts "Error when calling ReleasePoliciesBetaApi->get_release_policy_with_http_info: #{e}"
|
|
216
|
-
end
|
|
217
|
-
```
|
|
218
|
-
|
|
219
|
-
### Parameters
|
|
220
|
-
|
|
221
|
-
| Name | Type | Description | Notes |
|
|
222
|
-
| ---- | ---- | ----------- | ----- |
|
|
223
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
224
|
-
| **project_key** | **String** | The project key | |
|
|
225
|
-
| **policy_key** | **String** | The release policy key | |
|
|
226
|
-
|
|
227
|
-
### Return type
|
|
228
|
-
|
|
229
|
-
[**ReleasePolicy**](ReleasePolicy.md)
|
|
230
|
-
|
|
231
|
-
### Authorization
|
|
232
|
-
|
|
233
|
-
[ApiKey](../README.md#ApiKey)
|
|
234
|
-
|
|
235
|
-
### HTTP request headers
|
|
236
|
-
|
|
237
|
-
- **Content-Type**: Not defined
|
|
238
|
-
- **Accept**: application/json
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
## post_release_policies_order
|
|
242
|
-
|
|
243
|
-
> <Array<ReleasePolicy>> post_release_policies_order(ld_api_version, project_key, request_body)
|
|
244
|
-
|
|
245
|
-
Update the order of existing release policies
|
|
246
|
-
|
|
247
|
-
Update the order of existing release policies for the specified project.
|
|
248
|
-
|
|
249
|
-
### Examples
|
|
250
|
-
|
|
251
|
-
```ruby
|
|
252
|
-
require 'time'
|
|
253
|
-
require 'launchdarkly_api'
|
|
254
|
-
# setup authorization
|
|
255
|
-
LaunchDarklyApi.configure do |config|
|
|
256
|
-
# Configure API key authorization: ApiKey
|
|
257
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
258
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
259
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
260
|
-
end
|
|
261
|
-
|
|
262
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
263
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
264
|
-
project_key = 'default' # String | The project key
|
|
265
|
-
request_body = ['property_example'] # Array<String> | Array of release policy keys in the desired rank order (scoped policies only). These keys must include _all_ of the scoped release policies for the project.
|
|
266
|
-
|
|
267
|
-
begin
|
|
268
|
-
# Update the order of existing release policies
|
|
269
|
-
result = api_instance.post_release_policies_order(ld_api_version, project_key, request_body)
|
|
270
|
-
p result
|
|
271
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
272
|
-
puts "Error when calling ReleasePoliciesBetaApi->post_release_policies_order: #{e}"
|
|
273
|
-
end
|
|
274
|
-
```
|
|
275
|
-
|
|
276
|
-
#### Using the post_release_policies_order_with_http_info variant
|
|
277
|
-
|
|
278
|
-
This returns an Array which contains the response data, status code and headers.
|
|
279
|
-
|
|
280
|
-
> <Array(<Array<ReleasePolicy>>, Integer, Hash)> post_release_policies_order_with_http_info(ld_api_version, project_key, request_body)
|
|
281
|
-
|
|
282
|
-
```ruby
|
|
283
|
-
begin
|
|
284
|
-
# Update the order of existing release policies
|
|
285
|
-
data, status_code, headers = api_instance.post_release_policies_order_with_http_info(ld_api_version, project_key, request_body)
|
|
286
|
-
p status_code # => 2xx
|
|
287
|
-
p headers # => { ... }
|
|
288
|
-
p data # => <Array<ReleasePolicy>>
|
|
289
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
290
|
-
puts "Error when calling ReleasePoliciesBetaApi->post_release_policies_order_with_http_info: #{e}"
|
|
291
|
-
end
|
|
292
|
-
```
|
|
293
|
-
|
|
294
|
-
### Parameters
|
|
295
|
-
|
|
296
|
-
| Name | Type | Description | Notes |
|
|
297
|
-
| ---- | ---- | ----------- | ----- |
|
|
298
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
299
|
-
| **project_key** | **String** | The project key | |
|
|
300
|
-
| **request_body** | [**Array<String>**](String.md) | Array of release policy keys in the desired rank order (scoped policies only). These keys must include _all_ of the scoped release policies for the project. | |
|
|
301
|
-
|
|
302
|
-
### Return type
|
|
303
|
-
|
|
304
|
-
[**Array<ReleasePolicy>**](ReleasePolicy.md)
|
|
305
|
-
|
|
306
|
-
### Authorization
|
|
307
|
-
|
|
308
|
-
[ApiKey](../README.md#ApiKey)
|
|
309
|
-
|
|
310
|
-
### HTTP request headers
|
|
311
|
-
|
|
312
|
-
- **Content-Type**: application/json
|
|
313
|
-
- **Accept**: application/json
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
## post_release_policy
|
|
317
|
-
|
|
318
|
-
> <ReleasePolicy> post_release_policy(ld_api_version, project_key, post_release_policy_request)
|
|
319
|
-
|
|
320
|
-
Create a release policy
|
|
321
|
-
|
|
322
|
-
Create a new release policy for the specified project.
|
|
323
|
-
|
|
324
|
-
### Examples
|
|
325
|
-
|
|
326
|
-
```ruby
|
|
327
|
-
require 'time'
|
|
328
|
-
require 'launchdarkly_api'
|
|
329
|
-
# setup authorization
|
|
330
|
-
LaunchDarklyApi.configure do |config|
|
|
331
|
-
# Configure API key authorization: ApiKey
|
|
332
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
333
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
334
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
335
|
-
end
|
|
336
|
-
|
|
337
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
338
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
339
|
-
project_key = 'default' # String | The project key
|
|
340
|
-
post_release_policy_request = LaunchDarklyApi::PostReleasePolicyRequest.new({release_method: LaunchDarklyApi::ReleaseMethod::GUARDED_RELEASE, name: 'Production Release', key: 'production-release'}) # PostReleasePolicyRequest | Release policy to create
|
|
341
|
-
|
|
342
|
-
begin
|
|
343
|
-
# Create a release policy
|
|
344
|
-
result = api_instance.post_release_policy(ld_api_version, project_key, post_release_policy_request)
|
|
345
|
-
p result
|
|
346
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
347
|
-
puts "Error when calling ReleasePoliciesBetaApi->post_release_policy: #{e}"
|
|
348
|
-
end
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
#### Using the post_release_policy_with_http_info variant
|
|
352
|
-
|
|
353
|
-
This returns an Array which contains the response data, status code and headers.
|
|
354
|
-
|
|
355
|
-
> <Array(<ReleasePolicy>, Integer, Hash)> post_release_policy_with_http_info(ld_api_version, project_key, post_release_policy_request)
|
|
356
|
-
|
|
357
|
-
```ruby
|
|
358
|
-
begin
|
|
359
|
-
# Create a release policy
|
|
360
|
-
data, status_code, headers = api_instance.post_release_policy_with_http_info(ld_api_version, project_key, post_release_policy_request)
|
|
361
|
-
p status_code # => 2xx
|
|
362
|
-
p headers # => { ... }
|
|
363
|
-
p data # => <ReleasePolicy>
|
|
364
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
365
|
-
puts "Error when calling ReleasePoliciesBetaApi->post_release_policy_with_http_info: #{e}"
|
|
366
|
-
end
|
|
367
|
-
```
|
|
368
|
-
|
|
369
|
-
### Parameters
|
|
370
|
-
|
|
371
|
-
| Name | Type | Description | Notes |
|
|
372
|
-
| ---- | ---- | ----------- | ----- |
|
|
373
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
374
|
-
| **project_key** | **String** | The project key | |
|
|
375
|
-
| **post_release_policy_request** | [**PostReleasePolicyRequest**](PostReleasePolicyRequest.md) | Release policy to create | |
|
|
376
|
-
|
|
377
|
-
### Return type
|
|
378
|
-
|
|
379
|
-
[**ReleasePolicy**](ReleasePolicy.md)
|
|
380
|
-
|
|
381
|
-
### Authorization
|
|
382
|
-
|
|
383
|
-
[ApiKey](../README.md#ApiKey)
|
|
384
|
-
|
|
385
|
-
### HTTP request headers
|
|
386
|
-
|
|
387
|
-
- **Content-Type**: application/json
|
|
388
|
-
- **Accept**: application/json
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
## put_release_policy
|
|
392
|
-
|
|
393
|
-
> <ReleasePolicy> put_release_policy(ld_api_version, project_key, policy_key, put_release_policy_request)
|
|
394
|
-
|
|
395
|
-
Update a release policy
|
|
396
|
-
|
|
397
|
-
Update an existing release policy for the specified project.
|
|
398
|
-
|
|
399
|
-
### Examples
|
|
400
|
-
|
|
401
|
-
```ruby
|
|
402
|
-
require 'time'
|
|
403
|
-
require 'launchdarkly_api'
|
|
404
|
-
# setup authorization
|
|
405
|
-
LaunchDarklyApi.configure do |config|
|
|
406
|
-
# Configure API key authorization: ApiKey
|
|
407
|
-
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
408
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
409
|
-
# config.api_key_prefix['Authorization'] = 'Bearer'
|
|
410
|
-
end
|
|
411
|
-
|
|
412
|
-
api_instance = LaunchDarklyApi::ReleasePoliciesBetaApi.new
|
|
413
|
-
ld_api_version = 'beta' # String | Version of the endpoint.
|
|
414
|
-
project_key = 'default' # String | The project key
|
|
415
|
-
policy_key = 'production-release' # String | The human-readable key of the release policy
|
|
416
|
-
put_release_policy_request = LaunchDarklyApi::PutReleasePolicyRequest.new({release_method: LaunchDarklyApi::ReleaseMethod::GUARDED_RELEASE, name: 'Production Release'}) # PutReleasePolicyRequest | Release policy data to update
|
|
417
|
-
|
|
418
|
-
begin
|
|
419
|
-
# Update a release policy
|
|
420
|
-
result = api_instance.put_release_policy(ld_api_version, project_key, policy_key, put_release_policy_request)
|
|
421
|
-
p result
|
|
422
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
423
|
-
puts "Error when calling ReleasePoliciesBetaApi->put_release_policy: #{e}"
|
|
424
|
-
end
|
|
425
|
-
```
|
|
426
|
-
|
|
427
|
-
#### Using the put_release_policy_with_http_info variant
|
|
428
|
-
|
|
429
|
-
This returns an Array which contains the response data, status code and headers.
|
|
430
|
-
|
|
431
|
-
> <Array(<ReleasePolicy>, Integer, Hash)> put_release_policy_with_http_info(ld_api_version, project_key, policy_key, put_release_policy_request)
|
|
432
|
-
|
|
433
|
-
```ruby
|
|
434
|
-
begin
|
|
435
|
-
# Update a release policy
|
|
436
|
-
data, status_code, headers = api_instance.put_release_policy_with_http_info(ld_api_version, project_key, policy_key, put_release_policy_request)
|
|
437
|
-
p status_code # => 2xx
|
|
438
|
-
p headers # => { ... }
|
|
439
|
-
p data # => <ReleasePolicy>
|
|
440
|
-
rescue LaunchDarklyApi::ApiError => e
|
|
441
|
-
puts "Error when calling ReleasePoliciesBetaApi->put_release_policy_with_http_info: #{e}"
|
|
442
|
-
end
|
|
443
|
-
```
|
|
444
|
-
|
|
445
|
-
### Parameters
|
|
446
|
-
|
|
447
|
-
| Name | Type | Description | Notes |
|
|
448
|
-
| ---- | ---- | ----------- | ----- |
|
|
449
|
-
| **ld_api_version** | **String** | Version of the endpoint. | |
|
|
450
|
-
| **project_key** | **String** | The project key | |
|
|
451
|
-
| **policy_key** | **String** | The human-readable key of the release policy | |
|
|
452
|
-
| **put_release_policy_request** | [**PutReleasePolicyRequest**](PutReleasePolicyRequest.md) | Release policy data to update | |
|
|
453
|
-
|
|
454
|
-
### Return type
|
|
455
|
-
|
|
456
|
-
[**ReleasePolicy**](ReleasePolicy.md)
|
|
457
|
-
|
|
458
|
-
### Authorization
|
|
459
|
-
|
|
460
|
-
[ApiKey](../README.md#ApiKey)
|
|
461
|
-
|
|
462
|
-
### HTTP request headers
|
|
463
|
-
|
|
464
|
-
- **Content-Type**: application/json
|
|
465
|
-
- **Accept**: application/json
|
|
466
|
-
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::ReleasePoliciesResponse
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **items** | [**Array<ReleasePolicy>**](ReleasePolicy.md) | List of release policies | |
|
|
8
|
-
| **total_count** | **Integer** | Total number of release policies | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'launchdarkly_api'
|
|
14
|
-
|
|
15
|
-
instance = LaunchDarklyApi::ReleasePoliciesResponse.new(
|
|
16
|
-
items: null,
|
|
17
|
-
total_count: 42
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/ReleasePolicy.md
DELETED
|
@@ -1,34 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::ReleasePolicy
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **_access** | [**ReleasePoliciesAccessRep**](ReleasePoliciesAccessRep.md) | | [optional] |
|
|
8
|
-
| **_id** | **String** | The unique identifier of the release policy | |
|
|
9
|
-
| **scope** | [**ReleasePolicyScope**](ReleasePolicyScope.md) | | [optional] |
|
|
10
|
-
| **rank** | **Integer** | The rank/priority of the release policy | |
|
|
11
|
-
| **release_method** | [**ReleaseMethod**](ReleaseMethod.md) | | |
|
|
12
|
-
| **guarded_release_config** | [**GuardedReleaseConfig**](GuardedReleaseConfig.md) | | [optional] |
|
|
13
|
-
| **progressive_release_config** | [**ProgressiveReleaseConfig**](ProgressiveReleaseConfig.md) | | [optional] |
|
|
14
|
-
| **name** | **String** | The name of the release policy | |
|
|
15
|
-
| **key** | **String** | The human-readable key of the release policy | |
|
|
16
|
-
|
|
17
|
-
## Example
|
|
18
|
-
|
|
19
|
-
```ruby
|
|
20
|
-
require 'launchdarkly_api'
|
|
21
|
-
|
|
22
|
-
instance = LaunchDarklyApi::ReleasePolicy.new(
|
|
23
|
-
_access: null,
|
|
24
|
-
_id: 550e8400-e29b-41d4-a716-446655440000,
|
|
25
|
-
scope: null,
|
|
26
|
-
rank: 1,
|
|
27
|
-
release_method: null,
|
|
28
|
-
guarded_release_config: null,
|
|
29
|
-
progressive_release_config: null,
|
|
30
|
-
name: Production Release,
|
|
31
|
-
key: production-release
|
|
32
|
-
)
|
|
33
|
-
```
|
|
34
|
-
|
data/docs/ReleasePolicyScope.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::ReleasePolicyScope
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **environment_keys** | **Array<String>** | List of environment keys this policy applies to | [optional] |
|
|
8
|
-
| **flag_tag_keys** | **Array<String>** | List of flag tag keys this policy applies to. At most 1000 keys. Each key must only contain letters, numbers, '-', '_', or '.', and be at most 64 characters. | [optional] |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'launchdarkly_api'
|
|
14
|
-
|
|
15
|
-
instance = LaunchDarklyApi::ReleasePolicyScope.new(
|
|
16
|
-
environment_keys: ["production","staging"],
|
|
17
|
-
flag_tag_keys: ["frontend","backend"]
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|
data/docs/ReleasePolicyStage.md
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
# LaunchDarklyApi::ReleasePolicyStage
|
|
2
|
-
|
|
3
|
-
## Properties
|
|
4
|
-
|
|
5
|
-
| Name | Type | Description | Notes |
|
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **allocation** | **Integer** | | |
|
|
8
|
-
| **duration_millis** | **Integer** | | |
|
|
9
|
-
|
|
10
|
-
## Example
|
|
11
|
-
|
|
12
|
-
```ruby
|
|
13
|
-
require 'launchdarkly_api'
|
|
14
|
-
|
|
15
|
-
instance = LaunchDarklyApi::ReleasePolicyStage.new(
|
|
16
|
-
allocation: 25000,
|
|
17
|
-
duration_millis: 60000
|
|
18
|
-
)
|
|
19
|
-
```
|
|
20
|
-
|