launchdarkly_api 3.3.1 → 3.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +198 -168
- data/docs/AccessTokensApi.md +333 -0
- data/docs/AuditLogApi.md +4 -4
- data/docs/ClientSideAvailability.md +9 -0
- data/docs/EnvironmentsApi.md +120 -0
- data/docs/FeatureFlag.md +3 -2
- 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/StreamUsageSeries.md +2 -2
- 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 +2 -1
- data/docs/UserSegmentBody.md +1 -0
- data/docs/UserSegmentsApi.md +61 -0
- data/docs/UserTargetingExpirationForFlag.md +1 -1
- data/docs/UserTargetingExpirationForSegment.md +1 -1
- data/docs/UsersApi.md +2 -2
- 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 +5 -5
- 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 +3 -3
- 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 +13 -4
- 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 +3 -3
- 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 +13 -3
- 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 +2 -2
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +1 -1
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +2 -2
- 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 -23
- data/spec/api/access_tokens_api_spec.rb +103 -0
- data/spec/api/audit_log_api_spec.rb +3 -3
- 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 +2 -2
- 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.0
|
|
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.0'
|
|
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.0
|
|
14
14
|
host: app.launchdarkly.com
|
|
15
15
|
basePath: /api/v2
|
|
16
16
|
schemes:
|
|
@@ -179,6 +179,44 @@ 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/EnvironmentKeyExpiry'
|
|
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 with an optional expiry time for the
|
|
205
|
+
old key.
|
|
206
|
+
operationId: resetEnvironmentMobileKey
|
|
207
|
+
parameters:
|
|
208
|
+
- $ref: '#/parameters/ProjectKey'
|
|
209
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
210
|
+
- $ref: '#/parameters/EnvironmentKeyExpiry'
|
|
211
|
+
responses:
|
|
212
|
+
'200':
|
|
213
|
+
$ref: '#/responses/Environment2xx'
|
|
214
|
+
'404':
|
|
215
|
+
$ref: '#/responses/Standard404'
|
|
216
|
+
'409':
|
|
217
|
+
$ref: '#/responses/Standard409'
|
|
218
|
+
tags:
|
|
219
|
+
- Environments
|
|
182
220
|
'/flags/{projectKey}':
|
|
183
221
|
get:
|
|
184
222
|
summary: Get a list of all features in the given project.
|
|
@@ -528,6 +566,24 @@ paths:
|
|
|
528
566
|
$ref: '#/responses/Standard409'
|
|
529
567
|
tags:
|
|
530
568
|
- User segments
|
|
569
|
+
'/segments/{projectKey}/{environmentKey}/{userSegmentKey}/unbounded-users':
|
|
570
|
+
post:
|
|
571
|
+
summary: Update targets included or excluded in an unbounded segment
|
|
572
|
+
operationId: updatedUnboundedSegmentTargets
|
|
573
|
+
parameters:
|
|
574
|
+
- $ref: '#/parameters/ProjectKey'
|
|
575
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
576
|
+
- $ref: '#/parameters/UserSegmentKey'
|
|
577
|
+
- $ref: '#/parameters/UnboundedSegmentTargetsPostRequest'
|
|
578
|
+
responses:
|
|
579
|
+
'204':
|
|
580
|
+
$ref: '#/responses/Standard204'
|
|
581
|
+
'400':
|
|
582
|
+
$ref: '#/responses/Standard400'
|
|
583
|
+
'401':
|
|
584
|
+
$ref: '#/responses/Standard401'
|
|
585
|
+
tags:
|
|
586
|
+
- User segments
|
|
531
587
|
'/users/{projectKey}/{environmentKey}':
|
|
532
588
|
get:
|
|
533
589
|
summary: >-
|
|
@@ -1242,6 +1298,194 @@ paths:
|
|
|
1242
1298
|
$ref: '#/responses/EvaluationUsage404'
|
|
1243
1299
|
tags:
|
|
1244
1300
|
- Customer Metrics
|
|
1301
|
+
/tokens:
|
|
1302
|
+
get:
|
|
1303
|
+
summary: Returns a list of tokens in the account.
|
|
1304
|
+
operationId: getTokens
|
|
1305
|
+
parameters:
|
|
1306
|
+
- $ref: '#/parameters/TokenShowAllQuery'
|
|
1307
|
+
responses:
|
|
1308
|
+
'200':
|
|
1309
|
+
description: Tokens response.
|
|
1310
|
+
schema:
|
|
1311
|
+
$ref: '#/definitions/Tokens'
|
|
1312
|
+
'401':
|
|
1313
|
+
$ref: '#/responses/Standard401'
|
|
1314
|
+
tags:
|
|
1315
|
+
- Access tokens
|
|
1316
|
+
post:
|
|
1317
|
+
summary: Create a new token.
|
|
1318
|
+
operationId: postToken
|
|
1319
|
+
parameters:
|
|
1320
|
+
- $ref: '#/parameters/TokensPostRequest'
|
|
1321
|
+
responses:
|
|
1322
|
+
'201':
|
|
1323
|
+
description: Token response.
|
|
1324
|
+
schema:
|
|
1325
|
+
$ref: '#/definitions/Token'
|
|
1326
|
+
'400':
|
|
1327
|
+
$ref: '#/responses/Standard400'
|
|
1328
|
+
'401':
|
|
1329
|
+
$ref: '#/responses/Standard401'
|
|
1330
|
+
'409':
|
|
1331
|
+
$ref: '#/responses/Standard409'
|
|
1332
|
+
tags:
|
|
1333
|
+
- Access tokens
|
|
1334
|
+
'/tokens/{tokenId}':
|
|
1335
|
+
get:
|
|
1336
|
+
summary: Get a single access token by ID.
|
|
1337
|
+
operationId: getToken
|
|
1338
|
+
parameters:
|
|
1339
|
+
- $ref: '#/parameters/TokenId'
|
|
1340
|
+
responses:
|
|
1341
|
+
'200':
|
|
1342
|
+
$ref: '#/responses/Token2xx'
|
|
1343
|
+
'400':
|
|
1344
|
+
$ref: '#/responses/Standard400'
|
|
1345
|
+
'401':
|
|
1346
|
+
$ref: '#/responses/Standard401'
|
|
1347
|
+
tags:
|
|
1348
|
+
- Access tokens
|
|
1349
|
+
patch:
|
|
1350
|
+
summary: Modify an access token by ID.
|
|
1351
|
+
operationId: patchToken
|
|
1352
|
+
parameters:
|
|
1353
|
+
- $ref: '#/parameters/TokenId'
|
|
1354
|
+
- $ref: '#/parameters/PatchRequest'
|
|
1355
|
+
responses:
|
|
1356
|
+
'200':
|
|
1357
|
+
$ref: '#/responses/Token2xx'
|
|
1358
|
+
'400':
|
|
1359
|
+
$ref: '#/responses/Standard400'
|
|
1360
|
+
'401':
|
|
1361
|
+
$ref: '#/responses/Standard401'
|
|
1362
|
+
'404':
|
|
1363
|
+
$ref: '#/responses/Standard404'
|
|
1364
|
+
'409':
|
|
1365
|
+
$ref: '#/responses/Standard409'
|
|
1366
|
+
tags:
|
|
1367
|
+
- Access tokens
|
|
1368
|
+
delete:
|
|
1369
|
+
summary: Delete an access token by ID.
|
|
1370
|
+
operationId: deleteToken
|
|
1371
|
+
parameters:
|
|
1372
|
+
- $ref: '#/parameters/TokenId'
|
|
1373
|
+
responses:
|
|
1374
|
+
'204':
|
|
1375
|
+
$ref: '#/responses/Standard204'
|
|
1376
|
+
'401':
|
|
1377
|
+
$ref: '#/responses/Standard401'
|
|
1378
|
+
'404':
|
|
1379
|
+
$ref: '#/responses/Standard404'
|
|
1380
|
+
tags:
|
|
1381
|
+
- Access tokens
|
|
1382
|
+
'/tokens/{tokenId}/reset':
|
|
1383
|
+
post:
|
|
1384
|
+
summary: >-
|
|
1385
|
+
Reset an access token's secret key with an optional expiry time for the
|
|
1386
|
+
old key.
|
|
1387
|
+
operationId: resetToken
|
|
1388
|
+
parameters:
|
|
1389
|
+
- $ref: '#/parameters/TokenId'
|
|
1390
|
+
- $ref: '#/parameters/TokenExpiry'
|
|
1391
|
+
responses:
|
|
1392
|
+
'200':
|
|
1393
|
+
$ref: '#/responses/Token2xx'
|
|
1394
|
+
'400':
|
|
1395
|
+
$ref: '#/responses/Standard400'
|
|
1396
|
+
'401':
|
|
1397
|
+
$ref: '#/responses/Standard401'
|
|
1398
|
+
tags:
|
|
1399
|
+
- Access tokens
|
|
1400
|
+
/account/relay-auto-configs:
|
|
1401
|
+
get:
|
|
1402
|
+
summary: Returns a list of relay proxy configurations in the account.
|
|
1403
|
+
operationId: getRelayProxyConfigs
|
|
1404
|
+
responses:
|
|
1405
|
+
'200':
|
|
1406
|
+
description: Relay proxy configs response.
|
|
1407
|
+
schema:
|
|
1408
|
+
$ref: '#/definitions/RelayProxyConfigs'
|
|
1409
|
+
tags:
|
|
1410
|
+
- Relay proxy configurations
|
|
1411
|
+
post:
|
|
1412
|
+
summary: Create a new relay proxy config.
|
|
1413
|
+
operationId: postRelayAutoConfig
|
|
1414
|
+
parameters:
|
|
1415
|
+
- $ref: '#/parameters/RelayProxyConfigPostRequest'
|
|
1416
|
+
responses:
|
|
1417
|
+
'201':
|
|
1418
|
+
description: Relay proxy config response.
|
|
1419
|
+
schema:
|
|
1420
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
1421
|
+
'400':
|
|
1422
|
+
$ref: '#/responses/Standard400'
|
|
1423
|
+
'403':
|
|
1424
|
+
$ref: '#/responses/Standard403'
|
|
1425
|
+
tags:
|
|
1426
|
+
- Relay proxy configurations
|
|
1427
|
+
'/account/relay-auto-configs/{id}':
|
|
1428
|
+
get:
|
|
1429
|
+
summary: Get a single relay proxy configuration by ID.
|
|
1430
|
+
operationId: getRelayProxyConfig
|
|
1431
|
+
parameters:
|
|
1432
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1433
|
+
responses:
|
|
1434
|
+
'200':
|
|
1435
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1436
|
+
'404':
|
|
1437
|
+
$ref: '#/responses/Standard404'
|
|
1438
|
+
tags:
|
|
1439
|
+
- Relay proxy configurations
|
|
1440
|
+
patch:
|
|
1441
|
+
summary: Modify a relay proxy configuration by ID.
|
|
1442
|
+
operationId: patchRelayProxyConfig
|
|
1443
|
+
parameters:
|
|
1444
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1445
|
+
- $ref: '#/parameters/PatchRequest'
|
|
1446
|
+
responses:
|
|
1447
|
+
'200':
|
|
1448
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1449
|
+
'400':
|
|
1450
|
+
$ref: '#/responses/Standard400'
|
|
1451
|
+
'404':
|
|
1452
|
+
$ref: '#/responses/Standard404'
|
|
1453
|
+
'409':
|
|
1454
|
+
$ref: '#/responses/Standard409'
|
|
1455
|
+
tags:
|
|
1456
|
+
- Relay proxy configurations
|
|
1457
|
+
delete:
|
|
1458
|
+
summary: Delete a relay proxy configuration by ID.
|
|
1459
|
+
operationId: deleteRelayProxyConfig
|
|
1460
|
+
parameters:
|
|
1461
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1462
|
+
responses:
|
|
1463
|
+
'204':
|
|
1464
|
+
$ref: '#/responses/Standard204'
|
|
1465
|
+
'400':
|
|
1466
|
+
$ref: '#/responses/Standard400'
|
|
1467
|
+
'404':
|
|
1468
|
+
$ref: '#/responses/Standard404'
|
|
1469
|
+
tags:
|
|
1470
|
+
- Relay proxy configurations
|
|
1471
|
+
'/account/relay-auto-configs/{id}/reset':
|
|
1472
|
+
post:
|
|
1473
|
+
summary: >-
|
|
1474
|
+
Reset a relay proxy configuration's secret key with an optional expiry
|
|
1475
|
+
time for the old key.
|
|
1476
|
+
operationId: resetRelayProxyConfig
|
|
1477
|
+
parameters:
|
|
1478
|
+
- $ref: '#/parameters/RelayProxyConfigId'
|
|
1479
|
+
- $ref: '#/parameters/RelayProxyConfigsExpiry'
|
|
1480
|
+
responses:
|
|
1481
|
+
'200':
|
|
1482
|
+
$ref: '#/responses/RelayProxyConfig2xx'
|
|
1483
|
+
'400':
|
|
1484
|
+
$ref: '#/responses/Standard400'
|
|
1485
|
+
'404':
|
|
1486
|
+
$ref: '#/responses/Standard404'
|
|
1487
|
+
tags:
|
|
1488
|
+
- Relay proxy configurations
|
|
1245
1489
|
/:
|
|
1246
1490
|
get:
|
|
1247
1491
|
description: >-
|
|
@@ -1345,7 +1589,7 @@ definitions:
|
|
|
1345
1589
|
description: Whether the feature flag is a boolean flag or multivariate.
|
|
1346
1590
|
example: boolean
|
|
1347
1591
|
creationDate:
|
|
1348
|
-
type:
|
|
1592
|
+
type: integer
|
|
1349
1593
|
format: int64
|
|
1350
1594
|
description: >-
|
|
1351
1595
|
A unix epoch time in milliseconds specifying the creation time of this
|
|
@@ -1410,7 +1654,7 @@ definitions:
|
|
|
1410
1654
|
additionalProperties:
|
|
1411
1655
|
$ref: '#/definitions/FeatureFlagConfig'
|
|
1412
1656
|
archivedDate:
|
|
1413
|
-
type:
|
|
1657
|
+
type: integer
|
|
1414
1658
|
format: int64
|
|
1415
1659
|
description: >-
|
|
1416
1660
|
A unix epoch time in milliseconds specifying the archived time of this
|
|
@@ -1420,6 +1664,8 @@ definitions:
|
|
|
1420
1664
|
type: boolean
|
|
1421
1665
|
description: Whether or not this flag is archived.
|
|
1422
1666
|
example: false
|
|
1667
|
+
clientSideAvailability:
|
|
1668
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
1423
1669
|
defaults:
|
|
1424
1670
|
$ref: '#/definitions/Defaults'
|
|
1425
1671
|
FeatureFlags:
|
|
@@ -1622,6 +1868,68 @@ definitions:
|
|
|
1622
1868
|
type: string
|
|
1623
1869
|
variation:
|
|
1624
1870
|
type: integer
|
|
1871
|
+
FeatureFlagScheduledChanges:
|
|
1872
|
+
type: object
|
|
1873
|
+
properties:
|
|
1874
|
+
_links:
|
|
1875
|
+
$ref: '#/definitions/Links'
|
|
1876
|
+
items:
|
|
1877
|
+
type: array
|
|
1878
|
+
items:
|
|
1879
|
+
$ref: '#/definitions/FeatureFlagScheduledChange'
|
|
1880
|
+
FeatureFlagScheduledChange:
|
|
1881
|
+
type: object
|
|
1882
|
+
properties:
|
|
1883
|
+
executionDate:
|
|
1884
|
+
type: integer
|
|
1885
|
+
description: >-
|
|
1886
|
+
A unix epoch time in milliseconds specifying the date the scheduled
|
|
1887
|
+
changes will be applied
|
|
1888
|
+
_version:
|
|
1889
|
+
type: integer
|
|
1890
|
+
_id:
|
|
1891
|
+
type: string
|
|
1892
|
+
instructions:
|
|
1893
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
1894
|
+
FeatureFlagScheduledChangesConflicts:
|
|
1895
|
+
type: object
|
|
1896
|
+
properties:
|
|
1897
|
+
instructions:
|
|
1898
|
+
type: array
|
|
1899
|
+
items:
|
|
1900
|
+
properties:
|
|
1901
|
+
kind:
|
|
1902
|
+
type: string
|
|
1903
|
+
example: removeUserTargets
|
|
1904
|
+
description: >-
|
|
1905
|
+
The name of the modification you would like to perform on a
|
|
1906
|
+
resource.
|
|
1907
|
+
conflicts:
|
|
1908
|
+
type: array
|
|
1909
|
+
items:
|
|
1910
|
+
$ref: '#/definitions/ScheduledChangesFeatureFlagConflict'
|
|
1911
|
+
ScheduledChangesFeatureFlagConflict:
|
|
1912
|
+
type: object
|
|
1913
|
+
properties:
|
|
1914
|
+
_id:
|
|
1915
|
+
type: string
|
|
1916
|
+
description: Feature flag scheduled change id this change will conflict with
|
|
1917
|
+
reason:
|
|
1918
|
+
type: string
|
|
1919
|
+
description: Feature flag scheduled change conflict reason
|
|
1920
|
+
ClientSideAvailability:
|
|
1921
|
+
type: object
|
|
1922
|
+
properties:
|
|
1923
|
+
usingEnvironmentId:
|
|
1924
|
+
type: boolean
|
|
1925
|
+
description: >-
|
|
1926
|
+
When set to true, this flag will be available to SDKs using the
|
|
1927
|
+
client-side id.
|
|
1928
|
+
usingMobileKey:
|
|
1929
|
+
type: boolean
|
|
1930
|
+
description: >-
|
|
1931
|
+
When set to true, this flag will be available to SDKS using a mobile
|
|
1932
|
+
key.
|
|
1625
1933
|
FeatureFlagStatus:
|
|
1626
1934
|
type: object
|
|
1627
1935
|
properties:
|
|
@@ -1730,7 +2038,7 @@ definitions:
|
|
|
1730
2038
|
type: object
|
|
1731
2039
|
properties:
|
|
1732
2040
|
expirationDate:
|
|
1733
|
-
type:
|
|
2041
|
+
type: integer
|
|
1734
2042
|
format: int64
|
|
1735
2043
|
description: Unix epoch time in milliseconds specifying the expiration date
|
|
1736
2044
|
example: 1735689600000
|
|
@@ -1752,7 +2060,7 @@ definitions:
|
|
|
1752
2060
|
type: object
|
|
1753
2061
|
properties:
|
|
1754
2062
|
expirationDate:
|
|
1755
|
-
type:
|
|
2063
|
+
type: integer
|
|
1756
2064
|
format: int64
|
|
1757
2065
|
description: Unix epoch time in milliseconds specifying the expiration date
|
|
1758
2066
|
example: 1735689600000
|
|
@@ -1813,7 +2121,7 @@ definitions:
|
|
|
1813
2121
|
- ops
|
|
1814
2122
|
description: An array of tags for this user segment.
|
|
1815
2123
|
creationDate:
|
|
1816
|
-
type:
|
|
2124
|
+
type: integer
|
|
1817
2125
|
format: int64
|
|
1818
2126
|
description: >-
|
|
1819
2127
|
A unix epoch time in milliseconds specifying the creation time of this
|
|
@@ -1838,6 +2146,13 @@ definitions:
|
|
|
1838
2146
|
description: >-
|
|
1839
2147
|
An array of rules that can cause a user to be included in this
|
|
1840
2148
|
segment.
|
|
2149
|
+
unbounded:
|
|
2150
|
+
type: boolean
|
|
2151
|
+
example: false
|
|
2152
|
+
description: >-
|
|
2153
|
+
Controls whether this segment can support unlimited numbers of users.
|
|
2154
|
+
Requires the beta API and additional setup. Include/exclude lists in
|
|
2155
|
+
this payload are not used in unbounded segments.
|
|
1841
2156
|
version:
|
|
1842
2157
|
type: integer
|
|
1843
2158
|
_links:
|
|
@@ -1867,6 +2182,22 @@ definitions:
|
|
|
1867
2182
|
type: array
|
|
1868
2183
|
items:
|
|
1869
2184
|
$ref: '#/definitions/UserSegment'
|
|
2185
|
+
UnboundedSegmentTargetChanges:
|
|
2186
|
+
type: object
|
|
2187
|
+
properties:
|
|
2188
|
+
add:
|
|
2189
|
+
type: array
|
|
2190
|
+
example:
|
|
2191
|
+
- user@launchdarkly.com
|
|
2192
|
+
items:
|
|
2193
|
+
type: string
|
|
2194
|
+
description: Users to add to this list of targets
|
|
2195
|
+
remove:
|
|
2196
|
+
type: array
|
|
2197
|
+
example: []
|
|
2198
|
+
items:
|
|
2199
|
+
type: string
|
|
2200
|
+
description: Users to remove from this list of targets
|
|
1870
2201
|
Project:
|
|
1871
2202
|
type: object
|
|
1872
2203
|
properties:
|
|
@@ -1892,6 +2223,8 @@ definitions:
|
|
|
1892
2223
|
items:
|
|
1893
2224
|
type: string
|
|
1894
2225
|
description: An array of tags for this project.
|
|
2226
|
+
defaultClientSideAvailability:
|
|
2227
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
1895
2228
|
Projects:
|
|
1896
2229
|
type: object
|
|
1897
2230
|
properties:
|
|
@@ -2132,7 +2465,6 @@ definitions:
|
|
|
2132
2465
|
properties:
|
|
2133
2466
|
lastPing:
|
|
2134
2467
|
type: string
|
|
2135
|
-
format: int64
|
|
2136
2468
|
example: '2015-03-03T02:37:22.492Z'
|
|
2137
2469
|
environmentId:
|
|
2138
2470
|
type: string
|
|
@@ -2386,9 +2718,10 @@ definitions:
|
|
|
2386
2718
|
example: replace
|
|
2387
2719
|
path:
|
|
2388
2720
|
type: string
|
|
2389
|
-
example: /
|
|
2721
|
+
example: /name
|
|
2390
2722
|
value:
|
|
2391
2723
|
type: object
|
|
2724
|
+
example: My resource name
|
|
2392
2725
|
required:
|
|
2393
2726
|
- op
|
|
2394
2727
|
- path
|
|
@@ -2400,17 +2733,19 @@ definitions:
|
|
|
2400
2733
|
type: string
|
|
2401
2734
|
example: This is a comment string
|
|
2402
2735
|
instructions:
|
|
2403
|
-
|
|
2404
|
-
items:
|
|
2405
|
-
properties:
|
|
2406
|
-
kind:
|
|
2407
|
-
type: string
|
|
2408
|
-
example: removeUserTargets
|
|
2409
|
-
description: >-
|
|
2410
|
-
The name of the modification you would like to perform on a
|
|
2411
|
-
resource.
|
|
2736
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2412
2737
|
required:
|
|
2413
2738
|
- instructions
|
|
2739
|
+
SemanticPatchInstruction:
|
|
2740
|
+
type: array
|
|
2741
|
+
items:
|
|
2742
|
+
properties:
|
|
2743
|
+
kind:
|
|
2744
|
+
type: string
|
|
2745
|
+
example: removeUserTargets
|
|
2746
|
+
description: >-
|
|
2747
|
+
The name of the modification you would like to perform on a
|
|
2748
|
+
resource.
|
|
2414
2749
|
CustomProperty:
|
|
2415
2750
|
type: object
|
|
2416
2751
|
description: A name and value describing a custom property.
|
|
@@ -2512,12 +2847,12 @@ definitions:
|
|
|
2512
2847
|
type: object
|
|
2513
2848
|
properties:
|
|
2514
2849
|
'0':
|
|
2515
|
-
type:
|
|
2850
|
+
type: integer
|
|
2516
2851
|
format: int64
|
|
2517
2852
|
description: A key corresponding to a time series data point.
|
|
2518
2853
|
example: 0
|
|
2519
2854
|
time:
|
|
2520
|
-
type:
|
|
2855
|
+
type: integer
|
|
2521
2856
|
format: int64
|
|
2522
2857
|
description: >-
|
|
2523
2858
|
A unix epoch time in milliseconds specifying the creation time of this
|
|
@@ -2676,6 +3011,136 @@ definitions:
|
|
|
2676
3011
|
$ref: '#/definitions/Links'
|
|
2677
3012
|
_site:
|
|
2678
3013
|
$ref: '#/definitions/Site'
|
|
3014
|
+
Tokens:
|
|
3015
|
+
type: object
|
|
3016
|
+
properties:
|
|
3017
|
+
_links:
|
|
3018
|
+
$ref: '#/definitions/Links'
|
|
3019
|
+
items:
|
|
3020
|
+
type: array
|
|
3021
|
+
items:
|
|
3022
|
+
$ref: '#/definitions/Token'
|
|
3023
|
+
Token:
|
|
3024
|
+
type: object
|
|
3025
|
+
properties:
|
|
3026
|
+
_links:
|
|
3027
|
+
$ref: '#/definitions/Links'
|
|
3028
|
+
_id:
|
|
3029
|
+
$ref: '#/definitions/Id'
|
|
3030
|
+
ownerId:
|
|
3031
|
+
$ref: '#/definitions/Id'
|
|
3032
|
+
memberId:
|
|
3033
|
+
$ref: '#/definitions/Id'
|
|
3034
|
+
_member:
|
|
3035
|
+
$ref: '#/definitions/Member'
|
|
3036
|
+
creationDate:
|
|
3037
|
+
type: integer
|
|
3038
|
+
format: int64
|
|
3039
|
+
description: >-
|
|
3040
|
+
A unix epoch time in milliseconds specifying the creation time of this
|
|
3041
|
+
access token.
|
|
3042
|
+
example: 1443652232590
|
|
3043
|
+
lastModified:
|
|
3044
|
+
type: integer
|
|
3045
|
+
format: int64
|
|
3046
|
+
example: 1469326565348
|
|
3047
|
+
description: >-
|
|
3048
|
+
A unix epoch time in milliseconds specifying the last time this access
|
|
3049
|
+
token was modified.
|
|
3050
|
+
lastUsed:
|
|
3051
|
+
type: integer
|
|
3052
|
+
format: int64
|
|
3053
|
+
example: 1469326565348
|
|
3054
|
+
description: >-
|
|
3055
|
+
A unix epoch time in milliseconds specifying the last time this access
|
|
3056
|
+
token was used to authorize access to the LaunchDarkly REST API.
|
|
3057
|
+
token:
|
|
3058
|
+
type: string
|
|
3059
|
+
example: '3243'
|
|
3060
|
+
description: >-
|
|
3061
|
+
The last 4 digits of the unique secret key for this access token. If
|
|
3062
|
+
creating or resetting the token, this will be the full token secret.
|
|
3063
|
+
name:
|
|
3064
|
+
type: string
|
|
3065
|
+
description: A human-friendly name for the access token
|
|
3066
|
+
example: My access token
|
|
3067
|
+
role:
|
|
3068
|
+
type: string
|
|
3069
|
+
description: The name of a built-in role for the token
|
|
3070
|
+
example: writer
|
|
3071
|
+
customRoleIds:
|
|
3072
|
+
type: array
|
|
3073
|
+
items:
|
|
3074
|
+
type: string
|
|
3075
|
+
description: A list of custom role IDs to use as access limits for the access token
|
|
3076
|
+
inlineRole:
|
|
3077
|
+
type: array
|
|
3078
|
+
items:
|
|
3079
|
+
$ref: '#/definitions/Statement'
|
|
3080
|
+
serviceToken:
|
|
3081
|
+
type: boolean
|
|
3082
|
+
description: >-
|
|
3083
|
+
Whether the token will be a service token
|
|
3084
|
+
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
3085
|
+
defaultApiVersion:
|
|
3086
|
+
type: integer
|
|
3087
|
+
description: The default API version for this token
|
|
3088
|
+
RelayProxyConfigs:
|
|
3089
|
+
type: object
|
|
3090
|
+
properties:
|
|
3091
|
+
items:
|
|
3092
|
+
type: array
|
|
3093
|
+
items:
|
|
3094
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
3095
|
+
RelayProxyConfig:
|
|
3096
|
+
type: object
|
|
3097
|
+
properties:
|
|
3098
|
+
_id:
|
|
3099
|
+
$ref: '#/definitions/Id'
|
|
3100
|
+
_creator:
|
|
3101
|
+
$ref: '#/definitions/Member'
|
|
3102
|
+
name:
|
|
3103
|
+
type: string
|
|
3104
|
+
description: A human-friendly name for the relay proxy configuration
|
|
3105
|
+
example: My relay proxy config
|
|
3106
|
+
policy:
|
|
3107
|
+
type: array
|
|
3108
|
+
items:
|
|
3109
|
+
$ref: '#/definitions/Policy'
|
|
3110
|
+
fullKey:
|
|
3111
|
+
type: string
|
|
3112
|
+
example: rel-8a3a773d-b75e-48eb-a850-492cda9266eo
|
|
3113
|
+
description: >-
|
|
3114
|
+
Full secret key. Only included if creating or resetting the relay
|
|
3115
|
+
proxy configuration
|
|
3116
|
+
displayKey:
|
|
3117
|
+
type: string
|
|
3118
|
+
example: 66eo
|
|
3119
|
+
description: >-
|
|
3120
|
+
The last 4 digits of the unique secret key for this relay proxy
|
|
3121
|
+
configuration
|
|
3122
|
+
creationDate:
|
|
3123
|
+
type: integer
|
|
3124
|
+
format: int64
|
|
3125
|
+
description: >-
|
|
3126
|
+
A unix epoch time in milliseconds specifying the creation time of this
|
|
3127
|
+
relay proxy configuration
|
|
3128
|
+
example: 1443652232590
|
|
3129
|
+
lastModified:
|
|
3130
|
+
type: integer
|
|
3131
|
+
format: int64
|
|
3132
|
+
example: 1469326565348
|
|
3133
|
+
description: >-
|
|
3134
|
+
A unix epoch time in milliseconds specifying the last time this relay
|
|
3135
|
+
proxy configuration was modified
|
|
3136
|
+
required:
|
|
3137
|
+
- _id
|
|
3138
|
+
- _creator
|
|
3139
|
+
- name
|
|
3140
|
+
- policy
|
|
3141
|
+
- displayKey
|
|
3142
|
+
- creationDate
|
|
3143
|
+
- lastModified
|
|
2679
3144
|
responses:
|
|
2680
3145
|
Standard201:
|
|
2681
3146
|
description: Resource created.
|
|
@@ -2685,6 +3150,8 @@ responses:
|
|
|
2685
3150
|
description: Invalid request body.
|
|
2686
3151
|
Standard401:
|
|
2687
3152
|
description: Invalid access token.
|
|
3153
|
+
Standard403:
|
|
3154
|
+
description: Access to the requested resource was denied.
|
|
2688
3155
|
Standard404:
|
|
2689
3156
|
description: Invalid resource specifier.
|
|
2690
3157
|
Standard409:
|
|
@@ -2735,6 +3202,14 @@ responses:
|
|
|
2735
3202
|
description: Destination response.
|
|
2736
3203
|
schema:
|
|
2737
3204
|
$ref: '#/definitions/Destination'
|
|
3205
|
+
Token2xx:
|
|
3206
|
+
description: Token response.
|
|
3207
|
+
schema:
|
|
3208
|
+
$ref: '#/definitions/Token'
|
|
3209
|
+
RelayProxyConfig2xx:
|
|
3210
|
+
description: Relay proxy config response.
|
|
3211
|
+
schema:
|
|
3212
|
+
$ref: '#/definitions/RelayProxyConfig'
|
|
2738
3213
|
parameters:
|
|
2739
3214
|
ResourceId:
|
|
2740
3215
|
name: resourceId
|
|
@@ -2854,12 +3329,29 @@ parameters:
|
|
|
2854
3329
|
description: >-
|
|
2855
3330
|
Whether or not this flag should be made available to the client-side
|
|
2856
3331
|
JavaScript SDK.
|
|
3332
|
+
clientSideAvailability:
|
|
3333
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
2857
3334
|
defaults:
|
|
2858
3335
|
$ref: '#/definitions/Defaults'
|
|
2859
3336
|
required:
|
|
2860
3337
|
- name
|
|
2861
3338
|
- key
|
|
2862
3339
|
- variations
|
|
3340
|
+
ScheduledFeatureFlagChangesPostRequest:
|
|
3341
|
+
name: scheduledFeatureFlagChangesBody
|
|
3342
|
+
in: body
|
|
3343
|
+
required: true
|
|
3344
|
+
description: Create scheduled changes on a feature flag.
|
|
3345
|
+
schema:
|
|
3346
|
+
type: object
|
|
3347
|
+
properties:
|
|
3348
|
+
executionDate:
|
|
3349
|
+
type: integer
|
|
3350
|
+
description: >-
|
|
3351
|
+
A unix epoch time in milliseconds specifying the date the scheduled
|
|
3352
|
+
changes will be applied
|
|
3353
|
+
instructions:
|
|
3354
|
+
$ref: '#/definitions/SemanticPatchInstruction'
|
|
2863
3355
|
DestinationPostRequest:
|
|
2864
3356
|
name: destinationBody
|
|
2865
3357
|
in: body
|
|
@@ -2919,6 +3411,13 @@ parameters:
|
|
|
2919
3411
|
type: string
|
|
2920
3412
|
description: A description for the user segment.
|
|
2921
3413
|
example: Users in this segment will have access to beta features.
|
|
3414
|
+
unbounded:
|
|
3415
|
+
type: boolean
|
|
3416
|
+
example: false
|
|
3417
|
+
description: >-
|
|
3418
|
+
Controls whether this segment can support unlimited numbers of
|
|
3419
|
+
users. Requires the beta API and additional setup. Include/exclude
|
|
3420
|
+
lists in this payload are not used in unbounded segments.
|
|
2922
3421
|
tags:
|
|
2923
3422
|
type: array
|
|
2924
3423
|
items:
|
|
@@ -2928,6 +3427,20 @@ parameters:
|
|
|
2928
3427
|
required:
|
|
2929
3428
|
- name
|
|
2930
3429
|
- key
|
|
3430
|
+
UnboundedSegmentTargetsPostRequest:
|
|
3431
|
+
name: unboundedSegmentTargetsBody
|
|
3432
|
+
in: body
|
|
3433
|
+
required: true
|
|
3434
|
+
description: >-
|
|
3435
|
+
Add or remove user targets to the included or excluded lists on an
|
|
3436
|
+
unbounded segment
|
|
3437
|
+
schema:
|
|
3438
|
+
type: object
|
|
3439
|
+
properties:
|
|
3440
|
+
included:
|
|
3441
|
+
$ref: '#/definitions/UnboundedSegmentTargetChanges'
|
|
3442
|
+
excluded:
|
|
3443
|
+
$ref: '#/definitions/UnboundedSegmentTargetChanges'
|
|
2931
3444
|
ProjectPostRequest:
|
|
2932
3445
|
name: projectBody
|
|
2933
3446
|
in: body
|
|
@@ -2957,6 +3470,8 @@ parameters:
|
|
|
2957
3470
|
items:
|
|
2958
3471
|
$ref: '#/definitions/EnvironmentPost'
|
|
2959
3472
|
minLength: 1
|
|
3473
|
+
defaultClientSideAvailability:
|
|
3474
|
+
$ref: '#/definitions/ClientSideAvailability'
|
|
2960
3475
|
required:
|
|
2961
3476
|
- name
|
|
2962
3477
|
- key
|
|
@@ -2996,6 +3511,16 @@ parameters:
|
|
|
2996
3511
|
items:
|
|
2997
3512
|
type: string
|
|
2998
3513
|
collectionFormat: multi
|
|
3514
|
+
EnvironmentKeyExpiry:
|
|
3515
|
+
name: expiry
|
|
3516
|
+
in: query
|
|
3517
|
+
required: false
|
|
3518
|
+
type: integer
|
|
3519
|
+
format: int64
|
|
3520
|
+
description: >-
|
|
3521
|
+
An expiration time for the old environment SDK or mobile key, expressed as
|
|
3522
|
+
a Unix epoch time in milliseconds. By default, the key will expire
|
|
3523
|
+
immediately
|
|
2999
3524
|
SummaryQuery:
|
|
3000
3525
|
name: summary
|
|
3001
3526
|
in: query
|
|
@@ -3010,7 +3535,7 @@ parameters:
|
|
|
3010
3535
|
in: query
|
|
3011
3536
|
required: false
|
|
3012
3537
|
description: >-
|
|
3013
|
-
When set to 1, archived flags will be included in the list of flags
|
|
3538
|
+
When set to 1, only archived flags will be included in the list of flags
|
|
3014
3539
|
returned. By default, archived flags are not included in the list of
|
|
3015
3540
|
flags.
|
|
3016
3541
|
type: boolean
|
|
@@ -3119,7 +3644,7 @@ parameters:
|
|
|
3119
3644
|
required: false
|
|
3120
3645
|
description: >-
|
|
3121
3646
|
A timestamp filter, expressed as a Unix epoch time in milliseconds. All
|
|
3122
|
-
entries returned will have
|
|
3647
|
+
entries returned will have occurred after this timestamp.
|
|
3123
3648
|
format: int64
|
|
3124
3649
|
type: integer
|
|
3125
3650
|
PatchRequest:
|
|
@@ -3160,8 +3685,8 @@ parameters:
|
|
|
3160
3685
|
required: false
|
|
3161
3686
|
description: >-
|
|
3162
3687
|
Text to search for. You can search for the full or partial name of the
|
|
3163
|
-
resource involved or
|
|
3164
|
-
change.
|
|
3688
|
+
resource involved or full or partial email address of the member who made
|
|
3689
|
+
the change.
|
|
3165
3690
|
type: string
|
|
3166
3691
|
AuditLimit:
|
|
3167
3692
|
name: limit
|
|
@@ -3322,4 +3847,95 @@ parameters:
|
|
|
3322
3847
|
required: true
|
|
3323
3848
|
description: The key of the flag we want metrics for.
|
|
3324
3849
|
type: string
|
|
3850
|
+
TokensPostRequest:
|
|
3851
|
+
name: tokenBody
|
|
3852
|
+
in: body
|
|
3853
|
+
required: true
|
|
3854
|
+
description: Create a new access token.
|
|
3855
|
+
schema:
|
|
3856
|
+
type: object
|
|
3857
|
+
properties:
|
|
3858
|
+
name:
|
|
3859
|
+
type: string
|
|
3860
|
+
description: A human-friendly name for the access token
|
|
3861
|
+
example: My access token
|
|
3862
|
+
role:
|
|
3863
|
+
type: string
|
|
3864
|
+
description: The name of a built-in role for the token
|
|
3865
|
+
example: writer
|
|
3866
|
+
customRoleIds:
|
|
3867
|
+
type: array
|
|
3868
|
+
items:
|
|
3869
|
+
type: string
|
|
3870
|
+
example: []
|
|
3871
|
+
description: >-
|
|
3872
|
+
A list of custom role IDs to use as access limits for the access
|
|
3873
|
+
token
|
|
3874
|
+
inlineRole:
|
|
3875
|
+
type: array
|
|
3876
|
+
items:
|
|
3877
|
+
$ref: '#/definitions/Statement'
|
|
3878
|
+
serviceToken:
|
|
3879
|
+
type: boolean
|
|
3880
|
+
description: >-
|
|
3881
|
+
Whether the token will be a service token
|
|
3882
|
+
https://docs.launchdarkly.com/home/account-security/api-access-tokens#service-tokens
|
|
3883
|
+
defaultApiVersion:
|
|
3884
|
+
type: integer
|
|
3885
|
+
description: The default API version for this token
|
|
3886
|
+
TokenId:
|
|
3887
|
+
name: tokenId
|
|
3888
|
+
in: path
|
|
3889
|
+
required: true
|
|
3890
|
+
description: The access token ID.
|
|
3891
|
+
type: string
|
|
3892
|
+
TokenShowAllQuery:
|
|
3893
|
+
name: showAll
|
|
3894
|
+
in: query
|
|
3895
|
+
required: false
|
|
3896
|
+
description: >-
|
|
3897
|
+
If set to true, and the authentication access token has the "Admin" role,
|
|
3898
|
+
personal access tokens for all members will be retrieved.
|
|
3899
|
+
type: boolean
|
|
3900
|
+
TokenExpiry:
|
|
3901
|
+
name: expiry
|
|
3902
|
+
in: query
|
|
3903
|
+
required: false
|
|
3904
|
+
type: integer
|
|
3905
|
+
format: int64
|
|
3906
|
+
description: >-
|
|
3907
|
+
An expiration time for the old token key, expressed as a Unix epoch time
|
|
3908
|
+
in milliseconds. By default, the token will expire immediately.
|
|
3909
|
+
RelayProxyConfigPostRequest:
|
|
3910
|
+
name: relayProxyConfigBody
|
|
3911
|
+
in: body
|
|
3912
|
+
required: true
|
|
3913
|
+
description: Create a new relay proxy configuration
|
|
3914
|
+
schema:
|
|
3915
|
+
type: object
|
|
3916
|
+
properties:
|
|
3917
|
+
name:
|
|
3918
|
+
type: string
|
|
3919
|
+
description: A human-friendly name for the relay proxy configuration
|
|
3920
|
+
example: My relay proxy config
|
|
3921
|
+
policy:
|
|
3922
|
+
type: array
|
|
3923
|
+
items:
|
|
3924
|
+
$ref: '#/definitions/Policy'
|
|
3925
|
+
RelayProxyConfigId:
|
|
3926
|
+
name: id
|
|
3927
|
+
in: path
|
|
3928
|
+
required: true
|
|
3929
|
+
description: The relay proxy configuration ID
|
|
3930
|
+
type: string
|
|
3931
|
+
RelayProxyConfigsExpiry:
|
|
3932
|
+
name: expiry
|
|
3933
|
+
in: query
|
|
3934
|
+
required: false
|
|
3935
|
+
type: integer
|
|
3936
|
+
format: int64
|
|
3937
|
+
description: >-
|
|
3938
|
+
An expiration time for the old relay proxy configuration key, expressed as
|
|
3939
|
+
a Unix epoch time in milliseconds. By default, the relay proxy
|
|
3940
|
+
configuration will expire immediately
|
|
3325
3941
|
|