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
data/docs/AgentOptimization.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **_links** | [**ParentAndSelfLinks**](ParentAndSelfLinks.md) | | [optional] |
|
|
9
9
|
| **id** | **String** | The agent optimization ID | |
|
|
10
10
|
| **key** | **String** | The agent optimization key | |
|
|
11
|
-
| **ai_config_key** | **String** | The key of the
|
|
11
|
+
| **ai_config_key** | **String** | The key of the agent config to optimize | |
|
|
12
12
|
| **max_attempts** | **Integer** | The maximum number of attempts | |
|
|
13
13
|
| **model_choices** | **Array<String>** | The models to try | |
|
|
14
14
|
| **judge_model** | **String** | The model used to judge responses | |
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **key** | **String** | The key of the judge
|
|
7
|
+
| **key** | **String** | The key of the judge agent config | |
|
|
8
8
|
| **threshold** | **Float** | The minimum score needed to pass | |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **key** | **String** | A unique key for the agent optimization | |
|
|
8
|
-
| **ai_config_key** | **String** | The key of the
|
|
8
|
+
| **ai_config_key** | **String** | The key of the agent config to optimize | |
|
|
9
9
|
| **max_attempts** | **Integer** | The maximum number of attempts | |
|
|
10
10
|
| **model_choices** | **Array<String>** | The models to try | [optional] |
|
|
11
11
|
| **judge_model** | **String** | The model used to judge responses | |
|
data/docs/AgentSkill.md
CHANGED
|
@@ -12,7 +12,8 @@
|
|
|
12
12
|
| **description** | **String** | Human-readable description of what the agent skill does. | [optional] |
|
|
13
13
|
| **markdown** | **String** | The verbatim SKILL.md content of the agent skill | |
|
|
14
14
|
| **tags** | **Array<String>** | Tags for the agent skill. Tags can be used in custom role policies. | |
|
|
15
|
-
| **version** | **Integer** | Version of the agent skill. Starts at 1, and each update that changes the name, description, or
|
|
15
|
+
| **version** | **Integer** | Version of the agent skill. Starts at 1, and each update that changes the name, description, markdown, or tools creates a new version. Pass this value with `key` in a variation's `skills: [{key, version}]`. | |
|
|
16
|
+
| **tools** | [**Array<PinnedSkillToolRef>**](PinnedSkillToolRef.md) | The AI tool versions this version of the agent skill pins, in the order they reach the agent. | [optional] |
|
|
16
17
|
| **created_at** | **Integer** | | |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
@@ -30,6 +31,7 @@ instance = LaunchDarklyApi::AgentSkill.new(
|
|
|
30
31
|
markdown: null,
|
|
31
32
|
tags: ["documents"],
|
|
32
33
|
version: 2,
|
|
34
|
+
tools: [{"key":"get-weather","version":1},{"key":"search-docs","version":3}],
|
|
33
35
|
created_at: null
|
|
34
36
|
)
|
|
35
37
|
```
|
data/docs/AgentSkillPatch.md
CHANGED
|
@@ -10,6 +10,7 @@
|
|
|
10
10
|
| **maintainer_id** | **String** | The ID of the member who maintains this resource | [optional] |
|
|
11
11
|
| **maintainer_team_key** | **String** | The key of the team that maintains this resource | [optional] |
|
|
12
12
|
| **tags** | **Array<String>** | Replaces the tags on the agent skill. Tags can be used in custom role policies. Changing only the tags does not create a new version. | [optional] |
|
|
13
|
+
| **tools** | [**Array<SkillToolRef>**](SkillToolRef.md) | Replaces the AI tools pinned to the agent skill, in the order they reach the agent. Leave it out to keep the current tools, or send an empty array to remove them all. A change to the tools or their order creates a new version. Each tool key can appear once, and a skill can pin up to 20 tools by default. You need read access to each tool. | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = LaunchDarklyApi::AgentSkillPatch.new(
|
|
|
22
23
|
markdown: null,
|
|
23
24
|
maintainer_id: 507f1f77bcf86cd799439011,
|
|
24
25
|
maintainer_team_key: example-team-key,
|
|
25
|
-
tags: ["documents"]
|
|
26
|
+
tags: ["documents"],
|
|
27
|
+
tools: [{"key":"get-weather","version":1},{"key":"search-docs"}]
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|
data/docs/AgentSkillPost.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **maintainer_id** | **String** | The ID of the member who maintains this resource | [optional] |
|
|
12
12
|
| **maintainer_team_key** | **String** | The key of the team that maintains this resource | [optional] |
|
|
13
13
|
| **tags** | **Array<String>** | Tags for the agent skill. Tags can be used in custom role policies. | [optional] |
|
|
14
|
+
| **tools** | [**Array<SkillToolRef>**](SkillToolRef.md) | AI tools in the same project to pin to the agent skill, in the order they reach the agent. Each tool key can appear once, and a skill can pin up to 20 tools by default. You need read access to each tool. | [optional] |
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
@@ -24,7 +25,8 @@ instance = LaunchDarklyApi::AgentSkillPost.new(
|
|
|
24
25
|
markdown: null,
|
|
25
26
|
maintainer_id: 507f1f77bcf86cd799439011,
|
|
26
27
|
maintainer_team_key: example-team-key,
|
|
27
|
-
tags: ["documents"]
|
|
28
|
+
tags: ["documents"],
|
|
29
|
+
tools: [{"key":"get-weather","version":1},{"key":"search-docs"}]
|
|
28
30
|
)
|
|
29
31
|
```
|
|
30
32
|
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **metric_group_count** | **Integer** | The number of metric groups using this metric | [optional] |
|
|
9
9
|
| **guarded_rollout_count** | **Integer** | The number of guarded rollouts using this metric | [optional] |
|
|
10
10
|
| **release_policy_count** | **Integer** | The number of release policies using this metric | [optional] |
|
|
11
|
+
| **environment_release_plan_count** | **Integer** | The number of environment release plans using this metric | [optional] |
|
|
11
12
|
| **active_experiment_count** | **Integer** | The number of active experiments using this metric | [optional] |
|
|
12
13
|
| **active_guarded_rollout_count** | **Integer** | The number of active guarded rollouts using this metric | [optional] |
|
|
13
14
|
| **_id** | **String** | The ID of this metric | |
|
|
@@ -64,6 +65,7 @@ instance = LaunchDarklyApi::AiConfigsMetricListingRep.new(
|
|
|
64
65
|
metric_group_count: 0,
|
|
65
66
|
guarded_rollout_count: 0,
|
|
66
67
|
release_policy_count: 0,
|
|
68
|
+
environment_release_plan_count: 0,
|
|
67
69
|
active_experiment_count: 2,
|
|
68
70
|
active_guarded_rollout_count: 1,
|
|
69
71
|
_id: 5902deadbeef667524a01290,
|
data/docs/ApprovalsApi.md
CHANGED
|
@@ -323,7 +323,7 @@ end
|
|
|
323
323
|
|
|
324
324
|
List approval requests
|
|
325
325
|
|
|
326
|
-
Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag`, `segment`, and `aiConfig` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response.
|
|
326
|
+
Get all approval requests. ### Filtering approvals LaunchDarkly supports the `filter` query param for filtering, with the following fields: - `notifyMemberIds` filters for only approvals that are assigned to a member in the specified list. For example: `filter=notifyMemberIds anyOf [\"memberId1\", \"memberId2\"]`. - `requestorId` filters for only approvals that correspond to the ID of the member who requested the approval. For example: `filter=requestorId equals 457034721476302714390214`. - `resourceId` filters for only approvals that correspond to the the specified resource identifier. For example: `filter=resourceId equals proj/my-project:env/my-environment:flag/my-flag`. - `resourceKind` filters for only approvals that correspond to the specified resource kind. For example: `filter=resourceKind equals flag`. Currently, `flag`, `segment`, and `aiConfig` resource kinds are supported. - `reviewStatus` filters for only approvals which correspond to the review status in the specified list. The possible values are `approved`, `declined`, and `pending`. For example: `filter=reviewStatus anyOf [\"pending\", \"approved\"]`. - `status` filters for only approvals which correspond to the status in the specified list. The possible values are `pending`, `scheduled`, `failed`, and `completed`. For example: `filter=status anyOf [\"pending\", \"scheduled\"]`. - `creationDate` filters for only approvals created before or after a time. Use the `before` or `after` operator with Unix milliseconds or an RFC 3339 timestamp in quotes. Both are exclusive. For example: `filter=creationDate after 1794000000000` or `filter=creationDate after \"2026-11-10T00:00:00Z\", creationDate before \"2026-11-17T00:00:00Z\"`. URL-encode a `+` in a timestamp's offset as `%2B`, or use `Z`. You can also apply multiple filters at once. For example, setting `filter=projectKey equals my-project, reviewStatus anyOf [\"pending\",\"approved\"]` matches approval requests which correspond to the `my-project` project key, and a review status of either `pending` or `approved`. ### Expanding approval response LaunchDarkly supports the `expand` query param to include additional fields in the response, with the following fields: - `flag` includes the flag the approval request belongs to - `project` includes the project the approval request belongs to - `environments` includes the environments the approval request relates to For example, `expand=project,flag` includes the `project` and `flag` fields in the response.
|
|
327
327
|
|
|
328
328
|
### Examples
|
|
329
329
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# LaunchDarklyApi::CreateFlagReleasePlanRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **description** | **String** | | [optional] |
|
|
9
|
+
| **maintainer** | [**MaintainerIdentifier**](MaintainerIdentifier.md) | | [optional] |
|
|
10
|
+
| **execution_mode** | [**ExecutionMode**](ExecutionMode.md) | | [optional][default to 'sequential'] |
|
|
11
|
+
| **application_keys** | **Array<String>** | | [optional] |
|
|
12
|
+
| **default** | **Boolean** | Whether this plan is the project's default. At most one active plan per project is the default. On update, omitting it demotes the current default. | [optional] |
|
|
13
|
+
| **environments** | [**Array<FlagReleasePlanEnvironment>**](FlagReleasePlanEnvironment.md) | | |
|
|
14
|
+
| **key** | **String** | | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'launchdarkly_api'
|
|
20
|
+
|
|
21
|
+
instance = LaunchDarklyApi::CreateFlagReleasePlanRequest.new(
|
|
22
|
+
name: null,
|
|
23
|
+
description: null,
|
|
24
|
+
maintainer: null,
|
|
25
|
+
execution_mode: null,
|
|
26
|
+
application_keys: null,
|
|
27
|
+
default: null,
|
|
28
|
+
environments: null,
|
|
29
|
+
key: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlan
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | The release plan's unique identifier | |
|
|
8
|
+
| **key** | **String** | Unique key identifying this release plan within the project | |
|
|
9
|
+
| **name** | **String** | Human-readable name for this release plan | |
|
|
10
|
+
| **description** | **String** | Human-readable description of this release plan's purpose | [optional] |
|
|
11
|
+
| **environment_key** | **String** | The environment this release plan is scoped to | |
|
|
12
|
+
| **release_method** | **String** | Discriminates which nested config object is present | |
|
|
13
|
+
| **version** | **Integer** | The release plan's version, starting at 1 and incremented on every update | |
|
|
14
|
+
| **created_at** | **Integer** | | [optional] |
|
|
15
|
+
| **updated_at** | **Integer** | | [optional] |
|
|
16
|
+
| **default** | **Boolean** | Whether this plan is the default for its environment. At most one active plan per environment is the default. Managed via the environment's default-release-plan sub-resource, not this request body. | [optional][readonly] |
|
|
17
|
+
| **progressive_release** | [**EnvironmentReleasePlanProgressiveReleaseRep**](EnvironmentReleasePlanProgressiveReleaseRep.md) | | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'launchdarkly_api'
|
|
23
|
+
|
|
24
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlan.new(
|
|
25
|
+
_id: null,
|
|
26
|
+
key: null,
|
|
27
|
+
name: null,
|
|
28
|
+
description: null,
|
|
29
|
+
environment_key: null,
|
|
30
|
+
release_method: null,
|
|
31
|
+
version: null,
|
|
32
|
+
created_at: null,
|
|
33
|
+
updated_at: null,
|
|
34
|
+
default: null,
|
|
35
|
+
progressive_release: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanClause
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | The clause's server-generated identifier | [optional][readonly] |
|
|
8
|
+
| **context_kind** | **String** | Context kind this clause applies to | [optional][default to 'user'] |
|
|
9
|
+
| **attribute** | **String** | Context attribute to match on (may be empty for segmentMatch) | |
|
|
10
|
+
| **op** | **String** | Clause operator | |
|
|
11
|
+
| **values** | **Array<Object>** | Values to match against (strings, numbers, or booleans). Each string value can be at most 1,024 bytes when UTF-8 encoded, so a value with multibyte characters can be rejected even if it has fewer than 1,024 characters. | |
|
|
12
|
+
| **negate** | **Boolean** | Whether to negate the clause | [optional][default to false] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'launchdarkly_api'
|
|
18
|
+
|
|
19
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanClause.new(
|
|
20
|
+
_id: null,
|
|
21
|
+
context_kind: null,
|
|
22
|
+
attribute: email,
|
|
23
|
+
op: endsWith,
|
|
24
|
+
values: null,
|
|
25
|
+
negate: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanMetric
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **is_group** | **Boolean** | true if this key identifies a metric group, false if it identifies a single metric | |
|
|
8
|
+
| **auto_rollback** | **Boolean** | Whether to automatically roll back the release if this metric/group regresses | [optional][default to false] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'launchdarkly_api'
|
|
14
|
+
|
|
15
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanMetric.new(
|
|
16
|
+
is_group: null,
|
|
17
|
+
auto_rollback: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanPhase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | The phase's server-generated identifier | [optional][readonly] |
|
|
8
|
+
| **description** | **String** | Human-readable description of this phase | [optional] |
|
|
9
|
+
| **steps** | [**Array<EnvironmentReleasePlanStep>**](EnvironmentReleasePlanStep.md) | Ordered allocation increments within this phase | |
|
|
10
|
+
| **clauses** | [**Array<EnvironmentReleasePlanClause>**](EnvironmentReleasePlanClause.md) | Targeting clauses scoping this phase's audience. Each phase's clauses must include the randomization unit clause {\"contextKind\": \"<randomizationUnit>\", \"attribute\": \"kind\", \"op\": \"in\", \"values\": [\"<randomizationUnit>\"]}, so the release only reaches contexts with that context kind. To release to every context of the randomization unit, provide exactly that clause. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'launchdarkly_api'
|
|
16
|
+
|
|
17
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanPhase.new(
|
|
18
|
+
_id: null,
|
|
19
|
+
description: null,
|
|
20
|
+
steps: null,
|
|
21
|
+
clauses: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanProgressiveRelease
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **randomization_unit** | **String** | Context kind used to bucket contexts for allocation | |
|
|
8
|
+
| **advancement_mode** | **String** | Whether a release started from this plan advances to the next phase automatically once the current phase's steps complete, or waits for a user/API action | [optional][default to 'manual'] |
|
|
9
|
+
| **cleanup_behavior** | **String** | What happens to the flag's rules once a release started from this plan completes. Defaults to `remove_rules_and_update_default_rule`, which removes the release's targeting rules and updates the flag's default rule to serve the target variation; `leave_rules_in_place` leaves the targeting rules untouched. | [optional][default to 'remove_rules_and_update_default_rule'] |
|
|
10
|
+
| **phases** | [**Array<EnvironmentReleasePlanPhase>**](EnvironmentReleasePlanPhase.md) | Ordered list of phases this release plan configures | |
|
|
11
|
+
| **metrics** | [**Hash<String, EnvironmentReleasePlanMetric>**](EnvironmentReleasePlanMetric.md) | Metrics/metric groups to monitor during rollout, keyed by metric/group key | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'launchdarkly_api'
|
|
17
|
+
|
|
18
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanProgressiveRelease.new(
|
|
19
|
+
randomization_unit: user,
|
|
20
|
+
advancement_mode: null,
|
|
21
|
+
cleanup_behavior: null,
|
|
22
|
+
phases: null,
|
|
23
|
+
metrics: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanProgressiveReleaseRep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **randomization_unit** | **String** | Context kind used to bucket contexts for allocation. Required when you create or update a plan. | [optional] |
|
|
8
|
+
| **advancement_mode** | **String** | Whether a release started from this plan advances to the next phase automatically once the current phase's steps complete, or waits for a user/API action | [optional] |
|
|
9
|
+
| **cleanup_behavior** | **String** | What happens to the flag's rules once a release started from this plan completes. `remove_rules_and_update_default_rule` removes the release's targeting rules and updates the flag's default rule to serve the target variation; `leave_rules_in_place` leaves the targeting rules untouched. | [optional] |
|
|
10
|
+
| **phases** | [**Array<EnvironmentReleasePlanPhase>**](EnvironmentReleasePlanPhase.md) | Ordered list of phases this release plan configures | |
|
|
11
|
+
| **metrics** | [**Hash<String, EnvironmentReleasePlanMetric>**](EnvironmentReleasePlanMetric.md) | Metrics/metric groups to monitor during rollout, keyed by metric/group key | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'launchdarkly_api'
|
|
17
|
+
|
|
18
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanProgressiveReleaseRep.new(
|
|
19
|
+
randomization_unit: user,
|
|
20
|
+
advancement_mode: null,
|
|
21
|
+
cleanup_behavior: null,
|
|
22
|
+
phases: null,
|
|
23
|
+
metrics: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlanStep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_id** | **String** | The step's server-generated identifier | [optional][readonly] |
|
|
8
|
+
| **allocation** | **Integer** | Traffic allocation in per-100k units (100000 = 100%) | |
|
|
9
|
+
| **duration_millis** | **Integer** | How long this step holds before the next one starts | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlanStep.new(
|
|
17
|
+
_id: null,
|
|
18
|
+
allocation: 50000,
|
|
19
|
+
duration_millis: 3600000
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentReleasePlans
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_links** | [**EnvironmentReleasePlansPaginatedLinks**](EnvironmentReleasePlansPaginatedLinks.md) | | [optional] |
|
|
8
|
+
| **items** | [**Array<EnvironmentReleasePlan>**](EnvironmentReleasePlan.md) | One page of the listed release plans, ordered by creation time | |
|
|
9
|
+
| **total_count** | **Integer** | The total number of release plans in the listed scope, before pagination | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'launchdarkly_api'
|
|
15
|
+
|
|
16
|
+
instance = LaunchDarklyApi::EnvironmentReleasePlans.new(
|
|
17
|
+
_links: null,
|
|
18
|
+
items: null,
|
|
19
|
+
total_count: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|