launchdarkly_api 3.6.0 → 3.9.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +223 -196
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlagChangeRequest.md +19 -0
- data/docs/FeatureFlagChangeRequestApplyConfigBody.md +8 -0
- data/docs/FeatureFlagChangeRequestConfigBody.md +11 -0
- data/docs/FeatureFlagChangeRequestReview.md +11 -0
- data/docs/FeatureFlagChangeRequestReviewConfigBody.md +9 -0
- data/docs/FeatureFlagChangeRequestReviewStatus.md +7 -0
- data/docs/FeatureFlagChangeRequests.md +9 -0
- data/docs/FeatureFlagsApi.md +313 -0
- data/docs/HierarchicalLinks.md +9 -0
- data/docs/Integration.md +9 -0
- data/docs/IntegrationLinks.md +8 -0
- data/docs/IntegrationSubscription.md +16 -0
- data/docs/IntegrationSubscriptionStatus.md +10 -0
- data/docs/Integrations.md +9 -0
- data/docs/IntegrationsApi.md +334 -0
- data/docs/Rule.md +1 -0
- data/docs/SubscriptionBody.md +12 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +16 -1
- data/lib/launchdarkly_api/api/access_tokens_api.rb +1 -1
- data/lib/launchdarkly_api/api/audit_log_api.rb +1 -1
- data/lib/launchdarkly_api/api/custom_roles_api.rb +1 -1
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +1 -1
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +1 -1
- data/lib/launchdarkly_api/api/environments_api.rb +123 -1
- data/lib/launchdarkly_api/api/feature_flags_api.rb +351 -1
- data/lib/launchdarkly_api/api/integrations_api.rb +358 -0
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +1 -1
- data/lib/launchdarkly_api/api/root_api.rb +1 -1
- data/lib/launchdarkly_api/api/team_members_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_segments_api.rb +1 -1
- data/lib/launchdarkly_api/api/user_settings_api.rb +1 -1
- data/lib/launchdarkly_api/api/users_api.rb +1 -1
- data/lib/launchdarkly_api/api/webhooks_api.rb +1 -1
- data/lib/launchdarkly_api/api_client.rb +1 -1
- data/lib/launchdarkly_api/api_error.rb +1 -1
- data/lib/launchdarkly_api/configuration.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entries.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry.rb +1 -1
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +1 -1
- data/lib/launchdarkly_api/models/clause.rb +1 -1
- data/lib/launchdarkly_api/models/client_side_availability.rb +1 -1
- data/lib/launchdarkly_api/models/copy_actions.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property.rb +1 -1
- data/lib/launchdarkly_api/models/custom_property_values.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role.rb +1 -1
- data/lib/launchdarkly_api/models/custom_role_body.rb +1 -1
- data/lib/launchdarkly_api/models/custom_roles.rb +1 -1
- data/lib/launchdarkly_api/models/defaults.rb +1 -1
- data/lib/launchdarkly_api/models/destination.rb +1 -1
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +1 -1
- data/lib/launchdarkly_api/models/destination_body.rb +1 -1
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +1 -1
- data/lib/launchdarkly_api/models/destination_m_particle.rb +1 -1
- data/lib/launchdarkly_api/models/destination_segment.rb +1 -1
- data/lib/launchdarkly_api/models/destinations.rb +1 -1
- data/lib/launchdarkly_api/models/environment.rb +1 -1
- data/lib/launchdarkly_api/models/environment_post.rb +1 -1
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/events.rb +1 -1
- data/lib/launchdarkly_api/models/fallthrough.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_change_request.rb +325 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_apply_config_body.rb +184 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_config_body.rb +229 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review.rb +211 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review_config_body.rb +233 -0
- data/lib/launchdarkly_api/models/feature_flag_change_request_review_status.rb +31 -0
- data/lib/launchdarkly_api/models/feature_flag_change_requests.rb +194 -0
- data/lib/launchdarkly_api/models/feature_flag_config.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +1 -1
- data/lib/launchdarkly_api/models/feature_flags.rb +1 -1
- data/lib/launchdarkly_api/models/flag_list_item.rb +1 -1
- data/lib/launchdarkly_api/models/hierarchical_links.rb +192 -0
- data/lib/launchdarkly_api/models/id.rb +1 -1
- data/lib/launchdarkly_api/models/integration.rb +194 -0
- data/lib/launchdarkly_api/models/integration__links.rb +183 -0
- data/lib/launchdarkly_api/models/integration_subscription.rb +264 -0
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +202 -0
- data/lib/launchdarkly_api/models/integrations.rb +195 -0
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +1 -1
- data/lib/launchdarkly_api/models/project_body.rb +1 -1
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +1 -1
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +14 -5
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +1 -1
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/site.rb +1 -1
- data/lib/launchdarkly_api/models/statement.rb +1 -1
- data/lib/launchdarkly_api/models/stream.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +1 -1
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/stream_usage_series.rb +1 -1
- data/lib/launchdarkly_api/models/streams.rb +1 -1
- data/lib/launchdarkly_api/models/subscription_body.rb +237 -0
- data/lib/launchdarkly_api/models/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +1 -1
- data/lib/launchdarkly_api/models/token_body.rb +1 -1
- data/lib/launchdarkly_api/models/tokens.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +1 -1
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +1 -1
- data/lib/launchdarkly_api/models/usage.rb +1 -1
- data/lib/launchdarkly_api/models/usage_error.rb +1 -1
- data/lib/launchdarkly_api/models/usage_links.rb +1 -1
- data/lib/launchdarkly_api/models/user.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_setting.rb +1 -1
- data/lib/launchdarkly_api/models/user_flag_settings.rb +1 -1
- data/lib/launchdarkly_api/models/user_record.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_segment_rule.rb +1 -1
- data/lib/launchdarkly_api/models/user_segments.rb +1 -1
- data/lib/launchdarkly_api/models/user_settings_body.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +1 -1
- data/lib/launchdarkly_api/models/users.rb +1 -1
- data/lib/launchdarkly_api/models/variation.rb +1 -1
- data/lib/launchdarkly_api/models/webhook.rb +1 -1
- data/lib/launchdarkly_api/models/webhook_body.rb +1 -1
- data/lib/launchdarkly_api/models/webhooks.rb +1 -1
- data/lib/launchdarkly_api/models/weighted_variation.rb +1 -1
- data/lib/launchdarkly_api/version.rb +2 -2
- data/openapi.yml +565 -1
- data/spec/api/access_tokens_api_spec.rb +1 -1
- data/spec/api/audit_log_api_spec.rb +1 -1
- data/spec/api/custom_roles_api_spec.rb +1 -1
- data/spec/api/customer_metrics_api_spec.rb +1 -1
- data/spec/api/data_export_destinations_api_spec.rb +1 -1
- data/spec/api/environments_api_spec.rb +27 -1
- data/spec/api/feature_flags_api_spec.rb +71 -1
- data/spec/api/integrations_api_spec.rb +105 -0
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +1 -1
- data/spec/api/root_api_spec.rb +1 -1
- data/spec/api/team_members_api_spec.rb +1 -1
- data/spec/api/user_segments_api_spec.rb +1 -1
- data/spec/api/user_settings_api_spec.rb +1 -1
- data/spec/api/users_api_spec.rb +1 -1
- data/spec/api/webhooks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/audit_log_entries_spec.rb +1 -1
- data/spec/models/audit_log_entry_spec.rb +1 -1
- data/spec/models/audit_log_entry_target_spec.rb +1 -1
- data/spec/models/clause_spec.rb +1 -1
- data/spec/models/client_side_availability_spec.rb +1 -1
- data/spec/models/copy_actions_spec.rb +1 -1
- data/spec/models/custom_property_spec.rb +1 -1
- data/spec/models/custom_property_values_spec.rb +1 -1
- data/spec/models/custom_role_body_spec.rb +1 -1
- data/spec/models/custom_role_spec.rb +1 -1
- data/spec/models/custom_roles_spec.rb +1 -1
- data/spec/models/defaults_spec.rb +1 -1
- data/spec/models/destination_amazon_kinesis_spec.rb +1 -1
- data/spec/models/destination_body_spec.rb +1 -1
- data/spec/models/destination_google_pub_sub_spec.rb +1 -1
- data/spec/models/destination_m_particle_spec.rb +1 -1
- data/spec/models/destination_segment_spec.rb +1 -1
- data/spec/models/destination_spec.rb +1 -1
- data/spec/models/destinations_spec.rb +1 -1
- data/spec/models/environment_post_spec.rb +1 -1
- data/spec/models/environment_spec.rb +1 -1
- data/spec/models/evaluation_usage_error_spec.rb +1 -1
- data/spec/models/events_spec.rb +1 -1
- data/spec/models/fallthrough_spec.rb +1 -1
- data/spec/models/feature_flag_body_spec.rb +1 -1
- data/spec/models/feature_flag_change_request_apply_config_body_spec.rb +41 -0
- data/spec/models/feature_flag_change_request_config_body_spec.rb +59 -0
- data/spec/models/feature_flag_change_request_review_config_body_spec.rb +51 -0
- data/spec/models/feature_flag_change_request_review_spec.rb +59 -0
- data/spec/models/feature_flag_change_request_review_status_spec.rb +35 -0
- data/spec/models/feature_flag_change_request_spec.rb +111 -0
- data/spec/models/feature_flag_change_requests_spec.rb +47 -0
- data/spec/models/feature_flag_config_spec.rb +1 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_change_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_changes_spec.rb +1 -1
- data/spec/models/feature_flag_spec.rb +1 -1
- data/spec/models/feature_flag_status_across_environments_spec.rb +1 -1
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +1 -1
- data/spec/models/feature_flag_status_spec.rb +1 -1
- data/spec/models/feature_flag_statuses_spec.rb +1 -1
- data/spec/models/feature_flags_spec.rb +1 -1
- data/spec/models/flag_list_item_spec.rb +1 -1
- data/spec/models/hierarchical_links_spec.rb +47 -0
- data/spec/models/id_spec.rb +1 -1
- data/spec/models/integration__links_spec.rb +41 -0
- data/spec/models/integration_spec.rb +47 -0
- data/spec/models/integration_subscription__status_spec.rb +53 -0
- data/spec/models/integration_subscription_spec.rb +89 -0
- data/spec/models/integrations_spec.rb +47 -0
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +1 -1
- data/spec/models/project_spec.rb +1 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +1 -1
- data/spec/models/relay_proxy_config_spec.rb +1 -1
- data/spec/models/relay_proxy_configs_spec.rb +1 -1
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +7 -1
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_inner_spec.rb +1 -1
- data/spec/models/semantic_patch_instruction_spec.rb +1 -1
- data/spec/models/semantic_patch_operation_spec.rb +1 -1
- data/spec/models/site_spec.rb +1 -1
- data/spec/models/statement_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +1 -1
- data/spec/models/stream_by_sdk_links_spec.rb +1 -1
- data/spec/models/stream_by_sdk_spec.rb +1 -1
- data/spec/models/stream_links_spec.rb +1 -1
- data/spec/models/stream_sdk_version_data_spec.rb +1 -1
- data/spec/models/stream_sdk_version_spec.rb +1 -1
- data/spec/models/stream_spec.rb +1 -1
- data/spec/models/stream_usage_error_spec.rb +1 -1
- data/spec/models/stream_usage_links_spec.rb +1 -1
- data/spec/models/stream_usage_metadata_spec.rb +1 -1
- data/spec/models/stream_usage_series_spec.rb +1 -1
- data/spec/models/streams_spec.rb +1 -1
- data/spec/models/subscription_body_spec.rb +65 -0
- data/spec/models/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +1 -1
- data/spec/models/token_spec.rb +1 -1
- data/spec/models/tokens_spec.rb +1 -1
- data/spec/models/unbounded_segment_target_changes_spec.rb +1 -1
- data/spec/models/unbounded_segment_targets_body_spec.rb +1 -1
- data/spec/models/usage_error_spec.rb +1 -1
- data/spec/models/usage_links_spec.rb +1 -1
- data/spec/models/usage_spec.rb +1 -1
- data/spec/models/user_flag_setting_spec.rb +1 -1
- data/spec/models/user_flag_settings_spec.rb +1 -1
- data/spec/models/user_record_spec.rb +1 -1
- data/spec/models/user_segment_body_spec.rb +1 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +1 -1
- data/spec/models/user_segments_spec.rb +1 -1
- data/spec/models/user_settings_body_spec.rb +1 -1
- data/spec/models/user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +1 -1
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +1 -1
- data/spec/models/users_spec.rb +1 -1
- data/spec/models/variation_spec.rb +1 -1
- data/spec/models/webhook_body_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +1 -1
- data/spec/models/webhooks_spec.rb +1 -1
- data/spec/models/weighted_variation_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +164 -104
data/docs/EnvironmentsApi.md
CHANGED
|
@@ -8,6 +8,8 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**get_environment**](EnvironmentsApi.md#get_environment) | **GET** /projects/{projectKey}/environments/{environmentKey} | Get an environment given a project and key.
|
|
9
9
|
[**patch_environment**](EnvironmentsApi.md#patch_environment) | **PATCH** /projects/{projectKey}/environments/{environmentKey} | Modify an environment by ID.
|
|
10
10
|
[**post_environment**](EnvironmentsApi.md#post_environment) | **POST** /projects/{projectKey}/environments | Create a new environment in a specified project with a given name, key, and swatch color.
|
|
11
|
+
[**reset_environment_mobile_key**](EnvironmentsApi.md#reset_environment_mobile_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/mobileKey | Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
12
|
+
[**reset_environment_sdk_key**](EnvironmentsApi.md#reset_environment_sdk_key) | **POST** /projects/{projectKey}/environments/{environmentKey}/apiKey | Reset an environment's SDK key with an optional expiry time for the old key.
|
|
11
13
|
|
|
12
14
|
|
|
13
15
|
# **delete_environment**
|
|
@@ -232,3 +234,121 @@ Name | Type | Description | Notes
|
|
|
232
234
|
|
|
233
235
|
|
|
234
236
|
|
|
237
|
+
# **reset_environment_mobile_key**
|
|
238
|
+
> Environment reset_environment_mobile_key(project_key, environment_key, , opts)
|
|
239
|
+
|
|
240
|
+
Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
241
|
+
|
|
242
|
+
### Example
|
|
243
|
+
```ruby
|
|
244
|
+
# load the gem
|
|
245
|
+
require 'launchdarkly_api'
|
|
246
|
+
# setup authorization
|
|
247
|
+
LaunchDarklyApi.configure do |config|
|
|
248
|
+
# Configure API key authorization: Token
|
|
249
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
250
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
251
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
252
|
+
end
|
|
253
|
+
|
|
254
|
+
api_instance = LaunchDarklyApi::EnvironmentsApi.new
|
|
255
|
+
|
|
256
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
257
|
+
|
|
258
|
+
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.
|
|
259
|
+
|
|
260
|
+
opts = {
|
|
261
|
+
expiry: 789 # Integer | The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version.
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
begin
|
|
265
|
+
#Reset an environment's mobile key. The optional expiry for the old key is deprecated for this endpoint, so the old key will always expire immediately.
|
|
266
|
+
result = api_instance.reset_environment_mobile_key(project_key, environment_key, , opts)
|
|
267
|
+
p result
|
|
268
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
269
|
+
puts "Exception when calling EnvironmentsApi->reset_environment_mobile_key: #{e}"
|
|
270
|
+
end
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Parameters
|
|
274
|
+
|
|
275
|
+
Name | Type | Description | Notes
|
|
276
|
+
------------- | ------------- | ------------- | -------------
|
|
277
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
278
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
279
|
+
**expiry** | **Integer**| The expiry parameter is deprecated for this endpoint, so the old mobile key will always expire immediately. This parameter will be removed in an upcoming major API client version. | [optional]
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
[**Environment**](Environment.md)
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
[Token](../README.md#Token)
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: application/json
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
# **reset_environment_sdk_key**
|
|
297
|
+
> Environment reset_environment_sdk_key(project_key, environment_key, , opts)
|
|
298
|
+
|
|
299
|
+
Reset an environment's SDK key with an optional expiry time for the old key.
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
```ruby
|
|
303
|
+
# load the gem
|
|
304
|
+
require 'launchdarkly_api'
|
|
305
|
+
# setup authorization
|
|
306
|
+
LaunchDarklyApi.configure do |config|
|
|
307
|
+
# Configure API key authorization: Token
|
|
308
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
309
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
310
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
311
|
+
end
|
|
312
|
+
|
|
313
|
+
api_instance = LaunchDarklyApi::EnvironmentsApi.new
|
|
314
|
+
|
|
315
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
316
|
+
|
|
317
|
+
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.
|
|
318
|
+
|
|
319
|
+
opts = {
|
|
320
|
+
expiry: 789 # Integer | An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately.
|
|
321
|
+
}
|
|
322
|
+
|
|
323
|
+
begin
|
|
324
|
+
#Reset an environment's SDK key with an optional expiry time for the old key.
|
|
325
|
+
result = api_instance.reset_environment_sdk_key(project_key, environment_key, , opts)
|
|
326
|
+
p result
|
|
327
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
328
|
+
puts "Exception when calling EnvironmentsApi->reset_environment_sdk_key: #{e}"
|
|
329
|
+
end
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
### Parameters
|
|
333
|
+
|
|
334
|
+
Name | Type | Description | Notes
|
|
335
|
+
------------- | ------------- | ------------- | -------------
|
|
336
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
337
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
338
|
+
**expiry** | **Integer**| An expiration time for the old environment SDK key, expressed as a Unix epoch time in milliseconds. By default, the key will expire immediately. | [optional]
|
|
339
|
+
|
|
340
|
+
### Return type
|
|
341
|
+
|
|
342
|
+
[**Environment**](Environment.md)
|
|
343
|
+
|
|
344
|
+
### Authorization
|
|
345
|
+
|
|
346
|
+
[Token](../README.md#Token)
|
|
347
|
+
|
|
348
|
+
### HTTP request headers
|
|
349
|
+
|
|
350
|
+
- **Content-Type**: application/json
|
|
351
|
+
- **Accept**: application/json
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequest
|
|
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 change request was requested | [optional]
|
|
9
|
+
**requestor_id** | **String** | The id of the member that requested the change | [optional]
|
|
10
|
+
**review_status** | [**FeatureFlagChangeRequestReviewStatus**](FeatureFlagChangeRequestReviewStatus.md) | | [optional]
|
|
11
|
+
**status** | **String** | | Name | Description | | --------:| ----------- | | pending | the feature flag change request has not been applied yet | | completed| the feature flag change request has been applied successfully | | failed | the feature flag change 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 change request | [optional]
|
|
13
|
+
**applied_date** | **Integer** | A unix epoch time in milliseconds specifying the date the change request was applied | [optional]
|
|
14
|
+
**current_reviews_by_member_id** | [**FeatureFlagChangeRequestReview**](FeatureFlagChangeRequestReview.md) | | [optional]
|
|
15
|
+
**all_reviews** | [**Array<FeatureFlagChangeRequestReview>**](FeatureFlagChangeRequestReview.md) | | [optional]
|
|
16
|
+
**notify_member_ids** | **Array<String>** | | [optional]
|
|
17
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | | [optional]
|
|
18
|
+
|
|
19
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequestApplyConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequestConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**description** | **String** | A name that describes the changes you would like to apply to a feature flag configuration |
|
|
7
|
+
**instructions** | [**SemanticPatchInstruction**](SemanticPatchInstruction.md) | |
|
|
8
|
+
**notify_member_ids** | **Array<String>** | |
|
|
9
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequestReview
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**creation_date** | **Integer** | A unix epoch time in milliseconds specifying the date the change request was reviewed | [optional]
|
|
7
|
+
**kind** | [**FeatureFlagChangeRequestReviewStatus**](FeatureFlagChangeRequestReviewStatus.md) | | [optional]
|
|
8
|
+
**member_id** | [**Id**](Id.md) | | [optional]
|
|
9
|
+
**_id** | [**Id**](Id.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequestReviewConfigBody
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**kind** | **String** | Either approve or decline change request |
|
|
7
|
+
**comment** | **String** | comment will be included in audit log item for change. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# LaunchDarklyApi::FeatureFlagChangeRequests
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**_links** | [**Links**](Links.md) | | [optional]
|
|
7
|
+
**items** | [**Array<FeatureFlagChangeRequest>**](FeatureFlagChangeRequest.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/FeatureFlagsApi.md
CHANGED
|
@@ -8,13 +8,18 @@ Method | HTTP request | Description
|
|
|
8
8
|
[**delete_feature_flag**](FeatureFlagsApi.md#delete_feature_flag) | **DELETE** /flags/{projectKey}/{featureFlagKey} | Delete a feature flag in all environments. Be careful-- only delete feature flags that are no longer being used by your application.
|
|
9
9
|
[**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
10
|
[**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
|
|
11
13
|
[**get_feature_flag_status**](FeatureFlagsApi.md#get_feature_flag_status) | **GET** /flag-statuses/{projectKey}/{environmentKey}/{featureFlagKey} | Get the status for a particular feature flag.
|
|
12
14
|
[**get_feature_flag_status_across_environments**](FeatureFlagsApi.md#get_feature_flag_status_across_environments) | **GET** /flag-status/{projectKey}/{featureFlagKey} | Get the status for a particular feature flag across environments
|
|
13
15
|
[**get_feature_flag_statuses**](FeatureFlagsApi.md#get_feature_flag_statuses) | **GET** /flag-statuses/{projectKey}/{environmentKey} | Get a list of statuses for all feature flags. The status includes the last time the feature flag was requested, as well as the state of the flag.
|
|
14
16
|
[**get_feature_flags**](FeatureFlagsApi.md#get_feature_flags) | **GET** /flags/{projectKey} | Get a list of all features in the given project.
|
|
15
17
|
[**patch_expiring_user_targets**](FeatureFlagsApi.md#patch_expiring_user_targets) | **PATCH** /flags/{projectKey}/{featureFlagKey}/expiring-user-targets/{environmentKey} | Update, add, or delete expiring user targets on feature flag
|
|
16
18
|
[**patch_feature_flag**](FeatureFlagsApi.md#patch_feature_flag) | **PATCH** /flags/{projectKey}/{featureFlagKey} | Perform a partial update to a feature.
|
|
19
|
+
[**post_apply_feature_flag_change_request**](FeatureFlagsApi.md#post_apply_feature_flag_change_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/apply | Apply change request for a feature flag
|
|
17
20
|
[**post_feature_flag**](FeatureFlagsApi.md#post_feature_flag) | **POST** /flags/{projectKey} | Creates a new feature flag.
|
|
21
|
+
[**post_feature_flag_change_request**](FeatureFlagsApi.md#post_feature_flag_change_request) | **POST** /{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests |
|
|
22
|
+
[**post_review_feature_flag_change_request**](FeatureFlagsApi.md#post_review_feature_flag_change_request) | **POST** /projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{featureFlagChangeRequestId}/review | Review change request for a feature flag
|
|
18
23
|
|
|
19
24
|
|
|
20
25
|
# **copy_feature_flag**
|
|
@@ -246,6 +251,125 @@ Name | Type | Description | Notes
|
|
|
246
251
|
|
|
247
252
|
|
|
248
253
|
|
|
254
|
+
# **get_feature_flag_change_request**
|
|
255
|
+
> FeatureFlagChangeRequests get_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, )
|
|
256
|
+
|
|
257
|
+
Get a single change request for a feature flag
|
|
258
|
+
|
|
259
|
+
### Example
|
|
260
|
+
```ruby
|
|
261
|
+
# load the gem
|
|
262
|
+
require 'launchdarkly_api'
|
|
263
|
+
# setup authorization
|
|
264
|
+
LaunchDarklyApi.configure do |config|
|
|
265
|
+
# Configure API key authorization: Token
|
|
266
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
268
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
272
|
+
|
|
273
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
274
|
+
|
|
275
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
276
|
+
|
|
277
|
+
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
|
+
|
|
279
|
+
feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
begin
|
|
283
|
+
#Get a single change request for a feature flag
|
|
284
|
+
result = api_instance.get_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, )
|
|
285
|
+
p result
|
|
286
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
287
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag_change_request: #{e}"
|
|
288
|
+
end
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Parameters
|
|
292
|
+
|
|
293
|
+
Name | Type | Description | Notes
|
|
294
|
+
------------- | ------------- | ------------- | -------------
|
|
295
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
296
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
297
|
+
**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
|
+
|
|
300
|
+
### Return type
|
|
301
|
+
|
|
302
|
+
[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
|
|
303
|
+
|
|
304
|
+
### Authorization
|
|
305
|
+
|
|
306
|
+
[Token](../README.md#Token)
|
|
307
|
+
|
|
308
|
+
### HTTP request headers
|
|
309
|
+
|
|
310
|
+
- **Content-Type**: application/json
|
|
311
|
+
- **Accept**: application/json
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
# **get_feature_flag_change_requests**
|
|
316
|
+
> FeatureFlagChangeRequests get_feature_flag_change_requests(project_key, feature_flag_key, environment_key, )
|
|
317
|
+
|
|
318
|
+
Get all change requests for a feature flag
|
|
319
|
+
|
|
320
|
+
### Example
|
|
321
|
+
```ruby
|
|
322
|
+
# load the gem
|
|
323
|
+
require 'launchdarkly_api'
|
|
324
|
+
# setup authorization
|
|
325
|
+
LaunchDarklyApi.configure do |config|
|
|
326
|
+
# Configure API key authorization: Token
|
|
327
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
328
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
329
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
330
|
+
end
|
|
331
|
+
|
|
332
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
333
|
+
|
|
334
|
+
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
|
+
|
|
336
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
337
|
+
|
|
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
|
+
|
|
340
|
+
|
|
341
|
+
begin
|
|
342
|
+
#Get all change requests for a feature flag
|
|
343
|
+
result = api_instance.get_feature_flag_change_requests(project_key, feature_flag_key, environment_key, )
|
|
344
|
+
p result
|
|
345
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
346
|
+
puts "Exception when calling FeatureFlagsApi->get_feature_flag_change_requests: #{e}"
|
|
347
|
+
end
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Parameters
|
|
351
|
+
|
|
352
|
+
Name | Type | Description | Notes
|
|
353
|
+
------------- | ------------- | ------------- | -------------
|
|
354
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
355
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
356
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[Token](../README.md#Token)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: application/json
|
|
369
|
+
- **Accept**: application/json
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
249
373
|
# **get_feature_flag_status**
|
|
250
374
|
> FeatureFlagStatus get_feature_flag_status(project_key, environment_key, feature_flag_key, )
|
|
251
375
|
|
|
@@ -603,6 +727,70 @@ Name | Type | Description | Notes
|
|
|
603
727
|
|
|
604
728
|
|
|
605
729
|
|
|
730
|
+
# **post_apply_feature_flag_change_request**
|
|
731
|
+
> FeatureFlagChangeRequests post_apply_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_apply_config_body)
|
|
732
|
+
|
|
733
|
+
Apply change request for a feature flag
|
|
734
|
+
|
|
735
|
+
### Example
|
|
736
|
+
```ruby
|
|
737
|
+
# load the gem
|
|
738
|
+
require 'launchdarkly_api'
|
|
739
|
+
# setup authorization
|
|
740
|
+
LaunchDarklyApi.configure do |config|
|
|
741
|
+
# Configure API key authorization: Token
|
|
742
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
743
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
744
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
745
|
+
end
|
|
746
|
+
|
|
747
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
748
|
+
|
|
749
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
750
|
+
|
|
751
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
752
|
+
|
|
753
|
+
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
|
+
|
|
755
|
+
feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
|
|
756
|
+
|
|
757
|
+
feature_flag_change_request_apply_config_body = LaunchDarklyApi::FeatureFlagChangeRequestApplyConfigBody.new # FeatureFlagChangeRequestApplyConfigBody | Apply a new feature flag change request
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
begin
|
|
761
|
+
#Apply change request for a feature flag
|
|
762
|
+
result = api_instance.post_apply_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_apply_config_body)
|
|
763
|
+
p result
|
|
764
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
765
|
+
puts "Exception when calling FeatureFlagsApi->post_apply_feature_flag_change_request: #{e}"
|
|
766
|
+
end
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
### Parameters
|
|
770
|
+
|
|
771
|
+
Name | Type | Description | Notes
|
|
772
|
+
------------- | ------------- | ------------- | -------------
|
|
773
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
774
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
775
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
776
|
+
**feature_flag_change_request_id** | **String**| The feature flag change request ID |
|
|
777
|
+
**feature_flag_change_request_apply_config_body** | [**FeatureFlagChangeRequestApplyConfigBody**](FeatureFlagChangeRequestApplyConfigBody.md)| Apply a new feature flag change request |
|
|
778
|
+
|
|
779
|
+
### Return type
|
|
780
|
+
|
|
781
|
+
[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
|
|
782
|
+
|
|
783
|
+
### Authorization
|
|
784
|
+
|
|
785
|
+
[Token](../README.md#Token)
|
|
786
|
+
|
|
787
|
+
### HTTP request headers
|
|
788
|
+
|
|
789
|
+
- **Content-Type**: application/json
|
|
790
|
+
- **Accept**: application/json
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
606
794
|
# **post_feature_flag**
|
|
607
795
|
> FeatureFlag post_feature_flag(project_key, feature_flag_body, opts)
|
|
608
796
|
|
|
@@ -662,3 +850,128 @@ Name | Type | Description | Notes
|
|
|
662
850
|
|
|
663
851
|
|
|
664
852
|
|
|
853
|
+
# **post_feature_flag_change_request**
|
|
854
|
+
> FeatureFlagChangeRequest post_feature_flag_change_request(project_key, feature_flag_key, environment_key, , opts)
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
### Example
|
|
859
|
+
```ruby
|
|
860
|
+
# load the gem
|
|
861
|
+
require 'launchdarkly_api'
|
|
862
|
+
# setup authorization
|
|
863
|
+
LaunchDarklyApi.configure do |config|
|
|
864
|
+
# Configure API key authorization: Token
|
|
865
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
866
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
867
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
868
|
+
end
|
|
869
|
+
|
|
870
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
871
|
+
|
|
872
|
+
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
|
+
|
|
874
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
875
|
+
|
|
876
|
+
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
|
+
|
|
878
|
+
opts = {
|
|
879
|
+
feature_flag_change_request_config_body: LaunchDarklyApi::FeatureFlagChangeRequestConfigBody.new # FeatureFlagChangeRequestConfigBody | Create a new feature flag change request
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
begin
|
|
883
|
+
result = api_instance.post_feature_flag_change_request(project_key, feature_flag_key, environment_key, , opts)
|
|
884
|
+
p result
|
|
885
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
886
|
+
puts "Exception when calling FeatureFlagsApi->post_feature_flag_change_request: #{e}"
|
|
887
|
+
end
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Parameters
|
|
891
|
+
|
|
892
|
+
Name | Type | Description | Notes
|
|
893
|
+
------------- | ------------- | ------------- | -------------
|
|
894
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
895
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
896
|
+
**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
|
+
|
|
899
|
+
### Return type
|
|
900
|
+
|
|
901
|
+
[**FeatureFlagChangeRequest**](FeatureFlagChangeRequest.md)
|
|
902
|
+
|
|
903
|
+
### Authorization
|
|
904
|
+
|
|
905
|
+
[Token](../README.md#Token)
|
|
906
|
+
|
|
907
|
+
### HTTP request headers
|
|
908
|
+
|
|
909
|
+
- **Content-Type**: application/json
|
|
910
|
+
- **Accept**: application/json
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
# **post_review_feature_flag_change_request**
|
|
915
|
+
> FeatureFlagChangeRequests post_review_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_review_config_body)
|
|
916
|
+
|
|
917
|
+
Review change request for a feature flag
|
|
918
|
+
|
|
919
|
+
### Example
|
|
920
|
+
```ruby
|
|
921
|
+
# load the gem
|
|
922
|
+
require 'launchdarkly_api'
|
|
923
|
+
# setup authorization
|
|
924
|
+
LaunchDarklyApi.configure do |config|
|
|
925
|
+
# Configure API key authorization: Token
|
|
926
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
|
927
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
928
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
|
929
|
+
end
|
|
930
|
+
|
|
931
|
+
api_instance = LaunchDarklyApi::FeatureFlagsApi.new
|
|
932
|
+
|
|
933
|
+
project_key = 'project_key_example' # String | The project key, used to tie the flags together under one project so they can be managed together.
|
|
934
|
+
|
|
935
|
+
feature_flag_key = 'feature_flag_key_example' # String | The feature flag's key. The key identifies the flag in your code.
|
|
936
|
+
|
|
937
|
+
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
|
+
|
|
939
|
+
feature_flag_change_request_id = 'feature_flag_change_request_id_example' # String | The feature flag change request ID
|
|
940
|
+
|
|
941
|
+
feature_flag_change_request_review_config_body = LaunchDarklyApi::FeatureFlagChangeRequestReviewConfigBody.new # FeatureFlagChangeRequestReviewConfigBody | Review a feature flag change request
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
begin
|
|
945
|
+
#Review change request for a feature flag
|
|
946
|
+
result = api_instance.post_review_feature_flag_change_request(project_key, feature_flag_key, environment_key, feature_flag_change_request_id, feature_flag_change_request_review_config_body)
|
|
947
|
+
p result
|
|
948
|
+
rescue LaunchDarklyApi::ApiError => e
|
|
949
|
+
puts "Exception when calling FeatureFlagsApi->post_review_feature_flag_change_request: #{e}"
|
|
950
|
+
end
|
|
951
|
+
```
|
|
952
|
+
|
|
953
|
+
### Parameters
|
|
954
|
+
|
|
955
|
+
Name | Type | Description | Notes
|
|
956
|
+
------------- | ------------- | ------------- | -------------
|
|
957
|
+
**project_key** | **String**| The project key, used to tie the flags together under one project so they can be managed together. |
|
|
958
|
+
**feature_flag_key** | **String**| The feature flag's key. The key identifies the flag in your code. |
|
|
959
|
+
**environment_key** | **String**| The environment key, used to tie together flag configuration and users under one environment so they can be managed together. |
|
|
960
|
+
**feature_flag_change_request_id** | **String**| The feature flag change request ID |
|
|
961
|
+
**feature_flag_change_request_review_config_body** | [**FeatureFlagChangeRequestReviewConfigBody**](FeatureFlagChangeRequestReviewConfigBody.md)| Review a feature flag change request |
|
|
962
|
+
|
|
963
|
+
### Return type
|
|
964
|
+
|
|
965
|
+
[**FeatureFlagChangeRequests**](FeatureFlagChangeRequests.md)
|
|
966
|
+
|
|
967
|
+
### Authorization
|
|
968
|
+
|
|
969
|
+
[Token](../README.md#Token)
|
|
970
|
+
|
|
971
|
+
### HTTP request headers
|
|
972
|
+
|
|
973
|
+
- **Content-Type**: application/json
|
|
974
|
+
- **Accept**: application/json
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|