launchdarkly_api 4.0.0 → 5.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 +235 -225
- data/docs/{FeatureFlagApprovalRequest.md → ApprovalRequest.md} +4 -4
- data/docs/{FeatureFlagApprovalRequestApplyConfigBody.md → ApprovalRequestApplyConfigBody.md} +1 -1
- data/docs/{FeatureFlagApprovalRequestConfigBody.md → ApprovalRequestConfigBody.md} +1 -1
- data/docs/{FeatureFlagApprovalRequestReview.md → ApprovalRequestReview.md} +2 -2
- data/docs/{FeatureFlagApprovalRequestReviewConfigBody.md → ApprovalRequestReviewConfigBody.md} +1 -1
- data/docs/{FeatureFlagApprovalRequestReviewStatus.md → ApprovalRequestReviewStatus.md} +1 -1
- data/docs/{FeatureFlagApprovalRequests.md → ApprovalRequests.md} +2 -2
- data/docs/FeatureFlagsApi.md +470 -99
- data/docs/FlagConfigScheduledChangesConflictsBody.md +9 -0
- data/docs/FlagConfigScheduledChangesPatchBody.md +9 -0
- data/docs/FlagConfigScheduledChangesPostBody.md +10 -0
- data/docs/Member.md +2 -0
- data/docs/MemberLastSeenMetadata.md +8 -0
- data/docs/UserRecordApi.md +67 -0
- data/docs/UsersApi.md +0 -59
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +13 -8
- 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 +594 -175
- 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_record_api.rb +87 -0
- 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 -65
- 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/{feature_flag_approval_request.rb → approval_request.rb} +5 -5
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_apply_config_body.rb → approval_request_apply_config_body.rb} +2 -2
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_config_body.rb → approval_request_config_body.rb} +2 -2
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review.rb → approval_request_review.rb} +3 -3
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review_config_body.rb → approval_request_review_config_body.rb} +2 -2
- data/lib/launchdarkly_api/models/{feature_flag_approval_request_review_status.rb → approval_request_review_status.rb} +4 -4
- data/lib/launchdarkly_api/models/{feature_flag_approval_requests.rb → approval_requests.rb} +3 -3
- 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 +1 -1
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +1 -1
- 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_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_config.rb +1 -1
- 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_config_scheduled_changes_conflicts_body.rb +193 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +193 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +203 -0
- 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 +24 -5
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +184 -0
- 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 +1 -1
- 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 +247 -69
- 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 +130 -46
- 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_record_api_spec.rb +48 -0
- 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 -14
- 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/{feature_flag_approval_request_apply_config_body_spec.rb → approval_request_apply_config_body_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_request_config_body_spec.rb → approval_request_config_body_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_request_review_config_body_spec.rb → approval_request_review_config_body_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_request_review_spec.rb → approval_request_review_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_request_review_status_spec.rb → approval_request_review_status_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_request_spec.rb → approval_request_spec.rb} +7 -7
- data/spec/models/{feature_flag_approval_requests_spec.rb → approval_requests_spec.rb} +7 -7
- 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 +1 -1
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +1 -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_body_spec.rb +1 -1
- data/spec/models/feature_flag_config_spec.rb +1 -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_config_scheduled_changes_conflicts_body_spec.rb +47 -0
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +47 -0
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +53 -0
- 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__last_seen_metadata_spec.rb +41 -0
- data/spec/models/member_spec.rb +13 -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 +1 -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 +161 -141
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequest
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
@@ -7,11 +7,11 @@ Name | Type | Description | Notes
|
|
|
7
7
|
**_version** | **Integer** | | [optional]
|
|
8
8
|
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was requested | [optional]
|
|
9
9
|
**requestor_id** | **String** | The id of the member that requested the change | [optional]
|
|
10
|
-
**review_status** | [**
|
|
11
|
-
**status** | **String** | | Name | Description | | --------:| ----------- | | pending | the
|
|
10
|
+
**review_status** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
|
|
11
|
+
**status** | **String** | | Name | Description | | --------:| ----------- | | pending | the approval request has not been applied yet | | completed| the approval request has been applied successfully | | failed | the approval request has been applied but the changes were not applied successfully | | [optional]
|
|
12
12
|
**applied_by_member_id** | **String** | The id of the member that applied the approval request | [optional]
|
|
13
13
|
**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was applied | [optional]
|
|
14
|
-
**all_reviews** | [**Array<
|
|
14
|
+
**all_reviews** | [**Array<ApprovalRequestReview>**](ApprovalRequestReview.md) | | [optional]
|
|
15
15
|
**notify_member_ids** | **Array<String>** | | [optional]
|
|
16
16
|
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
|
17
17
|
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequestReview
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was reviewed | [optional]
|
|
7
|
-
**kind** | [**
|
|
7
|
+
**kind** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
|
|
8
8
|
**member_id** | [**Id**](Id.md) | | [optional]
|
|
9
9
|
**_id** | [**Id**](Id.md) | | [optional]
|
|
10
10
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# LaunchDarklyApi::
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequests
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
-
**items** | [**Array<
|
|
7
|
+
**items** | [**Array<ApprovalRequest>**](ApprovalRequest.md) | | [optional]
|
|
8
8
|
|
|
9
9
|
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -5,22 +5,28 @@ All URIs are relative to *https://app.launchdarkly.com/api/v2*
|
|
|
5
5
|
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
|
+
[**delete_approval_request**](FeatureFlagsApi.md#delete_approval_request) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Delete an approval request for a feature flag config
|
|
8
9
|
[**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
|
-
[**
|
|
10
|
+
[**delete_flag_config_scheduled_changes**](FeatureFlagsApi.md#delete_flag_config_scheduled_changes) | **DELETE** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Delete a scheduled change on a feature flag in an environment.
|
|
11
|
+
[**get_approval_request**](FeatureFlagsApi.md#get_approval_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Get a single approval request for a feature flag config
|
|
12
|
+
[**get_approval_requests**](FeatureFlagsApi.md#get_approval_requests) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all approval requests for a feature flag config
|
|
10
13
|
[**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
|
|
11
14
|
[**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
|
|
14
15
|
[**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
|
|
15
16
|
[**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
|
|
16
17
|
[**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.
|
|
17
18
|
[**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
|
|
19
|
+
[**get_flag_config_scheduled_change**](FeatureFlagsApi.md#get_flag_config_scheduled_change) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Get a scheduled change on a feature flag by id.
|
|
20
|
+
[**get_flag_config_scheduled_changes**](FeatureFlagsApi.md#get_flag_config_scheduled_changes) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Get all scheduled workflows for a feature flag by key.
|
|
21
|
+
[**get_flag_config_scheduled_changes_conflicts**](FeatureFlagsApi.md#get_flag_config_scheduled_changes_conflicts) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes-conflicts | Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
18
22
|
[**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
|
|
19
23
|
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
|
20
|
-
[**
|
|
24
|
+
[**patch_flag_config_scheduled_change**](FeatureFlagsApi.md#patch_flag_config_scheduled_change) | **PATCH** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes/{scheduledChangeId} | Updates an existing scheduled-change on a feature flag in an environment.
|
|
25
|
+
[**post_apply_approval_request**](FeatureFlagsApi.md#post_apply_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/apply | Apply approval request for a feature flag config
|
|
26
|
+
[**post_approval_request**](FeatureFlagsApi.md#post_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId} | Create an approval request for a feature flag config
|
|
21
27
|
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
|
22
|
-
[**
|
|
23
|
-
[**
|
|
28
|
+
[**post_flag_config_scheduled_changes**](FeatureFlagsApi.md#post_flag_config_scheduled_changes) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/scheduled-changes | Creates a new scheduled change for a feature flag.
|
|
29
|
+
[**post_review_approval_request**](FeatureFlagsApi.md#post_review_approval_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{approvalRequestId}/review | Review approval request for a feature flag config
|
|
24
30
|
|
|
25
31
|
|
|
26
32
|
# **copy_feature_flag**
|
|
@@ -81,6 +87,70 @@ Name | Type | Description | Notes
|
|
|
81
87
|
|
|
82
88
|
|
|
83
89
|
|
|
90
|
+
# **delete_approval_request**
|
|
91
|
+
> delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
|
92
|
+
|
|
93
|
+
Delete an approval request for a feature flag config
|
|
94
|
+
|
|
95
|
+
### Example
|
|
96
|
+
```ruby
|
|
97
|
+
# load the gem
|
|
98
|
+
require 'launchdarkly_api'
|
|
99
|
+
# setup authorization
|
|
100
|
+
LaunchDarklyApi.configure do |config|
|
|
101
|
+
# Configure API key authorization: Token
|
|
102
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
104
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
108
|
+
|
|
109
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
110
|
+
|
|
111
|
+
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.
|
|
112
|
+
|
|
113
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
114
|
+
|
|
115
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
116
|
+
|
|
117
|
+
opts = {
|
|
118
|
+
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
begin
|
|
122
|
+
#Delete an approval request for a feature flag config
|
|
123
|
+
api_instance.delete_approval_request(project_key, environment_key, feature_flag_key, approval_request_id, , opts)
|
|
124
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
125
|
+
puts "Exception when calling FeatureFlagsApi->delete_approval_request: #{e}"
|
|
126
|
+
end
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Parameters
|
|
130
|
+
|
|
131
|
+
Name | Type | Description | Notes
|
|
132
|
+
------------- | ------------- | ------------- | -------------
|
|
133
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
134
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
135
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
136
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
137
|
+
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
nil (empty response body)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[Token](../README.md#Token)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: application/json
|
|
150
|
+
- **Accept**: application/json
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
84
154
|
# **delete_feature_flag**
|
|
85
155
|
> delete_feature_flag(project_key, feature_flag_key, )
|
|
86
156
|
|
|
@@ -135,10 +205,10 @@ nil (empty response body)
|
|
|
135
205
|
|
|
136
206
|
|
|
137
207
|
|
|
138
|
-
# **
|
|
139
|
-
>
|
|
208
|
+
# **delete_flag_config_scheduled_changes**
|
|
209
|
+
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
140
210
|
|
|
141
|
-
Delete
|
|
211
|
+
Delete a scheduled change on a feature flag in an environment.
|
|
142
212
|
|
|
143
213
|
### Example
|
|
144
214
|
```ruby
|
|
@@ -156,21 +226,18 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
156
226
|
|
|
157
227
|
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
228
|
|
|
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
229
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
162
230
|
|
|
163
|
-
|
|
231
|
+
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.
|
|
232
|
+
|
|
233
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
164
234
|
|
|
165
|
-
opts = {
|
|
166
|
-
feature_flag_approval_request_config_body: LaunchDarklyApi::FeatureFlagApprovalRequestConfigBody.new # FeatureFlagApprovalRequestConfigBody | Create a new feature flag approval request
|
|
167
|
-
}
|
|
168
235
|
|
|
169
236
|
begin
|
|
170
|
-
#Delete
|
|
171
|
-
api_instance.
|
|
237
|
+
#Delete a scheduled change on a feature flag in an environment.
|
|
238
|
+
api_instance.delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
172
239
|
rescue LaunchDarklyApi::ApiError => e
|
|
173
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
240
|
+
puts "Exception when calling FeatureFlagsApi->delete_flag_config_scheduled_changes: #{e}"
|
|
174
241
|
end
|
|
175
242
|
```
|
|
176
243
|
|
|
@@ -179,10 +246,9 @@ end
|
|
|
179
246
|
Name | Type | Description | Notes
|
|
180
247
|
------------- | ------------- | ------------- | -------------
|
|
181
248
|
**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
249
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
184
|
-
**
|
|
185
|
-
**
|
|
250
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
251
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
186
252
|
|
|
187
253
|
### Return type
|
|
188
254
|
|
|
@@ -199,10 +265,10 @@ nil (empty response body)
|
|
|
199
265
|
|
|
200
266
|
|
|
201
267
|
|
|
202
|
-
# **
|
|
203
|
-
>
|
|
268
|
+
# **get_approval_request**
|
|
269
|
+
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
|
204
270
|
|
|
205
|
-
Get
|
|
271
|
+
Get a single approval request for a feature flag config
|
|
206
272
|
|
|
207
273
|
### Example
|
|
208
274
|
```ruby
|
|
@@ -220,17 +286,19 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
220
286
|
|
|
221
287
|
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
222
288
|
|
|
289
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
290
|
+
|
|
223
291
|
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.
|
|
224
292
|
|
|
225
|
-
|
|
293
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
226
294
|
|
|
227
295
|
|
|
228
296
|
begin
|
|
229
|
-
#Get
|
|
230
|
-
result = api_instance.
|
|
297
|
+
#Get a single approval request for a feature flag config
|
|
298
|
+
result = api_instance.get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
|
231
299
|
p result
|
|
232
300
|
rescue LaunchDarklyApi::ApiError => e
|
|
233
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
301
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_request: #{e}"
|
|
234
302
|
end
|
|
235
303
|
```
|
|
236
304
|
|
|
@@ -239,12 +307,13 @@ end
|
|
|
239
307
|
Name | Type | Description | Notes
|
|
240
308
|
------------- | ------------- | ------------- | -------------
|
|
241
309
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
242
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
243
310
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
311
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
312
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
244
313
|
|
|
245
314
|
### Return type
|
|
246
315
|
|
|
247
|
-
[**
|
|
316
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
248
317
|
|
|
249
318
|
### Authorization
|
|
250
319
|
|
|
@@ -257,10 +326,10 @@ Name | Type | Description | Notes
|
|
|
257
326
|
|
|
258
327
|
|
|
259
328
|
|
|
260
|
-
# **
|
|
261
|
-
>
|
|
329
|
+
# **get_approval_requests**
|
|
330
|
+
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
262
331
|
|
|
263
|
-
Get a
|
|
332
|
+
Get all approval requests for a feature flag config
|
|
264
333
|
|
|
265
334
|
### Example
|
|
266
335
|
```ruby
|
|
@@ -280,16 +349,15 @@ project_key = 'project_key_example' # String | The project key, used to tie the
|
|
|
280
349
|
|
|
281
350
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
282
351
|
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
}
|
|
352
|
+
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.
|
|
353
|
+
|
|
286
354
|
|
|
287
355
|
begin
|
|
288
|
-
#Get a
|
|
289
|
-
result = api_instance.
|
|
356
|
+
#Get all approval requests for a feature flag config
|
|
357
|
+
result = api_instance.get_approval_requests(project_key, feature_flag_key, environment_key, )
|
|
290
358
|
p result
|
|
291
359
|
rescue LaunchDarklyApi::ApiError => e
|
|
292
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
360
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_requests: #{e}"
|
|
293
361
|
end
|
|
294
362
|
```
|
|
295
363
|
|
|
@@ -299,11 +367,11 @@ Name | Type | Description | Notes
|
|
|
299
367
|
------------- | ------------- | ------------- | -------------
|
|
300
368
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
301
369
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
302
|
-
**
|
|
370
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
303
371
|
|
|
304
372
|
### Return type
|
|
305
373
|
|
|
306
|
-
[**
|
|
374
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
307
375
|
|
|
308
376
|
### Authorization
|
|
309
377
|
|
|
@@ -316,10 +384,10 @@ Name | Type | Description | Notes
|
|
|
316
384
|
|
|
317
385
|
|
|
318
386
|
|
|
319
|
-
# **
|
|
320
|
-
>
|
|
387
|
+
# **get_expiring_user_targets**
|
|
388
|
+
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
|
321
389
|
|
|
322
|
-
Get
|
|
390
|
+
Get expiring user targets for feature flag
|
|
323
391
|
|
|
324
392
|
### Example
|
|
325
393
|
```ruby
|
|
@@ -337,19 +405,17 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
337
405
|
|
|
338
406
|
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
407
|
|
|
340
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
341
|
-
|
|
342
408
|
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
409
|
|
|
344
|
-
|
|
410
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
345
411
|
|
|
346
412
|
|
|
347
413
|
begin
|
|
348
|
-
#Get
|
|
349
|
-
result = api_instance.
|
|
414
|
+
#Get expiring user targets for feature flag
|
|
415
|
+
result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
|
350
416
|
p result
|
|
351
417
|
rescue LaunchDarklyApi::ApiError => e
|
|
352
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
418
|
+
puts "Exception when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
|
353
419
|
end
|
|
354
420
|
```
|
|
355
421
|
|
|
@@ -358,13 +424,12 @@ end
|
|
|
358
424
|
Name | Type | Description | Notes
|
|
359
425
|
------------- | ------------- | ------------- | -------------
|
|
360
426
|
**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
427
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
363
|
-
**
|
|
428
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
364
429
|
|
|
365
430
|
### Return type
|
|
366
431
|
|
|
367
|
-
[**
|
|
432
|
+
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
|
368
433
|
|
|
369
434
|
### Authorization
|
|
370
435
|
|
|
@@ -377,10 +442,10 @@ Name | Type | Description | Notes
|
|
|
377
442
|
|
|
378
443
|
|
|
379
444
|
|
|
380
|
-
# **
|
|
381
|
-
>
|
|
445
|
+
# **get_feature_flag**
|
|
446
|
+
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
|
382
447
|
|
|
383
|
-
Get
|
|
448
|
+
Get a single feature flag by key.
|
|
384
449
|
|
|
385
450
|
### Example
|
|
386
451
|
```ruby
|
|
@@ -400,15 +465,16 @@ project_key = 'project_key_example' # String | The project key, used to tie the
|
|
|
400
465
|
|
|
401
466
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
402
467
|
|
|
403
|
-
|
|
404
|
-
|
|
468
|
+
opts = {
|
|
469
|
+
env: ['env_example'] # Array<String> | By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment.
|
|
470
|
+
}
|
|
405
471
|
|
|
406
472
|
begin
|
|
407
|
-
#Get
|
|
408
|
-
result = api_instance.
|
|
473
|
+
#Get a single feature flag by key.
|
|
474
|
+
result = api_instance.get_feature_flag(project_key, feature_flag_key, , opts)
|
|
409
475
|
p result
|
|
410
476
|
rescue LaunchDarklyApi::ApiError => e
|
|
411
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
477
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
|
412
478
|
end
|
|
413
479
|
```
|
|
414
480
|
|
|
@@ -418,11 +484,11 @@ Name | Type | Description | Notes
|
|
|
418
484
|
------------- | ------------- | ------------- | -------------
|
|
419
485
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
420
486
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
421
|
-
**
|
|
487
|
+
**env** | [**Array<String>**](String.md)| By default, each feature will include configurations for each environment. You can filter environments with the env query parameter. For example, setting env=[\"production\"] will restrict the returned configurations to just your production environment. | [optional]
|
|
422
488
|
|
|
423
489
|
### Return type
|
|
424
490
|
|
|
425
|
-
[**
|
|
491
|
+
[**FeatureFlag**](FeatureFlag.md)
|
|
426
492
|
|
|
427
493
|
### Authorization
|
|
428
494
|
|
|
@@ -673,6 +739,186 @@ Name | Type | Description | Notes
|
|
|
673
739
|
|
|
674
740
|
|
|
675
741
|
|
|
742
|
+
# **get_flag_config_scheduled_change**
|
|
743
|
+
> FeatureFlagScheduledChange get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
744
|
+
|
|
745
|
+
Get a scheduled change on a feature flag by id.
|
|
746
|
+
|
|
747
|
+
### Example
|
|
748
|
+
```ruby
|
|
749
|
+
# load the gem
|
|
750
|
+
require 'launchdarkly_api'
|
|
751
|
+
# setup authorization
|
|
752
|
+
LaunchDarklyApi.configure do |config|
|
|
753
|
+
# Configure API key authorization: Token
|
|
754
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
755
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
756
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
757
|
+
end
|
|
758
|
+
|
|
759
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
760
|
+
|
|
761
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
762
|
+
|
|
763
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
764
|
+
|
|
765
|
+
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.
|
|
766
|
+
|
|
767
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
begin
|
|
771
|
+
#Get a scheduled change on a feature flag by id.
|
|
772
|
+
result = api_instance.get_flag_config_scheduled_change(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
|
773
|
+
p result
|
|
774
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
775
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_change: #{e}"
|
|
776
|
+
end
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
Name | Type | Description | Notes
|
|
782
|
+
------------- | ------------- | ------------- | -------------
|
|
783
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
784
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
785
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
786
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
787
|
+
|
|
788
|
+
### Return type
|
|
789
|
+
|
|
790
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
791
|
+
|
|
792
|
+
### Authorization
|
|
793
|
+
|
|
794
|
+
[Token](../README.md#Token)
|
|
795
|
+
|
|
796
|
+
### HTTP request headers
|
|
797
|
+
|
|
798
|
+
- **Content-Type**: application/json
|
|
799
|
+
- **Accept**: application/json
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
# **get_flag_config_scheduled_changes**
|
|
804
|
+
> FeatureFlagScheduledChanges get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
|
805
|
+
|
|
806
|
+
Get all scheduled workflows for a feature flag by key.
|
|
807
|
+
|
|
808
|
+
### Example
|
|
809
|
+
```ruby
|
|
810
|
+
# load the gem
|
|
811
|
+
require 'launchdarkly_api'
|
|
812
|
+
# setup authorization
|
|
813
|
+
LaunchDarklyApi.configure do |config|
|
|
814
|
+
# Configure API key authorization: Token
|
|
815
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
816
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
817
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
818
|
+
end
|
|
819
|
+
|
|
820
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
821
|
+
|
|
822
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
823
|
+
|
|
824
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
825
|
+
|
|
826
|
+
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.
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
begin
|
|
830
|
+
#Get all scheduled workflows for a feature flag by key.
|
|
831
|
+
result = api_instance.get_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, )
|
|
832
|
+
p result
|
|
833
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
834
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_changes: #{e}"
|
|
835
|
+
end
|
|
836
|
+
```
|
|
837
|
+
|
|
838
|
+
### Parameters
|
|
839
|
+
|
|
840
|
+
Name | Type | Description | Notes
|
|
841
|
+
------------- | ------------- | ------------- | -------------
|
|
842
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
843
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
844
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
845
|
+
|
|
846
|
+
### Return type
|
|
847
|
+
|
|
848
|
+
[**FeatureFlagScheduledChanges**](FeatureFlagScheduledChanges.md)
|
|
849
|
+
|
|
850
|
+
### Authorization
|
|
851
|
+
|
|
852
|
+
[Token](../README.md#Token)
|
|
853
|
+
|
|
854
|
+
### HTTP request headers
|
|
855
|
+
|
|
856
|
+
- **Content-Type**: application/json
|
|
857
|
+
- **Accept**: application/json
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
# **get_flag_config_scheduled_changes_conflicts**
|
|
862
|
+
> FeatureFlagScheduledChangesConflicts get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
|
863
|
+
|
|
864
|
+
Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
865
|
+
|
|
866
|
+
### Example
|
|
867
|
+
```ruby
|
|
868
|
+
# load the gem
|
|
869
|
+
require 'launchdarkly_api'
|
|
870
|
+
# setup authorization
|
|
871
|
+
LaunchDarklyApi.configure do |config|
|
|
872
|
+
# Configure API key authorization: Token
|
|
873
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
874
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
875
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
876
|
+
end
|
|
877
|
+
|
|
878
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
879
|
+
|
|
880
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
881
|
+
|
|
882
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
883
|
+
|
|
884
|
+
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.
|
|
885
|
+
|
|
886
|
+
flag_config_scheduled_changes_conflicts_body = LaunchDarklyApi::FlagConfigScheduledChangesConflictsBody.new # FlagConfigScheduledChangesConflictsBody | Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag.
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
begin
|
|
890
|
+
#Lists conflicts between the given instructions and any existing scheduled changes for the feature flag. The actual HTTP verb should be REPORT, not POST.
|
|
891
|
+
result = api_instance.get_flag_config_scheduled_changes_conflicts(project_key, feature_flag_key, environment_key, flag_config_scheduled_changes_conflicts_body)
|
|
892
|
+
p result
|
|
893
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
894
|
+
puts "Exception when calling FeatureFlagsApi->get_flag_config_scheduled_changes_conflicts: #{e}"
|
|
895
|
+
end
|
|
896
|
+
```
|
|
897
|
+
|
|
898
|
+
### Parameters
|
|
899
|
+
|
|
900
|
+
Name | Type | Description | Notes
|
|
901
|
+
------------- | ------------- | ------------- | -------------
|
|
902
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
903
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
904
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
905
|
+
**flag_config_scheduled_changes_conflicts_body** | [**FlagConfigScheduledChangesConflictsBody**](FlagConfigScheduledChangesConflictsBody.md)| Used to determine if a semantic patch will result in conflicts with scheduled changes on a feature flag. |
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
[**FeatureFlagScheduledChangesConflicts**](FeatureFlagScheduledChangesConflicts.md)
|
|
910
|
+
|
|
911
|
+
### Authorization
|
|
912
|
+
|
|
913
|
+
[Token](../README.md#Token)
|
|
914
|
+
|
|
915
|
+
### HTTP request headers
|
|
916
|
+
|
|
917
|
+
- **Content-Type**: application/json
|
|
918
|
+
- **Accept**: application/json
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
676
922
|
# **patch_expiring_user_targets**
|
|
677
923
|
> UserTargetingExpirationForFlags patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment)
|
|
678
924
|
|
|
@@ -792,10 +1038,74 @@ Name | Type | Description | Notes
|
|
|
792
1038
|
|
|
793
1039
|
|
|
794
1040
|
|
|
795
|
-
# **
|
|
796
|
-
>
|
|
1041
|
+
# **patch_flag_config_scheduled_change**
|
|
1042
|
+
> FeatureFlagScheduledChange patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
|
1043
|
+
|
|
1044
|
+
Updates an existing scheduled-change on a feature flag in an environment.
|
|
1045
|
+
|
|
1046
|
+
### Example
|
|
1047
|
+
```ruby
|
|
1048
|
+
# load the gem
|
|
1049
|
+
require 'launchdarkly_api'
|
|
1050
|
+
# setup authorization
|
|
1051
|
+
LaunchDarklyApi.configure do |config|
|
|
1052
|
+
# Configure API key authorization: Token
|
|
1053
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1054
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1055
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1056
|
+
end
|
|
1057
|
+
|
|
1058
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
1059
|
+
|
|
1060
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
1061
|
+
|
|
1062
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
1063
|
+
|
|
1064
|
+
flag_config_scheduled_changes_patch_body = LaunchDarklyApi::FlagConfigScheduledChangesPatchBody.new # FlagConfigScheduledChangesPatchBody | Update scheduled changes on a feature flag.
|
|
1065
|
+
|
|
1066
|
+
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.
|
|
1067
|
+
|
|
1068
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
begin
|
|
1072
|
+
#Updates an existing scheduled-change on a feature flag in an environment.
|
|
1073
|
+
result = api_instance.patch_flag_config_scheduled_change(project_key, feature_flag_key, flag_config_scheduled_changes_patch_body, environment_key, scheduled_change_id)
|
|
1074
|
+
p result
|
|
1075
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1076
|
+
puts "Exception when calling FeatureFlagsApi->patch_flag_config_scheduled_change: #{e}"
|
|
1077
|
+
end
|
|
1078
|
+
```
|
|
1079
|
+
|
|
1080
|
+
### Parameters
|
|
1081
|
+
|
|
1082
|
+
Name | Type | Description | Notes
|
|
1083
|
+
------------- | ------------- | ------------- | -------------
|
|
1084
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1085
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1086
|
+
**flag_config_scheduled_changes_patch_body** | [**FlagConfigScheduledChangesPatchBody**](FlagConfigScheduledChangesPatchBody.md)| Update scheduled changes on a feature flag. |
|
|
1087
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1088
|
+
**scheduled_change_id** | **String**| The id of the scheduled change |
|
|
1089
|
+
|
|
1090
|
+
### Return type
|
|
1091
|
+
|
|
1092
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
1093
|
+
|
|
1094
|
+
### Authorization
|
|
1095
|
+
|
|
1096
|
+
[Token](../README.md#Token)
|
|
1097
|
+
|
|
1098
|
+
### HTTP request headers
|
|
1099
|
+
|
|
1100
|
+
- **Content-Type**: application/json
|
|
1101
|
+
- **Accept**: application/json
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
# **post_apply_approval_request**
|
|
1106
|
+
> ApprovalRequests post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
|
797
1107
|
|
|
798
|
-
Apply approval request for a feature flag
|
|
1108
|
+
Apply approval request for a feature flag config
|
|
799
1109
|
|
|
800
1110
|
### Example
|
|
801
1111
|
```ruby
|
|
@@ -817,17 +1127,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
817
1127
|
|
|
818
1128
|
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
1129
|
|
|
820
|
-
|
|
1130
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
821
1131
|
|
|
822
|
-
|
|
1132
|
+
approval_request_apply_config_body = LaunchDarklyApi::ApprovalRequestApplyConfigBody.new # ApprovalRequestApplyConfigBody | Apply an approval request
|
|
823
1133
|
|
|
824
1134
|
|
|
825
1135
|
begin
|
|
826
|
-
#Apply approval request for a feature flag
|
|
827
|
-
result = api_instance.
|
|
1136
|
+
#Apply approval request for a feature flag config
|
|
1137
|
+
result = api_instance.post_apply_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_apply_config_body)
|
|
828
1138
|
p result
|
|
829
1139
|
rescue LaunchDarklyApi::ApiError => e
|
|
830
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1140
|
+
puts "Exception when calling FeatureFlagsApi->post_apply_approval_request: #{e}"
|
|
831
1141
|
end
|
|
832
1142
|
```
|
|
833
1143
|
|
|
@@ -838,12 +1148,77 @@ Name | Type | Description | Notes
|
|
|
838
1148
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
839
1149
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
840
1150
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
841
|
-
**
|
|
842
|
-
**
|
|
1151
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1152
|
+
**approval_request_apply_config_body** | [**ApprovalRequestApplyConfigBody**](ApprovalRequestApplyConfigBody.md)| Apply an approval request |
|
|
843
1153
|
|
|
844
1154
|
### Return type
|
|
845
1155
|
|
|
846
|
-
[**
|
|
1156
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
[Token](../README.md#Token)
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: application/json
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
# **post_approval_request**
|
|
1170
|
+
> ApprovalRequest post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
|
1171
|
+
|
|
1172
|
+
Create an approval request for a feature flag config
|
|
1173
|
+
|
|
1174
|
+
### Example
|
|
1175
|
+
```ruby
|
|
1176
|
+
# load the gem
|
|
1177
|
+
require 'launchdarkly_api'
|
|
1178
|
+
# setup authorization
|
|
1179
|
+
LaunchDarklyApi.configure do |config|
|
|
1180
|
+
# Configure API key authorization: Token
|
|
1181
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
1182
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1183
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
1184
|
+
end
|
|
1185
|
+
|
|
1186
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
1187
|
+
|
|
1188
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
1189
|
+
|
|
1190
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
1191
|
+
|
|
1192
|
+
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.
|
|
1193
|
+
|
|
1194
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
1195
|
+
|
|
1196
|
+
opts = {
|
|
1197
|
+
approval_request_config_body: LaunchDarklyApi::ApprovalRequestConfigBody.new # ApprovalRequestConfigBody | Create a new approval request
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
begin
|
|
1201
|
+
#Create an approval request for a feature flag config
|
|
1202
|
+
result = api_instance.post_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, , opts)
|
|
1203
|
+
p result
|
|
1204
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
1205
|
+
puts "Exception when calling FeatureFlagsApi->post_approval_request: #{e}"
|
|
1206
|
+
end
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
### Parameters
|
|
1210
|
+
|
|
1211
|
+
Name | Type | Description | Notes
|
|
1212
|
+
------------- | ------------- | ------------- | -------------
|
|
1213
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1214
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1215
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1216
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1217
|
+
**approval_request_config_body** | [**ApprovalRequestConfigBody**](ApprovalRequestConfigBody.md)| Create a new approval request | [optional]
|
|
1218
|
+
|
|
1219
|
+
### Return type
|
|
1220
|
+
|
|
1221
|
+
[**ApprovalRequest**](ApprovalRequest.md)
|
|
847
1222
|
|
|
848
1223
|
### Authorization
|
|
849
1224
|
|
|
@@ -915,10 +1290,10 @@ Name | Type | Description | Notes
|
|
|
915
1290
|
|
|
916
1291
|
|
|
917
1292
|
|
|
918
|
-
# **
|
|
919
|
-
>
|
|
1293
|
+
# **post_flag_config_scheduled_changes**
|
|
1294
|
+
> FeatureFlagScheduledChange post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
|
920
1295
|
|
|
921
|
-
|
|
1296
|
+
Creates a new scheduled change for a feature flag.
|
|
922
1297
|
|
|
923
1298
|
### Example
|
|
924
1299
|
```ruby
|
|
@@ -936,22 +1311,19 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
|
936
1311
|
|
|
937
1312
|
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
1313
|
|
|
1314
|
+
flag_config_scheduled_changes_post_body = LaunchDarklyApi::FlagConfigScheduledChangesPostBody.new # FlagConfigScheduledChangesPostBody | Create scheduled changes on a feature flag.
|
|
1315
|
+
|
|
939
1316
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
940
1317
|
|
|
941
1318
|
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
1319
|
|
|
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
1320
|
|
|
949
1321
|
begin
|
|
950
|
-
#
|
|
951
|
-
result = api_instance.
|
|
1322
|
+
#Creates a new scheduled change for a feature flag.
|
|
1323
|
+
result = api_instance.post_flag_config_scheduled_changes(project_key, flag_config_scheduled_changes_post_body, feature_flag_key, environment_key, )
|
|
952
1324
|
p result
|
|
953
1325
|
rescue LaunchDarklyApi::ApiError => e
|
|
954
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1326
|
+
puts "Exception when calling FeatureFlagsApi->post_flag_config_scheduled_changes: #{e}"
|
|
955
1327
|
end
|
|
956
1328
|
```
|
|
957
1329
|
|
|
@@ -960,14 +1332,13 @@ end
|
|
|
960
1332
|
Name | Type | Description | Notes
|
|
961
1333
|
------------- | ------------- | ------------- | -------------
|
|
962
1334
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1335
|
+
**flag_config_scheduled_changes_post_body** | [**FlagConfigScheduledChangesPostBody**](FlagConfigScheduledChangesPostBody.md)| Create scheduled changes on a feature flag. |
|
|
963
1336
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
964
1337
|
**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
1338
|
|
|
968
1339
|
### Return type
|
|
969
1340
|
|
|
970
|
-
[**
|
|
1341
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
|
971
1342
|
|
|
972
1343
|
### Authorization
|
|
973
1344
|
|
|
@@ -980,10 +1351,10 @@ Name | Type | Description | Notes
|
|
|
980
1351
|
|
|
981
1352
|
|
|
982
1353
|
|
|
983
|
-
# **
|
|
984
|
-
>
|
|
1354
|
+
# **post_review_approval_request**
|
|
1355
|
+
> ApprovalRequests post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
|
985
1356
|
|
|
986
|
-
Review approval request for a feature flag
|
|
1357
|
+
Review approval request for a feature flag config
|
|
987
1358
|
|
|
988
1359
|
### Example
|
|
989
1360
|
```ruby
|
|
@@ -1005,17 +1376,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
|
1005
1376
|
|
|
1006
1377
|
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
1378
|
|
|
1008
|
-
|
|
1379
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
|
1009
1380
|
|
|
1010
|
-
|
|
1381
|
+
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
|
1011
1382
|
|
|
1012
1383
|
|
|
1013
1384
|
begin
|
|
1014
|
-
#Review approval request for a feature flag
|
|
1015
|
-
result = api_instance.
|
|
1385
|
+
#Review approval request for a feature flag config
|
|
1386
|
+
result = api_instance.post_review_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, approval_request_review_config_body)
|
|
1016
1387
|
p result
|
|
1017
1388
|
rescue LaunchDarklyApi::ApiError => e
|
|
1018
|
-
puts "Exception when calling FeatureFlagsApi->
|
|
1389
|
+
puts "Exception when calling FeatureFlagsApi->post_review_approval_request: #{e}"
|
|
1019
1390
|
end
|
|
1020
1391
|
```
|
|
1021
1392
|
|
|
@@ -1026,12 +1397,12 @@ Name | Type | Description | Notes
|
|
|
1026
1397
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
1027
1398
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
1028
1399
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
1029
|
-
**
|
|
1030
|
-
**
|
|
1400
|
+
**approval_request_id** | **String**| The approval request ID |
|
|
1401
|
+
**approval_request_review_config_body** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request |
|
|
1031
1402
|
|
|
1032
1403
|
### Return type
|
|
1033
1404
|
|
|
1034
|
-
[**
|
|
1405
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
|
1035
1406
|
|
|
1036
1407
|
### Authorization
|
|
1037
1408
|
|