launchdarkly_api 7.1.1 → 8.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +124 -73
- data/docs/Access.md +20 -0
- data/docs/AccessAllowedReason.md +28 -0
- data/docs/{AccessDeniedRep.md → AccessAllowedRep.md} +3 -3
- data/docs/AccessDenied.md +20 -0
- data/docs/{AccessDeniedReasonRep.md → AccessDeniedReason.md} +4 -4
- data/docs/AccessTokensApi.md +1 -1
- data/docs/AccountMembersApi.md +1 -1
- data/docs/AccountUsageBetaApi.md +11 -11
- data/docs/ApprovalsApi.md +14 -14
- data/docs/CodeReferencesApi.md +8 -8
- data/docs/ConditionInputRep.md +6 -0
- data/docs/ConditionOutputRep.md +6 -0
- data/docs/CustomRole.md +1 -1
- data/docs/CustomRolesApi.md +23 -23
- data/docs/DataExportDestinationsApi.md +37 -37
- data/docs/Destination.md +1 -1
- data/docs/EnvironmentPost.md +6 -4
- data/docs/EnvironmentsApi.md +15 -15
- data/docs/ExperimentsBetaApi.md +22 -22
- data/docs/Export.md +32 -0
- data/docs/FeatureFlag.md +1 -1
- data/docs/FeatureFlagBody.md +1 -1
- data/docs/FeatureFlagConfig.md +1 -1
- data/docs/FeatureFlags.md +3 -1
- data/docs/FeatureFlagsApi.md +107 -105
- data/docs/FeatureFlagsBetaApi.md +20 -20
- data/docs/FileRep.md +20 -0
- data/docs/FlagGlobalAttributesRep.md +1 -1
- data/docs/FlagLinkCollectionRep.md +20 -0
- data/docs/FlagLinkMember.md +24 -0
- data/docs/FlagLinkPost.md +30 -0
- data/docs/FlagLinkRep.md +38 -0
- data/docs/FlagLinksBetaApi.md +310 -0
- data/docs/FlagTriggersApi.md +55 -55
- data/docs/Import.md +30 -0
- data/docs/InitiatorRep.md +20 -0
- data/docs/Integration.md +1 -1
- data/docs/IntegrationAuditLogSubscriptionsApi.md +1 -1
- data/docs/IntegrationDeliveryConfiguration.md +38 -0
- data/docs/IntegrationDeliveryConfigurationCollection.md +20 -0
- data/docs/IntegrationDeliveryConfigurationCollectionLinks.md +20 -0
- data/docs/IntegrationDeliveryConfigurationLinks.md +24 -0
- data/docs/IntegrationDeliveryConfigurationPost.md +24 -0
- data/docs/IntegrationDeliveryConfigurationResponse.md +24 -0
- data/docs/IntegrationDeliveryConfigurationsBetaApi.md +541 -0
- data/docs/{MemberImportItemRep.md → MemberImportItem.md} +2 -2
- data/docs/{MemberSummaryRep.md → MemberSummary.md} +2 -2
- data/docs/MetricListingRep.md +2 -2
- data/docs/MetricRep.md +2 -2
- data/docs/MetricsApi.md +22 -22
- data/docs/PatchOperation.md +2 -2
- data/docs/PermissionGrantInput.md +4 -4
- data/docs/ProjectSummary.md +22 -0
- data/docs/ProjectsApi.md +1 -1
- data/docs/RelayAutoConfigRep.md +2 -2
- data/docs/RelayProxyConfigurationsApi.md +1 -1
- data/docs/RepositoryRep.md +1 -1
- data/docs/ResolvedContext.md +18 -0
- data/docs/ResolvedImage.md +22 -0
- data/docs/ResolvedTitle.md +20 -0
- data/docs/ResolvedUIBlockElement.md +24 -0
- data/docs/ResolvedUIBlocks.md +26 -0
- data/docs/ScheduleConditionInputRep.md +6 -0
- data/docs/ScheduleConditionOutputRep.md +7 -1
- data/docs/ScheduledChangesApi.md +10 -10
- data/docs/SegmentsApi.md +99 -99
- data/docs/SegmentsBetaApi.md +313 -0
- data/docs/SourceEnv.md +20 -0
- data/docs/Statement.md +2 -2
- data/docs/TagCollection.md +22 -0
- data/docs/TagsApi.md +83 -0
- data/docs/Team.md +32 -0
- data/docs/{CustomRolesRep.md → TeamCustomRole.md} +3 -3
- data/docs/TeamCustomRoles.md +22 -0
- data/docs/TeamImportsRep.md +1 -1
- data/docs/TeamMaintainers.md +22 -0
- data/docs/TeamProjects.md +20 -0
- data/docs/{TeamCollectionRep.md → Teams.md} +3 -3
- data/docs/TeamsBetaApi.md +196 -40
- data/docs/TimestampRep.md +24 -0
- data/docs/Token.md +1 -1
- data/docs/TriggerWorkflowRep.md +1 -1
- data/docs/User.md +0 -2
- data/docs/UserRecord.md +1 -1
- data/docs/UserSegment.md +1 -1
- data/docs/UserSettingsApi.md +60 -60
- data/docs/UsersApi.md +41 -41
- data/docs/Webhook.md +1 -1
- data/docs/WebhooksApi.md +1 -1
- data/docs/WorkflowsBetaApi.md +8 -8
- data/launchdarkly_api.gemspec +2 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
- data/lib/launchdarkly_api/api/account_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +20 -20
- data/lib/launchdarkly_api/api/approvals_api.rb +15 -15
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/code_references_api.rb +10 -10
- data/lib/launchdarkly_api/api/custom_roles_api.rb +30 -30
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +57 -57
- data/lib/launchdarkly_api/api/environments_api.rb +19 -19
- data/lib/launchdarkly_api/api/experiments_beta_api.rb +39 -39
- data/lib/launchdarkly_api/api/feature_flags_api.rb +162 -159
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +34 -34
- data/lib/launchdarkly_api/api/flag_links_beta_api.rb +332 -0
- data/lib/launchdarkly_api/api/flag_triggers_api.rb +96 -96
- data/lib/launchdarkly_api/api/integration_audit_log_subscriptions_api.rb +1 -1
- data/lib/launchdarkly_api/api/integration_delivery_configurations_beta_api.rb +569 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +28 -28
- data/lib/launchdarkly_api/api/other_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/scheduled_changes_api.rb +11 -11
- data/lib/launchdarkly_api/api/segments_api.rb +160 -160
- data/lib/launchdarkly_api/api/segments_beta_api.rb +334 -0
- data/lib/launchdarkly_api/api/tags_api.rb +85 -0
- data/lib/launchdarkly_api/api/teams_beta_api.rb +187 -49
- data/lib/launchdarkly_api/api/user_settings_api.rb +100 -100
- data/lib/launchdarkly_api/api/users_api.rb +69 -69
- data/lib/launchdarkly_api/api/users_beta_api.rb +1 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api/workflows_beta_api.rb +9 -9
- 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/access.rb +241 -0
- data/lib/launchdarkly_api/models/access_allowed_reason.rb +280 -0
- data/lib/launchdarkly_api/models/access_allowed_rep.rb +237 -0
- data/lib/launchdarkly_api/models/{access_denied_rep.rb → access_denied.rb} +5 -5
- data/lib/launchdarkly_api/models/{access_denied_reason_rep.rb → access_denied_reason.rb} +6 -6
- data/lib/launchdarkly_api/models/access_token_post.rb +1 -1
- data/lib/launchdarkly_api/models/action_input_rep.rb +1 -1
- data/lib/launchdarkly_api/models/action_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/approval_condition_input_rep.rb +1 -1
- data/lib/launchdarkly_api/models/approval_condition_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/approval_settings.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +1 -1
- data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +1 -1
- data/lib/launchdarkly_api/models/big_segment_target.rb +1 -1
- data/lib/launchdarkly_api/models/branch_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/branch_rep.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/client_side_availability_post.rb +1 -1
- data/lib/launchdarkly_api/models/condition_base_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/condition_input_rep.rb +29 -2
- data/lib/launchdarkly_api/models/condition_output_rep.rb +29 -2
- data/lib/launchdarkly_api/models/confidence_interval_rep.rb +1 -1
- data/lib/launchdarkly_api/models/conflict.rb +1 -1
- data/lib/launchdarkly_api/models/conflict_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/copied_from_env.rb +1 -1
- data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +1 -1
- data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +2 -2
- data/lib/launchdarkly_api/models/custom_role_post.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_post_data.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/custom_workflow_input_rep.rb +1 -1
- data/lib/launchdarkly_api/models/custom_workflow_meta.rb +1 -1
- data/lib/launchdarkly_api/models/custom_workflow_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/custom_workflow_stage_meta.rb +1 -1
- data/lib/launchdarkly_api/models/custom_workflows_listing_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/dependent_flag.rb +1 -1
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +1 -1
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +2 -2
- data/lib/launchdarkly_api/models/destination_post.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_post.rb +17 -8
- data/lib/launchdarkly_api/models/execution_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_info_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_results_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_stats_rep.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +1 -1
- data/lib/launchdarkly_api/models/experiment_totals_rep.rb +1 -1
- data/lib/launchdarkly_api/models/expiring_user_target_error.rb +1 -1
- data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +1 -1
- data/lib/launchdarkly_api/models/expiring_user_target_item.rb +1 -1
- data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +1 -1
- data/lib/launchdarkly_api/models/export.rb +323 -0
- data/lib/launchdarkly_api/models/extinction.rb +1 -1
- data/lib/launchdarkly_api/models/extinction_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +2 -2
- data/lib/launchdarkly_api/models/feature_flag_body.rb +2 -2
- data/lib/launchdarkly_api/models/feature_flag_config.rb +2 -2
- 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_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +14 -5
- data/lib/launchdarkly_api/models/{derived_attribute.rb → file_rep.rb} +17 -18
- data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +1 -1
- data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +1 -1
- data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +1 -1
- data/lib/launchdarkly_api/models/flag_copy_config_post.rb +1 -1
- data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +2 -2
- data/lib/launchdarkly_api/models/flag_link_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/flag_link_member.rb +257 -0
- data/lib/launchdarkly_api/models/flag_link_post.rb +274 -0
- data/lib/launchdarkly_api/models/flag_link_rep.rb +337 -0
- data/lib/launchdarkly_api/models/flag_listing_rep.rb +1 -1
- data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +1 -1
- data/lib/launchdarkly_api/models/flag_status_rep.rb +1 -1
- data/lib/launchdarkly_api/models/flag_summary.rb +1 -1
- data/lib/launchdarkly_api/models/flag_trigger_input.rb +1 -1
- data/lib/launchdarkly_api/models/forbidden_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/hunk_rep.rb +1 -1
- data/lib/launchdarkly_api/models/{expanded_team_rep.rb → import.rb} +71 -114
- data/lib/launchdarkly_api/models/initiator_rep.rb +227 -0
- data/lib/launchdarkly_api/models/integration.rb +2 -2
- data/lib/launchdarkly_api/models/integration_delivery_configuration.rb +369 -0
- data/lib/launchdarkly_api/models/integration_delivery_configuration_collection.rb +239 -0
- data/lib/launchdarkly_api/models/integration_delivery_configuration_collection_links.rb +232 -0
- data/lib/launchdarkly_api/models/integration_delivery_configuration_links.rb +265 -0
- data/lib/launchdarkly_api/models/integration_delivery_configuration_post.rb +257 -0
- data/lib/launchdarkly_api/models/integration_delivery_configuration_response.rb +245 -0
- data/lib/launchdarkly_api/models/integration_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/integration_status.rb +1 -1
- data/lib/launchdarkly_api/models/integration_status_rep.rb +1 -1
- data/lib/launchdarkly_api/models/integration_subscription_status_rep.rb +1 -1
- data/lib/launchdarkly_api/models/integrations.rb +1 -1
- data/lib/launchdarkly_api/models/invalid_request_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/ip_list.rb +1 -1
- data/lib/launchdarkly_api/models/last_seen_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/member_data_rep.rb +1 -1
- data/lib/launchdarkly_api/models/{member_import_item_rep.rb → member_import_item.rb} +4 -4
- data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +1 -1
- data/lib/launchdarkly_api/models/{member_summary_rep.rb → member_summary.rb} +4 -4
- data/lib/launchdarkly_api/models/member_team_summary_rep.rb +1 -1
- data/lib/launchdarkly_api/models/member_teams_post_input.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/method_not_allowed_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/metric_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +3 -3
- data/lib/launchdarkly_api/models/metric_post.rb +1 -1
- data/lib/launchdarkly_api/models/metric_rep.rb +3 -3
- data/lib/launchdarkly_api/models/metric_seen.rb +1 -1
- data/lib/launchdarkly_api/models/modification.rb +1 -1
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +1 -1
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +1 -1
- data/lib/launchdarkly_api/models/new_member_form.rb +1 -1
- data/lib/launchdarkly_api/models/not_found_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/parent_resource_rep.rb +1 -1
- data/lib/launchdarkly_api/models/patch_failed_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/patch_segment_instruction.rb +1 -1
- data/lib/launchdarkly_api/models/patch_segment_request.rb +1 -1
- data/lib/launchdarkly_api/models/patch_with_comment.rb +1 -1
- data/lib/launchdarkly_api/models/permission_grant_input.rb +16 -16
- data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +1 -1
- data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +1 -1
- data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.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_listing_rep.rb +1 -1
- data/lib/launchdarkly_api/models/project_post.rb +1 -1
- data/lib/launchdarkly_api/models/project_summary.rb +238 -0
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +1 -1
- data/lib/launchdarkly_api/models/put_branch.rb +1 -1
- data/lib/launchdarkly_api/models/rate_limited_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/recent_trigger_body.rb +1 -1
- data/lib/launchdarkly_api/models/reference_rep.rb +1 -1
- data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/relay_auto_config_post.rb +1 -1
- data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +3 -3
- data/lib/launchdarkly_api/models/repository_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/repository_post.rb +1 -1
- data/lib/launchdarkly_api/models/repository_rep.rb +2 -2
- data/lib/launchdarkly_api/models/{permission_grant_rep.rb → resolved_context.rb} +12 -41
- data/lib/launchdarkly_api/models/resolved_image.rb +236 -0
- data/lib/launchdarkly_api/models/resolved_title.rb +229 -0
- data/lib/launchdarkly_api/models/resolved_ui_block_element.rb +245 -0
- data/lib/launchdarkly_api/models/resolved_ui_blocks.rb +254 -0
- data/lib/launchdarkly_api/models/resource_access.rb +1 -1
- data/lib/launchdarkly_api/models/resource_id_response.rb +1 -1
- data/lib/launchdarkly_api/models/review_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/review_response.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/schedule_condition_input_rep.rb +29 -2
- data/lib/launchdarkly_api/models/schedule_condition_output_rep.rb +32 -5
- data/lib/launchdarkly_api/models/sdk_list_rep.rb +1 -1
- data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +1 -1
- data/lib/launchdarkly_api/models/sdk_version_rep.rb +1 -1
- data/lib/launchdarkly_api/models/segment_body.rb +1 -1
- data/lib/launchdarkly_api/models/segment_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/segment_user_list.rb +1 -1
- data/lib/launchdarkly_api/models/segment_user_state.rb +1 -1
- data/lib/launchdarkly_api/models/series_list_rep.rb +1 -1
- data/lib/launchdarkly_api/models/{access_rep.rb → source_env.rb} +22 -18
- data/lib/launchdarkly_api/models/source_flag.rb +1 -1
- data/lib/launchdarkly_api/models/stage_input_rep.rb +1 -1
- data/lib/launchdarkly_api/models/stage_output_rep.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +3 -3
- data/lib/launchdarkly_api/models/statement_post.rb +1 -1
- data/lib/launchdarkly_api/models/statement_post_data.rb +1 -1
- data/lib/launchdarkly_api/models/statement_rep.rb +1 -1
- data/lib/launchdarkly_api/models/statistic_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/statistic_rep.rb +1 -1
- data/lib/launchdarkly_api/models/statistics_root.rb +1 -1
- data/lib/launchdarkly_api/models/status_conflict_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/subject_data_rep.rb +1 -1
- data/lib/launchdarkly_api/models/subscription_post.rb +1 -1
- data/lib/launchdarkly_api/models/tag_collection.rb +252 -0
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/target_resource_rep.rb +1 -1
- data/lib/launchdarkly_api/models/{team_rep.rb → team.rb} +18 -62
- data/lib/launchdarkly_api/models/{custom_roles_rep.rb → team_custom_role.rb} +6 -8
- data/lib/launchdarkly_api/models/team_custom_roles.rb +240 -0
- data/lib/launchdarkly_api/models/team_imports_rep.rb +2 -2
- data/lib/launchdarkly_api/models/team_maintainers.rb +240 -0
- data/lib/launchdarkly_api/models/team_patch_input.rb +1 -1
- data/lib/launchdarkly_api/models/team_post_input.rb +1 -1
- data/lib/launchdarkly_api/models/team_projects.rb +229 -0
- data/lib/launchdarkly_api/models/{team_collection_rep.rb → teams.rb} +5 -5
- data/lib/launchdarkly_api/models/timestamp_rep.rb +245 -0
- data/lib/launchdarkly_api/models/title_rep.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +2 -2
- data/lib/launchdarkly_api/models/token_data_rep.rb +1 -1
- data/lib/launchdarkly_api/models/tokens.rb +1 -1
- data/lib/launchdarkly_api/models/trigger_post.rb +1 -1
- data/lib/launchdarkly_api/models/trigger_workflow_collection_rep.rb +1 -1
- data/lib/launchdarkly_api/models/trigger_workflow_rep.rb +2 -2
- data/lib/launchdarkly_api/models/unauthorized_error_rep.rb +1 -1
- data/lib/launchdarkly_api/models/url_post.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +2 -13
- data/lib/launchdarkly_api/models/user_attribute_names_rep.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 +2 -2
- data/lib/launchdarkly_api/models/user_record_rep.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +2 -2
- 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/users.rb +1 -1
- data/lib/launchdarkly_api/models/value_put.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +1 -1
- data/lib/launchdarkly_api/models/variation_summary.rb +1 -1
- data/lib/launchdarkly_api/models/versions_rep.rb +1 -1
- data/lib/launchdarkly_api/models/webhook.rb +2 -2
- data/lib/launchdarkly_api/models/webhook_post.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/lib/launchdarkly_api.rb +41 -12
- data/spec/api/access_tokens_api_spec.rb +1 -1
- data/spec/api/account_members_api_spec.rb +1 -1
- data/spec/api/account_usage_beta_api_spec.rb +4 -4
- data/spec/api/approvals_api_spec.rb +8 -8
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/code_references_api_spec.rb +2 -2
- data/spec/api/custom_roles_api_spec.rb +5 -5
- data/spec/api/data_export_destinations_api_spec.rb +9 -9
- data/spec/api/environments_api_spec.rb +3 -3
- data/spec/api/experiments_beta_api_spec.rb +7 -7
- data/spec/api/feature_flags_api_spec.rb +26 -25
- data/spec/api/feature_flags_beta_api_spec.rb +6 -6
- data/spec/api/flag_links_beta_api_spec.rb +91 -0
- data/spec/api/flag_triggers_api_spec.rb +16 -16
- data/spec/api/integration_audit_log_subscriptions_api_spec.rb +1 -1
- data/spec/api/integration_delivery_configurations_beta_api_spec.rb +135 -0
- data/spec/api/metrics_api_spec.rb +4 -4
- data/spec/api/other_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/scheduled_changes_api_spec.rb +6 -6
- data/spec/api/segments_api_spec.rb +28 -28
- data/spec/api/segments_beta_api_spec.rb +93 -0
- data/spec/api/tags_api_spec.rb +48 -0
- data/spec/api/teams_beta_api_spec.rb +37 -9
- data/spec/api/user_settings_api_spec.rb +18 -18
- data/spec/api/users_api_spec.rb +12 -12
- data/spec/api/users_beta_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api/workflows_beta_api_spec.rb +5 -5
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/access_allowed_reason_spec.rb +64 -0
- data/spec/models/access_allowed_rep_spec.rb +40 -0
- data/spec/models/{access_denied_reason_rep_spec.rb → access_denied_reason_spec.rb} +7 -7
- data/spec/models/{access_denied_rep_spec.rb → access_denied_spec.rb} +7 -7
- data/spec/models/{derived_attribute_spec.rb → access_spec.rb} +9 -9
- data/spec/models/access_token_post_spec.rb +1 -1
- data/spec/models/action_input_rep_spec.rb +1 -1
- data/spec/models/action_output_rep_spec.rb +1 -1
- data/spec/models/approval_condition_input_rep_spec.rb +1 -1
- data/spec/models/approval_condition_output_rep_spec.rb +1 -1
- data/spec/models/approval_settings_spec.rb +1 -1
- data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +1 -1
- data/spec/models/audit_log_entry_listing_rep_spec.rb +1 -1
- data/spec/models/audit_log_entry_rep_spec.rb +1 -1
- data/spec/models/authorized_app_data_rep_spec.rb +1 -1
- data/spec/models/big_segment_target_spec.rb +1 -1
- data/spec/models/branch_collection_rep_spec.rb +1 -1
- data/spec/models/branch_rep_spec.rb +1 -1
- data/spec/models/clause_spec.rb +1 -1
- data/spec/models/client_side_availability_post_spec.rb +1 -1
- data/spec/models/client_side_availability_spec.rb +1 -1
- data/spec/models/condition_base_output_rep_spec.rb +1 -1
- data/spec/models/condition_input_rep_spec.rb +19 -1
- data/spec/models/condition_output_rep_spec.rb +19 -1
- data/spec/models/confidence_interval_rep_spec.rb +1 -1
- data/spec/models/conflict_output_rep_spec.rb +1 -1
- data/spec/models/conflict_spec.rb +1 -1
- data/spec/models/copied_from_env_spec.rb +1 -1
- data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +1 -1
- data/spec/models/create_flag_config_approval_request_request_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_role_post_data_spec.rb +1 -1
- data/spec/models/custom_role_post_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/custom_workflow_input_rep_spec.rb +1 -1
- data/spec/models/custom_workflow_meta_spec.rb +1 -1
- data/spec/models/custom_workflow_output_rep_spec.rb +1 -1
- data/spec/models/custom_workflow_stage_meta_spec.rb +1 -1
- data/spec/models/custom_workflows_listing_output_rep_spec.rb +1 -1
- data/spec/models/default_client_side_availability_post_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/dependent_flag_environment_spec.rb +1 -1
- data/spec/models/dependent_flag_spec.rb +1 -1
- data/spec/models/dependent_flags_by_environment_spec.rb +1 -1
- data/spec/models/destination_post_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_post_spec.rb +7 -1
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/execution_output_rep_spec.rb +1 -1
- data/spec/models/experiment_allocation_rep_spec.rb +1 -1
- data/spec/models/experiment_enabled_period_rep_spec.rb +1 -1
- data/spec/models/experiment_environment_setting_rep_spec.rb +1 -1
- data/spec/models/experiment_info_rep_spec.rb +1 -1
- data/spec/models/experiment_metadata_rep_spec.rb +1 -1
- data/spec/models/experiment_rep_spec.rb +1 -1
- data/spec/models/experiment_results_rep_spec.rb +1 -1
- data/spec/models/experiment_stats_rep_spec.rb +1 -1
- data/spec/models/experiment_time_series_slice_spec.rb +1 -1
- data/spec/models/experiment_time_series_variation_slice_spec.rb +1 -1
- data/spec/models/experiment_totals_rep_spec.rb +1 -1
- data/spec/models/expiring_user_target_error_spec.rb +1 -1
- data/spec/models/expiring_user_target_get_response_spec.rb +1 -1
- data/spec/models/expiring_user_target_item_spec.rb +1 -1
- data/spec/models/expiring_user_target_patch_response_spec.rb +1 -1
- data/spec/models/export_spec.rb +76 -0
- data/spec/models/extinction_collection_rep_spec.rb +1 -1
- data/spec/models/extinction_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_scheduled_change_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_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +7 -1
- data/spec/models/file_rep_spec.rb +40 -0
- data/spec/models/flag_config_approval_request_response_spec.rb +1 -1
- data/spec/models/flag_config_approval_requests_response_spec.rb +1 -1
- data/spec/models/flag_copy_config_environment_spec.rb +1 -1
- data/spec/models/flag_copy_config_post_spec.rb +1 -1
- data/spec/models/flag_global_attributes_rep_spec.rb +1 -1
- data/spec/models/flag_link_collection_rep_spec.rb +40 -0
- data/spec/models/flag_link_member_spec.rb +52 -0
- data/spec/models/flag_link_post_spec.rb +70 -0
- data/spec/models/flag_link_rep_spec.rb +94 -0
- data/spec/models/flag_listing_rep_spec.rb +1 -1
- data/spec/models/flag_scheduled_changes_input_spec.rb +1 -1
- data/spec/models/flag_status_rep_spec.rb +1 -1
- data/spec/models/flag_summary_spec.rb +1 -1
- data/spec/models/flag_trigger_input_spec.rb +1 -1
- data/spec/models/forbidden_error_rep_spec.rb +1 -1
- data/spec/models/hunk_rep_spec.rb +1 -1
- data/spec/models/import_spec.rb +70 -0
- data/spec/models/initiator_rep_spec.rb +40 -0
- data/spec/models/integration_delivery_configuration_collection_links_spec.rb +40 -0
- data/spec/models/integration_delivery_configuration_collection_spec.rb +40 -0
- data/spec/models/integration_delivery_configuration_links_spec.rb +52 -0
- data/spec/models/integration_delivery_configuration_post_spec.rb +52 -0
- data/spec/models/integration_delivery_configuration_response_spec.rb +52 -0
- data/spec/models/integration_delivery_configuration_spec.rb +94 -0
- data/spec/models/integration_metadata_spec.rb +1 -1
- data/spec/models/integration_spec.rb +1 -1
- data/spec/models/integration_status_rep_spec.rb +1 -1
- data/spec/models/integration_status_spec.rb +1 -1
- data/spec/models/integration_subscription_status_rep_spec.rb +1 -1
- data/spec/models/integrations_spec.rb +1 -1
- data/spec/models/invalid_request_error_rep_spec.rb +1 -1
- data/spec/models/ip_list_spec.rb +1 -1
- data/spec/models/last_seen_metadata_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/member_data_rep_spec.rb +1 -1
- data/spec/models/{member_import_item_rep_spec.rb → member_import_item_spec.rb} +7 -7
- data/spec/models/member_permission_grant_summary_rep_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/{member_summary_rep_spec.rb → member_summary_spec.rb} +7 -7
- data/spec/models/member_team_summary_rep_spec.rb +1 -1
- data/spec/models/member_teams_post_input_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/method_not_allowed_error_rep_spec.rb +1 -1
- data/spec/models/metric_collection_rep_spec.rb +1 -1
- data/spec/models/metric_listing_rep_spec.rb +1 -1
- data/spec/models/metric_post_spec.rb +1 -1
- data/spec/models/metric_rep_spec.rb +1 -1
- data/spec/models/metric_seen_spec.rb +1 -1
- data/spec/models/modification_spec.rb +1 -1
- data/spec/models/multi_environment_dependent_flag_spec.rb +1 -1
- data/spec/models/multi_environment_dependent_flags_spec.rb +1 -1
- data/spec/models/new_member_form_spec.rb +1 -1
- data/spec/models/not_found_error_rep_spec.rb +1 -1
- data/spec/models/parent_resource_rep_spec.rb +1 -1
- data/spec/models/patch_failed_error_rep_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/patch_segment_instruction_spec.rb +1 -1
- data/spec/models/patch_segment_request_spec.rb +1 -1
- data/spec/models/patch_with_comment_spec.rb +1 -1
- data/spec/models/permission_grant_input_spec.rb +3 -3
- data/spec/models/post_approval_request_apply_request_spec.rb +1 -1
- data/spec/models/post_approval_request_review_request_spec.rb +1 -1
- data/spec/models/post_flag_scheduled_changes_input_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_listing_rep_spec.rb +1 -1
- data/spec/models/project_post_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/{team_rep_spec.rb → project_summary_spec.rb} +8 -62
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/pub_nub_detail_rep_spec.rb +1 -1
- data/spec/models/put_branch_spec.rb +1 -1
- data/spec/models/rate_limited_error_rep_spec.rb +1 -1
- data/spec/models/recent_trigger_body_spec.rb +1 -1
- data/spec/models/reference_rep_spec.rb +1 -1
- data/spec/models/relay_auto_config_collection_rep_spec.rb +1 -1
- data/spec/models/relay_auto_config_post_spec.rb +1 -1
- data/spec/models/relay_auto_config_rep_spec.rb +1 -1
- data/spec/models/repository_collection_rep_spec.rb +1 -1
- data/spec/models/repository_post_spec.rb +1 -1
- data/spec/models/repository_rep_spec.rb +1 -1
- data/spec/models/{access_rep_spec.rb → resolved_context_spec.rb} +8 -8
- data/spec/models/resolved_image_spec.rb +46 -0
- data/spec/models/resolved_title_spec.rb +40 -0
- data/spec/models/resolved_ui_block_element_spec.rb +52 -0
- data/spec/models/resolved_ui_blocks_spec.rb +58 -0
- data/spec/models/resource_access_spec.rb +1 -1
- data/spec/models/resource_id_response_spec.rb +1 -1
- data/spec/models/review_output_rep_spec.rb +1 -1
- data/spec/models/review_response_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/schedule_condition_input_rep_spec.rb +19 -1
- data/spec/models/schedule_condition_output_rep_spec.rb +19 -1
- data/spec/models/sdk_list_rep_spec.rb +1 -1
- data/spec/models/sdk_version_list_rep_spec.rb +1 -1
- data/spec/models/sdk_version_rep_spec.rb +1 -1
- data/spec/models/segment_body_spec.rb +1 -1
- data/spec/models/segment_metadata_spec.rb +1 -1
- data/spec/models/segment_user_list_spec.rb +1 -1
- data/spec/models/segment_user_state_spec.rb +1 -1
- data/spec/models/series_list_rep_spec.rb +1 -1
- data/spec/models/source_env_spec.rb +40 -0
- data/spec/models/source_flag_spec.rb +1 -1
- data/spec/models/stage_input_rep_spec.rb +1 -1
- data/spec/models/stage_output_rep_spec.rb +1 -1
- data/spec/models/statement_post_data_spec.rb +1 -1
- data/spec/models/statement_post_spec.rb +1 -1
- data/spec/models/statement_rep_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/statistic_collection_rep_spec.rb +1 -1
- data/spec/models/statistic_rep_spec.rb +1 -1
- data/spec/models/statistics_root_spec.rb +1 -1
- data/spec/models/status_conflict_error_rep_spec.rb +1 -1
- data/spec/models/subject_data_rep_spec.rb +1 -1
- data/spec/models/subscription_post_spec.rb +1 -1
- data/spec/models/tag_collection_spec.rb +46 -0
- data/spec/models/target_resource_rep_spec.rb +1 -1
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/{custom_roles_rep_spec.rb → team_custom_role_spec.rb} +7 -7
- data/spec/models/team_custom_roles_spec.rb +46 -0
- data/spec/models/team_imports_rep_spec.rb +1 -1
- data/spec/models/team_maintainers_spec.rb +46 -0
- data/spec/models/team_patch_input_spec.rb +1 -1
- data/spec/models/team_post_input_spec.rb +1 -1
- data/spec/models/team_projects_spec.rb +40 -0
- data/spec/models/{expanded_team_rep_spec.rb → team_spec.rb} +9 -45
- data/spec/models/{team_collection_rep_spec.rb → teams_spec.rb} +7 -7
- data/spec/models/{permission_grant_rep_spec.rb → timestamp_rep_spec.rb} +11 -11
- data/spec/models/title_rep_spec.rb +1 -1
- data/spec/models/token_data_rep_spec.rb +1 -1
- data/spec/models/token_spec.rb +1 -1
- data/spec/models/tokens_spec.rb +1 -1
- data/spec/models/trigger_post_spec.rb +1 -1
- data/spec/models/trigger_workflow_collection_rep_spec.rb +1 -1
- data/spec/models/trigger_workflow_rep_spec.rb +1 -1
- data/spec/models/unauthorized_error_rep_spec.rb +1 -1
- data/spec/models/url_post_spec.rb +1 -1
- data/spec/models/user_attribute_names_rep_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_rep_spec.rb +1 -1
- data/spec/models/user_record_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_spec.rb +1 -7
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/value_put_spec.rb +1 -1
- data/spec/models/variation_or_rollout_rep_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -1
- data/spec/models/variation_summary_spec.rb +1 -1
- data/spec/models/versions_rep_spec.rb +1 -1
- data/spec/models/webhook_post_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 +193 -59
- data/docs/AccessRep.md +0 -18
- data/docs/DerivedAttribute.md +0 -20
- data/docs/ExpandedTeamRep.md +0 -44
- data/docs/PermissionGrantRep.md +0 -24
- data/docs/TeamRep.md +0 -40
data/docs/FeatureFlagsApi.md
CHANGED
@@ -4,22 +4,22 @@ All URIs are relative to *https://app.launchdarkly.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{
|
8
|
-
| [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{
|
9
|
-
| [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /api/v2/flags/{
|
10
|
-
| [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /api/v2/flags/{
|
11
|
-
| [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /api/v2/flag-statuses/{
|
12
|
-
| [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /api/v2/flag-status/{
|
13
|
-
| [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /api/v2/flag-statuses/{
|
14
|
-
| [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /api/v2/flags/{
|
15
|
-
| [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{
|
16
|
-
| [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{
|
17
|
-
| [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{
|
7
|
+
| [**copy_feature_flag**](FeatureFlagsApi.md#copy_feature_flag) | **POST** /api/v2/flags/{projectKey}/{featureFlagKey}/copy | Copy feature flag |
|
8
|
+
| [**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /api/v2/flags/{projectKey}/{featureFlagKey} | Delete feature flag |
|
9
|
+
| [**get_expiring_user_targets**](FeatureFlagsApi.md#get_expiring_user_targets) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Get expiring user targets for feature flag |
|
10
|
+
| [**get_feature_flag**](FeatureFlagsApi.md#get_feature_flag) | **GET** /api/v2/flags/{projectKey}/{featureFlagKey} | Get feature flag |
|
11
|
+
| [**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /api/v2/flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get feature flag status |
|
12
|
+
| [**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /api/v2/flag-status/{projectKey}/{featureFlagKey} | Get flag status across environments |
|
13
|
+
| [**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /api/v2/flag-statuses/{projectKey}/{environmentKey} | List feature flag statuses |
|
14
|
+
| [**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /api/v2/flags/{projectKey} | List feature flags |
|
15
|
+
| [**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update expiring user targets on feature flag |
|
16
|
+
| [**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /api/v2/flags/{projectKey}/{featureFlagKey} | Update feature flag |
|
17
|
+
| [**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /api/v2/flags/{projectKey} | Create a feature flag |
|
18
18
|
|
19
19
|
|
20
20
|
## copy_feature_flag
|
21
21
|
|
22
|
-
> <FeatureFlag> copy_feature_flag(
|
22
|
+
> <FeatureFlag> copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)
|
23
23
|
|
24
24
|
Copy feature flag
|
25
25
|
|
@@ -39,13 +39,13 @@ LaunchDarklyApi.configure do |config|
|
|
39
39
|
end
|
40
40
|
|
41
41
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
42
|
-
|
43
|
-
feature_flag_key = 'feature_flag_key_example' # String | The feature flag
|
42
|
+
project_key = 'project_key_example' # String | The project key
|
43
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
|
44
44
|
flag_copy_config_post = LaunchDarklyApi::FlagCopyConfigPost.new({source: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'}), target: LaunchDarklyApi::FlagCopyConfigEnvironment.new({key: 'key_example'})}) # FlagCopyConfigPost |
|
45
45
|
|
46
46
|
begin
|
47
47
|
# Copy feature flag
|
48
|
-
result = api_instance.copy_feature_flag(
|
48
|
+
result = api_instance.copy_feature_flag(project_key, feature_flag_key, flag_copy_config_post)
|
49
49
|
p result
|
50
50
|
rescue LaunchDarklyApi::ApiError => e
|
51
51
|
puts "Error when calling FeatureFlagsApi->copy_feature_flag: #{e}"
|
@@ -56,12 +56,12 @@ end
|
|
56
56
|
|
57
57
|
This returns an Array which contains the response data, status code and headers.
|
58
58
|
|
59
|
-
> <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(
|
59
|
+
> <Array(<FeatureFlag>, Integer, Hash)> copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post)
|
60
60
|
|
61
61
|
```ruby
|
62
62
|
begin
|
63
63
|
# Copy feature flag
|
64
|
-
data, status_code, headers = api_instance.copy_feature_flag_with_http_info(
|
64
|
+
data, status_code, headers = api_instance.copy_feature_flag_with_http_info(project_key, feature_flag_key, flag_copy_config_post)
|
65
65
|
p status_code # => 2xx
|
66
66
|
p headers # => { ... }
|
67
67
|
p data # => <FeatureFlag>
|
@@ -74,8 +74,8 @@ end
|
|
74
74
|
|
75
75
|
| Name | Type | Description | Notes |
|
76
76
|
| ---- | ---- | ----------- | ----- |
|
77
|
-
| **
|
78
|
-
| **feature_flag_key** | **String** | The feature flag
|
77
|
+
| **project_key** | **String** | The project key | |
|
78
|
+
| **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
|
79
79
|
| **flag_copy_config_post** | [**FlagCopyConfigPost**](FlagCopyConfigPost.md) | | |
|
80
80
|
|
81
81
|
### Return type
|
@@ -94,7 +94,7 @@ end
|
|
94
94
|
|
95
95
|
## delete_feature_flag
|
96
96
|
|
97
|
-
> delete_feature_flag(
|
97
|
+
> delete_feature_flag(project_key, feature_flag_key)
|
98
98
|
|
99
99
|
Delete feature flag
|
100
100
|
|
@@ -114,12 +114,12 @@ LaunchDarklyApi.configure do |config|
|
|
114
114
|
end
|
115
115
|
|
116
116
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
117
|
-
|
118
|
-
|
117
|
+
project_key = 'project_key_example' # String | The project key
|
118
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
|
119
119
|
|
120
120
|
begin
|
121
121
|
# Delete feature flag
|
122
|
-
api_instance.delete_feature_flag(
|
122
|
+
api_instance.delete_feature_flag(project_key, feature_flag_key)
|
123
123
|
rescue LaunchDarklyApi::ApiError => e
|
124
124
|
puts "Error when calling FeatureFlagsApi->delete_feature_flag: #{e}"
|
125
125
|
end
|
@@ -129,12 +129,12 @@ end
|
|
129
129
|
|
130
130
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
131
131
|
|
132
|
-
> <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(
|
132
|
+
> <Array(nil, Integer, Hash)> delete_feature_flag_with_http_info(project_key, feature_flag_key)
|
133
133
|
|
134
134
|
```ruby
|
135
135
|
begin
|
136
136
|
# Delete feature flag
|
137
|
-
data, status_code, headers = api_instance.delete_feature_flag_with_http_info(
|
137
|
+
data, status_code, headers = api_instance.delete_feature_flag_with_http_info(project_key, feature_flag_key)
|
138
138
|
p status_code # => 2xx
|
139
139
|
p headers # => { ... }
|
140
140
|
p data # => nil
|
@@ -147,8 +147,8 @@ end
|
|
147
147
|
|
148
148
|
| Name | Type | Description | Notes |
|
149
149
|
| ---- | ---- | ----------- | ----- |
|
150
|
-
| **
|
151
|
-
| **
|
150
|
+
| **project_key** | **String** | The project key | |
|
151
|
+
| **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
|
152
152
|
|
153
153
|
### Return type
|
154
154
|
|
@@ -166,7 +166,7 @@ nil (empty response body)
|
|
166
166
|
|
167
167
|
## get_expiring_user_targets
|
168
168
|
|
169
|
-
> <ExpiringUserTargetGetResponse> get_expiring_user_targets(
|
169
|
+
> <ExpiringUserTargetGetResponse> get_expiring_user_targets(project_key, environment_key, feature_flag_key)
|
170
170
|
|
171
171
|
Get expiring user targets for feature flag
|
172
172
|
|
@@ -186,13 +186,13 @@ LaunchDarklyApi.configure do |config|
|
|
186
186
|
end
|
187
187
|
|
188
188
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
189
|
-
|
190
|
-
|
191
|
-
|
189
|
+
project_key = 'project_key_example' # String | The project key
|
190
|
+
environment_key = 'environment_key_example' # String | The environment key
|
191
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
|
192
192
|
|
193
193
|
begin
|
194
194
|
# Get expiring user targets for feature flag
|
195
|
-
result = api_instance.get_expiring_user_targets(
|
195
|
+
result = api_instance.get_expiring_user_targets(project_key, environment_key, feature_flag_key)
|
196
196
|
p result
|
197
197
|
rescue LaunchDarklyApi::ApiError => e
|
198
198
|
puts "Error when calling FeatureFlagsApi->get_expiring_user_targets: #{e}"
|
@@ -203,12 +203,12 @@ end
|
|
203
203
|
|
204
204
|
This returns an Array which contains the response data, status code and headers.
|
205
205
|
|
206
|
-
> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(
|
206
|
+
> <Array(<ExpiringUserTargetGetResponse>, Integer, Hash)> get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key)
|
207
207
|
|
208
208
|
```ruby
|
209
209
|
begin
|
210
210
|
# Get expiring user targets for feature flag
|
211
|
-
data, status_code, headers = api_instance.get_expiring_user_targets_with_http_info(
|
211
|
+
data, status_code, headers = api_instance.get_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key)
|
212
212
|
p status_code # => 2xx
|
213
213
|
p headers # => { ... }
|
214
214
|
p data # => <ExpiringUserTargetGetResponse>
|
@@ -221,9 +221,9 @@ end
|
|
221
221
|
|
222
222
|
| Name | Type | Description | Notes |
|
223
223
|
| ---- | ---- | ----------- | ----- |
|
224
|
-
| **
|
225
|
-
| **
|
226
|
-
| **
|
224
|
+
| **project_key** | **String** | The project key | |
|
225
|
+
| **environment_key** | **String** | The environment key | |
|
226
|
+
| **feature_flag_key** | **String** | The feature flag key | |
|
227
227
|
|
228
228
|
### Return type
|
229
229
|
|
@@ -241,7 +241,7 @@ end
|
|
241
241
|
|
242
242
|
## get_feature_flag
|
243
243
|
|
244
|
-
> <FeatureFlag> get_feature_flag(
|
244
|
+
> <FeatureFlag> get_feature_flag(project_key, feature_flag_key, opts)
|
245
245
|
|
246
246
|
Get feature flag
|
247
247
|
|
@@ -261,15 +261,15 @@ LaunchDarklyApi.configure do |config|
|
|
261
261
|
end
|
262
262
|
|
263
263
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
264
|
-
|
265
|
-
|
264
|
+
project_key = 'project_key_example' # String | The project key
|
265
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
|
266
266
|
opts = {
|
267
267
|
env: 'env_example' # String | Filter configurations by environment
|
268
268
|
}
|
269
269
|
|
270
270
|
begin
|
271
271
|
# Get feature flag
|
272
|
-
result = api_instance.get_feature_flag(
|
272
|
+
result = api_instance.get_feature_flag(project_key, feature_flag_key, opts)
|
273
273
|
p result
|
274
274
|
rescue LaunchDarklyApi::ApiError => e
|
275
275
|
puts "Error when calling FeatureFlagsApi->get_feature_flag: #{e}"
|
@@ -280,12 +280,12 @@ end
|
|
280
280
|
|
281
281
|
This returns an Array which contains the response data, status code and headers.
|
282
282
|
|
283
|
-
> <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(
|
283
|
+
> <Array(<FeatureFlag>, Integer, Hash)> get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
|
284
284
|
|
285
285
|
```ruby
|
286
286
|
begin
|
287
287
|
# Get feature flag
|
288
|
-
data, status_code, headers = api_instance.get_feature_flag_with_http_info(
|
288
|
+
data, status_code, headers = api_instance.get_feature_flag_with_http_info(project_key, feature_flag_key, opts)
|
289
289
|
p status_code # => 2xx
|
290
290
|
p headers # => { ... }
|
291
291
|
p data # => <FeatureFlag>
|
@@ -298,8 +298,8 @@ end
|
|
298
298
|
|
299
299
|
| Name | Type | Description | Notes |
|
300
300
|
| ---- | ---- | ----------- | ----- |
|
301
|
-
| **
|
302
|
-
| **
|
301
|
+
| **project_key** | **String** | The project key | |
|
302
|
+
| **feature_flag_key** | **String** | The feature flag key | |
|
303
303
|
| **env** | **String** | Filter configurations by environment | [optional] |
|
304
304
|
|
305
305
|
### Return type
|
@@ -318,7 +318,7 @@ end
|
|
318
318
|
|
319
319
|
## get_feature_flag_status
|
320
320
|
|
321
|
-
> <FlagStatusRep> get_feature_flag_status(
|
321
|
+
> <FlagStatusRep> get_feature_flag_status(project_key, environment_key, feature_flag_key)
|
322
322
|
|
323
323
|
Get feature flag status
|
324
324
|
|
@@ -338,13 +338,13 @@ LaunchDarklyApi.configure do |config|
|
|
338
338
|
end
|
339
339
|
|
340
340
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
341
|
-
|
342
|
-
|
343
|
-
|
341
|
+
project_key = 'project_key_example' # String | The project key
|
342
|
+
environment_key = 'environment_key_example' # String | The environment key
|
343
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
|
344
344
|
|
345
345
|
begin
|
346
346
|
# Get feature flag status
|
347
|
-
result = api_instance.get_feature_flag_status(
|
347
|
+
result = api_instance.get_feature_flag_status(project_key, environment_key, feature_flag_key)
|
348
348
|
p result
|
349
349
|
rescue LaunchDarklyApi::ApiError => e
|
350
350
|
puts "Error when calling FeatureFlagsApi->get_feature_flag_status: #{e}"
|
@@ -355,12 +355,12 @@ end
|
|
355
355
|
|
356
356
|
This returns an Array which contains the response data, status code and headers.
|
357
357
|
|
358
|
-
> <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(
|
358
|
+
> <Array(<FlagStatusRep>, Integer, Hash)> get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key)
|
359
359
|
|
360
360
|
```ruby
|
361
361
|
begin
|
362
362
|
# Get feature flag status
|
363
|
-
data, status_code, headers = api_instance.get_feature_flag_status_with_http_info(
|
363
|
+
data, status_code, headers = api_instance.get_feature_flag_status_with_http_info(project_key, environment_key, feature_flag_key)
|
364
364
|
p status_code # => 2xx
|
365
365
|
p headers # => { ... }
|
366
366
|
p data # => <FlagStatusRep>
|
@@ -373,9 +373,9 @@ end
|
|
373
373
|
|
374
374
|
| Name | Type | Description | Notes |
|
375
375
|
| ---- | ---- | ----------- | ----- |
|
376
|
-
| **
|
377
|
-
| **
|
378
|
-
| **
|
376
|
+
| **project_key** | **String** | The project key | |
|
377
|
+
| **environment_key** | **String** | The environment key | |
|
378
|
+
| **feature_flag_key** | **String** | The feature flag key | |
|
379
379
|
|
380
380
|
### Return type
|
381
381
|
|
@@ -393,7 +393,7 @@ end
|
|
393
393
|
|
394
394
|
## get_feature_flag_status_across_environments
|
395
395
|
|
396
|
-
> <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(
|
396
|
+
> <FeatureFlagStatusAcrossEnvironments> get_feature_flag_status_across_environments(project_key, feature_flag_key, opts)
|
397
397
|
|
398
398
|
Get flag status across environments
|
399
399
|
|
@@ -413,15 +413,15 @@ LaunchDarklyApi.configure do |config|
|
|
413
413
|
end
|
414
414
|
|
415
415
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
416
|
-
|
417
|
-
|
416
|
+
project_key = 'project_key_example' # String | The project key
|
417
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
|
418
418
|
opts = {
|
419
419
|
env: 'env_example' # String | Optional environment filter
|
420
420
|
}
|
421
421
|
|
422
422
|
begin
|
423
423
|
# Get flag status across environments
|
424
|
-
result = api_instance.get_feature_flag_status_across_environments(
|
424
|
+
result = api_instance.get_feature_flag_status_across_environments(project_key, feature_flag_key, opts)
|
425
425
|
p result
|
426
426
|
rescue LaunchDarklyApi::ApiError => e
|
427
427
|
puts "Error when calling FeatureFlagsApi->get_feature_flag_status_across_environments: #{e}"
|
@@ -432,12 +432,12 @@ end
|
|
432
432
|
|
433
433
|
This returns an Array which contains the response data, status code and headers.
|
434
434
|
|
435
|
-
> <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(
|
435
|
+
> <Array(<FeatureFlagStatusAcrossEnvironments>, Integer, Hash)> get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
|
436
436
|
|
437
437
|
```ruby
|
438
438
|
begin
|
439
439
|
# Get flag status across environments
|
440
|
-
data, status_code, headers = api_instance.get_feature_flag_status_across_environments_with_http_info(
|
440
|
+
data, status_code, headers = api_instance.get_feature_flag_status_across_environments_with_http_info(project_key, feature_flag_key, opts)
|
441
441
|
p status_code # => 2xx
|
442
442
|
p headers # => { ... }
|
443
443
|
p data # => <FeatureFlagStatusAcrossEnvironments>
|
@@ -450,8 +450,8 @@ end
|
|
450
450
|
|
451
451
|
| Name | Type | Description | Notes |
|
452
452
|
| ---- | ---- | ----------- | ----- |
|
453
|
-
| **
|
454
|
-
| **
|
453
|
+
| **project_key** | **String** | The project key | |
|
454
|
+
| **feature_flag_key** | **String** | The feature flag key | |
|
455
455
|
| **env** | **String** | Optional environment filter | [optional] |
|
456
456
|
|
457
457
|
### Return type
|
@@ -470,7 +470,7 @@ end
|
|
470
470
|
|
471
471
|
## get_feature_flag_statuses
|
472
472
|
|
473
|
-
> <FeatureFlagStatuses> get_feature_flag_statuses(
|
473
|
+
> <FeatureFlagStatuses> get_feature_flag_statuses(project_key, environment_key)
|
474
474
|
|
475
475
|
List feature flag statuses
|
476
476
|
|
@@ -490,12 +490,12 @@ LaunchDarklyApi.configure do |config|
|
|
490
490
|
end
|
491
491
|
|
492
492
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
493
|
-
|
494
|
-
|
493
|
+
project_key = 'project_key_example' # String | The project key
|
494
|
+
environment_key = 'environment_key_example' # String | The environment key
|
495
495
|
|
496
496
|
begin
|
497
497
|
# List feature flag statuses
|
498
|
-
result = api_instance.get_feature_flag_statuses(
|
498
|
+
result = api_instance.get_feature_flag_statuses(project_key, environment_key)
|
499
499
|
p result
|
500
500
|
rescue LaunchDarklyApi::ApiError => e
|
501
501
|
puts "Error when calling FeatureFlagsApi->get_feature_flag_statuses: #{e}"
|
@@ -506,12 +506,12 @@ end
|
|
506
506
|
|
507
507
|
This returns an Array which contains the response data, status code and headers.
|
508
508
|
|
509
|
-
> <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(
|
509
|
+
> <Array(<FeatureFlagStatuses>, Integer, Hash)> get_feature_flag_statuses_with_http_info(project_key, environment_key)
|
510
510
|
|
511
511
|
```ruby
|
512
512
|
begin
|
513
513
|
# List feature flag statuses
|
514
|
-
data, status_code, headers = api_instance.get_feature_flag_statuses_with_http_info(
|
514
|
+
data, status_code, headers = api_instance.get_feature_flag_statuses_with_http_info(project_key, environment_key)
|
515
515
|
p status_code # => 2xx
|
516
516
|
p headers # => { ... }
|
517
517
|
p data # => <FeatureFlagStatuses>
|
@@ -524,8 +524,8 @@ end
|
|
524
524
|
|
525
525
|
| Name | Type | Description | Notes |
|
526
526
|
| ---- | ---- | ----------- | ----- |
|
527
|
-
| **
|
528
|
-
| **
|
527
|
+
| **project_key** | **String** | The project key | |
|
528
|
+
| **environment_key** | **String** | The environment key | |
|
529
529
|
|
530
530
|
### Return type
|
531
531
|
|
@@ -543,7 +543,7 @@ end
|
|
543
543
|
|
544
544
|
## get_feature_flags
|
545
545
|
|
546
|
-
> <FeatureFlags> get_feature_flags(
|
546
|
+
> <FeatureFlags> get_feature_flags(project_key, opts)
|
547
547
|
|
548
548
|
List feature flags
|
549
549
|
|
@@ -563,7 +563,7 @@ LaunchDarklyApi.configure do |config|
|
|
563
563
|
end
|
564
564
|
|
565
565
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
566
|
-
|
566
|
+
project_key = 'project_key_example' # String | The project key
|
567
567
|
opts = {
|
568
568
|
env: 'env_example', # String | Filter configurations by environment
|
569
569
|
tag: 'tag_example', # String | Filter feature flags by tag
|
@@ -572,12 +572,13 @@ opts = {
|
|
572
572
|
archived: true, # Boolean | A boolean to filter the list to archived flags. When this is absent, only unarchived flags will be returned
|
573
573
|
summary: true, # Boolean | By default in API version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned
|
574
574
|
filter: 'filter_example', # String | A comma-separated list of filters. Each filter is of the form field:value
|
575
|
-
sort: 'sort_example' # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
|
575
|
+
sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order
|
576
|
+
compare: true # Boolean | A boolean to filter results by only flags that have differences between environments
|
576
577
|
}
|
577
578
|
|
578
579
|
begin
|
579
580
|
# List feature flags
|
580
|
-
result = api_instance.get_feature_flags(
|
581
|
+
result = api_instance.get_feature_flags(project_key, opts)
|
581
582
|
p result
|
582
583
|
rescue LaunchDarklyApi::ApiError => e
|
583
584
|
puts "Error when calling FeatureFlagsApi->get_feature_flags: #{e}"
|
@@ -588,12 +589,12 @@ end
|
|
588
589
|
|
589
590
|
This returns an Array which contains the response data, status code and headers.
|
590
591
|
|
591
|
-
> <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(
|
592
|
+
> <Array(<FeatureFlags>, Integer, Hash)> get_feature_flags_with_http_info(project_key, opts)
|
592
593
|
|
593
594
|
```ruby
|
594
595
|
begin
|
595
596
|
# List feature flags
|
596
|
-
data, status_code, headers = api_instance.get_feature_flags_with_http_info(
|
597
|
+
data, status_code, headers = api_instance.get_feature_flags_with_http_info(project_key, opts)
|
597
598
|
p status_code # => 2xx
|
598
599
|
p headers # => { ... }
|
599
600
|
p data # => <FeatureFlags>
|
@@ -606,7 +607,7 @@ end
|
|
606
607
|
|
607
608
|
| Name | Type | Description | Notes |
|
608
609
|
| ---- | ---- | ----------- | ----- |
|
609
|
-
| **
|
610
|
+
| **project_key** | **String** | The project key | |
|
610
611
|
| **env** | **String** | Filter configurations by environment | [optional] |
|
611
612
|
| **tag** | **String** | Filter feature flags by tag | [optional] |
|
612
613
|
| **limit** | **Integer** | The number of feature flags to return. Defaults to -1, which returns all flags | [optional] |
|
@@ -615,6 +616,7 @@ end
|
|
615
616
|
| **summary** | **Boolean** | By default in API version >= 1, flags will _not_ include their list of prerequisites, targets or rules. Set summary=0 to include these fields for each flag returned | [optional] |
|
616
617
|
| **filter** | **String** | A comma-separated list of filters. Each filter is of the form field:value | [optional] |
|
617
618
|
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order | [optional] |
|
619
|
+
| **compare** | **Boolean** | A boolean to filter results by only flags that have differences between environments | [optional] |
|
618
620
|
|
619
621
|
### Return type
|
620
622
|
|
@@ -632,7 +634,7 @@ end
|
|
632
634
|
|
633
635
|
## patch_expiring_user_targets
|
634
636
|
|
635
|
-
> <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(
|
637
|
+
> <ExpiringUserTargetPatchResponse> patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_with_comment)
|
636
638
|
|
637
639
|
Update expiring user targets on feature flag
|
638
640
|
|
@@ -652,14 +654,14 @@ LaunchDarklyApi.configure do |config|
|
|
652
654
|
end
|
653
655
|
|
654
656
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
655
|
-
|
656
|
-
|
657
|
-
|
658
|
-
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/
|
657
|
+
project_key = 'project_key_example' # String | The project key
|
658
|
+
environment_key = 'environment_key_example' # String | The environment key
|
659
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
|
660
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})]}) # PatchWithComment |
|
659
661
|
|
660
662
|
begin
|
661
663
|
# Update expiring user targets on feature flag
|
662
|
-
result = api_instance.patch_expiring_user_targets(
|
664
|
+
result = api_instance.patch_expiring_user_targets(project_key, environment_key, feature_flag_key, patch_with_comment)
|
663
665
|
p result
|
664
666
|
rescue LaunchDarklyApi::ApiError => e
|
665
667
|
puts "Error when calling FeatureFlagsApi->patch_expiring_user_targets: #{e}"
|
@@ -670,12 +672,12 @@ end
|
|
670
672
|
|
671
673
|
This returns an Array which contains the response data, status code and headers.
|
672
674
|
|
673
|
-
> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(
|
675
|
+
> <Array(<ExpiringUserTargetPatchResponse>, Integer, Hash)> patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment)
|
674
676
|
|
675
677
|
```ruby
|
676
678
|
begin
|
677
679
|
# Update expiring user targets on feature flag
|
678
|
-
data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(
|
680
|
+
data, status_code, headers = api_instance.patch_expiring_user_targets_with_http_info(project_key, environment_key, feature_flag_key, patch_with_comment)
|
679
681
|
p status_code # => 2xx
|
680
682
|
p headers # => { ... }
|
681
683
|
p data # => <ExpiringUserTargetPatchResponse>
|
@@ -688,9 +690,9 @@ end
|
|
688
690
|
|
689
691
|
| Name | Type | Description | Notes |
|
690
692
|
| ---- | ---- | ----------- | ----- |
|
691
|
-
| **
|
692
|
-
| **
|
693
|
-
| **
|
693
|
+
| **project_key** | **String** | The project key | |
|
694
|
+
| **environment_key** | **String** | The environment key | |
|
695
|
+
| **feature_flag_key** | **String** | The feature flag key | |
|
694
696
|
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
695
697
|
|
696
698
|
### Return type
|
@@ -709,11 +711,11 @@ end
|
|
709
711
|
|
710
712
|
## patch_feature_flag
|
711
713
|
|
712
|
-
> <FeatureFlag> patch_feature_flag(
|
714
|
+
> <FeatureFlag> patch_feature_flag(project_key, feature_flag_key, patch_with_comment)
|
713
715
|
|
714
716
|
Update feature flag
|
715
717
|
|
716
|
-
Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. comment `string`: (Optional) A description of the update. 1. environmentKey `string`: (Required) The key of the LaunchDarkly environment. 1. instructions `array`: (Required) The action or list of actions to be performed by the update. Each update action in the list must be an object/hash table with a `kind` property, although depending on the action, other properties may be necessary. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed). They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. #### `turnFlagOff` Sets the flag's targeting state to off. #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch).
|
718
|
+
Perform a partial update to a feature flag. ## Using JSON Patches on a feature flag When using the update feature flag endpoint to add individual users to a specific variation, there are two different patch documents, depending on whether users are already being individually targeted for the variation. If a flag variation already has users individually targeted, the path for the JSON Patch operation is: ```json { \"op\": \"add\", \"path\": \"/environments/devint/targets/0/values/-\", \"value\": \"TestClient10\" } ``` If a flag variation does not already have users individually targeted, the path for the JSON Patch operation is: ```json [ { \"op\": \"add\", \"path\": \"/environments/devint/targets/-\", \"value\": { \"variation\": 0, \"values\": [\"TestClient10\"] } } ] ``` ## Using semantic patches on a feature flag To use a [semantic patch](/reference#updates-via-semantic-patches) on a feature flag resource, you must include a header in the request. If you call a semantic patch resource without this header, you will receive a `400` response because your semantic patch will be interpreted as a JSON patch. Use this header: ``` Content-Type: application/json; domain-model=launchdarkly.semanticpatch ``` The body of a semantic patch request takes the following three properties: 1. `comment` (string): (Optional) A description of the update. 1. `environmentKey` (string): (Required) The key of the LaunchDarkly environment. 1. `instructions` (array): (Required) The list of actions to be performed by the update. Each action in the list must be an object/hash table with a `kind` property that indicates the instruction. Depending on the `kind`, the API may require other parameters. When this is the case, add the parameters as additional fields to the instruction object. Read below for more information on the specific supported semantic patch instructions. If any instruction in the patch encounters an error, the error will be returned and the flag will not be changed. In general, instructions will silently do nothing if the flag is already in the state requested by the patch instruction. For example, `removeUserTargets` does nothing when the targets have already been removed. They will generally error if a parameter refers to something that does not exist, like a variation ID that doesn't correspond to a variation on the flag or a rule ID that doesn't belong to a rule on the flag. Other specific error conditions are noted in the instruction descriptions. ### Instructions #### `turnFlagOn` Sets the flag's targeting state to on. For example, to flip a flag on, use this request body: ```json { \"environmentKey\": \"example-environment-key\", \"instructions\": [ { \"kind\": \"turnFlagOn\" } ] } ``` #### `turnFlagOff` Sets the flag's targeting state to off. For example, to flip a flag off, use this request body: ```json { \"environmentKey\": \"example-environment-key\", \"instructions\": [ { \"kind\": \"turnFlagOff\" } ] } ``` #### `addUserTargets` Adds the user keys in `values` to the individual user targets for the variation specified by `variationId`. Returns an error if this causes the same user key to be targeted in multiple variations. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `removeUserTargets` Removes the user keys in `values` to the individual user targets for the variation specified by `variationId`. Does nothing if the user keys are not targeted. ##### Parameters - `values`: list of user keys - `variationId`: ID of a variation on the flag #### `replaceUserTargets` Completely replaces the existing set of user targeting. All variations must be provided. Example: ```json { \"kind\": \"replaceUserTargets\", \"targets\": [ { \"variationId\": \"variation-1\", \"values\": [\"blah\", \"foo\", \"bar\"] }, { \"variationId\": \"variation-2\", \"values\": [\"abc\", \"def\"] } ] } ``` ##### Parameters - `targets`: a list of user targeting #### `clearUserTargets` Removes all individual user targets from the variation specified by `variationId` ##### Parameters - `variationId`: ID of a variation on the flag #### `addPrerequisite` Adds the flag indicated by `key` with variation `variationId` as a prerequisite to the flag. ##### Parameters - `key`: flag key of another flag - `variationId`: ID of a variation of the flag with key `key` #### `removePrerequisite` Removes the prerequisite indicated by `key`. Does nothing if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite #### `updatePrerequisite` Changes the prerequisite with flag key `key` to the variation indicated by `variationId`. Returns an error if this prerequisite does not exist. ##### Parameters - `key`: flag key of an existing prerequisite - `variationId`: ID of a variation of the flag with key `key` #### `replacePrerequisites` Completely replaces the existing set of prerequisites for a given flag. Example: ```json { \"kind\": \"replacePrerequisites\", \"prerequisites\": [ { \"key\": \"flag-key\", \"variationId\": \"variation-1\" }, { \"key\": \"another-flag\", \"variationId\": \"variation-2\" } ] } ``` ##### Parameters - `prerequisites`: a list of prerequisites #### `addRule` Adds a new rule to the flag with the given `clauses` which serves the variation indicated by `variationId` or the percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. If `beforeRuleId` is set, the rule will be added in the list of rules before the indicated rule. Otherwise, the rule will be added to the end of the list. ##### Parameters - `clauses`: Array of clauses (see `addClauses`) - `beforeRuleId`: Optional ID of a rule in the flag - `variationId`: ID of a variation of the flag - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `removeRule` Removes the targeting rule specified by `ruleId`. Does nothing if the rule does not exist. ##### Parameters - `ruleId`: ID of a rule in the flag #### `replaceRules` Completely replaces the existing rules for a given flag. Example: ```json { \"kind\": \"replaceRules\", \"rules\": [ { \"variationId\": \"variation-1\", \"description\": \"myRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"op\": \"segmentMatch\", \"values\": [\"test\"] } ], \"trackEvents\": true } ] } ``` ##### Parameters - `rules`: a list of rules #### `addClauses` Adds the given clauses to the rule indicated by `ruleId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauses`: Array of clause objects, with `attribute` (string), `op` (string), and `values` (array of strings, numbers, or dates) properties. #### `removeClauses` Removes the clauses specified by `clauseIds` from the rule indicated by `ruleId`. #### Parameters - `ruleId`: ID of a rule in the flag - `clauseIds`: Array of IDs of clauses in the rule #### `updateClause` Replaces the clause indicated by `ruleId` and `clauseId` with `clause`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `clause`: Clause object #### `addValuesToClause` Adds `values` to the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters - `ruleId`: ID of a rule in the flag - `clauseId`: ID of a clause in that rule - `values`: Array of strings #### `removeValuesFromClause` Removes `values` from the values of the clause indicated by `ruleId` and `clauseId`. ##### Parameters `ruleId`: ID of a rule in the flag `clauseId`: ID of a clause in that rule `values`: Array of strings #### `reorderRules` Rearranges the rules to match the order given in `ruleIds`. Will return an error if `ruleIds` does not match the current set of rules on the flag. ##### Parameters - `ruleIds`: Array of IDs of all rules in the flag #### `updateRuleVariationOrRollout` Updates what the rule indicated by `ruleId` serves if its clauses evaluate to true. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters - `ruleId`: ID of a rule in the flag - `variationId`: ID of a variation of the flag or - `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) - `rolloutBucketBy`: Optional user attribute #### `updateFallthroughVariationOrRollout` Updates the flag's fallthrough, which is served if none of the targeting rules match. Can either be a fixed variation indicated by `variationId` or a percent rollout indicated by `rolloutWeights` and `rolloutBucketBy`. ##### Parameters `variationId`: ID of a variation of the flag or `rolloutWeights`: Map of variationId to weight in thousandths of a percent (0-100000) `rolloutBucketBy`: Optional user attribute #### `updateOffVariation` Updates the variation served when the flag's targeting is off to the variation indicated by `variationId`. ##### Parameters `variationId`: ID of a variation of the flag ### Example ```json { \"environmentKey\": \"production\", \"instructions\": [ { \"kind\": \"turnFlagOn\" }, { \"kind\": \"turnFlagOff\" }, { \"kind\": \"addUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId\", \"userId2\"] }, { \"kind\": \"removeUserTargets\", \"variationId\": \"8bfb304e-d516-47e5-8727-e7f798e8992d\", \"values\": [\"userId3\", \"userId4\"] }, { \"kind\": \"updateFallthroughVariationOrRollout\", \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": null }, { \"kind\": \"addRule\", \"clauses\": [ { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } ], \"variationId\": null, \"rolloutWeights\": { \"variationId\": 50000, \"variationId2\": 50000 }, \"rolloutBucketBy\": \"key\" }, { \"kind\": \"removeRule\", \"ruleId\": \"99f12464-a429-40fc-86cc-b27612188955\" }, { \"kind\": \"reorderRules\", \"ruleIds\": [\"2f72974e-de68-4243-8dd3-739582147a1f\", \"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"addClauses\", \"ruleId\": \"1134\", \"clauses\": [ { \"attribute\": \"email\", \"op\": \"in\", \"negate\": false, \"values\": [\"test@test.com\"] } ] }, { \"kind\": \"removeClauses\", \"ruleId\": \"1242529\", \"clauseIds\": [\"8bfb304e-d516-47e5-8727-e7f798e8992d\"] }, { \"kind\": \"updateClause\", \"ruleId\": \"2f72974e-de68-4243-8dd3-739582147a1f\", \"clauseId\": \"309845\", \"clause\": { \"attribute\": \"segmentMatch\", \"negate\": false, \"values\": [\"test-segment\"] } }, { \"kind\": \"updateRuleVariationOrRollout\", \"ruleId\": \"2342\", \"rolloutWeights\": null, \"rolloutBucketBy\": null }, { \"kind\": \"updateOffVariation\", \"variationId\": \"3242453\" }, { \"kind\": \"addPrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"updatePrerequisite\", \"variationId\": \"234235\", \"key\": \"flagKey2\" }, { \"kind\": \"removePrerequisite\", \"key\": \"flagKey\" } ] } ``` ## Using JSON patches on a feature flag If you do not include the header described above, you can use [JSON patch](/reference#updates-via-json-patch).
|
717
719
|
|
718
720
|
### Examples
|
719
721
|
|
@@ -729,13 +731,13 @@ LaunchDarklyApi.configure do |config|
|
|
729
731
|
end
|
730
732
|
|
731
733
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
732
|
-
|
733
|
-
|
734
|
-
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/
|
734
|
+
project_key = 'project_key_example' # String | The project key
|
735
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key. The key identifies the flag in your code.
|
736
|
+
patch_with_comment = LaunchDarklyApi::PatchWithComment.new({patch: [LaunchDarklyApi::PatchOperation.new({op: 'replace', path: '/exampleField', value: new example value})]}) # PatchWithComment |
|
735
737
|
|
736
738
|
begin
|
737
739
|
# Update feature flag
|
738
|
-
result = api_instance.patch_feature_flag(
|
740
|
+
result = api_instance.patch_feature_flag(project_key, feature_flag_key, patch_with_comment)
|
739
741
|
p result
|
740
742
|
rescue LaunchDarklyApi::ApiError => e
|
741
743
|
puts "Error when calling FeatureFlagsApi->patch_feature_flag: #{e}"
|
@@ -746,12 +748,12 @@ end
|
|
746
748
|
|
747
749
|
This returns an Array which contains the response data, status code and headers.
|
748
750
|
|
749
|
-
> <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(
|
751
|
+
> <Array(<FeatureFlag>, Integer, Hash)> patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment)
|
750
752
|
|
751
753
|
```ruby
|
752
754
|
begin
|
753
755
|
# Update feature flag
|
754
|
-
data, status_code, headers = api_instance.patch_feature_flag_with_http_info(
|
756
|
+
data, status_code, headers = api_instance.patch_feature_flag_with_http_info(project_key, feature_flag_key, patch_with_comment)
|
755
757
|
p status_code # => 2xx
|
756
758
|
p headers # => { ... }
|
757
759
|
p data # => <FeatureFlag>
|
@@ -764,8 +766,8 @@ end
|
|
764
766
|
|
765
767
|
| Name | Type | Description | Notes |
|
766
768
|
| ---- | ---- | ----------- | ----- |
|
767
|
-
| **
|
768
|
-
| **
|
769
|
+
| **project_key** | **String** | The project key | |
|
770
|
+
| **feature_flag_key** | **String** | The feature flag key. The key identifies the flag in your code. | |
|
769
771
|
| **patch_with_comment** | [**PatchWithComment**](PatchWithComment.md) | | |
|
770
772
|
|
771
773
|
### Return type
|
@@ -784,7 +786,7 @@ end
|
|
784
786
|
|
785
787
|
## post_feature_flag
|
786
788
|
|
787
|
-
> <FeatureFlag> post_feature_flag(
|
789
|
+
> <FeatureFlag> post_feature_flag(project_key, feature_flag_body, opts)
|
788
790
|
|
789
791
|
Create a feature flag
|
790
792
|
|
@@ -804,7 +806,7 @@ LaunchDarklyApi.configure do |config|
|
|
804
806
|
end
|
805
807
|
|
806
808
|
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
807
|
-
|
809
|
+
project_key = 'project_key_example' # String | The project key
|
808
810
|
feature_flag_body = LaunchDarklyApi::FeatureFlagBody.new({name: 'name_example', key: 'key_example'}) # FeatureFlagBody |
|
809
811
|
opts = {
|
810
812
|
clone: 'clone_example' # String | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag.
|
@@ -812,7 +814,7 @@ opts = {
|
|
812
814
|
|
813
815
|
begin
|
814
816
|
# Create a feature flag
|
815
|
-
result = api_instance.post_feature_flag(
|
817
|
+
result = api_instance.post_feature_flag(project_key, feature_flag_body, opts)
|
816
818
|
p result
|
817
819
|
rescue LaunchDarklyApi::ApiError => e
|
818
820
|
puts "Error when calling FeatureFlagsApi->post_feature_flag: #{e}"
|
@@ -823,12 +825,12 @@ end
|
|
823
825
|
|
824
826
|
This returns an Array which contains the response data, status code and headers.
|
825
827
|
|
826
|
-
> <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(
|
828
|
+
> <Array(<FeatureFlag>, Integer, Hash)> post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
|
827
829
|
|
828
830
|
```ruby
|
829
831
|
begin
|
830
832
|
# Create a feature flag
|
831
|
-
data, status_code, headers = api_instance.post_feature_flag_with_http_info(
|
833
|
+
data, status_code, headers = api_instance.post_feature_flag_with_http_info(project_key, feature_flag_body, opts)
|
832
834
|
p status_code # => 2xx
|
833
835
|
p headers # => { ... }
|
834
836
|
p data # => <FeatureFlag>
|
@@ -841,7 +843,7 @@ end
|
|
841
843
|
|
842
844
|
| Name | Type | Description | Notes |
|
843
845
|
| ---- | ---- | ----------- | ----- |
|
844
|
-
| **
|
846
|
+
| **project_key** | **String** | The project key | |
|
845
847
|
| **feature_flag_body** | [**FeatureFlagBody**](FeatureFlagBody.md) | | |
|
846
848
|
| **clone** | **String** | The key of the feature flag to be cloned. The key identifies the flag in your code. For example, setting `clone=flagKey` copies the full targeting configuration for all environments, including `on/off` state, from the original flag to the new flag. | [optional] |
|
847
849
|
|