launchdarkly_api 3.3.2 → 3.7.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 +198 -168
- data/docs/AccessTokensApi.md +333 -0
- data/docs/ClientSideAvailability.md +9 -0
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlag.md +1 -0
- data/docs/FeatureFlagBody.md +1 -0
- data/docs/FeatureFlagScheduledChange.md +11 -0
- data/docs/FeatureFlagScheduledChanges.md +9 -0
- data/docs/FeatureFlagScheduledChangesConflicts.md +8 -0
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +9 -0
- data/docs/FeatureFlagsApi.md +2 -2
- data/docs/Project.md +1 -0
- data/docs/ProjectBody.md +1 -0
- data/docs/RelayProxyConfig.md +15 -0
- data/docs/RelayProxyConfigBody.md +9 -0
- data/docs/RelayProxyConfigs.md +8 -0
- data/docs/RelayProxyConfigurationsApi.md +326 -0
- data/docs/ScheduledChangesFeatureFlagConflict.md +9 -0
- data/docs/SemanticPatchInstruction.md +7 -0
- data/docs/{SemanticPatchOperationInstructions.md → SemanticPatchInstructionInner.md} +1 -1
- data/docs/SemanticPatchOperation.md +1 -1
- data/docs/Token.md +22 -0
- data/docs/TokenBody.md +13 -0
- data/docs/Tokens.md +9 -0
- data/docs/UnboundedSegmentTargetChanges.md +9 -0
- data/docs/UnboundedSegmentTargetsBody.md +9 -0
- data/docs/UserSegment.md +1 -0
- data/docs/UserSegmentBody.md +1 -0
- data/docs/UserSegmentsApi.md +61 -0
- data/launchdarkly_api.gemspec +1 -1
- data/lib/launchdarkly_api.rb +19 -2
- data/lib/launchdarkly_api/api/access_tokens_api.rb +340 -0
- 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 +3 -3
- data/lib/launchdarkly_api/api/projects_api.rb +1 -1
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +337 -0
- 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 +70 -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 +194 -0
- 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 +11 -2
- data/lib/launchdarkly_api/models/feature_flag_body.rb +11 -2
- 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 +211 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +194 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +185 -0
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +195 -0
- 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/id.rb +1 -1
- data/lib/launchdarkly_api/models/link.rb +1 -1
- data/lib/launchdarkly_api/models/links.rb +1 -1
- data/lib/launchdarkly_api/models/ma_uby_category.rb +1 -1
- data/lib/launchdarkly_api/models/mau.rb +1 -1
- data/lib/launchdarkly_api/models/mau_metadata.rb +1 -1
- data/lib/launchdarkly_api/models/member.rb +1 -1
- data/lib/launchdarkly_api/models/members.rb +1 -1
- data/lib/launchdarkly_api/models/members_body.rb +1 -1
- data/lib/launchdarkly_api/models/patch_comment.rb +1 -1
- data/lib/launchdarkly_api/models/patch_operation.rb +1 -1
- data/lib/launchdarkly_api/models/policy.rb +1 -1
- data/lib/launchdarkly_api/models/prerequisite.rb +1 -1
- data/lib/launchdarkly_api/models/project.rb +14 -5
- data/lib/launchdarkly_api/models/project_body.rb +14 -5
- data/lib/launchdarkly_api/models/projects.rb +1 -1
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +288 -0
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +195 -0
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +185 -0
- data/lib/launchdarkly_api/models/role.rb +1 -1
- data/lib/launchdarkly_api/models/rollout.rb +1 -1
- data/lib/launchdarkly_api/models/rule.rb +1 -1
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +194 -0
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +174 -0
- data/lib/launchdarkly_api/models/{semantic_patch_operation_instructions.rb → semantic_patch_instruction_inner.rb} +2 -2
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +3 -5
- 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/target.rb +1 -1
- data/lib/launchdarkly_api/models/token.rb +322 -0
- data/lib/launchdarkly_api/models/token_body.rb +237 -0
- data/lib/launchdarkly_api/models/tokens.rb +194 -0
- data/lib/launchdarkly_api/models/unbounded_segment_target_changes.rb +198 -0
- data/lib/launchdarkly_api/models/unbounded_segment_targets_body.rb +192 -0
- 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 +12 -2
- data/lib/launchdarkly_api/models/user_segment_body.rb +12 -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/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 +639 -12
- data/spec/api/access_tokens_api_spec.rb +103 -0
- 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 +2 -2
- data/spec/api/projects_api_spec.rb +1 -1
- data/spec/api/relay_proxy_configurations_api_spec.rb +102 -0
- 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 +15 -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 +47 -0
- 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 +7 -1
- data/spec/models/feature_flag_config_spec.rb +1 -1
- data/spec/models/feature_flag_copy_body_spec.rb +1 -1
- data/spec/models/feature_flag_copy_object_spec.rb +1 -1
- data/spec/models/feature_flag_scheduled_change_spec.rb +59 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +47 -0
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +41 -0
- data/spec/models/feature_flag_scheduled_changes_spec.rb +47 -0
- data/spec/models/feature_flag_spec.rb +7 -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/id_spec.rb +1 -1
- data/spec/models/link_spec.rb +1 -1
- data/spec/models/links_spec.rb +1 -1
- data/spec/models/ma_uby_category_spec.rb +1 -1
- data/spec/models/mau_metadata_spec.rb +1 -1
- data/spec/models/mau_spec.rb +1 -1
- data/spec/models/member_spec.rb +1 -1
- data/spec/models/members_body_spec.rb +1 -1
- data/spec/models/members_spec.rb +1 -1
- data/spec/models/patch_comment_spec.rb +1 -1
- data/spec/models/patch_operation_spec.rb +1 -1
- data/spec/models/policy_spec.rb +1 -1
- data/spec/models/prerequisite_spec.rb +1 -1
- data/spec/models/project_body_spec.rb +7 -1
- data/spec/models/project_spec.rb +7 -1
- data/spec/models/projects_spec.rb +1 -1
- data/spec/models/relay_proxy_config_body_spec.rb +47 -0
- data/spec/models/relay_proxy_config_spec.rb +83 -0
- data/spec/models/relay_proxy_configs_spec.rb +41 -0
- data/spec/models/role_spec.rb +1 -1
- data/spec/models/rollout_spec.rb +1 -1
- data/spec/models/rule_spec.rb +1 -1
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +47 -0
- data/spec/models/{semantic_patch_operation_instructions_spec.rb → semantic_patch_instruction_inner_spec.rb} +7 -7
- data/spec/models/semantic_patch_instruction_spec.rb +35 -0
- 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/target_spec.rb +1 -1
- data/spec/models/token_body_spec.rb +71 -0
- data/spec/models/token_spec.rb +125 -0
- data/spec/models/tokens_spec.rb +47 -0
- data/spec/models/unbounded_segment_target_changes_spec.rb +47 -0
- data/spec/models/unbounded_segment_targets_body_spec.rb +47 -0
- 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 +7 -1
- data/spec/models/user_segment_rule_spec.rb +1 -1
- data/spec/models/user_segment_spec.rb +7 -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 +160 -92
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
|
|
4
4
|
#Build custom integrations with the LaunchDarkly REST API
|
|
5
5
|
|
|
6
|
-
OpenAPI spec version: 3.
|
|
6
|
+
OpenAPI spec version: 3.7.1
|
|
7
7
|
Contact: support@launchdarkly.com
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
9
|
Swagger Codegen version: 2.4.8
|
|
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.8
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
module LaunchDarklyApi
|
|
14
|
-
VERSION = '3.
|
|
14
|
+
VERSION = '3.7.1'
|
|
15
15
|
end
|
data/openapi.yml
CHANGED
|
@@ -10,7 +10,7 @@ info:
|
|
|
10
10
|
license:
|
|
11
11
|
name: Apache 2.0
|
|
12
12
|
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
|
|
13
|
-
version: 3.
|
|
13
|
+
version: 3.7.1
|
|
14
14
|
host: app.launchdarkly.com
|
|
15
15
|
basePath: /api/v2
|
|
16
16
|
schemes:
|
|
@@ -179,6 +179,45 @@ paths:
|
|
|
179
179
|
$ref: '#/responses/Standard404'
|
|
180
180
|
tags:
|
|
181
181
|
- Environments
|
|
182
|
+
'/projects/{projectKey}/environments/{environmentKey}/apiKey':
|
|
183
|
+
post:
|
|
184
|
+
summary: >-
|
|
185
|
+
Reset an environment's SDK key with an optional expiry time for the old
|
|
186
|
+
key.
|
|
187
|
+
operationId: resetEnvironmentSDKKey
|
|
188
|
+
parameters:
|
|
189
|
+
- $ref: '#/parameters/ProjectKey'
|
|
190
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
191
|
+
- $ref: '#/parameters/EnvironmentSDKKeyExpiry'
|
|
192
|
+
responses:
|
|
193
|
+
'200':
|
|
194
|
+
$ref: '#/responses/Environment2xx'
|
|
195
|
+
'404':
|
|
196
|
+
$ref: '#/responses/Standard404'
|
|
197
|
+
'409':
|
|
198
|
+
$ref: '#/responses/Standard409'
|
|
199
|
+
tags:
|
|
200
|
+
- Environments
|
|
201
|
+
'/projects/{projectKey}/environments/{environmentKey}/mobileKey':
|
|
202
|
+
post:
|
|
203
|
+
summary: >-
|
|
204
|
+
Reset an environment's mobile key. The optional expiry for the old key
|
|
205
|
+
is deprecated for this endpoint, so the old key will always expire
|
|
206
|
+
immediately.
|
|
207
|
+
operationId: resetEnvironmentMobileKey
|
|
208
|
+
parameters:
|
|
209
|
+
- $ref: '#/parameters/ProjectKey'
|
|
210
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
211
|
+
- $ref: '#/parameters/EnvironmentMobileKeyExpiry'
|
|
212
|
+
responses:
|
|
213
|
+
'200':
|
|
214
|
+
$ref: '#/responses/Environment2xx'
|
|
215
|
+
'404':
|
|
216
|
+
$ref: '#/responses/Standard404'
|
|
217
|
+
'409':
|
|
218
|
+
$ref: '#/responses/Standard409'
|
|
219
|
+
tags:
|
|
220
|
+
- Environments
|
|
182
221
|
'/flags/{projectKey}':
|
|
183
222
|
get:
|
|
184
223
|
summary: Get a list of all features in the given project.
|
|
@@ -528,6 +567,24 @@ paths:
|
|
|
528
567
|
$ref: '#/responses/Standard409'
|
|
529
568
|
tags:
|
|
530
569
|
- User segments
|
|
570
|
+
'/segments/{projectKey}/{environmentKey}/{userSegmentKey}/unbounded-users':
|
|
571
|
+
post:
|
|
572
|
+
summary: Update targets included or excluded in an unbounded segment
|
|
573
|
+
operationId: updatedUnboundedSegmentTargets
|
|
574
|
+
parameters:
|
|
575
|
+
- $ref: '#/parameters/ProjectKey'
|
|
576
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
577
|
+
- $ref: '#/parameters/UserSegmentKey'
|
|
578
|
+
- $ref: '#/parameters/UnboundedSegmentTargetsPostRequest'
|
|
579
|
+
responses:
|
|
580
|
+
'204':
|
|
581
|
+
$ref: '#/responses/Standard204'
|
|
582
|
+
'400':
|
|
583
|
+
$ref: '#/responses/Standard400'
|
|
584
|
+
'401':
|
|
585
|
+
$ref: '#/responses/Standard401'
|
|
586
|
+
tags:
|
|
587
|
+
- User segments
|
|
531
588
|
'/users/{projectKey}/{environmentKey}':
|
|
532
589
|
get:
|
|
533
590
|
summary: >-
|
|
@@ -1242,6 +1299,194 @@ paths:
|
|
|
1242
1299
|
$ref: '#/responses/EvaluationUsage404'
|
|
1243
1300
|
tags:
|
|
1244
1301
|
- Customer Metrics
|
|
1302
|
+
/tokens:
|
|
1303
|
+
get:
|
|
1304
|
+
summary: Returns a list of tokens in the account.
|
|
1305
|
+
operationId: getTokens
|
|
1306
|
+
parameters:
|
|
1307
|
+
- $ref: '#/parameters/TokenShowAllQuery'
|
|
1308
|
+
responses:
|
|
1309
|
+
'200':
|
|
1310
|
+
description: Tokens response.
|
|
1311
|
+
schema:
|
|
1312
|
+
$ref: '#/definitions/Tokens'
|
|
1313
|
+
'401':
|
|
1314
|
+
$ref: '#/responses/Standard401'
|
|
1315
|
+
tags:
|
|
1316
|
+
- Access tokens
|
|
1317
|
+
post:
|
|
1318
|
+
summary: Create a new token.
|
|
1319
|
+
operationId: postToken
|
|
1320
|
+
parameters:
|
|
1321
|
+
- $ref: '#/parameters/TokensPostRequest'
|
|
1322
|
+
responses:
|
|
1323
|
+
'201':
|
|
1324
|
+
description: Token response.
|
|
1325
|
+
schema:
|
|
1326
|
+
$ref: '#/definitions/Token'
|
|
1327
|
+
'400':
|
|
1328
|
+
$ref: '#/responses/Standard400'
|
|
1329
|
+
'401':
|
|
1330
|
+
$ref: '#/responses/Standard401'
|
|
1331
|
+
'409':
|
|
1332
|
+
$ref: '#/responses/Standard409'
|
|
1333
|
+
tags:
|
|
1334
|
+
- Access tokens
|
|
1335
|
+
'/tokens/{tokenId}':
|
|
1336
|
+
get:
|
|
1337
|
+
summary: Get a single access token by ID.
|
|
1338
|
+
operationId: getToken
|
|
1339
|
+
parameters:
|
|
1340
|
+
- $ref: '#/parameters/TokenId'
|
|
1341
|
+
responses:
|
|
1342
|
+
'200':
|
|
1343
|
+
$ref: '#/responses/Token2xx'
|
|
1344
|
+
'400':
|
|
1345
|
+
$ref: '#/responses/Standard400'
|
|
1346
|
+
'401':
|
|
1347
|
+
$ref: '#/responses/Standard401'
|
|
1348
|
+
tags:
|
|
1349
|
+
- Access tokens
|
|
1350
|
+
patch:
|
|
1351
|
+
summary: Modify an access token by ID.
|
|
1352
|
+
operationId: patchToken
|
|
1353
|
+
parameters:
|
|
1354
|
+
- $ref: '#/parameters/TokenId'
|
|
1355
|
+
- $ref: '#/parameters/PatchRequest'
|
|
1356
|
+
responses:
|
|
1357
|
+
'200':
|
|
1358
|
+
$ref: '#/responses/Token2xx'
|
|
1359
|
+
'400':
|
|
1360
|
+
$ref: '#/responses/Standard400'
|
|
1361
|
+
'401':
|
|
1362
|
+
$ref: '#/responses/Standard401'
|
|
1363
|
+
'404':
|
|
1364
|
+
$ref: '#/responses/Standard404'
|
|
1365
|
+
'409':
|
|
1366
|
+
$ref: '#/responses/Standard409'
|
|
1367
|
+
tags:
|
|
1368
|
+
- Access tokens
|
|
1369
|
+
delete:
|
|
1370
|
+
summary: Delete an access token by ID.
|
|
1371
|
+
operationId: deleteToken
|
|
1372
|
+
parameters:
|
|
1373
|
+
- $ref: '#/parameters/TokenId'
|
|
1374
|
+
responses:
|
|
1375
|
+
'204':
|
|
1376
|
+
$ref: '#/responses/Standard204'
|
|
1377
|
+
'401':
|
|
1378
|
+
$ref: '#/responses/Standard401'
|
|
1379
|
+
'404':
|
|
1380
|
+
$ref: '#/responses/Standard404'
|
|
1381
|
+
tags:
|
|
1382
|
+
- Access tokens
|
|
1383
|
+
'/tokens/{tokenId}/reset':
|
|
1384
|
+
post:
|
|
1385
|
+
summary: >-
|
|
1386
|
+
Reset an access token's secret key with an optional expiry time for the
|
|
1387
|
+
old key.
|
|
1388
|
+
operationId: resetToken
|
|
1389
|
+
parameters:
|
|
1390
|
+
- $ref: '#/parameters/TokenId'
|
|
1391
|
+
- $ref: '#/parameters/TokenExpiry'
|
|
1392
|
+
responses:
|
|
1393
|
+
'200':
|
|
1394
|
+
$ref: '#/responses/Token2xx'
|
|
1395
|
+
'400':
|
|
1396
|
+
$ref: '#/responses/Standard400'
|
|
1397
|
+
'401':
|
|
1398
|
+
$ref: '#/responses/Standard401'
|
|
1399
|
+
tags:
|
|
1400
|
+
- Access tokens
|
|
1401
|
+
/account/relay-auto-configs:
|
|
1402
|
+
get:
|
|
1403
|
+
summary: Returns a list of relay proxy configurations in the account.
|
|
1404
|
+
operationId: getRelayProxyConfigs
|
|
1405
|
+
responses:
|
|
1406
|
+
'200':
|
|
1407
|
+
description: Relay proxy configs response.
|
|
1408
|
+
schema:
|
|
1409
|
+
$ref: '#/definitions/RelayProxyConfigs'
|
|
1410
|
+
tags:
|
|
1411
|
+
- Relay proxy configurations
|
|
1412
|
+
post:
|
|
1413
|
+
summary: Create a new relay proxy config.
|
|
1414
|
+
operationId: postRelayAutoConfig
|
|
1415
|
+
parameters:
|
|
1416
|
+
- $ref: '#/parameters/RelayProxyConfigPostRequest'
|
|
1417
|
+
responses:
|
|
1418
|
+
'201':
|
|
1419
|
+
description: Relay proxy config response.
|
|
1420
|
+
schema:
|
|
1421
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
1422
|
+
'400':
|
|
1423
|
+
$ref: '#/responses/Standard400'
|
|
1424
|
+
'403':
|
|
1425
|
+
$ref: '#/responses/Standard403'
|
|
1426
|
+
tags:
|
|
1427
|
+
- Relay proxy configurations
|
|
1428
|
+
'/account/relay-auto-configs/{id}':
|
|
1429
|
+
get:
|
|
1430
|
+
summary: Get a single relay proxy configuration by ID.
|
|
1431
|
+
operationId: getRelayProxyConfig
|
|
1432
|
+
parameters:
|
|
1433
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1434
|
+
responses:
|
|
1435
|
+
'200':
|
|
1436
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1437
|
+
'404':
|
|
1438
|
+
$ref: '#/responses/Standard404'
|
|
1439
|
+
tags:
|
|
1440
|
+
- Relay proxy configurations
|
|
1441
|
+
patch:
|
|
1442
|
+
summary: Modify a relay proxy configuration by ID.
|
|
1443
|
+
operationId: patchRelayProxyConfig
|
|
1444
|
+
parameters:
|
|
1445
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1446
|
+
- $ref: '#/parameters/PatchRequest'
|
|
1447
|
+
responses:
|
|
1448
|
+
'200':
|
|
1449
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1450
|
+
'400':
|
|
1451
|
+
$ref: '#/responses/Standard400'
|
|
1452
|
+
'404':
|
|
1453
|
+
$ref: '#/responses/Standard404'
|
|
1454
|
+
'409':
|
|
1455
|
+
$ref: '#/responses/Standard409'
|
|
1456
|
+
tags:
|
|
1457
|
+
- Relay proxy configurations
|
|
1458
|
+
delete:
|
|
1459
|
+
summary: Delete a relay proxy configuration by ID.
|
|
1460
|
+
operationId: deleteRelayProxyConfig
|
|
1461
|
+
parameters:
|
|
1462
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1463
|
+
responses:
|
|
1464
|
+
'204':
|
|
1465
|
+
$ref: '#/responses/Standard204'
|
|
1466
|
+
'400':
|
|
1467
|
+
$ref: '#/responses/Standard400'
|
|
1468
|
+
'404':
|
|
1469
|
+
$ref: '#/responses/Standard404'
|
|
1470
|
+
tags:
|
|
1471
|
+
- Relay proxy configurations
|
|
1472
|
+
'/account/relay-auto-configs/{id}/reset':
|
|
1473
|
+
post:
|
|
1474
|
+
summary: >-
|
|
1475
|
+
Reset a relay proxy configuration's secret key with an optional expiry
|
|
1476
|
+
time for the old key.
|
|
1477
|
+
operationId: resetRelayProxyConfig
|
|
1478
|
+
parameters:
|
|
1479
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1480
|
+
- $ref: '#/parameters/RelayProxyConfigsExpiry'
|
|
1481
|
+
responses:
|
|
1482
|
+
'200':
|
|
1483
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1484
|
+
'400':
|
|
1485
|
+
$ref: '#/responses/Standard400'
|
|
1486
|
+
'404':
|
|
1487
|
+
$ref: '#/responses/Standard404'
|
|
1488
|
+
tags:
|
|
1489
|
+
- Relay proxy configurations
|
|
1245
1490
|
/:
|
|
1246
1491
|
get:
|
|
1247
1492
|
description: >-
|
|
@@ -1420,6 +1665,8 @@ definitions:
|
|
|
1420
1665
|
type: boolean
|
|
1421
1666
|
description: Whether or not this flag is archived.
|
|
1422
1667
|
example: false
|
|
1668
|
+
clientSideAvailability:
|
|
1669
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
1423
1670
|
defaults:
|
|
1424
1671
|
$ref: '#/definitions/Defaults'
|
|
1425
1672
|
FeatureFlags:
|
|
@@ -1622,6 +1869,68 @@ definitions:
|
|
|
1622
1869
|
type: string
|
|
1623
1870
|
variation:
|
|
1624
1871
|
type: integer
|
|
1872
|
+
FeatureFlagScheduledChanges:
|
|
1873
|
+
type: object
|
|
1874
|
+
properties:
|
|
1875
|
+
_links:
|
|
1876
|
+
$ref: '#/definitions/Links'
|
|
1877
|
+
items:
|
|
1878
|
+
type: array
|
|
1879
|
+
items:
|
|
1880
|
+
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
1881
|
+
FeatureFlagScheduledChange:
|
|
1882
|
+
type: object
|
|
1883
|
+
properties:
|
|
1884
|
+
executionDate:
|
|
1885
|
+
type: integer
|
|
1886
|
+
description: >-
|
|
1887
|
+
A unix epoch time in milliseconds specifying the date the scheduled
|
|
1888
|
+
changes will be applied
|
|
1889
|
+
_version:
|
|
1890
|
+
type: integer
|
|
1891
|
+
_id:
|
|
1892
|
+
type: string
|
|
1893
|
+
instructions:
|
|
1894
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
1895
|
+
FeatureFlagScheduledChangesConflicts:
|
|
1896
|
+
type: object
|
|
1897
|
+
properties:
|
|
1898
|
+
instructions:
|
|
1899
|
+
type: array
|
|
1900
|
+
items:
|
|
1901
|
+
properties:
|
|
1902
|
+
kind:
|
|
1903
|
+
type: string
|
|
1904
|
+
example: removeUserTargets
|
|
1905
|
+
description: >-
|
|
1906
|
+
The name of the modification you would like to perform on a
|
|
1907
|
+
resource.
|
|
1908
|
+
conflicts:
|
|
1909
|
+
type: array
|
|
1910
|
+
items:
|
|
1911
|
+
$ref: '#/definitions/ScheduledChangesFeatureFlagConflict'
|
|
1912
|
+
ScheduledChangesFeatureFlagConflict:
|
|
1913
|
+
type: object
|
|
1914
|
+
properties:
|
|
1915
|
+
_id:
|
|
1916
|
+
type: string
|
|
1917
|
+
description: Feature flag scheduled change id this change will conflict with
|
|
1918
|
+
reason:
|
|
1919
|
+
type: string
|
|
1920
|
+
description: Feature flag scheduled change conflict reason
|
|
1921
|
+
ClientSideAvailability:
|
|
1922
|
+
type: object
|
|
1923
|
+
properties:
|
|
1924
|
+
usingEnvironmentId:
|
|
1925
|
+
type: boolean
|
|
1926
|
+
description: >-
|
|
1927
|
+
When set to true, this flag will be available to SDKs using the
|
|
1928
|
+
client-side id.
|
|
1929
|
+
usingMobileKey:
|
|
1930
|
+
type: boolean
|
|
1931
|
+
description: >-
|
|
1932
|
+
When set to true, this flag will be available to SDKS using a mobile
|
|
1933
|
+
key.
|
|
1625
1934
|
FeatureFlagStatus:
|
|
1626
1935
|
type: object
|
|
1627
1936
|
properties:
|
|
@@ -1838,6 +2147,13 @@ definitions:
|
|
|
1838
2147
|
description: >-
|
|
1839
2148
|
An array of rules that can cause a user to be included in this
|
|
1840
2149
|
segment.
|
|
2150
|
+
unbounded:
|
|
2151
|
+
type: boolean
|
|
2152
|
+
example: false
|
|
2153
|
+
description: >-
|
|
2154
|
+
Controls whether this segment can support unlimited numbers of users.
|
|
2155
|
+
Requires the beta API and additional setup. Include/exclude lists in
|
|
2156
|
+
this payload are not used in unbounded segments.
|
|
1841
2157
|
version:
|
|
1842
2158
|
type: integer
|
|
1843
2159
|
_links:
|
|
@@ -1867,6 +2183,22 @@ definitions:
|
|
|
1867
2183
|
type: array
|
|
1868
2184
|
items:
|
|
1869
2185
|
$ref: '#/definitions/UserSegment'
|
|
2186
|
+
UnboundedSegmentTargetChanges:
|
|
2187
|
+
type: object
|
|
2188
|
+
properties:
|
|
2189
|
+
add:
|
|
2190
|
+
type: array
|
|
2191
|
+
example:
|
|
2192
|
+
- user@launchdarkly.com
|
|
2193
|
+
items:
|
|
2194
|
+
type: string
|
|
2195
|
+
description: Users to add to this list of targets
|
|
2196
|
+
remove:
|
|
2197
|
+
type: array
|
|
2198
|
+
example: []
|
|
2199
|
+
items:
|
|
2200
|
+
type: string
|
|
2201
|
+
description: Users to remove from this list of targets
|
|
1870
2202
|
Project:
|
|
1871
2203
|
type: object
|
|
1872
2204
|
properties:
|
|
@@ -1892,6 +2224,8 @@ definitions:
|
|
|
1892
2224
|
items:
|
|
1893
2225
|
type: string
|
|
1894
2226
|
description: An array of tags for this project.
|
|
2227
|
+
defaultClientSideAvailability:
|
|
2228
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
1895
2229
|
Projects:
|
|
1896
2230
|
type: object
|
|
1897
2231
|
properties:
|
|
@@ -2385,9 +2719,10 @@ definitions:
|
|
|
2385
2719
|
example: replace
|
|
2386
2720
|
path:
|
|
2387
2721
|
type: string
|
|
2388
|
-
example: /
|
|
2722
|
+
example: /name
|
|
2389
2723
|
value:
|
|
2390
2724
|
type: object
|
|
2725
|
+
example: My resource name
|
|
2391
2726
|
required:
|
|
2392
2727
|
- op
|
|
2393
2728
|
- path
|
|
@@ -2399,17 +2734,19 @@ definitions:
|
|
|
2399
2734
|
type: string
|
|
2400
2735
|
example: This is a comment string
|
|
2401
2736
|
instructions:
|
|
2402
|
-
|
|
2403
|
-
items:
|
|
2404
|
-
properties:
|
|
2405
|
-
kind:
|
|
2406
|
-
type: string
|
|
2407
|
-
example: removeUserTargets
|
|
2408
|
-
description: >-
|
|
2409
|
-
The name of the modification you would like to perform on a
|
|
2410
|
-
resource.
|
|
2737
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2411
2738
|
required:
|
|
2412
2739
|
- instructions
|
|
2740
|
+
SemanticPatchInstruction:
|
|
2741
|
+
type: array
|
|
2742
|
+
items:
|
|
2743
|
+
properties:
|
|
2744
|
+
kind:
|
|
2745
|
+
type: string
|
|
2746
|
+
example: removeUserTargets
|
|
2747
|
+
description: >-
|
|
2748
|
+
The name of the modification you would like to perform on a
|
|
2749
|
+
resource.
|
|
2413
2750
|
CustomProperty:
|
|
2414
2751
|
type: object
|
|
2415
2752
|
description: A name and value describing a custom property.
|
|
@@ -2675,6 +3012,136 @@ definitions:
|
|
|
2675
3012
|
$ref: '#/definitions/Links'
|
|
2676
3013
|
_site:
|
|
2677
3014
|
$ref: '#/definitions/Site'
|
|
3015
|
+
Tokens:
|
|
3016
|
+
type: object
|
|
3017
|
+
properties:
|
|
3018
|
+
_links:
|
|
3019
|
+
$ref: '#/definitions/Links'
|
|
3020
|
+
items:
|
|
3021
|
+
type: array
|
|
3022
|
+
items:
|
|
3023
|
+
$ref: '#/definitions/Token'
|
|
3024
|
+
Token:
|
|
3025
|
+
type: object
|
|
3026
|
+
properties:
|
|
3027
|
+
_links:
|
|
3028
|
+
$ref: '#/definitions/Links'
|
|
3029
|
+
_id:
|
|
3030
|
+
$ref: '#/definitions/Id'
|
|
3031
|
+
ownerId:
|
|
3032
|
+
$ref: '#/definitions/Id'
|
|
3033
|
+
memberId:
|
|
3034
|
+
$ref: '#/definitions/Id'
|
|
3035
|
+
_member:
|
|
3036
|
+
$ref: '#/definitions/Member'
|
|
3037
|
+
creationDate:
|
|
3038
|
+
type: integer
|
|
3039
|
+
format: int64
|
|
3040
|
+
description: >-
|
|
3041
|
+
A unix epoch time in milliseconds specifying the creation time of this
|
|
3042
|
+
access token.
|
|
3043
|
+
example: 1443652232590
|
|
3044
|
+
lastModified:
|
|
3045
|
+
type: integer
|
|
3046
|
+
format: int64
|
|
3047
|
+
example: 1469326565348
|
|
3048
|
+
description: >-
|
|
3049
|
+
A unix epoch time in milliseconds specifying the last time this access
|
|
3050
|
+
token was modified.
|
|
3051
|
+
lastUsed:
|
|
3052
|
+
type: integer
|
|
3053
|
+
format: int64
|
|
3054
|
+
example: 1469326565348
|
|
3055
|
+
description: >-
|
|
3056
|
+
A unix epoch time in milliseconds specifying the last time this access
|
|
3057
|
+
token was used to authorize access to the LaunchDarkly REST API.
|
|
3058
|
+
token:
|
|
3059
|
+
type: string
|
|
3060
|
+
example: '3243'
|
|
3061
|
+
description: >-
|
|
3062
|
+
The last 4 digits of the unique secret key for this access token. If
|
|
3063
|
+
creating or resetting the token, this will be the full token secret.
|
|
3064
|
+
name:
|
|
3065
|
+
type: string
|
|
3066
|
+
description: A human-friendly name for the access token
|
|
3067
|
+
example: My access token
|
|
3068
|
+
role:
|
|
3069
|
+
type: string
|
|
3070
|
+
description: The name of a built-in role for the token
|
|
3071
|
+
example: writer
|
|
3072
|
+
customRoleIds:
|
|
3073
|
+
type: array
|
|
3074
|
+
items:
|
|
3075
|
+
type: string
|
|
3076
|
+
description: A list of custom role IDs to use as access limits for the access token
|
|
3077
|
+
inlineRole:
|
|
3078
|
+
type: array
|
|
3079
|
+
items:
|
|
3080
|
+
$ref: '#/definitions/Statement'
|
|
3081
|
+
serviceToken:
|
|
3082
|
+
type: boolean
|
|
3083
|
+
description: >-
|
|
3084
|
+
Whether the token will be a service token
|
|
3085
|
+
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
3086
|
+
defaultApiVersion:
|
|
3087
|
+
type: integer
|
|
3088
|
+
description: The default API version for this token
|
|
3089
|
+
RelayProxyConfigs:
|
|
3090
|
+
type: object
|
|
3091
|
+
properties:
|
|
3092
|
+
items:
|
|
3093
|
+
type: array
|
|
3094
|
+
items:
|
|
3095
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
3096
|
+
RelayProxyConfig:
|
|
3097
|
+
type: object
|
|
3098
|
+
properties:
|
|
3099
|
+
_id:
|
|
3100
|
+
$ref: '#/definitions/Id'
|
|
3101
|
+
_creator:
|
|
3102
|
+
$ref: '#/definitions/Member'
|
|
3103
|
+
name:
|
|
3104
|
+
type: string
|
|
3105
|
+
description: A human-friendly name for the relay proxy configuration
|
|
3106
|
+
example: My relay proxy config
|
|
3107
|
+
policy:
|
|
3108
|
+
type: array
|
|
3109
|
+
items:
|
|
3110
|
+
$ref: '#/definitions/Policy'
|
|
3111
|
+
fullKey:
|
|
3112
|
+
type: string
|
|
3113
|
+
example: rel-8a3a773d-b75e-48eb-a850-492cda9266eo
|
|
3114
|
+
description: >-
|
|
3115
|
+
Full secret key. Only included if creating or resetting the relay
|
|
3116
|
+
proxy configuration
|
|
3117
|
+
displayKey:
|
|
3118
|
+
type: string
|
|
3119
|
+
example: 66eo
|
|
3120
|
+
description: >-
|
|
3121
|
+
The last 4 digits of the unique secret key for this relay proxy
|
|
3122
|
+
configuration
|
|
3123
|
+
creationDate:
|
|
3124
|
+
type: integer
|
|
3125
|
+
format: int64
|
|
3126
|
+
description: >-
|
|
3127
|
+
A unix epoch time in milliseconds specifying the creation time of this
|
|
3128
|
+
relay proxy configuration
|
|
3129
|
+
example: 1443652232590
|
|
3130
|
+
lastModified:
|
|
3131
|
+
type: integer
|
|
3132
|
+
format: int64
|
|
3133
|
+
example: 1469326565348
|
|
3134
|
+
description: >-
|
|
3135
|
+
A unix epoch time in milliseconds specifying the last time this relay
|
|
3136
|
+
proxy configuration was modified
|
|
3137
|
+
required:
|
|
3138
|
+
- _id
|
|
3139
|
+
- _creator
|
|
3140
|
+
- name
|
|
3141
|
+
- policy
|
|
3142
|
+
- displayKey
|
|
3143
|
+
- creationDate
|
|
3144
|
+
- lastModified
|
|
2678
3145
|
responses:
|
|
2679
3146
|
Standard201:
|
|
2680
3147
|
description: Resource created.
|
|
@@ -2684,6 +3151,8 @@ responses:
|
|
|
2684
3151
|
description: Invalid request body.
|
|
2685
3152
|
Standard401:
|
|
2686
3153
|
description: Invalid access token.
|
|
3154
|
+
Standard403:
|
|
3155
|
+
description: Access to the requested resource was denied.
|
|
2687
3156
|
Standard404:
|
|
2688
3157
|
description: Invalid resource specifier.
|
|
2689
3158
|
Standard409:
|
|
@@ -2734,6 +3203,14 @@ responses:
|
|
|
2734
3203
|
description: Destination response.
|
|
2735
3204
|
schema:
|
|
2736
3205
|
$ref: '#/definitions/Destination'
|
|
3206
|
+
Token2xx:
|
|
3207
|
+
description: Token response.
|
|
3208
|
+
schema:
|
|
3209
|
+
$ref: '#/definitions/Token'
|
|
3210
|
+
RelayProxyConfig2xx:
|
|
3211
|
+
description: Relay proxy config response.
|
|
3212
|
+
schema:
|
|
3213
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
2737
3214
|
parameters:
|
|
2738
3215
|
ResourceId:
|
|
2739
3216
|
name: resourceId
|
|
@@ -2853,12 +3330,29 @@ parameters:
|
|
|
2853
3330
|
description: >-
|
|
2854
3331
|
Whether or not this flag should be made available to the client-side
|
|
2855
3332
|
JavaScript SDK.
|
|
3333
|
+
clientSideAvailability:
|
|
3334
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
2856
3335
|
defaults:
|
|
2857
3336
|
$ref: '#/definitions/Defaults'
|
|
2858
3337
|
required:
|
|
2859
3338
|
- name
|
|
2860
3339
|
- key
|
|
2861
3340
|
- variations
|
|
3341
|
+
ScheduledFeatureFlagChangesPostRequest:
|
|
3342
|
+
name: scheduledFeatureFlagChangesBody
|
|
3343
|
+
in: body
|
|
3344
|
+
required: true
|
|
3345
|
+
description: Create scheduled changes on a feature flag.
|
|
3346
|
+
schema:
|
|
3347
|
+
type: object
|
|
3348
|
+
properties:
|
|
3349
|
+
executionDate:
|
|
3350
|
+
type: integer
|
|
3351
|
+
description: >-
|
|
3352
|
+
A unix epoch time in milliseconds specifying the date the scheduled
|
|
3353
|
+
changes will be applied
|
|
3354
|
+
instructions:
|
|
3355
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2862
3356
|
DestinationPostRequest:
|
|
2863
3357
|
name: destinationBody
|
|
2864
3358
|
in: body
|
|
@@ -2918,6 +3412,13 @@ parameters:
|
|
|
2918
3412
|
type: string
|
|
2919
3413
|
description: A description for the user segment.
|
|
2920
3414
|
example: Users in this segment will have access to beta features.
|
|
3415
|
+
unbounded:
|
|
3416
|
+
type: boolean
|
|
3417
|
+
example: false
|
|
3418
|
+
description: >-
|
|
3419
|
+
Controls whether this segment can support unlimited numbers of
|
|
3420
|
+
users. Requires the beta API and additional setup. Include/exclude
|
|
3421
|
+
lists in this payload are not used in unbounded segments.
|
|
2921
3422
|
tags:
|
|
2922
3423
|
type: array
|
|
2923
3424
|
items:
|
|
@@ -2927,6 +3428,20 @@ parameters:
|
|
|
2927
3428
|
required:
|
|
2928
3429
|
- name
|
|
2929
3430
|
- key
|
|
3431
|
+
UnboundedSegmentTargetsPostRequest:
|
|
3432
|
+
name: unboundedSegmentTargetsBody
|
|
3433
|
+
in: body
|
|
3434
|
+
required: true
|
|
3435
|
+
description: >-
|
|
3436
|
+
Add or remove user targets to the included or excluded lists on an
|
|
3437
|
+
unbounded segment
|
|
3438
|
+
schema:
|
|
3439
|
+
type: object
|
|
3440
|
+
properties:
|
|
3441
|
+
included:
|
|
3442
|
+
$ref: '#/definitions/UnboundedSegmentTargetChanges'
|
|
3443
|
+
excluded:
|
|
3444
|
+
$ref: '#/definitions/UnboundedSegmentTargetChanges'
|
|
2930
3445
|
ProjectPostRequest:
|
|
2931
3446
|
name: projectBody
|
|
2932
3447
|
in: body
|
|
@@ -2956,6 +3471,8 @@ parameters:
|
|
|
2956
3471
|
items:
|
|
2957
3472
|
$ref: '#/definitions/EnvironmentPost'
|
|
2958
3473
|
minLength: 1
|
|
3474
|
+
defaultClientSideAvailability:
|
|
3475
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
2959
3476
|
required:
|
|
2960
3477
|
- name
|
|
2961
3478
|
- key
|
|
@@ -2995,6 +3512,25 @@ parameters:
|
|
|
2995
3512
|
items:
|
|
2996
3513
|
type: string
|
|
2997
3514
|
collectionFormat: multi
|
|
3515
|
+
EnvironmentSDKKeyExpiry:
|
|
3516
|
+
name: expiry
|
|
3517
|
+
in: query
|
|
3518
|
+
required: false
|
|
3519
|
+
type: integer
|
|
3520
|
+
format: int64
|
|
3521
|
+
description: >-
|
|
3522
|
+
An expiration time for the old environment SDK key, expressed as a Unix
|
|
3523
|
+
epoch time in milliseconds. By default, the key will expire immediately.
|
|
3524
|
+
EnvironmentMobileKeyExpiry:
|
|
3525
|
+
name: expiry
|
|
3526
|
+
in: query
|
|
3527
|
+
required: false
|
|
3528
|
+
type: integer
|
|
3529
|
+
format: int64
|
|
3530
|
+
description: >-
|
|
3531
|
+
The expiry parameter is deprecated for this endpoint, so the old mobile
|
|
3532
|
+
key will always expire immediately. This parameter will be removed in an
|
|
3533
|
+
upcoming major API client version.
|
|
2998
3534
|
SummaryQuery:
|
|
2999
3535
|
name: summary
|
|
3000
3536
|
in: query
|
|
@@ -3009,7 +3545,7 @@ parameters:
|
|
|
3009
3545
|
in: query
|
|
3010
3546
|
required: false
|
|
3011
3547
|
description: >-
|
|
3012
|
-
When set to 1, archived flags will be included in the list of flags
|
|
3548
|
+
When set to 1, only archived flags will be included in the list of flags
|
|
3013
3549
|
returned. By default, archived flags are not included in the list of
|
|
3014
3550
|
flags.
|
|
3015
3551
|
type: boolean
|
|
@@ -3321,4 +3857,95 @@ parameters:
|
|
|
3321
3857
|
required: true
|
|
3322
3858
|
description: The key of the flag we want metrics for.
|
|
3323
3859
|
type: string
|
|
3860
|
+
TokensPostRequest:
|
|
3861
|
+
name: tokenBody
|
|
3862
|
+
in: body
|
|
3863
|
+
required: true
|
|
3864
|
+
description: Create a new access token.
|
|
3865
|
+
schema:
|
|
3866
|
+
type: object
|
|
3867
|
+
properties:
|
|
3868
|
+
name:
|
|
3869
|
+
type: string
|
|
3870
|
+
description: A human-friendly name for the access token
|
|
3871
|
+
example: My access token
|
|
3872
|
+
role:
|
|
3873
|
+
type: string
|
|
3874
|
+
description: The name of a built-in role for the token
|
|
3875
|
+
example: writer
|
|
3876
|
+
customRoleIds:
|
|
3877
|
+
type: array
|
|
3878
|
+
items:
|
|
3879
|
+
type: string
|
|
3880
|
+
example: []
|
|
3881
|
+
description: >-
|
|
3882
|
+
A list of custom role IDs to use as access limits for the access
|
|
3883
|
+
token
|
|
3884
|
+
inlineRole:
|
|
3885
|
+
type: array
|
|
3886
|
+
items:
|
|
3887
|
+
$ref: '#/definitions/Statement'
|
|
3888
|
+
serviceToken:
|
|
3889
|
+
type: boolean
|
|
3890
|
+
description: >-
|
|
3891
|
+
Whether the token will be a service token
|
|
3892
|
+
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
3893
|
+
defaultApiVersion:
|
|
3894
|
+
type: integer
|
|
3895
|
+
description: The default API version for this token
|
|
3896
|
+
TokenId:
|
|
3897
|
+
name: tokenId
|
|
3898
|
+
in: path
|
|
3899
|
+
required: true
|
|
3900
|
+
description: The access token ID.
|
|
3901
|
+
type: string
|
|
3902
|
+
TokenShowAllQuery:
|
|
3903
|
+
name: showAll
|
|
3904
|
+
in: query
|
|
3905
|
+
required: false
|
|
3906
|
+
description: >-
|
|
3907
|
+
If set to true, and the authentication access token has the "Admin" role,
|
|
3908
|
+
personal access tokens for all members will be retrieved.
|
|
3909
|
+
type: boolean
|
|
3910
|
+
TokenExpiry:
|
|
3911
|
+
name: expiry
|
|
3912
|
+
in: query
|
|
3913
|
+
required: false
|
|
3914
|
+
type: integer
|
|
3915
|
+
format: int64
|
|
3916
|
+
description: >-
|
|
3917
|
+
An expiration time for the old token key, expressed as a Unix epoch time
|
|
3918
|
+
in milliseconds. By default, the token will expire immediately.
|
|
3919
|
+
RelayProxyConfigPostRequest:
|
|
3920
|
+
name: relayProxyConfigBody
|
|
3921
|
+
in: body
|
|
3922
|
+
required: true
|
|
3923
|
+
description: Create a new relay proxy configuration
|
|
3924
|
+
schema:
|
|
3925
|
+
type: object
|
|
3926
|
+
properties:
|
|
3927
|
+
name:
|
|
3928
|
+
type: string
|
|
3929
|
+
description: A human-friendly name for the relay proxy configuration
|
|
3930
|
+
example: My relay proxy config
|
|
3931
|
+
policy:
|
|
3932
|
+
type: array
|
|
3933
|
+
items:
|
|
3934
|
+
$ref: '#/definitions/Policy'
|
|
3935
|
+
RelayProxyConfigId:
|
|
3936
|
+
name: id
|
|
3937
|
+
in: path
|
|
3938
|
+
required: true
|
|
3939
|
+
description: The relay proxy configuration ID
|
|
3940
|
+
type: string
|
|
3941
|
+
RelayProxyConfigsExpiry:
|
|
3942
|
+
name: expiry
|
|
3943
|
+
in: query
|
|
3944
|
+
required: false
|
|
3945
|
+
type: integer
|
|
3946
|
+
format: int64
|
|
3947
|
+
description: >-
|
|
3948
|
+
An expiration time for the old relay proxy configuration key, expressed as
|
|
3949
|
+
a Unix epoch time in milliseconds. By default, the relay proxy
|
|
3950
|
+
configuration will expire immediately
|
|
3324
3951
|
|