launchdarkly_api 3.10.0 → 5.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +237 -224
- data/docs/ApprovalRequest.md +20 -0
- data/docs/{FeatureFlagChangeRequestApplyConfigBody.md → ApprovalRequestApplyConfigBody.md} +1 -1
- data/docs/{FeatureFlagChangeRequestConfigBody.md → ApprovalRequestConfigBody.md} +3 -1
- data/docs/{FeatureFlagChangeRequestReview.md → ApprovalRequestReview.md} +3 -3
- data/docs/{FeatureFlagChangeRequestReviewConfigBody.md → ApprovalRequestReviewConfigBody.md} +2 -2
- data/docs/{FeatureFlagChangeRequestReviewStatus.md → ApprovalRequestReviewStatus.md} +1 -1
- data/docs/{FeatureFlagChangeRequests.md → ApprovalRequests.md} +2 -2
- data/docs/{UnboundedSegmentTargetChanges.md → BigSegmentTargetChanges.md} +1 -1
- data/docs/BigSegmentTargetsBody.md +9 -0
- data/docs/Environment.md +1 -0
- data/docs/EnvironmentApprovalSettings.md +12 -0
- data/docs/FeatureFlagStatus.md +1 -1
- data/docs/FeatureFlagStatusAcrossEnvironments.md +1 -1
- data/docs/FeatureFlagStatusLinks.md +9 -0
- data/docs/FeatureFlagStatuses.md +1 -1
- data/docs/FeatureFlagsApi.md +517 -77
- 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/UserSegment.md +1 -1
- data/docs/UserSegmentBody.md +1 -1
- data/docs/UserSegmentsApi.md +9 -9
- data/docs/UsersApi.md +2 -2
- data/launchdarkly_api.gemspec +3 -2
- data/lib/launchdarkly_api.rb +17 -11
- data/lib/launchdarkly_api/api/access_tokens_api.rb +2 -2
- data/lib/launchdarkly_api/api/audit_log_api.rb +2 -2
- data/lib/launchdarkly_api/api/custom_roles_api.rb +2 -2
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +2 -2
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +2 -2
- data/lib/launchdarkly_api/api/environments_api.rb +2 -2
- data/lib/launchdarkly_api/api/feature_flags_api.rb +640 -142
- data/lib/launchdarkly_api/api/integrations_api.rb +2 -2
- data/lib/launchdarkly_api/api/projects_api.rb +2 -2
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +2 -2
- data/lib/launchdarkly_api/api/root_api.rb +2 -2
- data/lib/launchdarkly_api/api/team_members_api.rb +2 -2
- data/lib/launchdarkly_api/api/user_segments_api.rb +19 -19
- data/lib/launchdarkly_api/api/user_settings_api.rb +2 -2
- data/lib/launchdarkly_api/api/users_api.rb +5 -5
- data/lib/launchdarkly_api/api/webhooks_api.rb +2 -2
- data/lib/launchdarkly_api/api_client.rb +7 -5
- data/lib/launchdarkly_api/api_error.rb +2 -2
- data/lib/launchdarkly_api/configuration.rb +4 -4
- data/lib/launchdarkly_api/models/{feature_flag_change_request.rb → approval_request.rb} +37 -25
- data/lib/launchdarkly_api/models/{feature_flag_change_request_apply_config_body.rb → approval_request_apply_config_body.rb} +5 -4
- data/lib/launchdarkly_api/models/{feature_flag_change_request_config_body.rb → approval_request_config_body.rb} +29 -8
- data/lib/launchdarkly_api/models/{feature_flag_change_request_review.rb → approval_request_review.rb} +7 -6
- data/lib/launchdarkly_api/models/{feature_flag_change_request_review_config_body.rb → approval_request_review_config_body.rb} +8 -7
- data/lib/launchdarkly_api/models/{feature_flag_change_request_review_status.rb → approval_request_review_status.rb} +5 -5
- data/lib/launchdarkly_api/models/{feature_flag_change_requests.rb → approval_requests.rb} +6 -5
- data/lib/launchdarkly_api/models/audit_log_entries.rb +4 -3
- data/lib/launchdarkly_api/models/audit_log_entry.rb +4 -3
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +4 -3
- data/lib/launchdarkly_api/models/{unbounded_segment_target_changes.rb → big_segment_target_changes.rb} +5 -4
- data/lib/launchdarkly_api/models/{unbounded_segment_targets_body.rb → big_segment_targets_body.rb} +7 -6
- data/lib/launchdarkly_api/models/clause.rb +4 -3
- data/lib/launchdarkly_api/models/client_side_availability.rb +4 -3
- data/lib/launchdarkly_api/models/copy_actions.rb +2 -2
- data/lib/launchdarkly_api/models/custom_property.rb +4 -3
- data/lib/launchdarkly_api/models/custom_property_values.rb +4 -3
- data/lib/launchdarkly_api/models/custom_role.rb +4 -3
- data/lib/launchdarkly_api/models/custom_role_body.rb +4 -3
- data/lib/launchdarkly_api/models/custom_roles.rb +4 -3
- data/lib/launchdarkly_api/models/defaults.rb +4 -3
- data/lib/launchdarkly_api/models/destination.rb +4 -3
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +4 -3
- data/lib/launchdarkly_api/models/destination_body.rb +4 -3
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +4 -3
- data/lib/launchdarkly_api/models/destination_m_particle.rb +4 -3
- data/lib/launchdarkly_api/models/destination_segment.rb +4 -3
- data/lib/launchdarkly_api/models/destinations.rb +4 -3
- data/lib/launchdarkly_api/models/environment.rb +17 -7
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +260 -0
- data/lib/launchdarkly_api/models/environment_post.rb +4 -3
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/events.rb +4 -3
- data/lib/launchdarkly_api/models/fallthrough.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_body.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_config.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_status.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +4 -3
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +193 -0
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +5 -4
- data/lib/launchdarkly_api/models/feature_flags.rb +4 -3
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +194 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +194 -0
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +204 -0
- data/lib/launchdarkly_api/models/flag_list_item.rb +4 -3
- data/lib/launchdarkly_api/models/hierarchical_links.rb +4 -3
- data/lib/launchdarkly_api/models/id.rb +4 -3
- data/lib/launchdarkly_api/models/integration.rb +4 -3
- data/lib/launchdarkly_api/models/integration__links.rb +4 -3
- data/lib/launchdarkly_api/models/integration_subscription.rb +4 -3
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +4 -3
- data/lib/launchdarkly_api/models/integrations.rb +4 -3
- data/lib/launchdarkly_api/models/link.rb +4 -3
- data/lib/launchdarkly_api/models/links.rb +4 -3
- data/lib/launchdarkly_api/models/ma_uby_category.rb +4 -3
- data/lib/launchdarkly_api/models/mau.rb +4 -3
- data/lib/launchdarkly_api/models/mau_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/member.rb +27 -7
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +185 -0
- data/lib/launchdarkly_api/models/members.rb +4 -3
- data/lib/launchdarkly_api/models/members_body.rb +4 -3
- data/lib/launchdarkly_api/models/patch_comment.rb +4 -3
- data/lib/launchdarkly_api/models/patch_operation.rb +4 -3
- data/lib/launchdarkly_api/models/policy.rb +4 -3
- data/lib/launchdarkly_api/models/prerequisite.rb +4 -3
- data/lib/launchdarkly_api/models/project.rb +4 -3
- data/lib/launchdarkly_api/models/project_body.rb +4 -3
- data/lib/launchdarkly_api/models/projects.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +4 -3
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +4 -3
- data/lib/launchdarkly_api/models/role.rb +2 -2
- data/lib/launchdarkly_api/models/rollout.rb +4 -3
- data/lib/launchdarkly_api/models/rule.rb +4 -3
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +4 -3
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +4 -3
- data/lib/launchdarkly_api/models/site.rb +4 -3
- data/lib/launchdarkly_api/models/statement.rb +4 -3
- data/lib/launchdarkly_api/models/stream.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/stream_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +4 -3
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_links.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +4 -3
- data/lib/launchdarkly_api/models/stream_usage_series.rb +4 -3
- data/lib/launchdarkly_api/models/streams.rb +4 -3
- data/lib/launchdarkly_api/models/subscription_body.rb +4 -3
- data/lib/launchdarkly_api/models/target.rb +4 -3
- data/lib/launchdarkly_api/models/token.rb +4 -3
- data/lib/launchdarkly_api/models/token_body.rb +4 -3
- data/lib/launchdarkly_api/models/tokens.rb +4 -3
- data/lib/launchdarkly_api/models/usage.rb +4 -3
- data/lib/launchdarkly_api/models/usage_error.rb +4 -3
- data/lib/launchdarkly_api/models/usage_links.rb +4 -3
- data/lib/launchdarkly_api/models/user.rb +4 -3
- data/lib/launchdarkly_api/models/user_flag_setting.rb +4 -3
- data/lib/launchdarkly_api/models/user_flag_settings.rb +4 -3
- data/lib/launchdarkly_api/models/user_record.rb +4 -3
- data/lib/launchdarkly_api/models/user_segment.rb +5 -4
- data/lib/launchdarkly_api/models/user_segment_body.rb +5 -4
- data/lib/launchdarkly_api/models/user_segment_rule.rb +4 -3
- data/lib/launchdarkly_api/models/user_segments.rb +4 -3
- data/lib/launchdarkly_api/models/user_settings_body.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +4 -3
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +4 -3
- data/lib/launchdarkly_api/models/users.rb +4 -3
- data/lib/launchdarkly_api/models/variation.rb +4 -3
- data/lib/launchdarkly_api/models/webhook.rb +4 -3
- data/lib/launchdarkly_api/models/webhook_body.rb +4 -3
- data/lib/launchdarkly_api/models/webhooks.rb +4 -3
- data/lib/launchdarkly_api/models/weighted_variation.rb +4 -3
- data/lib/launchdarkly_api/version.rb +3 -3
- data/openapi.yml +351 -93
- data/spec/api/access_tokens_api_spec.rb +2 -2
- data/spec/api/audit_log_api_spec.rb +2 -2
- data/spec/api/custom_roles_api_spec.rb +2 -2
- data/spec/api/customer_metrics_api_spec.rb +2 -2
- data/spec/api/data_export_destinations_api_spec.rb +2 -2
- data/spec/api/environments_api_spec.rb +2 -2
- data/spec/api/feature_flags_api_spec.rb +139 -38
- data/spec/api/integrations_api_spec.rb +2 -2
- data/spec/api/projects_api_spec.rb +2 -2
- data/spec/api/relay_proxy_configurations_api_spec.rb +2 -2
- data/spec/api/root_api_spec.rb +2 -2
- data/spec/api/team_members_api_spec.rb +2 -2
- data/spec/api/user_segments_api_spec.rb +6 -6
- data/spec/api/user_settings_api_spec.rb +2 -2
- data/spec/api/users_api_spec.rb +3 -3
- data/spec/api/webhooks_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +19 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/{feature_flag_change_request_apply_config_body_spec.rb → approval_request_apply_config_body_spec.rb} +8 -8
- data/spec/models/{feature_flag_change_request_config_body_spec.rb → approval_request_config_body_spec.rb} +20 -8
- data/spec/models/{feature_flag_change_request_review_config_body_spec.rb → approval_request_review_config_body_spec.rb} +9 -9
- data/spec/models/{feature_flag_change_request_review_spec.rb → approval_request_review_spec.rb} +8 -8
- data/spec/models/approval_request_review_status_spec.rb +35 -0
- data/spec/models/{feature_flag_change_request_spec.rb → approval_request_spec.rb} +19 -13
- data/spec/models/{feature_flag_change_requests_spec.rb → approval_requests_spec.rb} +8 -8
- data/spec/models/audit_log_entries_spec.rb +2 -2
- data/spec/models/audit_log_entry_spec.rb +2 -2
- data/spec/models/audit_log_entry_target_spec.rb +2 -2
- data/spec/models/{unbounded_segment_target_changes_spec.rb → big_segment_target_changes_spec.rb} +8 -8
- data/spec/models/{unbounded_segment_targets_body_spec.rb → big_segment_targets_body_spec.rb} +8 -8
- data/spec/models/clause_spec.rb +2 -2
- data/spec/models/client_side_availability_spec.rb +2 -2
- data/spec/models/copy_actions_spec.rb +2 -2
- data/spec/models/custom_property_spec.rb +2 -2
- data/spec/models/custom_property_values_spec.rb +2 -2
- data/spec/models/custom_role_body_spec.rb +2 -2
- data/spec/models/custom_role_spec.rb +2 -2
- data/spec/models/custom_roles_spec.rb +2 -2
- data/spec/models/defaults_spec.rb +2 -2
- data/spec/models/destination_amazon_kinesis_spec.rb +2 -2
- data/spec/models/destination_body_spec.rb +2 -2
- data/spec/models/destination_google_pub_sub_spec.rb +2 -2
- data/spec/models/destination_m_particle_spec.rb +2 -2
- data/spec/models/destination_segment_spec.rb +2 -2
- data/spec/models/destination_spec.rb +2 -2
- data/spec/models/destinations_spec.rb +2 -2
- data/spec/models/environment_approval_settings_spec.rb +69 -0
- data/spec/models/environment_post_spec.rb +2 -2
- data/spec/models/environment_spec.rb +8 -2
- data/spec/models/evaluation_usage_error_spec.rb +2 -2
- data/spec/models/events_spec.rb +2 -2
- data/spec/models/fallthrough_spec.rb +2 -2
- data/spec/models/feature_flag_body_spec.rb +2 -2
- data/spec/models/feature_flag_config_spec.rb +2 -2
- data/spec/models/feature_flag_copy_body_spec.rb +2 -2
- data/spec/models/feature_flag_copy_object_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_change_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +2 -2
- data/spec/models/feature_flag_scheduled_changes_spec.rb +2 -2
- data/spec/models/feature_flag_spec.rb +2 -2
- data/spec/models/feature_flag_status_across_environments_spec.rb +2 -2
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +2 -2
- data/spec/models/feature_flag_status_links_spec.rb +47 -0
- data/spec/models/feature_flag_status_spec.rb +2 -2
- data/spec/models/feature_flag_statuses_spec.rb +2 -2
- data/spec/models/feature_flags_spec.rb +2 -2
- 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 +2 -2
- data/spec/models/hierarchical_links_spec.rb +2 -2
- data/spec/models/id_spec.rb +2 -2
- data/spec/models/integration__links_spec.rb +2 -2
- data/spec/models/integration_spec.rb +2 -2
- data/spec/models/integration_subscription__status_spec.rb +2 -2
- data/spec/models/integration_subscription_spec.rb +2 -2
- data/spec/models/integrations_spec.rb +2 -2
- data/spec/models/link_spec.rb +2 -2
- data/spec/models/links_spec.rb +2 -2
- data/spec/models/ma_uby_category_spec.rb +2 -2
- data/spec/models/mau_metadata_spec.rb +2 -2
- data/spec/models/mau_spec.rb +2 -2
- data/spec/models/member__last_seen_metadata_spec.rb +41 -0
- data/spec/models/member_spec.rb +14 -2
- data/spec/models/members_body_spec.rb +2 -2
- data/spec/models/members_spec.rb +2 -2
- data/spec/models/patch_comment_spec.rb +2 -2
- data/spec/models/patch_operation_spec.rb +2 -2
- data/spec/models/policy_spec.rb +2 -2
- data/spec/models/prerequisite_spec.rb +2 -2
- data/spec/models/project_body_spec.rb +2 -2
- data/spec/models/project_spec.rb +2 -2
- data/spec/models/projects_spec.rb +2 -2
- data/spec/models/relay_proxy_config_body_spec.rb +2 -2
- data/spec/models/relay_proxy_config_spec.rb +2 -2
- data/spec/models/relay_proxy_configs_spec.rb +2 -2
- data/spec/models/role_spec.rb +2 -2
- data/spec/models/rollout_spec.rb +2 -2
- data/spec/models/rule_spec.rb +2 -2
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +2 -2
- data/spec/models/semantic_patch_instruction_inner_spec.rb +2 -2
- data/spec/models/semantic_patch_instruction_spec.rb +2 -2
- data/spec/models/semantic_patch_operation_spec.rb +2 -2
- data/spec/models/site_spec.rb +2 -2
- data/spec/models/statement_spec.rb +2 -2
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +2 -2
- data/spec/models/stream_by_sdk_links_spec.rb +2 -2
- data/spec/models/stream_by_sdk_spec.rb +2 -2
- data/spec/models/stream_links_spec.rb +2 -2
- data/spec/models/stream_sdk_version_data_spec.rb +2 -2
- data/spec/models/stream_sdk_version_spec.rb +2 -2
- data/spec/models/stream_spec.rb +2 -2
- data/spec/models/stream_usage_error_spec.rb +2 -2
- data/spec/models/stream_usage_links_spec.rb +2 -2
- data/spec/models/stream_usage_metadata_spec.rb +2 -2
- data/spec/models/stream_usage_series_spec.rb +2 -2
- data/spec/models/streams_spec.rb +2 -2
- data/spec/models/subscription_body_spec.rb +2 -2
- data/spec/models/target_spec.rb +2 -2
- data/spec/models/token_body_spec.rb +2 -2
- data/spec/models/token_spec.rb +2 -2
- data/spec/models/tokens_spec.rb +2 -2
- data/spec/models/usage_error_spec.rb +2 -2
- data/spec/models/usage_links_spec.rb +2 -2
- data/spec/models/usage_spec.rb +2 -2
- data/spec/models/user_flag_setting_spec.rb +2 -2
- data/spec/models/user_flag_settings_spec.rb +2 -2
- data/spec/models/user_record_spec.rb +2 -2
- data/spec/models/user_segment_body_spec.rb +2 -2
- data/spec/models/user_segment_rule_spec.rb +2 -2
- data/spec/models/user_segment_spec.rb +2 -2
- data/spec/models/user_segments_spec.rb +2 -2
- data/spec/models/user_settings_body_spec.rb +2 -2
- data/spec/models/user_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +2 -2
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +2 -2
- data/spec/models/users_spec.rb +2 -2
- data/spec/models/variation_spec.rb +2 -2
- data/spec/models/webhook_body_spec.rb +2 -2
- data/spec/models/webhook_spec.rb +2 -2
- data/spec/models/webhooks_spec.rb +2 -2
- data/spec/models/weighted_variation_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- metadata +186 -142
- data/docs/FeatureFlagChangeRequest.md +0 -19
- data/docs/UnboundedSegmentTargetsBody.md +0 -9
- data/spec/models/feature_flag_change_request_review_status_spec.rb +0 -35
@@ -0,0 +1,20 @@
|
|
1
|
+
# LaunchDarklyApi::ApprovalRequest
|
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** | [**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 | | scheduled | the approval request for a scheduled change has been applied successfully | | failed | the 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<ApprovalRequestReview>**](ApprovalRequestReview.md) | | [optional]
|
15
|
+
**notify_member_ids** | **Array<String>** | | [optional]
|
16
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
17
|
+
**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional]
|
18
|
+
**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional]
|
19
|
+
|
20
|
+
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# LaunchDarklyApi::
|
1
|
+
# LaunchDarklyApi::ApprovalRequestConfigBody
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -7,5 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
|
8
8
|
**notify_member_ids** | **Array<String>** | |
|
9
9
|
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
10
|
+
**execution_date** | **Integer** | Timestamp for when instructions will be executed | [optional]
|
11
|
+
**operating_on_id** | **String** | ID of scheduled change to edit or delete | [optional]
|
10
12
|
|
11
13
|
|
@@ -1,10 +1,10 @@
|
|
1
|
-
# LaunchDarklyApi::
|
1
|
+
# LaunchDarklyApi::ApprovalRequestReview
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the
|
7
|
-
**kind** | [**
|
6
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the approval request was reviewed | [optional]
|
7
|
+
**kind** | [**ApprovalRequestReviewStatus**](ApprovalRequestReviewStatus.md) | | [optional]
|
8
8
|
**member_id** | [**Id**](Id.md) | | [optional]
|
9
9
|
**_id** | [**Id**](Id.md) | | [optional]
|
10
10
|
|
data/docs/{FeatureFlagChangeRequestReviewConfigBody.md → ApprovalRequestReviewConfigBody.md}
RENAMED
@@ -1,9 +1,9 @@
|
|
1
|
-
# LaunchDarklyApi::
|
1
|
+
# LaunchDarklyApi::ApprovalRequestReviewConfigBody
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**kind** | **String** |
|
6
|
+
**kind** | **String** | One of approve, decline, or comment. |
|
7
7
|
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
8
8
|
|
9
9
|
|
@@ -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
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# LaunchDarklyApi::BigSegmentTargetsBody
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**included** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) | | [optional]
|
7
|
+
**excluded** | [**BigSegmentTargetChanges**](BigSegmentTargetChanges.md) | | [optional]
|
8
|
+
|
9
|
+
|
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
|
+
|
data/docs/FeatureFlagStatus.md
CHANGED
@@ -6,6 +6,6 @@ Name | Type | Description | Notes
|
|
6
6
|
**name** | **String** | | Name | Description | | --------:| ----------- | | new | the feature flag was created within the last 7 days, and has not been requested yet | | active | the feature flag was requested by your servers or clients within the last 7 days | | inactive | the feature flag was created more than 7 days ago, and hasn't been requested by your servers or clients within the past 7 days | | launched | one variation of the feature flag has been rolled out to all your users for at least 7 days | | [optional]
|
7
7
|
**last_requested** | **String** | | [optional]
|
8
8
|
**default** | **Object** | | [optional]
|
9
|
-
**_links** | [**
|
9
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
10
10
|
|
11
11
|
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**_links** | [**
|
6
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
7
7
|
**key** | **String** | | [optional]
|
8
8
|
**environments** | [**Hash<String, FeatureFlagStatusForQueriedEnvironment>**](FeatureFlagStatusForQueriedEnvironment.md) | | [optional]
|
9
9
|
|
data/docs/FeatureFlagStatuses.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**_links** | [**
|
6
|
+
**_links** | [**FeatureFlagStatusLinks**](FeatureFlagStatusLinks.md) | | [optional]
|
7
7
|
**items** | [**Array<FeatureFlagStatus>**](FeatureFlagStatus.md) | | [optional]
|
8
8
|
|
9
9
|
|
data/docs/FeatureFlagsApi.md
CHANGED
@@ -5,21 +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.
|
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
|
9
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
|
10
14
|
[**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /flags/{projectKey}/{featureFlagKey} | Get a single feature flag by key.
|
11
|
-
[**get_feature_flag_change_request**](FeatureFlagsApi.md#get_feature_flag_change_request) | **GET** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId} | Get a single change request for a feature flag
|
12
|
-
[**get_feature_flag_change_requests**](FeatureFlagsApi.md#get_feature_flag_change_requests) | **GET** /{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Get all change requests for a feature flag
|
13
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.
|
14
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
|
15
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.
|
16
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.
|
17
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
|
18
23
|
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
19
|
-
[**
|
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
|
20
27
|
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
21
|
-
[**
|
22
|
-
[**
|
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
|
23
30
|
|
24
31
|
|
25
32
|
# **copy_feature_flag**
|
@@ -80,6 +87,70 @@ Name | Type | Description | Notes
|
|
80
87
|
|
81
88
|
|
82
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
|
+
|
83
154
|
# **delete_feature_flag**
|
84
155
|
> delete_feature_flag(project_key, feature_flag_key, )
|
85
156
|
|
@@ -134,10 +205,10 @@ nil (empty response body)
|
|
134
205
|
|
135
206
|
|
136
207
|
|
137
|
-
# **
|
138
|
-
>
|
208
|
+
# **delete_flag_config_scheduled_changes**
|
209
|
+
> delete_flag_config_scheduled_changes(project_key, feature_flag_key, environment_key, scheduled_change_id)
|
139
210
|
|
140
|
-
|
211
|
+
Delete a scheduled change on a feature flag in an environment.
|
141
212
|
|
142
213
|
### Example
|
143
214
|
```ruby
|
@@ -155,17 +226,18 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
155
226
|
|
156
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.
|
157
228
|
|
229
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
230
|
+
|
158
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.
|
159
232
|
|
160
|
-
|
233
|
+
scheduled_change_id = 'scheduled_change_id_example' # String | The id of the scheduled change
|
161
234
|
|
162
235
|
|
163
236
|
begin
|
164
|
-
#
|
165
|
-
|
166
|
-
p result
|
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)
|
167
239
|
rescue LaunchDarklyApi::ApiError => e
|
168
|
-
puts "Exception when calling FeatureFlagsApi->
|
240
|
+
puts "Exception when calling FeatureFlagsApi->delete_flag_config_scheduled_changes: #{e}"
|
169
241
|
end
|
170
242
|
```
|
171
243
|
|
@@ -174,12 +246,13 @@ end
|
|
174
246
|
Name | Type | Description | Notes
|
175
247
|
------------- | ------------- | ------------- | -------------
|
176
248
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
177
|
-
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
178
249
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
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 |
|
179
252
|
|
180
253
|
### Return type
|
181
254
|
|
182
|
-
|
255
|
+
nil (empty response body)
|
183
256
|
|
184
257
|
### Authorization
|
185
258
|
|
@@ -192,10 +265,10 @@ Name | Type | Description | Notes
|
|
192
265
|
|
193
266
|
|
194
267
|
|
195
|
-
# **
|
196
|
-
>
|
268
|
+
# **get_approval_request**
|
269
|
+
> ApprovalRequests get_approval_request(project_key, feature_flag_key, environment_key, approval_request_id, )
|
197
270
|
|
198
|
-
Get a single feature flag
|
271
|
+
Get a single approval request for a feature flag config
|
199
272
|
|
200
273
|
### Example
|
201
274
|
```ruby
|
@@ -215,16 +288,17 @@ project_key = 'project_key_example' # String | The project key, used to tie the
|
|
215
288
|
|
216
289
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
217
290
|
|
218
|
-
|
219
|
-
|
220
|
-
|
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.
|
292
|
+
|
293
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
294
|
+
|
221
295
|
|
222
296
|
begin
|
223
|
-
#Get a single feature flag
|
224
|
-
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, )
|
225
299
|
p result
|
226
300
|
rescue LaunchDarklyApi::ApiError => e
|
227
|
-
puts "Exception when calling FeatureFlagsApi->
|
301
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_request: #{e}"
|
228
302
|
end
|
229
303
|
```
|
230
304
|
|
@@ -234,11 +308,12 @@ Name | Type | Description | Notes
|
|
234
308
|
------------- | ------------- | ------------- | -------------
|
235
309
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
236
310
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
237
|
-
**
|
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 |
|
238
313
|
|
239
314
|
### Return type
|
240
315
|
|
241
|
-
[**
|
316
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
242
317
|
|
243
318
|
### Authorization
|
244
319
|
|
@@ -251,10 +326,10 @@ Name | Type | Description | Notes
|
|
251
326
|
|
252
327
|
|
253
328
|
|
254
|
-
# **
|
255
|
-
>
|
329
|
+
# **get_approval_requests**
|
330
|
+
> ApprovalRequests get_approval_requests(project_key, feature_flag_key, environment_key, )
|
256
331
|
|
257
|
-
Get
|
332
|
+
Get all approval requests for a feature flag config
|
258
333
|
|
259
334
|
### Example
|
260
335
|
```ruby
|
@@ -276,15 +351,13 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
276
351
|
|
277
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.
|
278
353
|
|
279
|
-
feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
|
280
|
-
|
281
354
|
|
282
355
|
begin
|
283
|
-
#Get
|
284
|
-
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, )
|
285
358
|
p result
|
286
359
|
rescue LaunchDarklyApi::ApiError => e
|
287
|
-
puts "Exception when calling FeatureFlagsApi->
|
360
|
+
puts "Exception when calling FeatureFlagsApi->get_approval_requests: #{e}"
|
288
361
|
end
|
289
362
|
```
|
290
363
|
|
@@ -295,11 +368,10 @@ Name | Type | Description | Notes
|
|
295
368
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
296
369
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
297
370
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
298
|
-
**feature_flag_change_request_id** | **String**| The feature flag change request ID |
|
299
371
|
|
300
372
|
### Return type
|
301
373
|
|
302
|
-
[**
|
374
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
303
375
|
|
304
376
|
### Authorization
|
305
377
|
|
@@ -312,10 +384,10 @@ Name | Type | Description | Notes
|
|
312
384
|
|
313
385
|
|
314
386
|
|
315
|
-
# **
|
316
|
-
>
|
387
|
+
# **get_expiring_user_targets**
|
388
|
+
> UserTargetingExpirationForFlags get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
317
389
|
|
318
|
-
Get
|
390
|
+
Get expiring user targets for feature flag
|
319
391
|
|
320
392
|
### Example
|
321
393
|
```ruby
|
@@ -333,17 +405,76 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
333
405
|
|
334
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.
|
335
407
|
|
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.
|
409
|
+
|
336
410
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
337
411
|
|
338
|
-
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.
|
339
412
|
|
413
|
+
begin
|
414
|
+
#Get expiring user targets for feature flag
|
415
|
+
result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key, )
|
416
|
+
p result
|
417
|
+
rescue LaunchDarklyApi::ApiError => e
|
418
|
+
puts "Exception when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
419
|
+
end
|
420
|
+
```
|
421
|
+
|
422
|
+
### Parameters
|
423
|
+
|
424
|
+
Name | Type | Description | Notes
|
425
|
+
------------- | ------------- | ------------- | -------------
|
426
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
427
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
428
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
429
|
+
|
430
|
+
### Return type
|
431
|
+
|
432
|
+
[**UserTargetingExpirationForFlags**](UserTargetingExpirationForFlags.md)
|
433
|
+
|
434
|
+
### Authorization
|
435
|
+
|
436
|
+
[Token](../README.md#Token)
|
437
|
+
|
438
|
+
### HTTP request headers
|
439
|
+
|
440
|
+
- **Content-Type**: application/json
|
441
|
+
- **Accept**: application/json
|
442
|
+
|
443
|
+
|
444
|
+
|
445
|
+
# **get_feature_flag**
|
446
|
+
> FeatureFlag get_feature_flag(project_key, feature_flag_key, , opts)
|
447
|
+
|
448
|
+
Get a single feature flag by key.
|
449
|
+
|
450
|
+
### Example
|
451
|
+
```ruby
|
452
|
+
# load the gem
|
453
|
+
require 'launchdarkly_api'
|
454
|
+
# setup authorization
|
455
|
+
LaunchDarklyApi.configure do |config|
|
456
|
+
# Configure API key authorization: Token
|
457
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
458
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
459
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
460
|
+
end
|
461
|
+
|
462
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
463
|
+
|
464
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
465
|
+
|
466
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
467
|
+
|
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
|
+
}
|
340
471
|
|
341
472
|
begin
|
342
|
-
#Get
|
343
|
-
result = api_instance.
|
473
|
+
#Get a single feature flag by key.
|
474
|
+
result = api_instance.get_feature_flag(project_key, feature_flag_key, , opts)
|
344
475
|
p result
|
345
476
|
rescue LaunchDarklyApi::ApiError => e
|
346
|
-
puts "Exception when calling FeatureFlagsApi->
|
477
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
347
478
|
end
|
348
479
|
```
|
349
480
|
|
@@ -353,11 +484,11 @@ Name | Type | Description | Notes
|
|
353
484
|
------------- | ------------- | ------------- | -------------
|
354
485
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
355
486
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
356
|
-
**
|
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]
|
357
488
|
|
358
489
|
### Return type
|
359
490
|
|
360
|
-
[**
|
491
|
+
[**FeatureFlag**](FeatureFlag.md)
|
361
492
|
|
362
493
|
### Authorization
|
363
494
|
|
@@ -608,6 +739,186 @@ Name | Type | Description | Notes
|
|
608
739
|
|
609
740
|
|
610
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
|
+
|
611
922
|
# **patch_expiring_user_targets**
|
612
923
|
> UserTargetingExpirationForFlags patch_expiring_user_targets(project_key, environment_key, feature_flag_key, semantic_patch_with_comment)
|
613
924
|
|
@@ -727,10 +1038,74 @@ Name | Type | Description | Notes
|
|
727
1038
|
|
728
1039
|
|
729
1040
|
|
730
|
-
# **
|
731
|
-
>
|
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)
|
732
1107
|
|
733
|
-
Apply
|
1108
|
+
Apply approval request for a feature flag config
|
734
1109
|
|
735
1110
|
### Example
|
736
1111
|
```ruby
|
@@ -752,17 +1127,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
752
1127
|
|
753
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.
|
754
1129
|
|
755
|
-
|
1130
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
756
1131
|
|
757
|
-
|
1132
|
+
approval_request_apply_config_body = LaunchDarklyApi::ApprovalRequestApplyConfigBody.new # ApprovalRequestApplyConfigBody | Apply an approval request
|
758
1133
|
|
759
1134
|
|
760
1135
|
begin
|
761
|
-
#Apply
|
762
|
-
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)
|
763
1138
|
p result
|
764
1139
|
rescue LaunchDarklyApi::ApiError => e
|
765
|
-
puts "Exception when calling FeatureFlagsApi->
|
1140
|
+
puts "Exception when calling FeatureFlagsApi->post_apply_approval_request: #{e}"
|
766
1141
|
end
|
767
1142
|
```
|
768
1143
|
|
@@ -773,12 +1148,77 @@ Name | Type | Description | Notes
|
|
773
1148
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
774
1149
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
775
1150
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
776
|
-
**
|
777
|
-
**
|
1151
|
+
**approval_request_id** | **String**| The approval request ID |
|
1152
|
+
**approval_request_apply_config_body** | [**ApprovalRequestApplyConfigBody**](ApprovalRequestApplyConfigBody.md)| Apply an approval request |
|
778
1153
|
|
779
1154
|
### Return type
|
780
1155
|
|
781
|
-
[**
|
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)
|
782
1222
|
|
783
1223
|
### Authorization
|
784
1224
|
|
@@ -850,10 +1290,10 @@ Name | Type | Description | Notes
|
|
850
1290
|
|
851
1291
|
|
852
1292
|
|
853
|
-
# **
|
854
|
-
>
|
855
|
-
|
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, )
|
856
1295
|
|
1296
|
+
Creates a new scheduled change for a feature flag.
|
857
1297
|
|
858
1298
|
### Example
|
859
1299
|
```ruby
|
@@ -871,19 +1311,19 @@ api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
871
1311
|
|
872
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.
|
873
1313
|
|
1314
|
+
flag_config_scheduled_changes_post_body = LaunchDarklyApi::FlagConfigScheduledChangesPostBody.new # FlagConfigScheduledChangesPostBody | Create scheduled changes on a feature flag.
|
1315
|
+
|
874
1316
|
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
875
1317
|
|
876
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.
|
877
1319
|
|
878
|
-
opts = {
|
879
|
-
feature_flag_change_request_config_body: LaunchDarklyApi::FeatureFlagChangeRequestConfigBody.new # FeatureFlagChangeRequestConfigBody | Create a new feature flag change request
|
880
|
-
}
|
881
1320
|
|
882
1321
|
begin
|
883
|
-
|
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, )
|
884
1324
|
p result
|
885
1325
|
rescue LaunchDarklyApi::ApiError => e
|
886
|
-
puts "Exception when calling FeatureFlagsApi->
|
1326
|
+
puts "Exception when calling FeatureFlagsApi->post_flag_config_scheduled_changes: #{e}"
|
887
1327
|
end
|
888
1328
|
```
|
889
1329
|
|
@@ -892,13 +1332,13 @@ end
|
|
892
1332
|
Name | Type | Description | Notes
|
893
1333
|
------------- | ------------- | ------------- | -------------
|
894
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. |
|
895
1336
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
896
1337
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
897
|
-
**feature_flag_change_request_config_body** | [**FeatureFlagChangeRequestConfigBody**](FeatureFlagChangeRequestConfigBody.md)| Create a new feature flag change request | [optional]
|
898
1338
|
|
899
1339
|
### Return type
|
900
1340
|
|
901
|
-
[**
|
1341
|
+
[**FeatureFlagScheduledChange**](FeatureFlagScheduledChange.md)
|
902
1342
|
|
903
1343
|
### Authorization
|
904
1344
|
|
@@ -911,10 +1351,10 @@ Name | Type | Description | Notes
|
|
911
1351
|
|
912
1352
|
|
913
1353
|
|
914
|
-
# **
|
915
|
-
>
|
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)
|
916
1356
|
|
917
|
-
Review
|
1357
|
+
Review approval request for a feature flag config
|
918
1358
|
|
919
1359
|
### Example
|
920
1360
|
```ruby
|
@@ -936,17 +1376,17 @@ feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key.
|
|
936
1376
|
|
937
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.
|
938
1378
|
|
939
|
-
|
1379
|
+
approval_request_id = 'approval_request_id_example' # String | The approval request ID
|
940
1380
|
|
941
|
-
|
1381
|
+
approval_request_review_config_body = LaunchDarklyApi::ApprovalRequestReviewConfigBody.new # ApprovalRequestReviewConfigBody | Review an approval request
|
942
1382
|
|
943
1383
|
|
944
1384
|
begin
|
945
|
-
#Review
|
946
|
-
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)
|
947
1387
|
p result
|
948
1388
|
rescue LaunchDarklyApi::ApiError => e
|
949
|
-
puts "Exception when calling FeatureFlagsApi->
|
1389
|
+
puts "Exception when calling FeatureFlagsApi->post_review_approval_request: #{e}"
|
950
1390
|
end
|
951
1391
|
```
|
952
1392
|
|
@@ -957,12 +1397,12 @@ Name | Type | Description | Notes
|
|
957
1397
|
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
958
1398
|
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
959
1399
|
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
960
|
-
**
|
961
|
-
**
|
1400
|
+
**approval_request_id** | **String**| The approval request ID |
|
1401
|
+
**approval_request_review_config_body** | [**ApprovalRequestReviewConfigBody**](ApprovalRequestReviewConfigBody.md)| Review an approval request |
|
962
1402
|
|
963
1403
|
### Return type
|
964
1404
|
|
965
|
-
[**
|
1405
|
+
[**ApprovalRequests**](ApprovalRequests.md)
|
966
1406
|
|
967
1407
|
### Authorization
|
968
1408
|
|