launchdarkly_api 2.0.10 → 2.0.27
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 +5 -5
- data/README.md +153 -151
- data/docs/AuditLogApi.md +7 -7
- data/docs/{Action.md → CopyActions.md} +1 -1
- data/docs/CustomProperty.md +1 -1
- data/docs/CustomRole.md +1 -1
- data/docs/CustomRoleBody.md +1 -1
- data/docs/CustomRoles.md +1 -1
- data/docs/CustomRolesApi.md +7 -6
- data/docs/CustomerMetricsApi.md +511 -0
- data/docs/DataExportDestinationsApi.md +293 -0
- data/docs/Destination.md +14 -0
- data/docs/DestinationAmazonKinesis.md +10 -0
- data/docs/DestinationBody.md +11 -0
- data/docs/DestinationGooglePubSub.md +9 -0
- data/docs/DestinationMParticle.md +11 -0
- data/docs/{CustomRoleKeyOrId.md → DestinationSegment.md} +2 -1
- data/docs/Destinations.md +9 -0
- data/docs/Environment.md +2 -0
- data/docs/EnvironmentPost.md +5 -0
- data/docs/EnvironmentsApi.md +11 -10
- data/docs/EvaluationUsageError.md +9 -0
- data/docs/Events.md +8 -0
- data/docs/FeatureFlag.md +4 -1
- data/docs/FeatureFlagConfig.md +0 -1
- data/docs/FeatureFlagCopyBody.md +12 -0
- data/docs/FeatureFlagCopyObject.md +9 -0
- data/docs/FeatureFlagStatus.md +1 -1
- data/docs/FeatureFlagStatusAcrossEnvironments.md +10 -0
- data/docs/FeatureFlagStatusForQueriedEnvironment.md +10 -0
- data/docs/FeatureFlagsApi.md +136 -17
- data/docs/MAU.md +10 -0
- data/docs/{Actions.md → MAUMetadata.md} +1 -1
- data/docs/MAUbyCategory.md +10 -0
- data/docs/Member.md +2 -0
- data/docs/Members.md +1 -1
- data/docs/MembersBody.md +1 -1
- data/docs/Policy.md +4 -2
- data/docs/ProjectBody.md +2 -0
- data/docs/ProjectsApi.md +7 -6
- data/docs/Rollout.md +1 -0
- data/docs/Statement.md +4 -4
- data/docs/Stream.md +10 -0
- data/docs/StreamBySDK.md +10 -0
- data/docs/StreamBySDKLinks.md +9 -0
- data/docs/StreamBySDKLinksMetadata.md +10 -0
- data/docs/StreamLinks.md +10 -0
- data/docs/StreamSDKVersion.md +9 -0
- data/docs/StreamSDKVersionData.md +9 -0
- data/docs/StreamUsageError.md +9 -0
- data/docs/StreamUsageLinks.md +10 -0
- data/docs/StreamUsageMetadata.md +10 -0
- data/docs/StreamUsageSeries.md +9 -0
- data/docs/Streams.md +8 -0
- data/docs/TeamMembersApi.md +7 -6
- data/docs/Usage.md +9 -0
- data/docs/{CustomProperties.md → UsageError.md} +2 -1
- data/docs/UsageLinks.md +10 -0
- data/docs/UserSegmentsApi.md +18 -17
- data/docs/UserSettingsApi.md +11 -11
- data/docs/UsersApi.md +15 -15
- data/docs/Webhook.md +1 -0
- data/docs/WebhookBody.md +2 -0
- data/docs/WebhooksApi.md +7 -6
- data/launchdarkly_api.gemspec +5 -6
- data/lib/launchdarkly_api/api/audit_log_api.rb +13 -19
- data/lib/launchdarkly_api/api/custom_roles_api.rb +23 -37
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +519 -0
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +330 -0
- data/lib/launchdarkly_api/api/environments_api.rb +20 -31
- data/lib/launchdarkly_api/api/feature_flags_api.rb +150 -43
- data/lib/launchdarkly_api/api/projects_api.rb +23 -37
- data/lib/launchdarkly_api/api/root_api.rb +6 -9
- data/lib/launchdarkly_api/api/team_members_api.rb +23 -37
- data/lib/launchdarkly_api/api/user_segments_api.rb +23 -37
- data/lib/launchdarkly_api/api/user_settings_api.rb +12 -21
- data/lib/launchdarkly_api/api/users_api.rb +17 -29
- data/lib/launchdarkly_api/api/webhooks_api.rb +23 -37
- data/lib/launchdarkly_api/api_client.rb +10 -10
- data/lib/launchdarkly_api/api_error.rb +2 -2
- data/lib/launchdarkly_api/configuration.rb +3 -3
- data/lib/launchdarkly_api/models/audit_log_entries.rb +7 -12
- data/lib/launchdarkly_api/models/audit_log_entry.rb +7 -12
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +7 -12
- data/lib/launchdarkly_api/models/clause.rb +7 -12
- data/lib/launchdarkly_api/models/copy_actions.rb +34 -0
- data/lib/launchdarkly_api/models/custom_property.rb +13 -14
- data/lib/launchdarkly_api/models/custom_property_values.rb +7 -11
- data/lib/launchdarkly_api/models/custom_role.rb +9 -13
- data/lib/launchdarkly_api/models/custom_role_body.rb +12 -16
- data/lib/launchdarkly_api/models/custom_roles.rb +11 -14
- data/lib/launchdarkly_api/models/destination.rb +276 -0
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +201 -0
- data/lib/launchdarkly_api/models/destination_body.rb +263 -0
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +192 -0
- data/lib/launchdarkly_api/models/destination_m_particle.rb +210 -0
- data/lib/launchdarkly_api/models/destination_segment.rb +183 -0
- data/lib/launchdarkly_api/models/destinations.rb +194 -0
- data/lib/launchdarkly_api/models/environment.rb +29 -14
- data/lib/launchdarkly_api/models/environment_post.rb +64 -17
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +192 -0
- data/lib/launchdarkly_api/models/{action.rb → events.rb} +17 -13
- data/lib/launchdarkly_api/models/fallthrough.rb +7 -12
- data/lib/launchdarkly_api/models/feature_flag.rb +46 -16
- data/lib/launchdarkly_api/models/feature_flag_body.rb +10 -15
- data/lib/launchdarkly_api/models/feature_flag_config.rb +8 -24
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +226 -0
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +199 -0
- data/lib/launchdarkly_api/models/feature_flag_status.rb +22 -26
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +203 -0
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +236 -0
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +7 -12
- data/lib/launchdarkly_api/models/feature_flags.rb +7 -12
- data/lib/launchdarkly_api/models/id.rb +7 -11
- data/lib/launchdarkly_api/models/link.rb +7 -12
- data/lib/launchdarkly_api/models/links.rb +7 -12
- data/lib/launchdarkly_api/models/ma_uby_category.rb +205 -0
- data/lib/launchdarkly_api/models/mau.rb +205 -0
- data/lib/launchdarkly_api/models/{actions.rb → mau_metadata.rb} +8 -13
- data/lib/launchdarkly_api/models/member.rb +26 -13
- data/lib/launchdarkly_api/models/members.rb +11 -14
- data/lib/launchdarkly_api/models/members_body.rb +9 -14
- data/lib/launchdarkly_api/models/patch_comment.rb +7 -12
- data/lib/launchdarkly_api/models/patch_operation.rb +10 -15
- data/lib/launchdarkly_api/models/policy.rb +40 -17
- data/lib/launchdarkly_api/models/prerequisite.rb +7 -12
- data/lib/launchdarkly_api/models/project.rb +7 -12
- data/lib/launchdarkly_api/models/project_body.rb +30 -15
- data/lib/launchdarkly_api/models/projects.rb +7 -12
- data/lib/launchdarkly_api/models/role.rb +7 -8
- data/lib/launchdarkly_api/models/rollout.rb +17 -13
- data/lib/launchdarkly_api/models/rule.rb +7 -12
- data/lib/launchdarkly_api/models/statement.rb +35 -31
- data/lib/launchdarkly_api/models/statements.rb +7 -12
- data/lib/launchdarkly_api/models/stream.rb +205 -0
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +205 -0
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +192 -0
- data/lib/launchdarkly_api/models/{resources.rb → stream_by_sdk_links_metadata.rb} +34 -12
- data/lib/launchdarkly_api/models/stream_links.rb +204 -0
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +194 -0
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +194 -0
- data/lib/launchdarkly_api/models/stream_usage_error.rb +192 -0
- data/lib/launchdarkly_api/models/stream_usage_links.rb +204 -0
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +203 -0
- data/lib/launchdarkly_api/models/stream_usage_series.rb +194 -0
- data/lib/launchdarkly_api/models/{custom_properties.rb → streams.rb} +17 -13
- data/lib/launchdarkly_api/models/target.rb +7 -12
- data/lib/launchdarkly_api/models/usage.rb +194 -0
- data/lib/launchdarkly_api/models/{custom_role_key_or_id.rb → usage_error.rb} +17 -13
- data/lib/launchdarkly_api/models/usage_links.rb +204 -0
- data/lib/launchdarkly_api/models/user.rb +7 -12
- data/lib/launchdarkly_api/models/user_flag_setting.rb +7 -12
- data/lib/launchdarkly_api/models/user_flag_settings.rb +7 -12
- data/lib/launchdarkly_api/models/user_record.rb +7 -12
- data/lib/launchdarkly_api/models/user_segment.rb +10 -15
- data/lib/launchdarkly_api/models/user_segment_body.rb +9 -14
- data/lib/launchdarkly_api/models/user_segment_rule.rb +7 -12
- data/lib/launchdarkly_api/models/user_segments.rb +7 -12
- data/lib/launchdarkly_api/models/user_settings_body.rb +7 -12
- data/lib/launchdarkly_api/models/users.rb +7 -12
- data/lib/launchdarkly_api/models/variation.rb +8 -13
- data/lib/launchdarkly_api/models/webhook.rb +17 -13
- data/lib/launchdarkly_api/models/webhook_body.rb +33 -17
- data/lib/launchdarkly_api/models/webhooks.rb +7 -12
- data/lib/launchdarkly_api/models/weighted_variation.rb +7 -12
- data/lib/launchdarkly_api/version.rb +3 -3
- data/lib/launchdarkly_api.rb +36 -8
- data/openapi.yml +1004 -115
- data/spec/api/audit_log_api_spec.rb +6 -8
- data/spec/api/custom_roles_api_spec.rb +8 -13
- data/spec/api/customer_metrics_api_spec.rb +141 -0
- data/spec/api/data_export_destinations_api_spec.rb +98 -0
- data/spec/api/environments_api_spec.rb +7 -11
- data/spec/api/feature_flags_api_spec.rb +36 -16
- data/spec/api/projects_api_spec.rb +8 -13
- data/spec/api/root_api_spec.rb +3 -4
- data/spec/api/team_members_api_spec.rb +8 -13
- data/spec/api/user_segments_api_spec.rb +8 -13
- data/spec/api/user_settings_api_spec.rb +5 -8
- data/spec/api/users_api_spec.rb +7 -11
- data/spec/api/webhooks_api_spec.rb +8 -13
- data/spec/api_client_spec.rb +36 -36
- data/spec/configuration_spec.rb +10 -10
- data/spec/models/audit_log_entries_spec.rb +4 -5
- data/spec/models/audit_log_entry_spec.rb +14 -15
- data/spec/models/audit_log_entry_target_spec.rb +5 -6
- data/spec/models/clause_spec.rb +6 -7
- data/spec/models/{action_spec.rb → copy_actions_spec.rb} +8 -9
- data/spec/models/custom_property_spec.rb +4 -5
- data/spec/models/custom_property_values_spec.rb +2 -3
- data/spec/models/custom_role_body_spec.rb +6 -7
- data/spec/models/custom_role_spec.rb +8 -9
- data/spec/models/custom_roles_spec.rb +4 -5
- data/spec/models/destination_amazon_kinesis_spec.rb +53 -0
- data/spec/models/destination_body_spec.rb +63 -0
- data/spec/models/destination_google_pub_sub_spec.rb +47 -0
- data/spec/models/destination_m_particle_spec.rb +59 -0
- data/spec/models/destination_segment_spec.rb +41 -0
- data/spec/models/destination_spec.rb +81 -0
- data/spec/models/destinations_spec.rb +47 -0
- data/spec/models/environment_post_spec.rb +36 -7
- data/spec/models/environment_spec.rb +25 -14
- data/spec/models/evaluation_usage_error_spec.rb +47 -0
- data/spec/models/events_spec.rb +41 -0
- data/spec/models/fallthrough_spec.rb +4 -5
- data/spec/models/feature_flag_body_spec.rb +9 -10
- data/spec/models/feature_flag_config_spec.rb +14 -21
- data/spec/models/feature_flag_copy_body_spec.rb +65 -0
- data/spec/models/feature_flag_copy_object_spec.rb +47 -0
- data/spec/models/feature_flag_spec.rb +35 -18
- data/spec/models/feature_flag_status_across_environments_spec.rb +53 -0
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +57 -0
- data/spec/models/feature_flag_status_spec.rb +14 -15
- data/spec/models/feature_flag_statuses_spec.rb +4 -5
- data/spec/models/feature_flags_spec.rb +4 -5
- data/spec/models/id_spec.rb +2 -3
- data/spec/models/link_spec.rb +4 -5
- data/spec/models/links_spec.rb +4 -5
- data/spec/models/ma_uby_category_spec.rb +53 -0
- data/spec/models/{actions_spec.rb → mau_metadata_spec.rb} +8 -9
- data/spec/models/mau_spec.rb +53 -0
- data/spec/models/member_spec.rb +21 -10
- data/spec/models/members_body_spec.rb +8 -9
- data/spec/models/members_spec.rb +4 -5
- data/spec/models/patch_comment_spec.rb +4 -5
- data/spec/models/patch_operation_spec.rb +5 -6
- data/spec/models/policy_spec.rb +17 -6
- data/spec/models/prerequisite_spec.rb +4 -5
- data/spec/models/project_body_spec.rb +17 -6
- data/spec/models/project_spec.rb +8 -9
- data/spec/models/projects_spec.rb +4 -5
- data/spec/models/role_spec.rb +2 -3
- data/spec/models/rollout_spec.rb +9 -4
- data/spec/models/rule_spec.rb +6 -7
- data/spec/models/statement_spec.rb +13 -14
- data/spec/models/statements_spec.rb +2 -3
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +53 -0
- data/spec/models/stream_by_sdk_links_spec.rb +47 -0
- data/spec/models/stream_by_sdk_spec.rb +53 -0
- data/spec/models/stream_links_spec.rb +53 -0
- data/spec/models/stream_sdk_version_data_spec.rb +47 -0
- data/spec/models/stream_sdk_version_spec.rb +47 -0
- data/spec/models/stream_spec.rb +53 -0
- data/spec/models/stream_usage_error_spec.rb +47 -0
- data/spec/models/stream_usage_links_spec.rb +53 -0
- data/spec/models/stream_usage_metadata_spec.rb +53 -0
- data/spec/models/stream_usage_series_spec.rb +47 -0
- data/spec/models/streams_spec.rb +41 -0
- data/spec/models/target_spec.rb +4 -5
- data/spec/models/usage_error_spec.rb +41 -0
- data/spec/models/usage_links_spec.rb +53 -0
- data/spec/models/usage_spec.rb +47 -0
- data/spec/models/user_flag_setting_spec.rb +5 -6
- data/spec/models/user_flag_settings_spec.rb +4 -5
- data/spec/models/user_record_spec.rb +7 -8
- data/spec/models/user_segment_body_spec.rb +6 -7
- data/spec/models/user_segment_rule_spec.rb +5 -6
- data/spec/models/user_segment_spec.rb +12 -13
- data/spec/models/user_segments_spec.rb +4 -5
- data/spec/models/user_settings_body_spec.rb +3 -4
- data/spec/models/user_spec.rb +13 -14
- data/spec/models/users_spec.rb +5 -6
- data/spec/models/variation_spec.rb +5 -6
- data/spec/models/webhook_body_spec.rb +19 -8
- data/spec/models/webhook_spec.rb +15 -10
- data/spec/models/webhooks_spec.rb +4 -5
- data/spec/models/weighted_variation_spec.rb +4 -5
- data/spec/spec_helper.rb +2 -2
- metadata +187 -74
- data/docs/Resource.md +0 -7
- data/docs/Resources.md +0 -7
- data/lib/launchdarkly_api/models/resource.rb +0 -179
- data/spec/models/custom_properties_spec.rb +0 -36
- data/spec/models/custom_role_key_or_id_spec.rb +0 -36
- data/spec/models/resource_spec.rb +0 -36
- data/spec/models/resources_spec.rb +0 -36
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: 2.0.
|
|
13
|
+
version: 2.0.27
|
|
14
14
|
host: app.launchdarkly.com
|
|
15
15
|
basePath: /api/v2
|
|
16
16
|
schemes:
|
|
@@ -48,7 +48,7 @@ paths:
|
|
|
48
48
|
- $ref: '#/parameters/ProjectPostRequest'
|
|
49
49
|
responses:
|
|
50
50
|
'201':
|
|
51
|
-
$ref: '#/responses/
|
|
51
|
+
$ref: '#/responses/Project2xx'
|
|
52
52
|
'400':
|
|
53
53
|
$ref: '#/responses/Standard400'
|
|
54
54
|
'401':
|
|
@@ -65,7 +65,7 @@ paths:
|
|
|
65
65
|
- $ref: '#/parameters/ProjectKey'
|
|
66
66
|
responses:
|
|
67
67
|
'200':
|
|
68
|
-
$ref: '#/responses/
|
|
68
|
+
$ref: '#/responses/Project2xx'
|
|
69
69
|
'401':
|
|
70
70
|
$ref: '#/responses/Standard401'
|
|
71
71
|
'404':
|
|
@@ -80,7 +80,7 @@ paths:
|
|
|
80
80
|
- $ref: '#/parameters/PatchRequest'
|
|
81
81
|
responses:
|
|
82
82
|
'200':
|
|
83
|
-
$ref: '#/responses/
|
|
83
|
+
$ref: '#/responses/Project2xx'
|
|
84
84
|
'400':
|
|
85
85
|
$ref: '#/responses/Standard400'
|
|
86
86
|
'401':
|
|
@@ -119,7 +119,7 @@ paths:
|
|
|
119
119
|
- $ref: '#/parameters/EnvironmentPostRequest'
|
|
120
120
|
responses:
|
|
121
121
|
'201':
|
|
122
|
-
$ref: '#/responses/
|
|
122
|
+
$ref: '#/responses/Environment2xx'
|
|
123
123
|
'400':
|
|
124
124
|
$ref: '#/responses/Standard400'
|
|
125
125
|
'401':
|
|
@@ -137,9 +137,7 @@ paths:
|
|
|
137
137
|
- $ref: '#/parameters/EnvironmentKey'
|
|
138
138
|
responses:
|
|
139
139
|
'200':
|
|
140
|
-
|
|
141
|
-
schema:
|
|
142
|
-
$ref: '#/definitions/Environment'
|
|
140
|
+
$ref: '#/responses/Environment2xx'
|
|
143
141
|
'401':
|
|
144
142
|
$ref: '#/responses/Standard401'
|
|
145
143
|
'404':
|
|
@@ -155,9 +153,7 @@ paths:
|
|
|
155
153
|
- $ref: '#/parameters/PatchRequest'
|
|
156
154
|
responses:
|
|
157
155
|
'200':
|
|
158
|
-
|
|
159
|
-
schema:
|
|
160
|
-
$ref: '#/definitions/Environment'
|
|
156
|
+
$ref: '#/responses/Environment2xx'
|
|
161
157
|
'400':
|
|
162
158
|
$ref: '#/responses/Standard400'
|
|
163
159
|
'401':
|
|
@@ -190,6 +186,8 @@ paths:
|
|
|
190
186
|
parameters:
|
|
191
187
|
- $ref: '#/parameters/ProjectKey'
|
|
192
188
|
- $ref: '#/parameters/EnvironmentKeyQuery'
|
|
189
|
+
- $ref: '#/parameters/SummaryQuery'
|
|
190
|
+
- $ref: '#/parameters/ArchivedQuery'
|
|
193
191
|
- $ref: '#/parameters/Tag'
|
|
194
192
|
responses:
|
|
195
193
|
'200':
|
|
@@ -278,6 +276,29 @@ paths:
|
|
|
278
276
|
$ref: '#/responses/Standard404'
|
|
279
277
|
tags:
|
|
280
278
|
- Feature flags
|
|
279
|
+
'/flags/{projectKey}/{featureFlagKey}/copy':
|
|
280
|
+
post:
|
|
281
|
+
summary: >-
|
|
282
|
+
Copies the feature flag configuration from one environment to the same
|
|
283
|
+
feature flag in another environment.
|
|
284
|
+
operationId: copyFeatureFlag
|
|
285
|
+
parameters:
|
|
286
|
+
- $ref: '#/parameters/ProjectKey'
|
|
287
|
+
- $ref: '#/parameters/FeatureFlagKey'
|
|
288
|
+
- $ref: '#/parameters/FeatureFlagCopyBody'
|
|
289
|
+
responses:
|
|
290
|
+
'201':
|
|
291
|
+
description: Flag configuration copy response.
|
|
292
|
+
schema:
|
|
293
|
+
$ref: '#/definitions/FeatureFlag'
|
|
294
|
+
'400':
|
|
295
|
+
$ref: '#/responses/Standard400'
|
|
296
|
+
'401':
|
|
297
|
+
$ref: '#/responses/Standard401'
|
|
298
|
+
'409':
|
|
299
|
+
$ref: '#/responses/Standard409'
|
|
300
|
+
tags:
|
|
301
|
+
- Feature flags
|
|
281
302
|
'/flag-statuses/{projectKey}/{environmentKey}':
|
|
282
303
|
get:
|
|
283
304
|
summary: >-
|
|
@@ -314,6 +335,24 @@ paths:
|
|
|
314
335
|
$ref: '#/responses/Standard401'
|
|
315
336
|
tags:
|
|
316
337
|
- Feature flags
|
|
338
|
+
'/flag-status/{projectKey}/{featureFlagKey}':
|
|
339
|
+
get:
|
|
340
|
+
summary: Get the status for a particular feature flag across environments
|
|
341
|
+
operationId: getFeatureFlagStatusAcrossEnvironments
|
|
342
|
+
parameters:
|
|
343
|
+
- $ref: '#/parameters/ProjectKey'
|
|
344
|
+
- $ref: '#/parameters/FeatureFlagKey'
|
|
345
|
+
responses:
|
|
346
|
+
'200':
|
|
347
|
+
description: Status of the requested feature flag across environments
|
|
348
|
+
schema:
|
|
349
|
+
$ref: '#/definitions/FeatureFlagStatusAcrossEnvironments'
|
|
350
|
+
'401':
|
|
351
|
+
$ref: '#/responses/Standard401'
|
|
352
|
+
'403':
|
|
353
|
+
$ref: '#/responses/BetaApi403'
|
|
354
|
+
tags:
|
|
355
|
+
- Feature flags
|
|
317
356
|
'/segments/{projectKey}/{environmentKey}':
|
|
318
357
|
get:
|
|
319
358
|
summary: Get a list of all user segments in the given project.
|
|
@@ -340,7 +379,7 @@ paths:
|
|
|
340
379
|
- $ref: '#/parameters/UserSegmentPostRequest'
|
|
341
380
|
responses:
|
|
342
381
|
'201':
|
|
343
|
-
$ref: '#/responses/
|
|
382
|
+
$ref: '#/responses/UserSegment2xx'
|
|
344
383
|
'400':
|
|
345
384
|
$ref: '#/responses/Standard400'
|
|
346
385
|
'401':
|
|
@@ -359,9 +398,7 @@ paths:
|
|
|
359
398
|
- $ref: '#/parameters/UserSegmentKey'
|
|
360
399
|
responses:
|
|
361
400
|
'200':
|
|
362
|
-
|
|
363
|
-
schema:
|
|
364
|
-
$ref: '#/definitions/UserSegment'
|
|
401
|
+
$ref: '#/responses/UserSegment2xx'
|
|
365
402
|
'401':
|
|
366
403
|
$ref: '#/responses/Standard401'
|
|
367
404
|
'404':
|
|
@@ -378,7 +415,7 @@ paths:
|
|
|
378
415
|
- $ref: '#/parameters/PatchOnly'
|
|
379
416
|
responses:
|
|
380
417
|
'200':
|
|
381
|
-
$ref: '#/responses/
|
|
418
|
+
$ref: '#/responses/UserSegment2xx'
|
|
382
419
|
'400':
|
|
383
420
|
$ref: '#/responses/Standard400'
|
|
384
421
|
'401':
|
|
@@ -609,7 +646,7 @@ paths:
|
|
|
609
646
|
- $ref: '#/parameters/WebhookPostRequest'
|
|
610
647
|
responses:
|
|
611
648
|
'201':
|
|
612
|
-
$ref: '#/responses/
|
|
649
|
+
$ref: '#/responses/Webhook2xx'
|
|
613
650
|
'400':
|
|
614
651
|
$ref: '#/responses/Standard400'
|
|
615
652
|
'401':
|
|
@@ -624,7 +661,7 @@ paths:
|
|
|
624
661
|
- $ref: '#/parameters/ResourceId'
|
|
625
662
|
responses:
|
|
626
663
|
'200':
|
|
627
|
-
$ref: '#/responses/
|
|
664
|
+
$ref: '#/responses/Webhook2xx'
|
|
628
665
|
'401':
|
|
629
666
|
$ref: '#/responses/Standard401'
|
|
630
667
|
'404':
|
|
@@ -639,7 +676,7 @@ paths:
|
|
|
639
676
|
- $ref: '#/parameters/PatchRequest'
|
|
640
677
|
responses:
|
|
641
678
|
'200':
|
|
642
|
-
$ref: '#/responses/
|
|
679
|
+
$ref: '#/responses/Webhook2xx'
|
|
643
680
|
'400':
|
|
644
681
|
$ref: '#/responses/Standard400'
|
|
645
682
|
'401':
|
|
@@ -684,7 +721,7 @@ paths:
|
|
|
684
721
|
- $ref: '#/parameters/CustomRolePostRequest'
|
|
685
722
|
responses:
|
|
686
723
|
'201':
|
|
687
|
-
$ref: '#/responses/
|
|
724
|
+
$ref: '#/responses/CustomRole2xx'
|
|
688
725
|
'400':
|
|
689
726
|
$ref: '#/responses/Standard400'
|
|
690
727
|
'401':
|
|
@@ -701,7 +738,7 @@ paths:
|
|
|
701
738
|
- $ref: '#/parameters/CustomRoleKey'
|
|
702
739
|
responses:
|
|
703
740
|
'200':
|
|
704
|
-
$ref: '#/responses/
|
|
741
|
+
$ref: '#/responses/CustomRole2xx'
|
|
705
742
|
'400':
|
|
706
743
|
$ref: '#/responses/Standard400'
|
|
707
744
|
'401':
|
|
@@ -716,7 +753,7 @@ paths:
|
|
|
716
753
|
- $ref: '#/parameters/PatchRequest'
|
|
717
754
|
responses:
|
|
718
755
|
'200':
|
|
719
|
-
$ref: '#/responses/
|
|
756
|
+
$ref: '#/responses/CustomRole2xx'
|
|
720
757
|
'400':
|
|
721
758
|
$ref: '#/responses/Standard400'
|
|
722
759
|
'401':
|
|
@@ -747,7 +784,7 @@ paths:
|
|
|
747
784
|
operationId: getMembers
|
|
748
785
|
responses:
|
|
749
786
|
'200':
|
|
750
|
-
description:
|
|
787
|
+
description: Members response.
|
|
751
788
|
schema:
|
|
752
789
|
$ref: '#/definitions/Members'
|
|
753
790
|
'401':
|
|
@@ -761,7 +798,9 @@ paths:
|
|
|
761
798
|
- $ref: '#/parameters/MembersPostRequest'
|
|
762
799
|
responses:
|
|
763
800
|
'201':
|
|
764
|
-
|
|
801
|
+
description: Members response.
|
|
802
|
+
schema:
|
|
803
|
+
$ref: '#/definitions/Members'
|
|
765
804
|
'400':
|
|
766
805
|
$ref: '#/responses/Standard400'
|
|
767
806
|
'401':
|
|
@@ -778,7 +817,7 @@ paths:
|
|
|
778
817
|
- $ref: '#/parameters/MemberId'
|
|
779
818
|
responses:
|
|
780
819
|
'200':
|
|
781
|
-
$ref: '#/responses/
|
|
820
|
+
$ref: '#/responses/Member2xx'
|
|
782
821
|
'400':
|
|
783
822
|
$ref: '#/responses/Standard400'
|
|
784
823
|
'401':
|
|
@@ -793,7 +832,7 @@ paths:
|
|
|
793
832
|
- $ref: '#/parameters/PatchRequest'
|
|
794
833
|
responses:
|
|
795
834
|
'200':
|
|
796
|
-
$ref: '#/responses/
|
|
835
|
+
$ref: '#/responses/Member2xx'
|
|
797
836
|
'400':
|
|
798
837
|
$ref: '#/responses/Standard400'
|
|
799
838
|
'401':
|
|
@@ -818,6 +857,245 @@ paths:
|
|
|
818
857
|
$ref: '#/responses/Standard404'
|
|
819
858
|
tags:
|
|
820
859
|
- Team members
|
|
860
|
+
/destinations:
|
|
861
|
+
get:
|
|
862
|
+
summary: Returns a list of all data export destinations.
|
|
863
|
+
operationId: getDestinations
|
|
864
|
+
responses:
|
|
865
|
+
'200':
|
|
866
|
+
description: Destinations response.
|
|
867
|
+
schema:
|
|
868
|
+
$ref: '#/definitions/Destinations'
|
|
869
|
+
'401':
|
|
870
|
+
$ref: '#/responses/Standard401'
|
|
871
|
+
tags:
|
|
872
|
+
- Data export destinations
|
|
873
|
+
'/destinations/{projectKey}/{environmentKey}':
|
|
874
|
+
post:
|
|
875
|
+
summary: Create a new data export destination
|
|
876
|
+
operationId: postDestination
|
|
877
|
+
parameters:
|
|
878
|
+
- $ref: '#/parameters/ProjectKey'
|
|
879
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
880
|
+
- $ref: '#/parameters/DestinationPostRequest'
|
|
881
|
+
responses:
|
|
882
|
+
'201':
|
|
883
|
+
$ref: '#/responses/Destination2xx'
|
|
884
|
+
'400':
|
|
885
|
+
$ref: '#/responses/Standard400'
|
|
886
|
+
'401':
|
|
887
|
+
$ref: '#/responses/Standard401'
|
|
888
|
+
'409':
|
|
889
|
+
$ref: '#/responses/Standard409'
|
|
890
|
+
tags:
|
|
891
|
+
- Data export destinations
|
|
892
|
+
'/destinations/{projectKey}/{environmentKey}/{destinationId}':
|
|
893
|
+
get:
|
|
894
|
+
summary: Get a single data export destination by ID
|
|
895
|
+
operationId: getDestination
|
|
896
|
+
parameters:
|
|
897
|
+
- $ref: '#/parameters/ProjectKey'
|
|
898
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
899
|
+
- $ref: '#/parameters/DestinationId'
|
|
900
|
+
responses:
|
|
901
|
+
'200':
|
|
902
|
+
$ref: '#/responses/Destination2xx'
|
|
903
|
+
'401':
|
|
904
|
+
$ref: '#/responses/Standard401'
|
|
905
|
+
'404':
|
|
906
|
+
$ref: '#/responses/Standard404'
|
|
907
|
+
tags:
|
|
908
|
+
- Data export destinations
|
|
909
|
+
patch:
|
|
910
|
+
summary: Perform a partial update to a data export destination.
|
|
911
|
+
operationId: patchDestination
|
|
912
|
+
parameters:
|
|
913
|
+
- $ref: '#/parameters/ProjectKey'
|
|
914
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
915
|
+
- $ref: '#/parameters/DestinationId'
|
|
916
|
+
- $ref: '#/parameters/PatchOnly'
|
|
917
|
+
responses:
|
|
918
|
+
'200':
|
|
919
|
+
$ref: '#/responses/Destination2xx'
|
|
920
|
+
'400':
|
|
921
|
+
$ref: '#/responses/Standard400'
|
|
922
|
+
'401':
|
|
923
|
+
$ref: '#/responses/Standard401'
|
|
924
|
+
'404':
|
|
925
|
+
$ref: '#/responses/Standard404'
|
|
926
|
+
'409':
|
|
927
|
+
$ref: '#/responses/Standard409'
|
|
928
|
+
tags:
|
|
929
|
+
- Data export destinations
|
|
930
|
+
delete:
|
|
931
|
+
summary: Get a single data export destination by ID
|
|
932
|
+
operationId: deleteDestination
|
|
933
|
+
parameters:
|
|
934
|
+
- $ref: '#/parameters/ProjectKey'
|
|
935
|
+
- $ref: '#/parameters/EnvironmentKey'
|
|
936
|
+
- $ref: '#/parameters/DestinationId'
|
|
937
|
+
responses:
|
|
938
|
+
'204':
|
|
939
|
+
$ref: '#/responses/Standard204'
|
|
940
|
+
'401':
|
|
941
|
+
$ref: '#/responses/Standard401'
|
|
942
|
+
'404':
|
|
943
|
+
$ref: '#/responses/Standard404'
|
|
944
|
+
tags:
|
|
945
|
+
- Data export destinations
|
|
946
|
+
/usage:
|
|
947
|
+
get:
|
|
948
|
+
summary: Returns of the usage endpoints available.
|
|
949
|
+
operationId: getUsage
|
|
950
|
+
responses:
|
|
951
|
+
'200':
|
|
952
|
+
description: Usage endpoints
|
|
953
|
+
schema:
|
|
954
|
+
$ref: '#/definitions/Usage'
|
|
955
|
+
'403':
|
|
956
|
+
$ref: '#/responses/BetaApi403'
|
|
957
|
+
tags:
|
|
958
|
+
- Customer Metrics
|
|
959
|
+
/usage/streams:
|
|
960
|
+
get:
|
|
961
|
+
summary: Returns a list of all streams.
|
|
962
|
+
operationId: getStreams
|
|
963
|
+
responses:
|
|
964
|
+
'200':
|
|
965
|
+
description: Stream usage endpoints
|
|
966
|
+
schema:
|
|
967
|
+
$ref: '#/definitions/Streams'
|
|
968
|
+
'403':
|
|
969
|
+
$ref: '#/responses/BetaApi403'
|
|
970
|
+
tags:
|
|
971
|
+
- Customer Metrics
|
|
972
|
+
'/usage/streams/{source}':
|
|
973
|
+
get:
|
|
974
|
+
summary: Get a stream endpoint and return timeseries data.
|
|
975
|
+
operationId: getStream
|
|
976
|
+
parameters:
|
|
977
|
+
- $ref: '#/parameters/StreamSource'
|
|
978
|
+
responses:
|
|
979
|
+
'200':
|
|
980
|
+
description: Responds with time series data on stream usage.
|
|
981
|
+
schema:
|
|
982
|
+
$ref: '#/definitions/Stream'
|
|
983
|
+
'403':
|
|
984
|
+
$ref: '#/responses/BetaApi403'
|
|
985
|
+
'404':
|
|
986
|
+
$ref: '#/responses/StreamUsage404'
|
|
987
|
+
tags:
|
|
988
|
+
- Customer Metrics
|
|
989
|
+
'/usage/streams/{source}/bysdkversion':
|
|
990
|
+
get:
|
|
991
|
+
summary: Get a stream timeseries data by source show sdk version metadata.
|
|
992
|
+
operationId: getStreamBySDK
|
|
993
|
+
parameters:
|
|
994
|
+
- $ref: '#/parameters/StreamSource'
|
|
995
|
+
responses:
|
|
996
|
+
'200':
|
|
997
|
+
description: Returns timeseries data and metadata on sdk version.
|
|
998
|
+
schema:
|
|
999
|
+
$ref: '#/definitions/StreamBySDK'
|
|
1000
|
+
'403':
|
|
1001
|
+
$ref: '#/responses/BetaApi403'
|
|
1002
|
+
'404':
|
|
1003
|
+
$ref: '#/responses/StreamUsage404'
|
|
1004
|
+
tags:
|
|
1005
|
+
- Customer Metrics
|
|
1006
|
+
'/usage/streams/{source}/sdkversions':
|
|
1007
|
+
get:
|
|
1008
|
+
summary: >-
|
|
1009
|
+
Get a stream timeseries data by source and show all sdk version
|
|
1010
|
+
associated.
|
|
1011
|
+
operationId: getStreamSDKVersion
|
|
1012
|
+
parameters:
|
|
1013
|
+
- $ref: '#/parameters/StreamSource'
|
|
1014
|
+
responses:
|
|
1015
|
+
'200':
|
|
1016
|
+
description: Returns timeseries data and all sdk versions.
|
|
1017
|
+
schema:
|
|
1018
|
+
$ref: '#/definitions/StreamSDKVersion'
|
|
1019
|
+
'403':
|
|
1020
|
+
$ref: '#/responses/BetaApi403'
|
|
1021
|
+
'404':
|
|
1022
|
+
$ref: '#/responses/StreamUsage404'
|
|
1023
|
+
tags:
|
|
1024
|
+
- Customer Metrics
|
|
1025
|
+
/usage/mau:
|
|
1026
|
+
get:
|
|
1027
|
+
summary: Get monthly active user data.
|
|
1028
|
+
operationId: getMAU
|
|
1029
|
+
responses:
|
|
1030
|
+
'200':
|
|
1031
|
+
description: Returns timeseries data and all sdk versions.
|
|
1032
|
+
schema:
|
|
1033
|
+
$ref: '#/definitions/MAU'
|
|
1034
|
+
'403':
|
|
1035
|
+
$ref: '#/responses/BetaApi403'
|
|
1036
|
+
tags:
|
|
1037
|
+
- Customer Metrics
|
|
1038
|
+
/usage/mau/bycategory:
|
|
1039
|
+
get:
|
|
1040
|
+
summary: Get monthly active user data by category.
|
|
1041
|
+
operationId: getMAUByCategory
|
|
1042
|
+
responses:
|
|
1043
|
+
'200':
|
|
1044
|
+
description: Returns timeseries data and all sdk versions.
|
|
1045
|
+
schema:
|
|
1046
|
+
$ref: '#/definitions/MAUbyCategory'
|
|
1047
|
+
'403':
|
|
1048
|
+
$ref: '#/responses/BetaApi403'
|
|
1049
|
+
tags:
|
|
1050
|
+
- Customer Metrics
|
|
1051
|
+
/usage/events:
|
|
1052
|
+
get:
|
|
1053
|
+
summary: Get events usage endpoints.
|
|
1054
|
+
operationId: getEvents
|
|
1055
|
+
responses:
|
|
1056
|
+
'200':
|
|
1057
|
+
description: Returns timeseries data and all sdk versions.
|
|
1058
|
+
schema:
|
|
1059
|
+
$ref: '#/definitions/Events'
|
|
1060
|
+
'403':
|
|
1061
|
+
$ref: '#/responses/BetaApi403'
|
|
1062
|
+
tags:
|
|
1063
|
+
- Customer Metrics
|
|
1064
|
+
'/usage/events/{type}':
|
|
1065
|
+
get:
|
|
1066
|
+
summary: Get events usage by event type.
|
|
1067
|
+
operationId: getEvent
|
|
1068
|
+
parameters:
|
|
1069
|
+
- $ref: '#/parameters/EventType'
|
|
1070
|
+
responses:
|
|
1071
|
+
'200':
|
|
1072
|
+
description: Returns timeseries data and all sdk versions.
|
|
1073
|
+
schema:
|
|
1074
|
+
$ref: '#/definitions/StreamSDKVersion'
|
|
1075
|
+
'403':
|
|
1076
|
+
$ref: '#/responses/BetaApi403'
|
|
1077
|
+
'404':
|
|
1078
|
+
$ref: '#/responses/StreamUsage404'
|
|
1079
|
+
tags:
|
|
1080
|
+
- Customer Metrics
|
|
1081
|
+
'/usage/evaluations/{envId}/{flagKey}':
|
|
1082
|
+
get:
|
|
1083
|
+
summary: Get events usage by event id and the feature flag key.
|
|
1084
|
+
operationId: getEvaluations
|
|
1085
|
+
parameters:
|
|
1086
|
+
- $ref: '#/parameters/EvaluationEnvId'
|
|
1087
|
+
- $ref: '#/parameters/EvaluationFlagKey'
|
|
1088
|
+
responses:
|
|
1089
|
+
'200':
|
|
1090
|
+
description: Returns timeseries data and all sdk versions.
|
|
1091
|
+
schema:
|
|
1092
|
+
$ref: '#/definitions/StreamSDKVersion'
|
|
1093
|
+
'403':
|
|
1094
|
+
$ref: '#/responses/BetaApi403'
|
|
1095
|
+
'404':
|
|
1096
|
+
$ref: '#/responses/EvaluationUsage404'
|
|
1097
|
+
tags:
|
|
1098
|
+
- Customer Metrics
|
|
821
1099
|
/:
|
|
822
1100
|
get:
|
|
823
1101
|
description: >-
|
|
@@ -874,6 +1152,8 @@ definitions:
|
|
|
874
1152
|
type: string
|
|
875
1153
|
description: The name of the webhook.
|
|
876
1154
|
example: Example hook
|
|
1155
|
+
statements:
|
|
1156
|
+
$ref: '#/definitions/Statements'
|
|
877
1157
|
tags:
|
|
878
1158
|
type: array
|
|
879
1159
|
description: Tags assigned to this webhook.
|
|
@@ -939,11 +1219,31 @@ definitions:
|
|
|
939
1219
|
example:
|
|
940
1220
|
- value: a
|
|
941
1221
|
- value: b
|
|
1222
|
+
goalIds:
|
|
1223
|
+
type: array
|
|
1224
|
+
description: An array goals from all environments associated with this feature flag
|
|
1225
|
+
items:
|
|
1226
|
+
type: string
|
|
1227
|
+
example:
|
|
1228
|
+
- d7239405bd89c930e885aa76
|
|
1229
|
+
- 405bc930e88d7239d895aa76
|
|
942
1230
|
_version:
|
|
943
1231
|
type: integer
|
|
944
1232
|
example: 23
|
|
945
1233
|
customProperties:
|
|
946
|
-
|
|
1234
|
+
type: object
|
|
1235
|
+
description: A mapping of keys to CustomProperty entries.
|
|
1236
|
+
additionalProperties:
|
|
1237
|
+
$ref: '#/definitions/CustomProperty'
|
|
1238
|
+
example:
|
|
1239
|
+
bugs:
|
|
1240
|
+
name: Issue tracker ids
|
|
1241
|
+
value:
|
|
1242
|
+
- '123'
|
|
1243
|
+
- '456'
|
|
1244
|
+
deprecated:
|
|
1245
|
+
name: Deprecated Date
|
|
1246
|
+
value: []
|
|
947
1247
|
_links:
|
|
948
1248
|
$ref: '#/definitions/Links'
|
|
949
1249
|
_maintainer:
|
|
@@ -952,6 +1252,17 @@ definitions:
|
|
|
952
1252
|
type: object
|
|
953
1253
|
additionalProperties:
|
|
954
1254
|
$ref: '#/definitions/FeatureFlagConfig'
|
|
1255
|
+
archivedDate:
|
|
1256
|
+
type: number
|
|
1257
|
+
format: int64
|
|
1258
|
+
description: >-
|
|
1259
|
+
A unix epoch time in milliseconds specifying the archived time of this
|
|
1260
|
+
flag.
|
|
1261
|
+
example: 1443652232590
|
|
1262
|
+
archived:
|
|
1263
|
+
type: boolean
|
|
1264
|
+
description: Whether or not this flag is archived.
|
|
1265
|
+
example: false
|
|
955
1266
|
FeatureFlags:
|
|
956
1267
|
type: object
|
|
957
1268
|
properties:
|
|
@@ -973,6 +1284,12 @@ definitions:
|
|
|
973
1284
|
email:
|
|
974
1285
|
type: string
|
|
975
1286
|
example: user@launchdarkly.com
|
|
1287
|
+
firstName:
|
|
1288
|
+
type: string
|
|
1289
|
+
example: Alan
|
|
1290
|
+
lastName:
|
|
1291
|
+
type: string
|
|
1292
|
+
example: Turing
|
|
976
1293
|
_pendingInvite:
|
|
977
1294
|
type: boolean
|
|
978
1295
|
isBeta:
|
|
@@ -987,7 +1304,9 @@ definitions:
|
|
|
987
1304
|
_links:
|
|
988
1305
|
$ref: '#/definitions/Links'
|
|
989
1306
|
items:
|
|
990
|
-
|
|
1307
|
+
type: array
|
|
1308
|
+
items:
|
|
1309
|
+
$ref: '#/definitions/Member'
|
|
991
1310
|
FeatureFlagConfig:
|
|
992
1311
|
type: object
|
|
993
1312
|
properties:
|
|
@@ -1012,13 +1331,6 @@ definitions:
|
|
|
1012
1331
|
type: array
|
|
1013
1332
|
items:
|
|
1014
1333
|
$ref: '#/definitions/Target'
|
|
1015
|
-
goalIds:
|
|
1016
|
-
type: array
|
|
1017
|
-
example:
|
|
1018
|
-
- d7239405bd89c930e885aa76
|
|
1019
|
-
- 405bc930e88d7239d895aa76
|
|
1020
|
-
items:
|
|
1021
|
-
type: string
|
|
1022
1334
|
rules:
|
|
1023
1335
|
type: array
|
|
1024
1336
|
items:
|
|
@@ -1068,6 +1380,8 @@ definitions:
|
|
|
1068
1380
|
Rollout:
|
|
1069
1381
|
type: object
|
|
1070
1382
|
properties:
|
|
1383
|
+
bucketBy:
|
|
1384
|
+
type: string
|
|
1071
1385
|
variations:
|
|
1072
1386
|
type: array
|
|
1073
1387
|
items:
|
|
@@ -1118,8 +1432,6 @@ definitions:
|
|
|
1118
1432
|
FeatureFlagStatus:
|
|
1119
1433
|
type: object
|
|
1120
1434
|
properties:
|
|
1121
|
-
_links:
|
|
1122
|
-
$ref: '#/definitions/Links'
|
|
1123
1435
|
name:
|
|
1124
1436
|
type: string
|
|
1125
1437
|
description: >
|
|
@@ -1149,6 +1461,8 @@ definitions:
|
|
|
1149
1461
|
example: '2016-08-16T21:10:11.886Z'
|
|
1150
1462
|
default:
|
|
1151
1463
|
type: object
|
|
1464
|
+
_links:
|
|
1465
|
+
$ref: '#/definitions/Links'
|
|
1152
1466
|
FeatureFlagStatuses:
|
|
1153
1467
|
type: object
|
|
1154
1468
|
properties:
|
|
@@ -1158,6 +1472,49 @@ definitions:
|
|
|
1158
1472
|
type: array
|
|
1159
1473
|
items:
|
|
1160
1474
|
$ref: '#/definitions/FeatureFlagStatus'
|
|
1475
|
+
FeatureFlagStatusForQueriedEnvironment:
|
|
1476
|
+
type: object
|
|
1477
|
+
properties:
|
|
1478
|
+
name:
|
|
1479
|
+
type: string
|
|
1480
|
+
description: >
|
|
1481
|
+
| Name | Description |
|
|
1482
|
+
|
|
1483
|
+
| --------:| ----------- |
|
|
1484
|
+
|
|
1485
|
+
| new | the feature flag was created within the last 7 days, and
|
|
1486
|
+
has not been requested yet |
|
|
1487
|
+
|
|
1488
|
+
| active | the feature flag was requested by your servers or clients
|
|
1489
|
+
within the last 7 days |
|
|
1490
|
+
|
|
1491
|
+
| inactive | the feature flag was created more than 7 days ago, and
|
|
1492
|
+
hasn't been requested by your servers or clients within the past 7
|
|
1493
|
+
days |
|
|
1494
|
+
|
|
1495
|
+
| launched | one variation of the feature flag has been rolled out to
|
|
1496
|
+
all your users for at least 7 days |
|
|
1497
|
+
enum:
|
|
1498
|
+
- new
|
|
1499
|
+
- active
|
|
1500
|
+
- inactive
|
|
1501
|
+
- launched
|
|
1502
|
+
lastRequested:
|
|
1503
|
+
type: string
|
|
1504
|
+
example: '2016-08-16T21:10:11.886Z'
|
|
1505
|
+
default:
|
|
1506
|
+
type: object
|
|
1507
|
+
FeatureFlagStatusAcrossEnvironments:
|
|
1508
|
+
type: object
|
|
1509
|
+
properties:
|
|
1510
|
+
_links:
|
|
1511
|
+
$ref: '#/definitions/Links'
|
|
1512
|
+
key:
|
|
1513
|
+
type: string
|
|
1514
|
+
environments:
|
|
1515
|
+
type: object
|
|
1516
|
+
additionalProperties:
|
|
1517
|
+
$ref: '#/definitions/FeatureFlagStatusForQueriedEnvironment'
|
|
1161
1518
|
UserSegment:
|
|
1162
1519
|
type: object
|
|
1163
1520
|
required:
|
|
@@ -1266,39 +1623,127 @@ definitions:
|
|
|
1266
1623
|
type: array
|
|
1267
1624
|
items:
|
|
1268
1625
|
$ref: '#/definitions/Project'
|
|
1269
|
-
|
|
1626
|
+
Destination:
|
|
1270
1627
|
type: object
|
|
1271
1628
|
properties:
|
|
1272
1629
|
_links:
|
|
1273
1630
|
$ref: '#/definitions/Links'
|
|
1274
1631
|
_id:
|
|
1275
|
-
$ref: '#/definitions/Id'
|
|
1276
|
-
key:
|
|
1277
1632
|
type: string
|
|
1278
|
-
example:
|
|
1279
|
-
description:
|
|
1633
|
+
example: 37ed9aad-de0a-4665-932e-41c35587aeea
|
|
1634
|
+
description: Unique destination ID.
|
|
1280
1635
|
name:
|
|
1281
1636
|
type: string
|
|
1282
|
-
example:
|
|
1283
|
-
description: The name
|
|
1284
|
-
|
|
1285
|
-
type: string
|
|
1286
|
-
example: XXX
|
|
1287
|
-
description: The SDK key for backend LaunchDarkly SDKs.
|
|
1288
|
-
mobileKey:
|
|
1289
|
-
type: string
|
|
1290
|
-
example: XXX
|
|
1291
|
-
description: The SDK key for mobile LaunchDarkly SDKs.
|
|
1292
|
-
color:
|
|
1637
|
+
example: Example Google Pub/Sub Destination
|
|
1638
|
+
description: The destination name
|
|
1639
|
+
kind:
|
|
1293
1640
|
type: string
|
|
1294
|
-
example:
|
|
1295
|
-
description:
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1641
|
+
example: google-pubsub
|
|
1642
|
+
description: >-
|
|
1643
|
+
Destination type ("google-pubsub", "kinesis", "mparticle", or
|
|
1644
|
+
"segment")
|
|
1645
|
+
enum:
|
|
1646
|
+
- google-pubsub
|
|
1647
|
+
- kinesis
|
|
1648
|
+
- mparticle
|
|
1649
|
+
- segment
|
|
1650
|
+
config:
|
|
1651
|
+
type: object
|
|
1652
|
+
description: destination-specific configuration.
|
|
1653
|
+
example:
|
|
1654
|
+
project: cool-project
|
|
1655
|
+
topic: test
|
|
1656
|
+
'on':
|
|
1657
|
+
type: boolean
|
|
1658
|
+
example: true
|
|
1659
|
+
description: Whether the data export destination is on or not.
|
|
1660
|
+
version:
|
|
1661
|
+
type: integer
|
|
1662
|
+
example: 2
|
|
1663
|
+
Destinations:
|
|
1664
|
+
type: object
|
|
1665
|
+
properties:
|
|
1666
|
+
_links:
|
|
1667
|
+
$ref: '#/definitions/Links'
|
|
1668
|
+
items:
|
|
1669
|
+
type: array
|
|
1670
|
+
items:
|
|
1671
|
+
$ref: '#/definitions/Destination'
|
|
1672
|
+
DestinationGooglePubSub:
|
|
1673
|
+
type: object
|
|
1674
|
+
properties:
|
|
1675
|
+
project:
|
|
1676
|
+
type: string
|
|
1677
|
+
example: cool-project
|
|
1678
|
+
topic:
|
|
1679
|
+
type: string
|
|
1680
|
+
example: test
|
|
1681
|
+
DestinationAmazonKinesis:
|
|
1682
|
+
type: object
|
|
1683
|
+
properties:
|
|
1684
|
+
region:
|
|
1685
|
+
type: string
|
|
1686
|
+
example: us-east-1
|
|
1687
|
+
roleArn:
|
|
1688
|
+
type: string
|
|
1689
|
+
example: 'arn:aws:iam::123456789012:role/marketingadmin'
|
|
1690
|
+
streamName:
|
|
1691
|
+
type: string
|
|
1692
|
+
example: cat-stream
|
|
1693
|
+
DestinationMParticle:
|
|
1694
|
+
type: object
|
|
1695
|
+
properties:
|
|
1696
|
+
apiKey:
|
|
1697
|
+
type: string
|
|
1698
|
+
example: apiKeyfromMParticle
|
|
1699
|
+
secret:
|
|
1700
|
+
type: string
|
|
1701
|
+
example: mParticleSecret
|
|
1702
|
+
userIdentity:
|
|
1703
|
+
type: string
|
|
1704
|
+
example: customer_id
|
|
1705
|
+
environment:
|
|
1706
|
+
type: string
|
|
1707
|
+
example: production
|
|
1708
|
+
DestinationSegment:
|
|
1709
|
+
type: object
|
|
1710
|
+
properties:
|
|
1711
|
+
writeKey:
|
|
1712
|
+
type: string
|
|
1713
|
+
example: segmentWriteKey
|
|
1714
|
+
Environment:
|
|
1715
|
+
type: object
|
|
1716
|
+
properties:
|
|
1717
|
+
_links:
|
|
1718
|
+
$ref: '#/definitions/Links'
|
|
1719
|
+
_id:
|
|
1720
|
+
$ref: '#/definitions/Id'
|
|
1721
|
+
key:
|
|
1722
|
+
type: string
|
|
1723
|
+
example: production
|
|
1724
|
+
description: The key for the environment.
|
|
1725
|
+
name:
|
|
1726
|
+
type: string
|
|
1727
|
+
example: Production
|
|
1728
|
+
description: The name of the environment.
|
|
1729
|
+
apiKey:
|
|
1730
|
+
type: string
|
|
1731
|
+
example: XXX
|
|
1732
|
+
description: The SDK key for backend LaunchDarkly SDKs.
|
|
1733
|
+
mobileKey:
|
|
1734
|
+
type: string
|
|
1735
|
+
example: XXX
|
|
1736
|
+
description: The SDK key for mobile LaunchDarkly SDKs.
|
|
1737
|
+
color:
|
|
1738
|
+
type: string
|
|
1739
|
+
example: '417505'
|
|
1740
|
+
description: The swatch color for the environment.
|
|
1741
|
+
defaultTtl:
|
|
1742
|
+
type: number
|
|
1743
|
+
example: 0
|
|
1744
|
+
description: The default TTL.
|
|
1745
|
+
secureMode:
|
|
1746
|
+
type: boolean
|
|
1302
1747
|
example: false
|
|
1303
1748
|
description: Determines if this environment is in safe mode.
|
|
1304
1749
|
defaultTrackEvents:
|
|
@@ -1310,6 +1755,18 @@ definitions:
|
|
|
1310
1755
|
items:
|
|
1311
1756
|
type: string
|
|
1312
1757
|
description: An array of tags for this environment.
|
|
1758
|
+
requireComments:
|
|
1759
|
+
type: boolean
|
|
1760
|
+
example: false
|
|
1761
|
+
description: >-
|
|
1762
|
+
Determines if this environment requires comments for flag and segment
|
|
1763
|
+
changes.
|
|
1764
|
+
confirmChanges:
|
|
1765
|
+
type: boolean
|
|
1766
|
+
example: false
|
|
1767
|
+
description: >-
|
|
1768
|
+
Determines if this environment requires confirmation for flag and
|
|
1769
|
+
segment changes.
|
|
1313
1770
|
EnvironmentPost:
|
|
1314
1771
|
type: object
|
|
1315
1772
|
properties:
|
|
@@ -1329,6 +1786,36 @@ definitions:
|
|
|
1329
1786
|
type: number
|
|
1330
1787
|
description: The default TTL for the new environment.
|
|
1331
1788
|
example: 0
|
|
1789
|
+
secureMode:
|
|
1790
|
+
type: boolean
|
|
1791
|
+
description: Determines whether the environment is in secure mode.
|
|
1792
|
+
example: false
|
|
1793
|
+
defaultTrackEvents:
|
|
1794
|
+
type: boolean
|
|
1795
|
+
description: >-
|
|
1796
|
+
Set to true to send detailed event information for newly created
|
|
1797
|
+
flags.
|
|
1798
|
+
example: false
|
|
1799
|
+
tags:
|
|
1800
|
+
type: array
|
|
1801
|
+
description: An array of tags for this environment.
|
|
1802
|
+
items:
|
|
1803
|
+
type: string
|
|
1804
|
+
example:
|
|
1805
|
+
- tag1
|
|
1806
|
+
- tag2
|
|
1807
|
+
requireComments:
|
|
1808
|
+
type: boolean
|
|
1809
|
+
description: >-
|
|
1810
|
+
Determines if this environment requires comments for flag and segment
|
|
1811
|
+
changes.
|
|
1812
|
+
example: false
|
|
1813
|
+
confirmChanges:
|
|
1814
|
+
type: boolean
|
|
1815
|
+
description: >-
|
|
1816
|
+
Determines if this environment requires confirmation for flag and
|
|
1817
|
+
segment changes.
|
|
1818
|
+
example: false
|
|
1332
1819
|
required:
|
|
1333
1820
|
- name
|
|
1334
1821
|
- key
|
|
@@ -1503,16 +1990,32 @@ definitions:
|
|
|
1503
1990
|
type: object
|
|
1504
1991
|
properties:
|
|
1505
1992
|
resources:
|
|
1506
|
-
|
|
1507
|
-
|
|
1508
|
-
|
|
1993
|
+
type: array
|
|
1994
|
+
items:
|
|
1995
|
+
type: string
|
|
1996
|
+
description: A resource specifier string
|
|
1997
|
+
example: 'proj/*:env/*:flag/my-flag'
|
|
1998
|
+
notResources:
|
|
1999
|
+
type: array
|
|
2000
|
+
items:
|
|
2001
|
+
type: string
|
|
2002
|
+
description: A resource specifier string
|
|
2003
|
+
example: 'proj/*:env/*:flag/my-flag'
|
|
1509
2004
|
description: >-
|
|
1510
2005
|
Targeted resource will be those resources NOT in this list. The
|
|
1511
2006
|
"resources`" field must be empty to use this field.
|
|
1512
2007
|
actions:
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
2008
|
+
type: array
|
|
2009
|
+
items:
|
|
2010
|
+
type: string
|
|
2011
|
+
description: An action to perform on a resource.
|
|
2012
|
+
example: updateOn
|
|
2013
|
+
notActions:
|
|
2014
|
+
type: array
|
|
2015
|
+
items:
|
|
2016
|
+
type: string
|
|
2017
|
+
description: An action to perform on a resource.
|
|
2018
|
+
example: updateOn
|
|
1516
2019
|
description: >-
|
|
1517
2020
|
Targeted actions will be those actions NOT in this list. The "actions"
|
|
1518
2021
|
field must be empty to use this field.
|
|
@@ -1521,22 +2024,6 @@ definitions:
|
|
|
1521
2024
|
enum:
|
|
1522
2025
|
- allow
|
|
1523
2026
|
- deny
|
|
1524
|
-
Resources:
|
|
1525
|
-
type: array
|
|
1526
|
-
items:
|
|
1527
|
-
$ref: '#/definitions/Resource'
|
|
1528
|
-
Resource:
|
|
1529
|
-
type: string
|
|
1530
|
-
description: A resource specifier string
|
|
1531
|
-
example: 'proj/*:env/*:flag/my-flag'
|
|
1532
|
-
Actions:
|
|
1533
|
-
type: array
|
|
1534
|
-
items:
|
|
1535
|
-
$ref: '#/definitions/Action'
|
|
1536
|
-
Action:
|
|
1537
|
-
type: string
|
|
1538
|
-
description: An action to perform on a resource.
|
|
1539
|
-
example: updateOn
|
|
1540
2027
|
Role:
|
|
1541
2028
|
type: string
|
|
1542
2029
|
enum:
|
|
@@ -1544,10 +2031,6 @@ definitions:
|
|
|
1544
2031
|
- reader
|
|
1545
2032
|
- admin
|
|
1546
2033
|
- owner
|
|
1547
|
-
CustomRoleKeyOrId:
|
|
1548
|
-
type: string
|
|
1549
|
-
description: The 20-hexdigit id or the key for a custom role.
|
|
1550
|
-
example: revenue-team
|
|
1551
2034
|
CustomRole:
|
|
1552
2035
|
type: object
|
|
1553
2036
|
properties:
|
|
@@ -1558,7 +2041,9 @@ definitions:
|
|
|
1558
2041
|
description: Name of the custom role.
|
|
1559
2042
|
example: revenue team
|
|
1560
2043
|
key:
|
|
1561
|
-
|
|
2044
|
+
type: string
|
|
2045
|
+
description: The 20-hexdigit id or the key for a custom role.
|
|
2046
|
+
example: revenue-team
|
|
1562
2047
|
description:
|
|
1563
2048
|
type: string
|
|
1564
2049
|
description: Description of the custom role.
|
|
@@ -1575,14 +2060,42 @@ definitions:
|
|
|
1575
2060
|
_links:
|
|
1576
2061
|
$ref: '#/definitions/Links'
|
|
1577
2062
|
items:
|
|
1578
|
-
|
|
2063
|
+
type: array
|
|
2064
|
+
items:
|
|
2065
|
+
$ref: '#/definitions/CustomRole'
|
|
1579
2066
|
Policy:
|
|
1580
2067
|
type: object
|
|
1581
2068
|
properties:
|
|
1582
2069
|
resources:
|
|
1583
|
-
|
|
2070
|
+
type: array
|
|
2071
|
+
items:
|
|
2072
|
+
type: string
|
|
2073
|
+
description: A resource specifier string
|
|
2074
|
+
example: 'proj/*:env/*:flag/my-flag'
|
|
2075
|
+
notResources:
|
|
2076
|
+
type: array
|
|
2077
|
+
items:
|
|
2078
|
+
type: string
|
|
2079
|
+
description: A resource specifier string
|
|
2080
|
+
example: 'proj/*:env/*:flag/my-flag'
|
|
2081
|
+
description: >-
|
|
2082
|
+
Targeted resource will be those resources NOT in this list. The
|
|
2083
|
+
"resources`" field must be empty to use this field.
|
|
1584
2084
|
actions:
|
|
1585
|
-
|
|
2085
|
+
type: array
|
|
2086
|
+
items:
|
|
2087
|
+
type: string
|
|
2088
|
+
description: An action to perform on a resource.
|
|
2089
|
+
example: updateOn
|
|
2090
|
+
notActions:
|
|
2091
|
+
type: array
|
|
2092
|
+
items:
|
|
2093
|
+
type: string
|
|
2094
|
+
description: An action to perform on a resource.
|
|
2095
|
+
example: updateOn
|
|
2096
|
+
description: >-
|
|
2097
|
+
Targeted actions will be those actions NOT in this list. The "actions"
|
|
2098
|
+
field must be empty to use this field.
|
|
1586
2099
|
effect:
|
|
1587
2100
|
type: string
|
|
1588
2101
|
description: Effect of the policy - allow or deny.
|
|
@@ -1606,20 +2119,6 @@ definitions:
|
|
|
1606
2119
|
- op
|
|
1607
2120
|
- path
|
|
1608
2121
|
- value
|
|
1609
|
-
CustomProperties:
|
|
1610
|
-
type: object
|
|
1611
|
-
description: A mapping of keys to CustomProperty entries.
|
|
1612
|
-
items:
|
|
1613
|
-
$ref: '#/definitions/CustomProperty'
|
|
1614
|
-
example:
|
|
1615
|
-
bugs:
|
|
1616
|
-
name: Issue tracker ids
|
|
1617
|
-
value:
|
|
1618
|
-
- '123'
|
|
1619
|
-
- '456'
|
|
1620
|
-
deprecated:
|
|
1621
|
-
name: Deprecated Date
|
|
1622
|
-
value: []
|
|
1623
2122
|
CustomProperty:
|
|
1624
2123
|
type: object
|
|
1625
2124
|
description: A name and value describing a custom property.
|
|
@@ -1629,7 +2128,13 @@ definitions:
|
|
|
1629
2128
|
description: The name of the property.
|
|
1630
2129
|
example: My property
|
|
1631
2130
|
value:
|
|
1632
|
-
|
|
2131
|
+
type: array
|
|
2132
|
+
description: Values for this property.
|
|
2133
|
+
items:
|
|
2134
|
+
type: string
|
|
2135
|
+
example:
|
|
2136
|
+
- Value 1
|
|
2137
|
+
- Value 2
|
|
1633
2138
|
required:
|
|
1634
2139
|
- name
|
|
1635
2140
|
CustomPropertyValues:
|
|
@@ -1640,6 +2145,234 @@ definitions:
|
|
|
1640
2145
|
example:
|
|
1641
2146
|
- Value 1
|
|
1642
2147
|
- Value 2
|
|
2148
|
+
UsageLinks:
|
|
2149
|
+
type: object
|
|
2150
|
+
properties:
|
|
2151
|
+
parent:
|
|
2152
|
+
$ref: '#/definitions/Link'
|
|
2153
|
+
self:
|
|
2154
|
+
$ref: '#/definitions/Link'
|
|
2155
|
+
subseries:
|
|
2156
|
+
type: array
|
|
2157
|
+
description: The following links that are in the response.
|
|
2158
|
+
items:
|
|
2159
|
+
$ref: '#/definitions/Link'
|
|
2160
|
+
StreamLinks:
|
|
2161
|
+
type: object
|
|
2162
|
+
properties:
|
|
2163
|
+
parent:
|
|
2164
|
+
$ref: '#/definitions/Link'
|
|
2165
|
+
self:
|
|
2166
|
+
$ref: '#/definitions/Link'
|
|
2167
|
+
subseries:
|
|
2168
|
+
type: array
|
|
2169
|
+
description: Links to endpoints that are in the request path.
|
|
2170
|
+
items:
|
|
2171
|
+
$ref: '#/definitions/Link'
|
|
2172
|
+
Usage:
|
|
2173
|
+
type: object
|
|
2174
|
+
properties:
|
|
2175
|
+
_links:
|
|
2176
|
+
$ref: '#/definitions/UsageLinks'
|
|
2177
|
+
series:
|
|
2178
|
+
type: array
|
|
2179
|
+
items:
|
|
2180
|
+
$ref: '#/definitions/StreamUsageSeries'
|
|
2181
|
+
UsageError:
|
|
2182
|
+
type: object
|
|
2183
|
+
properties:
|
|
2184
|
+
message:
|
|
2185
|
+
type: string
|
|
2186
|
+
example: >-
|
|
2187
|
+
This is a beta API, you must pass beta in the LD-API-Version header to
|
|
2188
|
+
use it.
|
|
2189
|
+
Streams:
|
|
2190
|
+
type: object
|
|
2191
|
+
properties:
|
|
2192
|
+
_links:
|
|
2193
|
+
$ref: '#/definitions/StreamUsageLinks'
|
|
2194
|
+
Stream:
|
|
2195
|
+
type: object
|
|
2196
|
+
properties:
|
|
2197
|
+
_links:
|
|
2198
|
+
$ref: '#/definitions/StreamUsageLinks'
|
|
2199
|
+
metadata:
|
|
2200
|
+
type: array
|
|
2201
|
+
items:
|
|
2202
|
+
$ref: '#/definitions/StreamUsageMetadata'
|
|
2203
|
+
series:
|
|
2204
|
+
type: array
|
|
2205
|
+
items:
|
|
2206
|
+
$ref: '#/definitions/StreamUsageSeries'
|
|
2207
|
+
StreamUsageLinks:
|
|
2208
|
+
type: object
|
|
2209
|
+
properties:
|
|
2210
|
+
parent:
|
|
2211
|
+
$ref: '#/definitions/Link'
|
|
2212
|
+
self:
|
|
2213
|
+
$ref: '#/definitions/Link'
|
|
2214
|
+
subseries:
|
|
2215
|
+
type: array
|
|
2216
|
+
description: The following links that are in the response.
|
|
2217
|
+
items:
|
|
2218
|
+
$ref: '#/definitions/Link'
|
|
2219
|
+
StreamUsageSeries:
|
|
2220
|
+
type: object
|
|
2221
|
+
properties:
|
|
2222
|
+
'0':
|
|
2223
|
+
type: number
|
|
2224
|
+
format: int64
|
|
2225
|
+
description: A key corresponding to a time series data point.
|
|
2226
|
+
example: 0
|
|
2227
|
+
time:
|
|
2228
|
+
type: number
|
|
2229
|
+
format: int64
|
|
2230
|
+
description: >-
|
|
2231
|
+
A unix epoch time in milliseconds specifying the creation time of this
|
|
2232
|
+
flag.
|
|
2233
|
+
example: 1551740400000
|
|
2234
|
+
StreamUsageMetadata:
|
|
2235
|
+
type: object
|
|
2236
|
+
properties:
|
|
2237
|
+
sdk:
|
|
2238
|
+
type: string
|
|
2239
|
+
description: The language of the sdk
|
|
2240
|
+
example: ruby
|
|
2241
|
+
version:
|
|
2242
|
+
type: string
|
|
2243
|
+
description: The version of the SDK
|
|
2244
|
+
example: 5.4.3
|
|
2245
|
+
source:
|
|
2246
|
+
type: string
|
|
2247
|
+
example: server
|
|
2248
|
+
StreamUsageError:
|
|
2249
|
+
type: object
|
|
2250
|
+
properties:
|
|
2251
|
+
code:
|
|
2252
|
+
type: string
|
|
2253
|
+
example: not_found
|
|
2254
|
+
message:
|
|
2255
|
+
type: string
|
|
2256
|
+
example: Stream source not found
|
|
2257
|
+
StreamBySDK:
|
|
2258
|
+
type: object
|
|
2259
|
+
properties:
|
|
2260
|
+
_links:
|
|
2261
|
+
$ref: '#/definitions/StreamBySDKLinks'
|
|
2262
|
+
metadata:
|
|
2263
|
+
type: array
|
|
2264
|
+
items:
|
|
2265
|
+
$ref: '#/definitions/StreamBySDKLinksMetadata'
|
|
2266
|
+
series:
|
|
2267
|
+
type: array
|
|
2268
|
+
items:
|
|
2269
|
+
$ref: '#/definitions/StreamUsageSeries'
|
|
2270
|
+
StreamBySDKLinks:
|
|
2271
|
+
type: object
|
|
2272
|
+
properties:
|
|
2273
|
+
parent:
|
|
2274
|
+
$ref: '#/definitions/Link'
|
|
2275
|
+
self:
|
|
2276
|
+
$ref: '#/definitions/Link'
|
|
2277
|
+
StreamBySDKLinksMetadata:
|
|
2278
|
+
type: object
|
|
2279
|
+
properties:
|
|
2280
|
+
sdk:
|
|
2281
|
+
type: string
|
|
2282
|
+
example: ruby
|
|
2283
|
+
version:
|
|
2284
|
+
type: string
|
|
2285
|
+
example: 5.4.3
|
|
2286
|
+
source:
|
|
2287
|
+
type: string
|
|
2288
|
+
example: server
|
|
2289
|
+
StreamSDKVersion:
|
|
2290
|
+
type: object
|
|
2291
|
+
properties:
|
|
2292
|
+
_links:
|
|
2293
|
+
$ref: '#/definitions/StreamBySDKLinks'
|
|
2294
|
+
sdkVersions:
|
|
2295
|
+
type: array
|
|
2296
|
+
items:
|
|
2297
|
+
$ref: '#/definitions/StreamSDKVersionData'
|
|
2298
|
+
StreamSDKVersionData:
|
|
2299
|
+
type: object
|
|
2300
|
+
properties:
|
|
2301
|
+
sdk:
|
|
2302
|
+
type: string
|
|
2303
|
+
description: The language of the sdk
|
|
2304
|
+
example: ruby
|
|
2305
|
+
version:
|
|
2306
|
+
type: string
|
|
2307
|
+
description: The version of the sdk
|
|
2308
|
+
example: 5.4.3
|
|
2309
|
+
MAU:
|
|
2310
|
+
type: object
|
|
2311
|
+
properties:
|
|
2312
|
+
_links:
|
|
2313
|
+
$ref: '#/definitions/UsageLinks'
|
|
2314
|
+
metadata:
|
|
2315
|
+
type: array
|
|
2316
|
+
items:
|
|
2317
|
+
$ref: '#/definitions/StreamBySDKLinksMetadata'
|
|
2318
|
+
series:
|
|
2319
|
+
type: array
|
|
2320
|
+
items:
|
|
2321
|
+
$ref: '#/definitions/StreamUsageSeries'
|
|
2322
|
+
MAUbyCategory:
|
|
2323
|
+
type: object
|
|
2324
|
+
properties:
|
|
2325
|
+
_links:
|
|
2326
|
+
$ref: '#/definitions/StreamBySDKLinks'
|
|
2327
|
+
metadata:
|
|
2328
|
+
type: array
|
|
2329
|
+
items:
|
|
2330
|
+
$ref: '#/definitions/MAUMetadata'
|
|
2331
|
+
series:
|
|
2332
|
+
type: array
|
|
2333
|
+
items:
|
|
2334
|
+
$ref: '#/definitions/StreamUsageSeries'
|
|
2335
|
+
MAUMetadata:
|
|
2336
|
+
type: object
|
|
2337
|
+
Events:
|
|
2338
|
+
type: object
|
|
2339
|
+
properties:
|
|
2340
|
+
links:
|
|
2341
|
+
$ref: '#/definitions/UsageLinks'
|
|
2342
|
+
EvaluationUsageError:
|
|
2343
|
+
type: object
|
|
2344
|
+
properties:
|
|
2345
|
+
code:
|
|
2346
|
+
type: string
|
|
2347
|
+
example: not_found
|
|
2348
|
+
message:
|
|
2349
|
+
type: string
|
|
2350
|
+
example: unknown environment
|
|
2351
|
+
FeatureFlagCopyObject:
|
|
2352
|
+
type: object
|
|
2353
|
+
properties:
|
|
2354
|
+
key:
|
|
2355
|
+
type: string
|
|
2356
|
+
description: The environment key to be used.
|
|
2357
|
+
example: staging
|
|
2358
|
+
currentVersion:
|
|
2359
|
+
type: integer
|
|
2360
|
+
description: >-
|
|
2361
|
+
If the latest version of the flag matches provided version it will
|
|
2362
|
+
copy, otherwise it will return a conflict.
|
|
2363
|
+
example: 65
|
|
2364
|
+
required:
|
|
2365
|
+
- key
|
|
2366
|
+
CopyActions:
|
|
2367
|
+
type: string
|
|
2368
|
+
example: []
|
|
2369
|
+
enum:
|
|
2370
|
+
- updateOn
|
|
2371
|
+
- updatePrerequisites
|
|
2372
|
+
- updateTargets
|
|
2373
|
+
- updateRules
|
|
2374
|
+
- updateFallthrough
|
|
2375
|
+
- updateOffVariation
|
|
1643
2376
|
responses:
|
|
1644
2377
|
Standard201:
|
|
1645
2378
|
description: Resource created.
|
|
@@ -1657,26 +2390,48 @@ responses:
|
|
|
1657
2390
|
description: A list of links to available resources in the API.
|
|
1658
2391
|
schema:
|
|
1659
2392
|
$ref: '#/definitions/Links'
|
|
1660
|
-
|
|
2393
|
+
Webhook2xx:
|
|
1661
2394
|
description: Webhook response.
|
|
1662
2395
|
schema:
|
|
1663
2396
|
$ref: '#/definitions/Webhook'
|
|
1664
|
-
|
|
2397
|
+
UserSegment2xx:
|
|
1665
2398
|
description: User segment response.
|
|
1666
2399
|
schema:
|
|
1667
2400
|
$ref: '#/definitions/UserSegment'
|
|
1668
|
-
|
|
2401
|
+
Project2xx:
|
|
1669
2402
|
description: Successful Project response.
|
|
1670
2403
|
schema:
|
|
1671
2404
|
$ref: '#/definitions/Project'
|
|
1672
|
-
|
|
2405
|
+
Member2xx:
|
|
1673
2406
|
description: Member response.
|
|
1674
2407
|
schema:
|
|
1675
2408
|
$ref: '#/definitions/Member'
|
|
1676
|
-
|
|
2409
|
+
CustomRole2xx:
|
|
1677
2410
|
description: Custom role response.
|
|
1678
2411
|
schema:
|
|
1679
2412
|
$ref: '#/definitions/CustomRole'
|
|
2413
|
+
BetaApi403:
|
|
2414
|
+
description: >-
|
|
2415
|
+
This is a beta API, you must pass beta in the LD-API-Version header to use
|
|
2416
|
+
it.
|
|
2417
|
+
schema:
|
|
2418
|
+
$ref: '#/definitions/UsageError'
|
|
2419
|
+
StreamUsage404:
|
|
2420
|
+
description: The stream source you requested could not be found
|
|
2421
|
+
schema:
|
|
2422
|
+
$ref: '#/definitions/StreamUsageError'
|
|
2423
|
+
EvaluationUsage404:
|
|
2424
|
+
description: The environment or flag you requested could not be found
|
|
2425
|
+
schema:
|
|
2426
|
+
$ref: '#/definitions/EvaluationUsageError'
|
|
2427
|
+
Environment2xx:
|
|
2428
|
+
description: Environment response.
|
|
2429
|
+
schema:
|
|
2430
|
+
$ref: '#/definitions/Environment'
|
|
2431
|
+
Destination2xx:
|
|
2432
|
+
description: Destination response.
|
|
2433
|
+
schema:
|
|
2434
|
+
$ref: '#/definitions/Destination'
|
|
1680
2435
|
parameters:
|
|
1681
2436
|
ResourceId:
|
|
1682
2437
|
name: resourceId
|
|
@@ -1715,10 +2470,44 @@ parameters:
|
|
|
1715
2470
|
type: string
|
|
1716
2471
|
example: Example hook
|
|
1717
2472
|
description: The name of the webhook.
|
|
2473
|
+
statements:
|
|
2474
|
+
$ref: '#/definitions/Statements'
|
|
2475
|
+
tags:
|
|
2476
|
+
type: array
|
|
2477
|
+
items:
|
|
2478
|
+
type: string
|
|
2479
|
+
example: []
|
|
2480
|
+
description: Tags for the webhook.
|
|
1718
2481
|
required:
|
|
1719
2482
|
- url
|
|
1720
2483
|
- sign
|
|
1721
2484
|
- 'on'
|
|
2485
|
+
FeatureFlagCopyBody:
|
|
2486
|
+
name: featureFlagCopyBody
|
|
2487
|
+
in: body
|
|
2488
|
+
required: true
|
|
2489
|
+
description: Copy feature flag configurations between environments.
|
|
2490
|
+
schema:
|
|
2491
|
+
type: object
|
|
2492
|
+
properties:
|
|
2493
|
+
source:
|
|
2494
|
+
$ref: '#/definitions/FeatureFlagCopyObject'
|
|
2495
|
+
target:
|
|
2496
|
+
$ref: '#/definitions/FeatureFlagCopyObject'
|
|
2497
|
+
comment:
|
|
2498
|
+
type: string
|
|
2499
|
+
description: comment will be included in audit log item for change.
|
|
2500
|
+
example: This is a comment string
|
|
2501
|
+
includedActions:
|
|
2502
|
+
type: array
|
|
2503
|
+
items:
|
|
2504
|
+
$ref: '#/definitions/CopyActions'
|
|
2505
|
+
description: Define the parts of the flag configuration that will be copied.
|
|
2506
|
+
excludedActions:
|
|
2507
|
+
type: array
|
|
2508
|
+
items:
|
|
2509
|
+
$ref: '#/definitions/CopyActions'
|
|
2510
|
+
description: Define the parts of the flag configuration that will not be copied.
|
|
1722
2511
|
FeatureFlagPostRequest:
|
|
1723
2512
|
name: featureFlagBody
|
|
1724
2513
|
in: body
|
|
@@ -1764,6 +2553,43 @@ parameters:
|
|
|
1764
2553
|
- name
|
|
1765
2554
|
- key
|
|
1766
2555
|
- variations
|
|
2556
|
+
DestinationPostRequest:
|
|
2557
|
+
name: destinationBody
|
|
2558
|
+
in: body
|
|
2559
|
+
required: true
|
|
2560
|
+
description: Create a new data export destination.
|
|
2561
|
+
schema:
|
|
2562
|
+
type: object
|
|
2563
|
+
properties:
|
|
2564
|
+
name:
|
|
2565
|
+
type: string
|
|
2566
|
+
description: A human-readable name for your data export destination.
|
|
2567
|
+
example: Example Google Pub/Sub Destination
|
|
2568
|
+
kind:
|
|
2569
|
+
type: string
|
|
2570
|
+
description: >-
|
|
2571
|
+
The data export destination type. Available choices are kinesis,
|
|
2572
|
+
google-pubsub, mparticle, or segment.
|
|
2573
|
+
example: google-pubsub
|
|
2574
|
+
enum:
|
|
2575
|
+
- google-pubsub
|
|
2576
|
+
- kinesis
|
|
2577
|
+
- mparticle
|
|
2578
|
+
- segment
|
|
2579
|
+
config:
|
|
2580
|
+
type: object
|
|
2581
|
+
description: destination-specific configuration.
|
|
2582
|
+
example:
|
|
2583
|
+
project: cool-project
|
|
2584
|
+
topic: test
|
|
2585
|
+
'on':
|
|
2586
|
+
type: boolean
|
|
2587
|
+
example: true
|
|
2588
|
+
description: Whether the data export destination is on or not.
|
|
2589
|
+
required:
|
|
2590
|
+
- name
|
|
2591
|
+
- kind
|
|
2592
|
+
- config
|
|
1767
2593
|
UserSegmentPostRequest:
|
|
1768
2594
|
name: userSegmentBody
|
|
1769
2595
|
in: body
|
|
@@ -1809,6 +2635,16 @@ parameters:
|
|
|
1809
2635
|
key:
|
|
1810
2636
|
type: string
|
|
1811
2637
|
example: new-project
|
|
2638
|
+
includeInSnippetByDefault:
|
|
2639
|
+
type: boolean
|
|
2640
|
+
example: false
|
|
2641
|
+
tags:
|
|
2642
|
+
type: array
|
|
2643
|
+
items:
|
|
2644
|
+
type: string
|
|
2645
|
+
example:
|
|
2646
|
+
- ops
|
|
2647
|
+
- dev
|
|
1812
2648
|
environments:
|
|
1813
2649
|
type: array
|
|
1814
2650
|
items:
|
|
@@ -1850,6 +2686,24 @@ parameters:
|
|
|
1850
2686
|
setting env=production will restrict the returned configurations to just
|
|
1851
2687
|
your production environment.
|
|
1852
2688
|
type: string
|
|
2689
|
+
SummaryQuery:
|
|
2690
|
+
name: summary
|
|
2691
|
+
in: query
|
|
2692
|
+
required: false
|
|
2693
|
+
description: >-
|
|
2694
|
+
By default in api version >= 1, flags will _not_ include their list of
|
|
2695
|
+
prerequisites, targets or rules. Set summary=0 to include these fields
|
|
2696
|
+
for each flag returned.
|
|
2697
|
+
type: boolean
|
|
2698
|
+
ArchivedQuery:
|
|
2699
|
+
name: archived
|
|
2700
|
+
in: query
|
|
2701
|
+
required: false
|
|
2702
|
+
description: >-
|
|
2703
|
+
When set to 1, archived flags will be included in the list of flags
|
|
2704
|
+
returned. By default, archived flags are not included in the list of
|
|
2705
|
+
flags.
|
|
2706
|
+
type: boolean
|
|
1853
2707
|
FeatureFlagKey:
|
|
1854
2708
|
name: featureFlagKey
|
|
1855
2709
|
in: path
|
|
@@ -1872,6 +2726,12 @@ parameters:
|
|
|
1872
2726
|
required: true
|
|
1873
2727
|
description: The user segment's key. The key identifies the user segment in your code.
|
|
1874
2728
|
type: string
|
|
2729
|
+
DestinationId:
|
|
2730
|
+
name: destinationId
|
|
2731
|
+
in: path
|
|
2732
|
+
required: true
|
|
2733
|
+
description: The data export destination ID.
|
|
2734
|
+
type: string
|
|
1875
2735
|
UserKey:
|
|
1876
2736
|
name: userKey
|
|
1877
2737
|
in: path
|
|
@@ -1922,7 +2782,7 @@ parameters:
|
|
|
1922
2782
|
A timestamp filter, expressed as a Unix epoch time in milliseconds. All
|
|
1923
2783
|
entries returned will have occured after this timestamp.
|
|
1924
2784
|
format: int64
|
|
1925
|
-
type:
|
|
2785
|
+
type: integer
|
|
1926
2786
|
PatchRequest:
|
|
1927
2787
|
name: patchDelta
|
|
1928
2788
|
in: body
|
|
@@ -1953,7 +2813,8 @@ parameters:
|
|
|
1953
2813
|
description: >-
|
|
1954
2814
|
A timestamp filter, expressed as a Unix epoch time in milliseconds. All
|
|
1955
2815
|
entries returned will have before this timestamp.
|
|
1956
|
-
|
|
2816
|
+
format: int64
|
|
2817
|
+
type: integer
|
|
1957
2818
|
Q:
|
|
1958
2819
|
name: q
|
|
1959
2820
|
in: query
|
|
@@ -2003,7 +2864,9 @@ parameters:
|
|
|
2003
2864
|
customRoles:
|
|
2004
2865
|
type: array
|
|
2005
2866
|
items:
|
|
2006
|
-
|
|
2867
|
+
type: string
|
|
2868
|
+
description: The 20-hexdigit id or the key for a custom role.
|
|
2869
|
+
example: revenue-team
|
|
2007
2870
|
inlineRole:
|
|
2008
2871
|
$ref: '#/definitions/Statements'
|
|
2009
2872
|
required:
|
|
@@ -2031,7 +2894,9 @@ parameters:
|
|
|
2031
2894
|
description: Description of the custom role.
|
|
2032
2895
|
example: Description of revenue team role here
|
|
2033
2896
|
key:
|
|
2034
|
-
|
|
2897
|
+
type: string
|
|
2898
|
+
description: The 20-hexdigit id or the key for a custom role.
|
|
2899
|
+
example: revenue-team
|
|
2035
2900
|
policy:
|
|
2036
2901
|
type: array
|
|
2037
2902
|
items:
|
|
@@ -2079,4 +2944,28 @@ parameters:
|
|
|
2079
2944
|
type: array
|
|
2080
2945
|
items:
|
|
2081
2946
|
$ref: '#/definitions/PatchOperation'
|
|
2947
|
+
StreamSource:
|
|
2948
|
+
name: source
|
|
2949
|
+
in: path
|
|
2950
|
+
required: true
|
|
2951
|
+
description: The source of where the stream comes from.
|
|
2952
|
+
type: string
|
|
2953
|
+
EventType:
|
|
2954
|
+
name: type
|
|
2955
|
+
in: path
|
|
2956
|
+
required: true
|
|
2957
|
+
description: The type of event we would like to track.
|
|
2958
|
+
type: string
|
|
2959
|
+
EvaluationEnvId:
|
|
2960
|
+
name: envId
|
|
2961
|
+
in: path
|
|
2962
|
+
required: true
|
|
2963
|
+
description: The environment id for the flag evaluations in question.
|
|
2964
|
+
type: string
|
|
2965
|
+
EvaluationFlagKey:
|
|
2966
|
+
name: flagKey
|
|
2967
|
+
in: path
|
|
2968
|
+
required: true
|
|
2969
|
+
description: The key of the flag we want metrics for.
|
|
2970
|
+
type: string
|
|
2082
2971
|
|