launchdarkly_api 3.8.0 → 4.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 +225 -211
- data/docs/Environment.md +1 -0
- data/docs/EnvironmentApprovalSettings.md +12 -0
- data/docs/FeatureFlagApprovalRequest.md +18 -0
- data/docs/FeatureFlagApprovalRequestApplyConfigBody.md +8 -0
- data/docs/FeatureFlagApprovalRequestConfigBody.md +11 -0
- data/docs/FeatureFlagApprovalRequestReview.md +11 -0
- data/docs/FeatureFlagApprovalRequestReviewConfigBody.md +9 -0
- data/docs/FeatureFlagApprovalRequestReviewStatus.md +7 -0
- data/docs/FeatureFlagApprovalRequests.md +9 -0
- data/docs/FeatureFlagConfig.md +2 -0
- data/docs/FeatureFlagsApi.md +382 -0
- data/docs/Rule.md +1 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +9 -1
- data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +1 -1
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +1 -1
- data/lib/launchdarkly_api/api/environments_api.rb +1 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +430 -1
- data/lib/launchdarkly_api/api/integrations_api.rb +1 -1
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +1 -1
- data/lib/launchdarkly_api/api/users_api.rb +1 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api_client.rb +1 -1
- data/lib/launchdarkly_api/api_error.rb +1 -1
- data/lib/launchdarkly_api/configuration.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
- data/lib/launchdarkly_api/models/clause.rb +1 -1
- data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
- data/lib/launchdarkly_api/models/copy_actions.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property_values.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +1 -1
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +1 -1
- data/lib/launchdarkly_api/models/destination_body.rb +1 -1
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +1 -1
- data/lib/launchdarkly_api/models/destination_m_particle.rb +1 -1
- data/lib/launchdarkly_api/models/destination_segment.rb +1 -1
- data/lib/launchdarkly_api/models/destinations.rb +1 -1
- data/lib/launchdarkly_api/models/environment.rb +14 -5
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +259 -0
- data/lib/launchdarkly_api/models/environment_post.rb +1 -1
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/events.rb +1 -1
- data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_approval_request.rb +316 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_request_apply_config_body.rb +184 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_request_config_body.rb +229 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_request_review.rb +211 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_request_review_config_body.rb +233 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_request_review_status.rb +31 -0
- data/lib/launchdarkly_api/models/feature_flag_approval_requests.rb +194 -0
- data/lib/launchdarkly_api/models/feature_flag_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_config.rb +23 -5
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +1 -1
- data/lib/launchdarkly_api/models/flag_list_item.rb +1 -1
- data/lib/launchdarkly_api/models/hierarchical_links.rb +1 -1
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/integration.rb +1 -1
- data/lib/launchdarkly_api/models/integration__links.rb +1 -1
- data/lib/launchdarkly_api/models/integration_subscription.rb +1 -1
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +1 -1
- data/lib/launchdarkly_api/models/integrations.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +1 -1
- data/lib/launchdarkly_api/models/project_body.rb +1 -1
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +1 -1
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +14 -5
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/site.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +1 -1
- data/lib/launchdarkly_api/models/stream.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_series.rb +1 -1
- data/lib/launchdarkly_api/models/streams.rb +1 -1
- data/lib/launchdarkly_api/models/subscription_body.rb +1 -1
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +1 -1
- data/lib/launchdarkly_api/models/token_body.rb +1 -1
- data/lib/launchdarkly_api/models/tokens.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +1 -1
- data/lib/launchdarkly_api/models/usage.rb +1 -1
- data/lib/launchdarkly_api/models/usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
- data/lib/launchdarkly_api/models/user_record.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
- data/lib/launchdarkly_api/models/user_segments.rb +1 -1
- data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- data/lib/launchdarkly_api/models/webhook.rb +1 -1
- data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
- data/lib/launchdarkly_api/models/webhooks.rb +1 -1
- data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
- data/lib/launchdarkly_api/version.rb +2 -2
- data/openapi.yml +326 -1
- data/spec/api/access_tokens_api_spec.rb +1 -1
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/custom_roles_api_spec.rb +1 -1
- data/spec/api/customer_metrics_api_spec.rb +1 -1
- data/spec/api/data_export_destinations_api_spec.rb +1 -1
- data/spec/api/environments_api_spec.rb +1 -1
- data/spec/api/feature_flags_api_spec.rb +88 -1
- data/spec/api/integrations_api_spec.rb +1 -1
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +1 -1
- data/spec/api/user_segments_api_spec.rb +1 -1
- data/spec/api/user_settings_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audit_log_entries_spec.rb +1 -1
- data/spec/models/audit_log_entry_spec.rb +1 -1
- data/spec/models/audit_log_entry_target_spec.rb +1 -1
- data/spec/models/clause_spec.rb +1 -1
- data/spec/models/client_side_availability_spec.rb +1 -1
- data/spec/models/copy_actions_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_property_values_spec.rb +1 -1
- data/spec/models/custom_role_body_spec.rb +1 -1
- data/spec/models/custom_role_spec.rb +1 -1
- data/spec/models/custom_roles_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/destination_amazon_kinesis_spec.rb +1 -1
- data/spec/models/destination_body_spec.rb +1 -1
- data/spec/models/destination_google_pub_sub_spec.rb +1 -1
- data/spec/models/destination_m_particle_spec.rb +1 -1
- data/spec/models/destination_segment_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_approval_settings_spec.rb +69 -0
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +7 -1
- data/spec/models/evaluation_usage_error_spec.rb +1 -1
- data/spec/models/events_spec.rb +1 -1
- data/spec/models/fallthrough_spec.rb +1 -1
- data/spec/models/feature_flag_approval_request_apply_config_body_spec.rb +41 -0
- data/spec/models/feature_flag_approval_request_config_body_spec.rb +59 -0
- data/spec/models/feature_flag_approval_request_review_config_body_spec.rb +51 -0
- data/spec/models/feature_flag_approval_request_review_spec.rb +59 -0
- data/spec/models/feature_flag_approval_request_review_status_spec.rb +35 -0
- data/spec/models/feature_flag_approval_request_spec.rb +105 -0
- data/spec/models/feature_flag_approval_requests_spec.rb +47 -0
- data/spec/models/feature_flag_body_spec.rb +1 -1
- data/spec/models/feature_flag_config_spec.rb +13 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +1 -1
- data/spec/models/feature_flag_status_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +1 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/hierarchical_links_spec.rb +1 -1
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/integration__links_spec.rb +1 -1
- data/spec/models/integration_spec.rb +1 -1
- data/spec/models/integration_subscription__status_spec.rb +1 -1
- data/spec/models/integration_subscription_spec.rb +1 -1
- data/spec/models/integrations_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +1 -1
- data/spec/models/relay_proxy_config_spec.rb +1 -1
- data/spec/models/relay_proxy_configs_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +7 -1
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_inner_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_spec.rb +1 -1
- data/spec/models/semantic_patch_operation_spec.rb +1 -1
- data/spec/models/site_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_spec.rb +1 -1
- data/spec/models/stream_by_sdk_spec.rb +1 -1
- data/spec/models/stream_links_spec.rb +1 -1
- data/spec/models/stream_sdk_version_data_spec.rb +1 -1
- data/spec/models/stream_sdk_version_spec.rb +1 -1
- data/spec/models/stream_spec.rb +1 -1
- data/spec/models/stream_usage_error_spec.rb +1 -1
- data/spec/models/stream_usage_links_spec.rb +1 -1
- data/spec/models/stream_usage_metadata_spec.rb +1 -1
- data/spec/models/stream_usage_series_spec.rb +1 -1
- data/spec/models/streams_spec.rb +1 -1
- data/spec/models/subscription_body_spec.rb +1 -1
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +1 -1
- data/spec/models/token_spec.rb +1 -1
- data/spec/models/tokens_spec.rb +1 -1
- data/spec/models/unbounded_segment_target_changes_spec.rb +1 -1
- data/spec/models/unbounded_segment_targets_body_spec.rb +1 -1
- data/spec/models/usage_error_spec.rb +1 -1
- data/spec/models/usage_links_spec.rb +1 -1
- data/spec/models/usage_spec.rb +1 -1
- data/spec/models/user_flag_setting_spec.rb +1 -1
- data/spec/models/user_flag_settings_spec.rb +1 -1
- data/spec/models/user_record_spec.rb +1 -1
- data/spec/models/user_segment_body_spec.rb +1 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +1 -1
- data/spec/models/user_segments_spec.rb +1 -1
- data/spec/models/user_settings_body_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -1
- data/spec/models/webhook_body_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhooks_spec.rb +1 -1
- data/spec/models/weighted_variation_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +143 -111
data/docs/Environment.md
CHANGED
|
@@ -16,5 +16,6 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**tags** | **Array<String>** | An array of tags for this environment. | [optional]
|
|
17
17
|
**require_comments** | **BOOLEAN** | Determines if this environment requires comments for flag and segment changes. | [optional]
|
|
18
18
|
**confirm_changes** | **BOOLEAN** | Determines if this environment requires confirmation for flag and segment changes. | [optional]
|
|
19
|
+
**approval_settings** | [**EnvironmentApprovalSettings**](EnvironmentApprovalSettings.md) | | [optional]
|
|
19
20
|
|
|
20
21
|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# LaunchDarklyApi::EnvironmentApprovalSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**service_kind** | **String** | The approvals system used. | [optional]
|
|
7
|
+
**required** | **BOOLEAN** | Whether any changes to flags in this environment will require approval. | [optional]
|
|
8
|
+
**can_review_own_request** | **BOOLEAN** | Whether requesters can approve or decline their own request. They may always comment. | [optional]
|
|
9
|
+
**min_num_approvals** | **Integer** | The number of approvals required before an approval request can be applied. | [optional]
|
|
10
|
+
**can_apply_declined_changes** | **BOOLEAN** | Whether changes can be applied as long as minNumApprovals is met, regardless of if any reviewers have declined a request. | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
7
|
+
**_version** | **Integer** | | [optional]
|
|
8
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was requested | [optional]
|
|
9
|
+
**requestor_id** | **String** | The id of the member that requested the change | [optional]
|
|
10
|
+
**review_status** | [**FeatureFlagApprovalRequestReviewStatus**](FeatureFlagApprovalRequestReviewStatus.md) | | [optional]
|
|
11
|
+
**status** | **String** | | Name | Description | | --------:| ----------- | | pending | the feature flag approval request has not been applied yet | | completed| the feature flag approval request has been applied successfully | | failed | the feature flag approval request has been applied but the changes were not applied successfully | | [optional]
|
|
12
|
+
**applied_by_member_id** | **String** | The id of the member that applied the approval request | [optional]
|
|
13
|
+
**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was applied | [optional]
|
|
14
|
+
**all_reviews** | [**Array<FeatureFlagApprovalRequestReview>**](FeatureFlagApprovalRequestReview.md) | | [optional]
|
|
15
|
+
**notify_member_ids** | **Array<String>** | | [optional]
|
|
16
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequestApplyConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**description** | **String** | A name that describes the changes you would like to apply to a feature flag configuration |
|
|
7
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
|
|
8
|
+
**notify_member_ids** | **Array<String>** | |
|
|
9
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequestReview
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was reviewed | [optional]
|
|
7
|
+
**kind** | [**FeatureFlagApprovalRequestReviewStatus**](FeatureFlagApprovalRequestReviewStatus.md) | | [optional]
|
|
8
|
+
**member_id** | [**Id**](Id.md) | | [optional]
|
|
9
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequestReviewConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**kind** | **String** | One of approve, decline, or comment. |
|
|
7
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagApprovalRequests
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
+
**items** | [**Array<FeatureFlagApprovalRequest>**](FeatureFlagApprovalRequest.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/FeatureFlagConfig.md
CHANGED
|
@@ -16,5 +16,7 @@ Name | Type | Description | Notes
|
|
|
16
16
|
**prerequisites** | [**Array<Prerequisite>**](Prerequisite.md) | | [optional]
|
|
17
17
|
**track_events** | **BOOLEAN** | Set to true to send detailed event information for this flag. | [optional]
|
|
18
18
|
**track_events_fallthrough** | **BOOLEAN** | Set to true to send detailed event information when targeting is enabled but no individual targeting rule is matched. | [optional]
|
|
19
|
+
**_site** | [**Site**](Site.md) | | [optional]
|
|
20
|
+
**_environment_name** | **String** | | [optional]
|
|
19
21
|
|
|
20
22
|
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -6,15 +6,21 @@ Method | HTTP request | Description
|
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /flags/{projectKey}/{featureFlagKey}/copy | Copies the feature flag configuration from one environment to the same feature flag in another environment.
|
|
8
8
|
[**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
|
9
|
+
[**delete_feature_flag_approval_request**](FeatureFlagsApi.md#delete_feature_flag_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Delete an approval request for a feature flag
|
|
9
10
|
[**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag
|
|
10
11
|
[**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
|
|
12
|
+
[**get_feature_flag_approval_request**](FeatureFlagsApi.md#get_feature_flag_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Get a single approval request for a feature flag
|
|
13
|
+
[**get_feature_flag_approval_requests**](FeatureFlagsApi.md#get_feature_flag_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag
|
|
11
14
|
[**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
|
|
12
15
|
[**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
|
|
13
16
|
[**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
|
|
14
17
|
[**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
|
|
15
18
|
[**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
|
|
16
19
|
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
|
20
|
+
[**post_apply_feature_flag_approval_request**](FeatureFlagsApi.md#post_apply_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId}/apply | Apply approval request for a feature flag
|
|
17
21
|
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
|
22
|
+
[**post_feature_flag_approval_request**](FeatureFlagsApi.md#post_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId} | Create an approval request for a feature flag
|
|
23
|
+
[**post_review_feature_flag_approval_request**](FeatureFlagsApi.md#post_review_feature_flag_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagApprovalRequestId}/review | Review approval request for a feature flag
|
|
18
24
|
|
|
19
25
|
|
|
20
26
|
# **copy_feature_flag**
|
|
@@ -129,6 +135,70 @@ nil (empty response body)
|
|
|
129
135
|
|
|
130
136
|
|
|
131
137
|
|
|
138
|
+
# **delete_feature_flag_approval_request**
|
|
139
|
+
> delete_feature_flag_approval_request(project_key, environment_key, feature_flag_key, feature_flag_approval_request_id, , opts)
|
|
140
|
+
|
|
141
|
+
Delete an approval request for a feature flag
|
|
142
|
+
|
|
143
|
+
### Example
|
|
144
|
+
```ruby
|
|
145
|
+
# load the gem
|
|
146
|
+
require 'launchdarkly_api'
|
|
147
|
+
# setup authorization
|
|
148
|
+
LaunchDarklyApi.configure do |config|
|
|
149
|
+
# Configure API key authorization: Token
|
|
150
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
151
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
152
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
156
|
+
|
|
157
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
158
|
+
|
|
159
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
160
|
+
|
|
161
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
162
|
+
|
|
163
|
+
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
164
|
+
|
|
165
|
+
opts = {
|
|
166
|
+
feature_flag_approval_request_config_body: LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody.new # FeatureFlagApprovalRequestConfigBody | Create a new feature flag approval request
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
begin
|
|
170
|
+
#Delete an approval request for a feature flag
|
|
171
|
+
api_instance.delete_feature_flag_approval_request(project_key, environment_key, feature_flag_key, feature_flag_approval_request_id, , opts)
|
|
172
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
173
|
+
puts "Exception when calling FeatureFlagsApi->delete_feature_flag_approval_request: #{e}"
|
|
174
|
+
end
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Parameters
|
|
178
|
+
|
|
179
|
+
Name | Type | Description | Notes
|
|
180
|
+
------------- | ------------- | ------------- | -------------
|
|
181
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
182
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
183
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
184
|
+
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
185
|
+
**feature_flag_approval_request_config_body** | [**FeatureFlagApprovalRequestConfigBody**](FeatureFlagApprovalRequestConfigBody.md)| Create a new feature flag approval request | [optional]
|
|
186
|
+
|
|
187
|
+
### Return type
|
|
188
|
+
|
|
189
|
+
nil (empty response body)
|
|
190
|
+
|
|
191
|
+
### Authorization
|
|
192
|
+
|
|
193
|
+
[Token](../README.md#Token)
|
|
194
|
+
|
|
195
|
+
### HTTP request headers
|
|
196
|
+
|
|
197
|
+
- **Content-Type**: application/json
|
|
198
|
+
- **Accept**: application/json
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
|
|
132
202
|
# **get_expiring_user_targets**
|
|
133
203
|
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
|
134
204
|
|
|
@@ -246,6 +316,125 @@ Name | Type | Description | Notes
|
|
|
246
316
|
|
|
247
317
|
|
|
248
318
|
|
|
319
|
+
# **get_feature_flag_approval_request**
|
|
320
|
+
> FeatureFlagApprovalRequests get_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, )
|
|
321
|
+
|
|
322
|
+
Get a single approval request for a feature flag
|
|
323
|
+
|
|
324
|
+
### Example
|
|
325
|
+
```ruby
|
|
326
|
+
# load the gem
|
|
327
|
+
require 'launchdarkly_api'
|
|
328
|
+
# setup authorization
|
|
329
|
+
LaunchDarklyApi.configure do |config|
|
|
330
|
+
# Configure API key authorization: Token
|
|
331
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
333
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
334
|
+
end
|
|
335
|
+
|
|
336
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
337
|
+
|
|
338
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
339
|
+
|
|
340
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
341
|
+
|
|
342
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
343
|
+
|
|
344
|
+
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
begin
|
|
348
|
+
#Get a single approval request for a feature flag
|
|
349
|
+
result = api_instance.get_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, )
|
|
350
|
+
p result
|
|
351
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
352
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag_approval_request: #{e}"
|
|
353
|
+
end
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### Parameters
|
|
357
|
+
|
|
358
|
+
Name | Type | Description | Notes
|
|
359
|
+
------------- | ------------- | ------------- | -------------
|
|
360
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
361
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
362
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
363
|
+
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
367
|
+
[**FeatureFlagApprovalRequests**](FeatureFlagApprovalRequests.md)
|
|
368
|
+
|
|
369
|
+
### Authorization
|
|
370
|
+
|
|
371
|
+
[Token](../README.md#Token)
|
|
372
|
+
|
|
373
|
+
### HTTP request headers
|
|
374
|
+
|
|
375
|
+
- **Content-Type**: application/json
|
|
376
|
+
- **Accept**: application/json
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
# **get_feature_flag_approval_requests**
|
|
381
|
+
> FeatureFlagApprovalRequests get_feature_flag_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
382
|
+
|
|
383
|
+
Get all approval requests for a feature flag
|
|
384
|
+
|
|
385
|
+
### Example
|
|
386
|
+
```ruby
|
|
387
|
+
# load the gem
|
|
388
|
+
require 'launchdarkly_api'
|
|
389
|
+
# setup authorization
|
|
390
|
+
LaunchDarklyApi.configure do |config|
|
|
391
|
+
# Configure API key authorization: Token
|
|
392
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
393
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
394
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
395
|
+
end
|
|
396
|
+
|
|
397
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
398
|
+
|
|
399
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
400
|
+
|
|
401
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
402
|
+
|
|
403
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
begin
|
|
407
|
+
#Get all approval requests for a feature flag
|
|
408
|
+
result = api_instance.get_feature_flag_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
409
|
+
p result
|
|
410
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
411
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag_approval_requests: #{e}"
|
|
412
|
+
end
|
|
413
|
+
```
|
|
414
|
+
|
|
415
|
+
### Parameters
|
|
416
|
+
|
|
417
|
+
Name | Type | Description | Notes
|
|
418
|
+
------------- | ------------- | ------------- | -------------
|
|
419
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
420
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
421
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
422
|
+
|
|
423
|
+
### Return type
|
|
424
|
+
|
|
425
|
+
[**FeatureFlagApprovalRequests**](FeatureFlagApprovalRequests.md)
|
|
426
|
+
|
|
427
|
+
### Authorization
|
|
428
|
+
|
|
429
|
+
[Token](../README.md#Token)
|
|
430
|
+
|
|
431
|
+
### HTTP request headers
|
|
432
|
+
|
|
433
|
+
- **Content-Type**: application/json
|
|
434
|
+
- **Accept**: application/json
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
249
438
|
# **get_feature_flag_status**
|
|
250
439
|
> FeatureFlagStatus get_feature_flag_status(project_key, environment_key, feature_flag_key, )
|
|
251
440
|
|
|
@@ -603,6 +792,70 @@ Name | Type | Description | Notes
|
|
|
603
792
|
|
|
604
793
|
|
|
605
794
|
|
|
795
|
+
# **post_apply_feature_flag_approval_request**
|
|
796
|
+
> FeatureFlagApprovalRequests post_apply_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, feature_flag_approval_request_apply_config_body)
|
|
797
|
+
|
|
798
|
+
Apply approval request for a feature flag
|
|
799
|
+
|
|
800
|
+
### Example
|
|
801
|
+
```ruby
|
|
802
|
+
# load the gem
|
|
803
|
+
require 'launchdarkly_api'
|
|
804
|
+
# setup authorization
|
|
805
|
+
LaunchDarklyApi.configure do |config|
|
|
806
|
+
# Configure API key authorization: Token
|
|
807
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
808
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
809
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
810
|
+
end
|
|
811
|
+
|
|
812
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
813
|
+
|
|
814
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
815
|
+
|
|
816
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
817
|
+
|
|
818
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
819
|
+
|
|
820
|
+
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
821
|
+
|
|
822
|
+
feature_flag_approval_request_apply_config_body = LaunchDarklyApi::FeatureFlagApprovalRequestApplyConfigBody.new # FeatureFlagApprovalRequestApplyConfigBody | Apply a new feature flag approval request
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
begin
|
|
826
|
+
#Apply approval request for a feature flag
|
|
827
|
+
result = api_instance.post_apply_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, feature_flag_approval_request_apply_config_body)
|
|
828
|
+
p result
|
|
829
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
830
|
+
puts "Exception when calling FeatureFlagsApi->post_apply_feature_flag_approval_request: #{e}"
|
|
831
|
+
end
|
|
832
|
+
```
|
|
833
|
+
|
|
834
|
+
### Parameters
|
|
835
|
+
|
|
836
|
+
Name | Type | Description | Notes
|
|
837
|
+
------------- | ------------- | ------------- | -------------
|
|
838
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
839
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
840
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
841
|
+
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
842
|
+
**feature_flag_approval_request_apply_config_body** | [**FeatureFlagApprovalRequestApplyConfigBody**](FeatureFlagApprovalRequestApplyConfigBody.md)| Apply a new feature flag approval request |
|
|
843
|
+
|
|
844
|
+
### Return type
|
|
845
|
+
|
|
846
|
+
[**FeatureFlagApprovalRequests**](FeatureFlagApprovalRequests.md)
|
|
847
|
+
|
|
848
|
+
### Authorization
|
|
849
|
+
|
|
850
|
+
[Token](../README.md#Token)
|
|
851
|
+
|
|
852
|
+
### HTTP request headers
|
|
853
|
+
|
|
854
|
+
- **Content-Type**: application/json
|
|
855
|
+
- **Accept**: application/json
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
606
859
|
# **post_feature_flag**
|
|
607
860
|
> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
|
|
608
861
|
|
|
@@ -662,3 +915,132 @@ Name | Type | Description | Notes
|
|
|
662
915
|
|
|
663
916
|
|
|
664
917
|
|
|
918
|
+
# **post_feature_flag_approval_request**
|
|
919
|
+
> FeatureFlagApprovalRequest post_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, , opts)
|
|
920
|
+
|
|
921
|
+
Create an approval request for a feature flag
|
|
922
|
+
|
|
923
|
+
### Example
|
|
924
|
+
```ruby
|
|
925
|
+
# load the gem
|
|
926
|
+
require 'launchdarkly_api'
|
|
927
|
+
# setup authorization
|
|
928
|
+
LaunchDarklyApi.configure do |config|
|
|
929
|
+
# Configure API key authorization: Token
|
|
930
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
931
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
932
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
933
|
+
end
|
|
934
|
+
|
|
935
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
936
|
+
|
|
937
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
938
|
+
|
|
939
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
940
|
+
|
|
941
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
942
|
+
|
|
943
|
+
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
944
|
+
|
|
945
|
+
opts = {
|
|
946
|
+
feature_flag_approval_request_config_body: LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody.new # FeatureFlagApprovalRequestConfigBody | Create a new feature flag approval request
|
|
947
|
+
}
|
|
948
|
+
|
|
949
|
+
begin
|
|
950
|
+
#Create an approval request for a feature flag
|
|
951
|
+
result = api_instance.post_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, , opts)
|
|
952
|
+
p result
|
|
953
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
954
|
+
puts "Exception when calling FeatureFlagsApi->post_feature_flag_approval_request: #{e}"
|
|
955
|
+
end
|
|
956
|
+
```
|
|
957
|
+
|
|
958
|
+
### Parameters
|
|
959
|
+
|
|
960
|
+
Name | Type | Description | Notes
|
|
961
|
+
------------- | ------------- | ------------- | -------------
|
|
962
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
963
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
964
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
965
|
+
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
966
|
+
**feature_flag_approval_request_config_body** | [**FeatureFlagApprovalRequestConfigBody**](FeatureFlagApprovalRequestConfigBody.md)| Create a new feature flag approval request | [optional]
|
|
967
|
+
|
|
968
|
+
### Return type
|
|
969
|
+
|
|
970
|
+
[**FeatureFlagApprovalRequest**](FeatureFlagApprovalRequest.md)
|
|
971
|
+
|
|
972
|
+
### Authorization
|
|
973
|
+
|
|
974
|
+
[Token](../README.md#Token)
|
|
975
|
+
|
|
976
|
+
### HTTP request headers
|
|
977
|
+
|
|
978
|
+
- **Content-Type**: application/json
|
|
979
|
+
- **Accept**: application/json
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
# **post_review_feature_flag_approval_request**
|
|
984
|
+
> FeatureFlagApprovalRequests post_review_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, feature_flag_approval_request_review_config_body)
|
|
985
|
+
|
|
986
|
+
Review approval request for a feature flag
|
|
987
|
+
|
|
988
|
+
### Example
|
|
989
|
+
```ruby
|
|
990
|
+
# load the gem
|
|
991
|
+
require 'launchdarkly_api'
|
|
992
|
+
# setup authorization
|
|
993
|
+
LaunchDarklyApi.configure do |config|
|
|
994
|
+
# Configure API key authorization: Token
|
|
995
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
996
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
997
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
998
|
+
end
|
|
999
|
+
|
|
1000
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
1001
|
+
|
|
1002
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
1003
|
+
|
|
1004
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
1005
|
+
|
|
1006
|
+
environment_key = 'environment_key_example' # String | The environment key, used to tie together flag configuration and users under one environment so they can be managed together.
|
|
1007
|
+
|
|
1008
|
+
feature_flag_approval_request_id = 'feature_flag_approval_request_id_example' # String | The feature flag approval request ID
|
|
1009
|
+
|
|
1010
|
+
feature_flag_approval_request_review_config_body = LaunchDarklyApi::FeatureFlagApprovalRequestReviewConfigBody.new # FeatureFlagApprovalRequestReviewConfigBody | Review a feature flag approval request
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
begin
|
|
1014
|
+
#Review approval request for a feature flag
|
|
1015
|
+
result = api_instance.post_review_feature_flag_approval_request(project_key, feature_flag_key, environment_key, feature_flag_approval_request_id, feature_flag_approval_request_review_config_body)
|
|
1016
|
+
p result
|
|
1017
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1018
|
+
puts "Exception when calling FeatureFlagsApi->post_review_feature_flag_approval_request: #{e}"
|
|
1019
|
+
end
|
|
1020
|
+
```
|
|
1021
|
+
|
|
1022
|
+
### Parameters
|
|
1023
|
+
|
|
1024
|
+
Name | Type | Description | Notes
|
|
1025
|
+
------------- | ------------- | ------------- | -------------
|
|
1026
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1027
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1028
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1029
|
+
**feature_flag_approval_request_id** | **String**| The feature flag approval request ID |
|
|
1030
|
+
**feature_flag_approval_request_review_config_body** | [**FeatureFlagApprovalRequestReviewConfigBody**](FeatureFlagApprovalRequestReviewConfigBody.md)| Review a feature flag approval request |
|
|
1031
|
+
|
|
1032
|
+
### Return type
|
|
1033
|
+
|
|
1034
|
+
[**FeatureFlagApprovalRequests**](FeatureFlagApprovalRequests.md)
|
|
1035
|
+
|
|
1036
|
+
### Authorization
|
|
1037
|
+
|
|
1038
|
+
[Token](../README.md#Token)
|
|
1039
|
+
|
|
1040
|
+
### HTTP request headers
|
|
1041
|
+
|
|
1042
|
+
- **Content-Type**: application/json
|
|
1043
|
+
- **Accept**: application/json
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|