launchdarkly_api 5.4.0 → 6.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/Gemfile +3 -1
- data/README.md +304 -261
- data/Rakefile +2 -0
- data/docs/AccessDeniedReasonRep.md +28 -0
- data/docs/AccessDeniedRep.md +20 -0
- data/docs/AccessRep.md +18 -0
- data/docs/AccessTokenPost.md +30 -0
- data/docs/AccessTokensApi.md +239 -126
- data/docs/AccountMembersApi.md +376 -0
- data/docs/AccountUsageBetaApi.md +647 -0
- data/docs/ApprovalSettings.md +32 -0
- data/docs/ApprovalsApi.md +554 -0
- data/docs/AuditLogApi.md +93 -55
- data/docs/AuditLogEntryListingRep.md +52 -0
- data/docs/AuditLogEntryListingRepCollection.md +20 -0
- data/docs/AuditLogEntryRep.md +64 -0
- data/docs/AuthorizedAppDataRep.md +26 -0
- data/docs/BigSegmentTarget.md +22 -0
- data/docs/BranchCollectionRep.md +20 -0
- data/docs/BranchRep.md +28 -0
- data/docs/Clause.md +21 -7
- data/docs/ClientSideAvailability.md +15 -4
- data/docs/ClientSideAvailabilityPost.md +20 -0
- data/docs/CodeReferencesApi.md +975 -0
- data/docs/ConfidenceIntervalRep.md +20 -0
- data/docs/Conflict.md +20 -0
- data/docs/CopiedFromEnv.md +20 -0
- data/docs/CreateCopyFlagConfigApprovalRequestRequest.md +28 -0
- data/docs/CreateFlagConfigApprovalRequestRequest.md +30 -0
- data/docs/CustomProperty.md +15 -4
- data/docs/CustomRole.md +25 -8
- data/docs/CustomRolePost.md +24 -0
- data/docs/CustomRolePostData.md +24 -0
- data/docs/CustomRoles.md +15 -4
- data/docs/CustomRolesApi.md +197 -101
- data/docs/DataExportDestinationsApi.md +205 -117
- data/docs/DefaultClientSideAvailabilityPost.md +20 -0
- data/docs/Defaults.md +15 -4
- data/docs/DependentFlag.md +19 -6
- data/docs/DependentFlagEnvironment.md +19 -6
- data/docs/DependentFlagsByEnvironment.md +17 -5
- data/docs/Destination.md +27 -9
- data/docs/DestinationPost.md +24 -0
- data/docs/Destinations.md +15 -4
- data/docs/Environment.md +35 -16
- data/docs/EnvironmentPost.md +29 -11
- data/docs/EnvironmentsApi.md +246 -144
- data/docs/ExperimentAllocationRep.md +20 -0
- data/docs/ExperimentEnabledPeriodRep.md +20 -0
- data/docs/ExperimentEnvironmentSettingRep.md +22 -0
- data/docs/ExperimentInfoRep.md +20 -0
- data/docs/ExperimentMetadataRep.md +18 -0
- data/docs/ExperimentRep.md +24 -0
- data/docs/ExperimentResultsRep.md +28 -0
- data/docs/ExperimentStatsRep.md +24 -0
- data/docs/ExperimentTimeSeriesSlice.md +20 -0
- data/docs/ExperimentTimeSeriesVariationSlice.md +32 -0
- data/docs/ExperimentTotalsRep.md +32 -0
- data/docs/ExperimentsBetaApi.md +168 -0
- data/docs/ExpiringUserTargetError.md +20 -0
- data/docs/ExpiringUserTargetGetResponse.md +20 -0
- data/docs/ExpiringUserTargetItem.md +30 -0
- data/docs/ExpiringUserTargetPatchResponse.md +28 -0
- data/docs/Extinction.md +26 -0
- data/docs/ExtinctionCollectionRep.md +20 -0
- data/docs/ExtinctionRep.md +26 -0
- data/docs/FeatureFlag.md +55 -22
- data/docs/FeatureFlagBody.md +33 -11
- data/docs/FeatureFlagConfig.md +47 -17
- data/docs/FeatureFlagScheduledChange.md +27 -6
- data/docs/FeatureFlagScheduledChanges.md +15 -4
- data/docs/FeatureFlagStatus.md +17 -6
- data/docs/FeatureFlagStatusAcrossEnvironments.md +17 -5
- data/docs/FeatureFlagStatuses.md +15 -4
- data/docs/FeatureFlags.md +17 -5
- data/docs/FeatureFlagsApi.md +451 -1184
- data/docs/FeatureFlagsBetaApi.md +157 -0
- data/docs/FlagConfigApprovalRequestResponse.md +54 -0
- data/docs/FlagConfigApprovalRequestsResponse.md +20 -0
- data/docs/FlagCopyConfigEnvironment.md +20 -0
- data/docs/FlagCopyConfigPost.md +26 -0
- data/docs/FlagGlobalAttributesRep.md +58 -0
- data/docs/FlagListingRep.md +24 -0
- data/docs/FlagScheduledChangesInput.md +20 -0
- data/docs/FlagStatusRep.md +24 -0
- data/docs/FlagSummary.md +18 -0
- data/docs/HunkRep.md +26 -0
- data/docs/InlineObject.md +26 -0
- data/docs/InlineObject1.md +28 -0
- data/docs/InlineResponse200.md +20 -0
- data/docs/IntegrationMetadata.md +24 -0
- data/docs/IntegrationStatus.md +20 -0
- data/docs/IpList.md +20 -0
- data/docs/LastSeenMetadata.md +18 -0
- data/docs/Link.md +15 -4
- data/docs/Member.md +45 -14
- data/docs/MemberDataRep.md +26 -0
- data/docs/MemberPermissionGrantSummaryRep.md +22 -0
- data/docs/MemberSummaryRep.md +28 -0
- data/docs/MemberTeamSummaryRep.md +22 -0
- data/docs/Members.md +17 -5
- data/docs/MetricCollectionRep.md +20 -0
- data/docs/MetricListingRep.md +52 -0
- data/docs/MetricPost.md +40 -0
- data/docs/MetricRep.md +62 -0
- data/docs/MetricsApi.md +376 -0
- data/docs/Modification.md +18 -0
- data/docs/MultiEnvironmentDependentFlag.md +17 -7
- data/docs/MultiEnvironmentDependentFlags.md +17 -5
- data/docs/NewMemberForm.md +28 -0
- data/docs/OtherApi.md +282 -0
- data/docs/ParentResourceRep.md +22 -0
- data/docs/PatchOperation.md +17 -5
- data/docs/PatchSegmentInstruction.md +26 -0
- data/docs/PatchSegmentRequest.md +20 -0
- data/docs/PatchWithComment.md +20 -0
- data/docs/PostApprovalRequestApplyRequest.md +18 -0
- data/docs/PostApprovalRequestReviewRequest.md +20 -0
- data/docs/PostFlagScheduledChangesInput.md +22 -0
- data/docs/Prerequisite.md +15 -4
- data/docs/Project.md +27 -10
- data/docs/ProjectListingRep.md +30 -0
- data/docs/ProjectPost.md +28 -0
- data/docs/Projects.md +15 -4
- data/docs/ProjectsApi.md +196 -100
- data/docs/PubNubDetailRep.md +20 -0
- data/docs/ReferenceRep.md +22 -0
- data/docs/RelayAutoConfigCollectionRep.md +18 -0
- data/docs/RelayAutoConfigPost.md +20 -0
- data/docs/RelayAutoConfigRep.md +34 -0
- data/docs/RelayProxyConfigurationsApi.md +244 -129
- data/docs/RepositoryCollectionRep.md +20 -0
- data/docs/RepositoryPost.md +28 -0
- data/docs/RepositoryRep.md +38 -0
- data/docs/ResourceAccess.md +20 -0
- data/docs/ResourceIDResponse.md +26 -0
- data/docs/ReviewResponse.md +26 -0
- data/docs/Rollout.md +19 -4
- data/docs/Rule.md +23 -8
- data/docs/ScheduledChangesApi.md +404 -0
- data/docs/SdkListRep.md +20 -0
- data/docs/SdkVersionListRep.md +20 -0
- data/docs/SdkVersionRep.md +20 -0
- data/docs/SegmentBody.md +26 -0
- data/docs/SegmentMetadata.md +28 -0
- data/docs/SegmentUserList.md +20 -0
- data/docs/SegmentUserState.md +20 -0
- data/docs/SegmentsApi.md +695 -0
- data/docs/SeriesListRep.md +22 -0
- data/docs/SourceFlag.md +20 -0
- data/docs/Statement.md +21 -7
- data/docs/StatementPost.md +26 -0
- data/docs/StatementPostData.md +26 -0
- data/docs/StatementRep.md +26 -0
- data/docs/StatisticCollectionRep.md +20 -0
- data/docs/StatisticRep.md +30 -0
- data/docs/StatisticsRoot.md +20 -0
- data/docs/SubjectDataRep.md +22 -0
- data/docs/Target.md +15 -4
- data/docs/TargetResourceRep.md +22 -0
- data/docs/TitleRep.md +32 -0
- data/docs/Token.md +43 -17
- data/docs/TokenDataRep.md +26 -0
- data/docs/Tokens.md +15 -4
- data/docs/UrlPost.md +24 -0
- data/docs/User.md +25 -13
- data/docs/UserAttributeNamesRep.md +22 -0
- data/docs/UserFlagSetting.md +17 -5
- data/docs/UserFlagSettings.md +15 -4
- data/docs/UserRecord.md +21 -7
- data/docs/UserSegment.md +47 -14
- data/docs/UserSegmentRule.md +19 -5
- data/docs/UserSegments.md +15 -4
- data/docs/UserSettingsApi.md +217 -137
- data/docs/Users.md +17 -5
- data/docs/UsersApi.md +184 -115
- data/docs/UsersBetaApi.md +81 -0
- data/docs/ValuePut.md +20 -0
- data/docs/Variate.md +24 -0
- data/docs/Variation.md +19 -6
- data/docs/VariationOrRolloutRep.md +20 -0
- data/docs/VariationSummary.md +30 -0
- data/docs/VersionsRep.md +24 -0
- data/docs/Webhook.md +29 -10
- data/docs/WebhookPost.md +30 -0
- data/docs/Webhooks.md +15 -4
- data/docs/WebhooksApi.md +199 -103
- data/docs/WeightedVariation.md +17 -4
- data/git_push.sh +12 -10
- data/launchdarkly_api.gemspec +6 -14
- data/lib/launchdarkly_api/api/access_tokens_api.rb +190 -122
- data/lib/launchdarkly_api/api/account_members_api.rb +351 -0
- data/lib/launchdarkly_api/api/account_usage_beta_api.rb +598 -0
- data/lib/launchdarkly_api/api/approvals_api.rb +601 -0
- data/lib/launchdarkly_api/api/audit_log_api.rb +72 -51
- data/lib/launchdarkly_api/api/code_references_api.rb +898 -0
- data/lib/launchdarkly_api/api/custom_roles_api.rb +163 -106
- data/lib/launchdarkly_api/api/data_export_destinations_api.rb +202 -145
- data/lib/launchdarkly_api/api/environments_api.rb +197 -132
- data/lib/launchdarkly_api/api/experiments_beta_api.rb +188 -0
- data/lib/launchdarkly_api/api/feature_flags_api.rb +487 -1390
- data/lib/launchdarkly_api/api/feature_flags_beta_api.rb +166 -0
- data/lib/launchdarkly_api/api/metrics_api.rb +369 -0
- data/lib/launchdarkly_api/api/other_api.rb +248 -0
- data/lib/launchdarkly_api/api/projects_api.rb +147 -90
- data/lib/launchdarkly_api/api/relay_proxy_configurations_api.rb +195 -127
- data/lib/launchdarkly_api/api/scheduled_changes_api.rb +435 -0
- data/lib/launchdarkly_api/api/segments_api.rb +719 -0
- data/lib/launchdarkly_api/api/user_settings_api.rb +237 -180
- data/lib/launchdarkly_api/api/users_api.rb +180 -138
- data/lib/launchdarkly_api/api/users_beta_api.rb +91 -0
- data/lib/launchdarkly_api/api/webhooks_api.rb +170 -113
- data/lib/launchdarkly_api/api_client.rb +87 -88
- data/lib/launchdarkly_api/api_error.rb +23 -4
- data/lib/launchdarkly_api/configuration.rb +83 -15
- data/lib/launchdarkly_api/models/access_denied_reason_rep.rb +276 -0
- data/lib/launchdarkly_api/models/access_denied_rep.rb +237 -0
- data/lib/launchdarkly_api/models/access_rep.rb +225 -0
- data/lib/launchdarkly_api/models/access_token_post.rb +317 -0
- data/lib/launchdarkly_api/models/approval_settings.rb +331 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb +420 -0
- data/lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb +241 -0
- data/lib/launchdarkly_api/models/audit_log_entry_rep.rb +481 -0
- data/lib/launchdarkly_api/models/authorized_app_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/big_segment_target.rb +254 -0
- data/lib/launchdarkly_api/models/branch_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/branch_rep.rb +267 -0
- data/lib/launchdarkly_api/models/clause.rb +78 -24
- data/lib/launchdarkly_api/models/client_side_availability.rb +65 -33
- data/lib/launchdarkly_api/models/client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/confidence_interval_rep.rb +227 -0
- data/lib/launchdarkly_api/models/conflict.rb +230 -0
- data/lib/launchdarkly_api/models/copied_from_env.rb +233 -0
- data/lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb +281 -0
- data/lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb +297 -0
- data/lib/launchdarkly_api/models/custom_property.rb +59 -23
- data/lib/launchdarkly_api/models/custom_role.rb +101 -34
- data/lib/launchdarkly_api/models/custom_role_post.rb +265 -0
- data/lib/launchdarkly_api/models/custom_role_post_data.rb +265 -0
- data/lib/launchdarkly_api/models/custom_roles.rb +58 -22
- data/lib/launchdarkly_api/models/default_client_side_availability_post.rb +237 -0
- data/lib/launchdarkly_api/models/defaults.rb +56 -25
- data/lib/launchdarkly_api/models/dependent_flag.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flag_environment.rb +76 -25
- data/lib/launchdarkly_api/models/dependent_flags_by_environment.rb +75 -24
- data/lib/launchdarkly_api/models/destination.rb +88 -47
- data/lib/launchdarkly_api/models/destination_post.rb +281 -0
- data/lib/launchdarkly_api/models/destinations.rb +58 -22
- data/lib/launchdarkly_api/models/environment.rb +144 -73
- data/lib/launchdarkly_api/models/environment_post.rb +90 -56
- data/lib/launchdarkly_api/models/experiment_allocation_rep.rb +237 -0
- data/lib/launchdarkly_api/models/experiment_enabled_period_rep.rb +227 -0
- data/lib/launchdarkly_api/models/experiment_environment_setting_rep.rb +238 -0
- data/lib/launchdarkly_api/models/experiment_info_rep.rb +239 -0
- data/lib/launchdarkly_api/models/experiment_metadata_rep.rb +219 -0
- data/lib/launchdarkly_api/models/experiment_rep.rb +249 -0
- data/lib/launchdarkly_api/models/experiment_results_rep.rb +271 -0
- data/lib/launchdarkly_api/models/experiment_stats_rep.rb +245 -0
- data/lib/launchdarkly_api/models/experiment_time_series_slice.rb +229 -0
- data/lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb +281 -0
- data/lib/launchdarkly_api/models/experiment_totals_rep.rb +281 -0
- data/lib/launchdarkly_api/models/expiring_user_target_error.rb +237 -0
- data/lib/launchdarkly_api/models/expiring_user_target_get_response.rb +236 -0
- data/lib/launchdarkly_api/models/expiring_user_target_item.rb +300 -0
- data/lib/launchdarkly_api/models/expiring_user_target_patch_response.rb +274 -0
- data/lib/launchdarkly_api/models/extinction.rb +274 -0
- data/lib/launchdarkly_api/models/extinction_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/extinction_rep.rb +279 -0
- data/lib/launchdarkly_api/models/feature_flag.rb +276 -123
- data/lib/launchdarkly_api/models/feature_flag_body.rb +105 -55
- data/lib/launchdarkly_api/models/feature_flag_config.rb +184 -55
- data/lib/launchdarkly_api/models/feature_flag_scheduled_change.rb +142 -38
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb +73 -32
- data/lib/launchdarkly_api/models/feature_flag_status.rb +70 -71
- data/lib/launchdarkly_api/models/feature_flag_status_across_environments.rb +71 -33
- data/lib/launchdarkly_api/models/feature_flag_statuses.rb +64 -23
- data/lib/launchdarkly_api/models/feature_flags.rb +78 -32
- data/lib/launchdarkly_api/models/flag_config_approval_request_response.rb +448 -0
- data/lib/launchdarkly_api/models/flag_config_approval_requests_response.rb +242 -0
- data/lib/launchdarkly_api/models/flag_copy_config_environment.rb +232 -0
- data/lib/launchdarkly_api/models/flag_copy_config_post.rb +290 -0
- data/lib/launchdarkly_api/models/flag_global_attributes_rep.rb +514 -0
- data/lib/launchdarkly_api/models/flag_listing_rep.rb +257 -0
- data/lib/launchdarkly_api/models/flag_scheduled_changes_input.rb +234 -0
- data/lib/launchdarkly_api/models/flag_status_rep.rb +256 -0
- data/lib/launchdarkly_api/models/flag_summary.rb +223 -0
- data/lib/launchdarkly_api/models/hunk_rep.rb +256 -0
- data/lib/launchdarkly_api/models/inline_object.rb +274 -0
- data/lib/launchdarkly_api/models/inline_object1.rb +276 -0
- data/lib/launchdarkly_api/models/inline_response200.rb +227 -0
- data/lib/launchdarkly_api/models/integration_metadata.rb +265 -0
- data/lib/launchdarkly_api/models/integration_status.rb +237 -0
- data/lib/launchdarkly_api/models/ip_list.rb +241 -0
- data/lib/launchdarkly_api/models/last_seen_metadata.rb +219 -0
- data/lib/launchdarkly_api/models/link.rb +54 -20
- data/lib/launchdarkly_api/models/member.rb +213 -67
- data/lib/launchdarkly_api/models/member_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/member_summary_rep.rb +285 -0
- data/lib/launchdarkly_api/models/member_team_summary_rep.rb +253 -0
- data/lib/launchdarkly_api/models/members.rb +78 -32
- data/lib/launchdarkly_api/models/metric_collection_rep.rb +231 -0
- data/lib/launchdarkly_api/models/metric_listing_rep.rb +444 -0
- data/lib/launchdarkly_api/models/metric_post.rb +368 -0
- data/lib/launchdarkly_api/models/metric_rep.rb +493 -0
- data/lib/launchdarkly_api/models/modification.rb +218 -0
- data/lib/launchdarkly_api/models/multi_environment_dependent_flag.rb +69 -43
- data/lib/launchdarkly_api/models/multi_environment_dependent_flags.rb +75 -24
- data/lib/launchdarkly_api/models/new_member_form.rb +276 -0
- data/lib/launchdarkly_api/models/parent_resource_rep.rb +239 -0
- data/lib/launchdarkly_api/models/patch_operation.rb +59 -26
- data/lib/launchdarkly_api/models/patch_segment_instruction.rb +273 -0
- data/lib/launchdarkly_api/models/patch_segment_request.rb +236 -0
- data/lib/launchdarkly_api/models/patch_with_comment.rb +234 -0
- data/lib/launchdarkly_api/models/post_approval_request_apply_request.rb +218 -0
- data/lib/launchdarkly_api/models/post_approval_request_review_request.rb +227 -0
- data/lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb +248 -0
- data/lib/launchdarkly_api/models/prerequisite.rb +64 -20
- data/lib/launchdarkly_api/models/project.rb +120 -50
- data/lib/launchdarkly_api/models/project_listing_rep.rb +306 -0
- data/lib/launchdarkly_api/models/project_post.rb +281 -0
- data/lib/launchdarkly_api/models/projects.rb +70 -22
- data/lib/launchdarkly_api/models/pub_nub_detail_rep.rb +227 -0
- data/lib/launchdarkly_api/models/reference_rep.rb +238 -0
- data/lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb +225 -0
- data/lib/launchdarkly_api/models/relay_auto_config_post.rb +240 -0
- data/lib/launchdarkly_api/models/relay_auto_config_rep.rb +327 -0
- data/lib/launchdarkly_api/models/repository_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/repository_post.rb +304 -0
- data/lib/launchdarkly_api/models/repository_rep.rb +342 -0
- data/lib/launchdarkly_api/models/resource_access.rb +228 -0
- data/lib/launchdarkly_api/models/resource_id_response.rb +254 -0
- data/lib/launchdarkly_api/models/review_response.rb +302 -0
- data/lib/launchdarkly_api/models/rollout.rb +89 -32
- data/lib/launchdarkly_api/models/rule.rb +77 -33
- data/lib/launchdarkly_api/models/sdk_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_list_rep.rb +241 -0
- data/lib/launchdarkly_api/models/sdk_version_rep.rb +237 -0
- data/lib/launchdarkly_api/models/segment_body.rb +270 -0
- data/lib/launchdarkly_api/models/segment_metadata.rb +263 -0
- data/lib/launchdarkly_api/models/segment_user_list.rb +231 -0
- data/lib/launchdarkly_api/models/segment_user_state.rb +227 -0
- data/lib/launchdarkly_api/models/series_list_rep.rb +257 -0
- data/lib/launchdarkly_api/models/source_flag.rb +233 -0
- data/lib/launchdarkly_api/models/statement.rb +66 -63
- data/lib/launchdarkly_api/models/statement_post.rb +271 -0
- data/lib/launchdarkly_api/models/statement_post_data.rb +271 -0
- data/lib/launchdarkly_api/models/statement_rep.rb +266 -0
- data/lib/launchdarkly_api/models/statistic_collection_rep.rb +241 -0
- data/lib/launchdarkly_api/models/statistic_rep.rb +309 -0
- data/lib/launchdarkly_api/models/statistics_root.rb +229 -0
- data/lib/launchdarkly_api/models/subject_data_rep.rb +238 -0
- data/lib/launchdarkly_api/models/target.rb +64 -20
- data/lib/launchdarkly_api/models/target_resource_rep.rb +240 -0
- data/lib/launchdarkly_api/models/title_rep.rb +281 -0
- data/lib/launchdarkly_api/models/token.rb +159 -93
- data/lib/launchdarkly_api/models/token_data_rep.rb +256 -0
- data/lib/launchdarkly_api/models/tokens.rb +68 -32
- data/lib/launchdarkly_api/models/url_post.rb +279 -0
- data/lib/launchdarkly_api/models/user.rb +97 -96
- data/lib/launchdarkly_api/models/user_attribute_names_rep.rb +245 -0
- data/lib/launchdarkly_api/models/user_flag_setting.rb +68 -27
- data/lib/launchdarkly_api/models/user_flag_settings.rb +78 -32
- data/lib/launchdarkly_api/models/user_record.rb +69 -34
- data/lib/launchdarkly_api/models/user_segment.rb +186 -69
- data/lib/launchdarkly_api/models/user_segment_rule.rb +71 -23
- data/lib/launchdarkly_api/models/user_segments.rb +78 -32
- data/lib/launchdarkly_api/models/users.rb +72 -26
- data/lib/launchdarkly_api/models/value_put.rb +229 -0
- data/lib/launchdarkly_api/models/variate.rb +246 -0
- data/lib/launchdarkly_api/models/variation.rb +70 -38
- data/lib/launchdarkly_api/models/variation_or_rollout_rep.rb +227 -0
- data/lib/launchdarkly_api/models/variation_summary.rb +287 -0
- data/lib/launchdarkly_api/models/versions_rep.rb +262 -0
- data/lib/launchdarkly_api/models/webhook.rb +120 -55
- data/lib/launchdarkly_api/models/webhook_post.rb +297 -0
- data/lib/launchdarkly_api/models/webhooks.rb +68 -22
- data/lib/launchdarkly_api/models/weighted_variation.rb +77 -24
- data/lib/launchdarkly_api/version.rb +5 -5
- data/lib/launchdarkly_api.rb +129 -97
- data/spec/api/access_tokens_api_spec.rb +23 -17
- data/spec/api/account_members_api_spec.rb +99 -0
- data/spec/api/account_usage_beta_api_spec.rb +156 -0
- data/spec/api/approvals_api_spec.rb +141 -0
- data/spec/api/audit_log_api_spec.rb +19 -17
- data/spec/api/code_references_api_spec.rb +206 -0
- data/spec/api/custom_roles_api_spec.rb +23 -18
- data/spec/api/data_export_destinations_api_spec.rb +30 -25
- data/spec/api/environments_api_spec.rb +31 -26
- data/spec/api/experiments_beta_api_spec.rb +67 -0
- data/spec/api/feature_flags_api_spec.rb +70 -267
- data/spec/api/feature_flags_beta_api_spec.rb +62 -0
- data/spec/api/metrics_api_spec.rb +100 -0
- data/spec/api/other_api_spec.rb +79 -0
- data/spec/api/projects_api_spec.rb +22 -17
- data/spec/api/relay_proxy_configurations_api_spec.rb +37 -31
- data/spec/api/scheduled_changes_api_spec.rb +112 -0
- data/spec/api/segments_api_spec.rb +164 -0
- data/spec/api/user_settings_api_spec.rb +41 -36
- data/spec/api/users_api_spec.rb +33 -29
- data/spec/api/users_beta_api_spec.rb +48 -0
- data/spec/api/webhooks_api_spec.rb +27 -22
- data/spec/api_client_spec.rb +5 -22
- data/spec/configuration_spec.rb +7 -7
- data/spec/models/access_denied_reason_rep_spec.rb +64 -0
- data/spec/models/access_denied_rep_spec.rb +40 -0
- data/spec/models/access_rep_spec.rb +34 -0
- data/spec/models/access_token_post_spec.rb +74 -0
- data/spec/models/approval_settings_spec.rb +76 -0
- data/spec/models/audit_log_entry_listing_rep_collection_spec.rb +40 -0
- data/spec/models/audit_log_entry_listing_rep_spec.rb +136 -0
- data/spec/models/audit_log_entry_rep_spec.rb +172 -0
- data/spec/models/authorized_app_data_rep_spec.rb +58 -0
- data/spec/models/big_segment_target_spec.rb +46 -0
- data/spec/models/branch_collection_rep_spec.rb +40 -0
- data/spec/models/branch_rep_spec.rb +64 -0
- data/spec/models/clause_spec.rb +8 -15
- data/spec/models/client_side_availability_post_spec.rb +40 -0
- data/spec/models/client_side_availability_spec.rb +10 -17
- data/spec/models/confidence_interval_rep_spec.rb +40 -0
- data/spec/models/conflict_spec.rb +40 -0
- data/spec/models/copied_from_env_spec.rb +40 -0
- data/spec/models/create_copy_flag_config_approval_request_request_spec.rb +64 -0
- data/spec/models/create_flag_config_approval_request_request_spec.rb +70 -0
- data/spec/models/custom_property_spec.rb +8 -15
- data/spec/models/custom_role_post_data_spec.rb +52 -0
- data/spec/models/custom_role_post_spec.rb +52 -0
- data/spec/models/custom_role_spec.rb +14 -15
- data/spec/models/custom_roles_spec.rb +8 -15
- data/spec/models/default_client_side_availability_post_spec.rb +40 -0
- data/spec/models/defaults_spec.rb +8 -15
- data/spec/models/dependent_flag_environment_spec.rb +8 -15
- data/spec/models/dependent_flag_spec.rb +8 -15
- data/spec/models/dependent_flags_by_environment_spec.rb +8 -15
- data/spec/models/destination_post_spec.rb +56 -0
- data/spec/models/destination_spec.rb +19 -20
- data/spec/models/destinations_spec.rb +8 -15
- data/spec/models/environment_post_spec.rb +10 -17
- data/spec/models/environment_spec.rb +8 -27
- data/spec/models/experiment_allocation_rep_spec.rb +40 -0
- data/spec/models/experiment_enabled_period_rep_spec.rb +40 -0
- data/spec/models/experiment_environment_setting_rep_spec.rb +46 -0
- data/spec/models/experiment_info_rep_spec.rb +40 -0
- data/spec/models/experiment_metadata_rep_spec.rb +34 -0
- data/spec/models/experiment_rep_spec.rb +52 -0
- data/spec/models/experiment_results_rep_spec.rb +64 -0
- data/spec/models/experiment_stats_rep_spec.rb +52 -0
- data/spec/models/experiment_time_series_slice_spec.rb +40 -0
- data/spec/models/experiment_time_series_variation_slice_spec.rb +76 -0
- data/spec/models/experiment_totals_rep_spec.rb +76 -0
- data/spec/models/expiring_user_target_error_spec.rb +40 -0
- data/spec/models/expiring_user_target_get_response_spec.rb +40 -0
- data/spec/models/expiring_user_target_item_spec.rb +70 -0
- data/spec/models/expiring_user_target_patch_response_spec.rb +64 -0
- data/spec/models/extinction_collection_rep_spec.rb +40 -0
- data/spec/models/extinction_rep_spec.rb +58 -0
- data/spec/models/extinction_spec.rb +58 -0
- data/spec/models/feature_flag_body_spec.rb +24 -19
- data/spec/models/feature_flag_config_spec.rb +28 -17
- data/spec/models/feature_flag_scheduled_change_spec.rb +34 -17
- data/spec/models/feature_flag_scheduled_changes_spec.rb +10 -17
- data/spec/models/feature_flag_spec.rb +39 -30
- data/spec/models/feature_flag_status_across_environments_spec.rb +10 -17
- data/spec/models/feature_flag_status_spec.rb +8 -25
- data/spec/models/feature_flag_statuses_spec.rb +8 -15
- data/spec/models/feature_flags_spec.rb +10 -17
- data/spec/models/flag_config_approval_request_response_spec.rb +142 -0
- data/spec/models/flag_config_approval_requests_response_spec.rb +40 -0
- data/spec/models/flag_copy_config_environment_spec.rb +40 -0
- data/spec/models/flag_copy_config_post_spec.rb +66 -0
- data/spec/models/flag_global_attributes_rep_spec.rb +158 -0
- data/spec/models/flag_listing_rep_spec.rb +52 -0
- data/spec/models/flag_scheduled_changes_input_spec.rb +40 -0
- data/spec/models/flag_status_rep_spec.rb +52 -0
- data/spec/models/flag_summary_spec.rb +34 -0
- data/spec/models/hunk_rep_spec.rb +58 -0
- data/spec/models/inline_object1_spec.rb +64 -0
- data/spec/models/inline_object_spec.rb +58 -0
- data/spec/models/inline_response200_spec.rb +40 -0
- data/spec/models/integration_metadata_spec.rb +52 -0
- data/spec/models/integration_status_spec.rb +40 -0
- data/spec/models/ip_list_spec.rb +40 -0
- data/spec/models/last_seen_metadata_spec.rb +34 -0
- data/spec/models/link_spec.rb +8 -15
- data/spec/models/member_data_rep_spec.rb +58 -0
- data/spec/models/member_permission_grant_summary_rep_spec.rb +46 -0
- data/spec/models/member_spec.rb +44 -21
- data/spec/models/member_summary_rep_spec.rb +64 -0
- data/spec/models/member_team_summary_rep_spec.rb +46 -0
- data/spec/models/members_spec.rb +10 -17
- data/spec/models/metric_collection_rep_spec.rb +40 -0
- data/spec/models/metric_listing_rep_spec.rb +140 -0
- data/spec/models/metric_post_spec.rb +104 -0
- data/spec/models/metric_rep_spec.rb +170 -0
- data/spec/models/modification_spec.rb +34 -0
- data/spec/models/multi_environment_dependent_flag_spec.rb +8 -27
- data/spec/models/multi_environment_dependent_flags_spec.rb +8 -15
- data/spec/models/new_member_form_spec.rb +64 -0
- data/spec/models/parent_resource_rep_spec.rb +46 -0
- data/spec/models/patch_operation_spec.rb +8 -15
- data/spec/models/patch_segment_instruction_spec.rb +58 -0
- data/spec/models/patch_segment_request_spec.rb +40 -0
- data/spec/models/patch_with_comment_spec.rb +40 -0
- data/spec/models/post_approval_request_apply_request_spec.rb +34 -0
- data/spec/models/post_approval_request_review_request_spec.rb +40 -0
- data/spec/models/post_flag_scheduled_changes_input_spec.rb +46 -0
- data/spec/models/prerequisite_spec.rb +8 -15
- data/spec/models/project_listing_rep_spec.rb +70 -0
- data/spec/models/project_post_spec.rb +64 -0
- data/spec/models/project_spec.rb +12 -19
- data/spec/models/projects_spec.rb +8 -15
- data/spec/models/pub_nub_detail_rep_spec.rb +40 -0
- data/spec/models/reference_rep_spec.rb +46 -0
- data/spec/models/relay_auto_config_collection_rep_spec.rb +34 -0
- data/spec/models/relay_auto_config_post_spec.rb +40 -0
- data/spec/models/relay_auto_config_rep_spec.rb +82 -0
- data/spec/models/repository_collection_rep_spec.rb +40 -0
- data/spec/models/repository_post_spec.rb +68 -0
- data/spec/models/repository_rep_spec.rb +94 -0
- data/spec/models/resource_access_spec.rb +40 -0
- data/spec/models/resource_id_response_spec.rb +58 -0
- data/spec/models/review_response_spec.rb +62 -0
- data/spec/models/rollout_spec.rb +22 -17
- data/spec/models/rule_spec.rb +11 -18
- data/spec/models/sdk_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_list_rep_spec.rb +40 -0
- data/spec/models/sdk_version_rep_spec.rb +40 -0
- data/spec/models/segment_body_spec.rb +58 -0
- data/spec/models/segment_metadata_spec.rb +64 -0
- data/spec/models/segment_user_list_spec.rb +40 -0
- data/spec/models/segment_user_state_spec.rb +40 -0
- data/spec/models/series_list_rep_spec.rb +46 -0
- data/spec/models/source_flag_spec.rb +40 -0
- data/spec/models/statement_post_data_spec.rb +58 -0
- data/spec/models/statement_post_spec.rb +58 -0
- data/spec/models/statement_rep_spec.rb +58 -0
- data/spec/models/statement_spec.rb +8 -19
- data/spec/models/statistic_collection_rep_spec.rb +40 -0
- data/spec/models/statistic_rep_spec.rb +70 -0
- data/spec/models/statistics_root_spec.rb +40 -0
- data/spec/models/subject_data_rep_spec.rb +46 -0
- data/spec/models/target_resource_rep_spec.rb +46 -0
- data/spec/models/target_spec.rb +8 -15
- data/spec/models/title_rep_spec.rb +76 -0
- data/spec/models/token_data_rep_spec.rb +58 -0
- data/spec/models/token_spec.rb +27 -28
- data/spec/models/tokens_spec.rb +10 -17
- data/spec/models/url_post_spec.rb +56 -0
- data/spec/models/user_attribute_names_rep_spec.rb +46 -0
- data/spec/models/user_flag_setting_spec.rb +8 -15
- data/spec/models/user_flag_settings_spec.rb +10 -17
- data/spec/models/user_record_spec.rb +9 -16
- data/spec/models/user_segment_rule_spec.rb +14 -15
- data/spec/models/user_segment_spec.rb +52 -23
- data/spec/models/user_segments_spec.rb +10 -17
- data/spec/models/user_spec.rb +15 -46
- data/spec/models/users_spec.rb +8 -15
- data/spec/models/value_put_spec.rb +40 -0
- data/spec/models/variate_spec.rb +52 -0
- data/spec/models/variation_or_rollout_rep_spec.rb +40 -0
- data/spec/models/variation_spec.rb +10 -17
- data/spec/models/variation_summary_spec.rb +70 -0
- data/spec/models/versions_rep_spec.rb +52 -0
- data/spec/models/webhook_post_spec.rb +70 -0
- data/spec/models/webhook_spec.rb +18 -19
- data/spec/models/webhooks_spec.rb +8 -15
- data/spec/models/weighted_variation_spec.rb +14 -15
- data/spec/spec_helper.rb +4 -4
- metadata +815 -582
- data/docs/ApprovalRequest.md +0 -21
- data/docs/ApprovalRequestApplyConfigBody.md +0 -8
- data/docs/ApprovalRequestConfigBody.md +0 -13
- data/docs/ApprovalRequestFlagConfigCopyBody.md +0 -13
- data/docs/ApprovalRequestReview.md +0 -11
- data/docs/ApprovalRequestReviewConfigBody.md +0 -9
- data/docs/ApprovalRequestReviewStatus.md +0 -7
- data/docs/ApprovalRequests.md +0 -9
- data/docs/AuditLogEntries.md +0 -9
- data/docs/AuditLogEntry.md +0 -19
- data/docs/AuditLogEntryTarget.md +0 -10
- data/docs/BigSegmentTargetChanges.md +0 -9
- data/docs/BigSegmentTargetsBody.md +0 -9
- data/docs/CopyActions.md +0 -7
- data/docs/CustomPropertyValues.md +0 -7
- data/docs/CustomRoleBody.md +0 -11
- data/docs/CustomerMetricsApi.md +0 -511
- data/docs/DependentFlagEnvironmentLinks.md +0 -9
- data/docs/DependentFlagLinks.md +0 -8
- data/docs/DependentFlagsLinks.md +0 -9
- data/docs/DestinationAmazonKinesis.md +0 -10
- data/docs/DestinationBody.md +0 -11
- data/docs/DestinationGooglePubSub.md +0 -9
- data/docs/DestinationMParticle.md +0 -11
- data/docs/DestinationSegment.md +0 -8
- data/docs/EnvironmentApprovalSettings.md +0 -13
- data/docs/EvaluationUsageError.md +0 -9
- data/docs/Events.md +0 -8
- data/docs/Fallthrough.md +0 -9
- data/docs/FeatureFlagCopyBody.md +0 -12
- data/docs/FeatureFlagCopyObject.md +0 -9
- data/docs/FeatureFlagScheduledChangesConflicts.md +0 -8
- data/docs/FeatureFlagScheduledChangesConflictsInstructions.md +0 -9
- data/docs/FeatureFlagStatusForQueriedEnvironment.md +0 -10
- data/docs/FeatureFlagStatusLinks.md +0 -9
- data/docs/FlagConfigScheduledChangesConflictsBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPatchBody.md +0 -9
- data/docs/FlagConfigScheduledChangesPostBody.md +0 -10
- data/docs/FlagListItem.md +0 -11
- data/docs/HierarchicalLinks.md +0 -9
- data/docs/Id.md +0 -7
- data/docs/Integration.md +0 -9
- data/docs/IntegrationSubscription.md +0 -16
- data/docs/IntegrationSubscriptionStatus.md +0 -10
- data/docs/Integrations.md +0 -9
- data/docs/IntegrationsApi.md +0 -334
- data/docs/Links.md +0 -9
- data/docs/MAU.md +0 -10
- data/docs/MAUMetadata.md +0 -7
- data/docs/MAUbyCategory.md +0 -10
- data/docs/MemberLastSeenMetadata.md +0 -8
- data/docs/MembersBody.md +0 -13
- data/docs/PatchComment.md +0 -9
- data/docs/Policy.md +0 -12
- data/docs/ProjectBody.md +0 -13
- data/docs/RelayProxyConfig.md +0 -15
- data/docs/RelayProxyConfigBody.md +0 -9
- data/docs/RelayProxyConfigs.md +0 -8
- data/docs/Role.md +0 -7
- data/docs/RootApi.md +0 -56
- data/docs/ScheduledChangesFeatureFlagConflict.md +0 -9
- data/docs/SemanticPatchInstruction.md +0 -7
- data/docs/SemanticPatchInstructionInner.md +0 -8
- data/docs/SemanticPatchOperation.md +0 -9
- data/docs/Site.md +0 -9
- data/docs/Source.md +0 -9
- data/docs/Stream.md +0 -10
- data/docs/StreamBySDK.md +0 -10
- data/docs/StreamBySDKLinks.md +0 -9
- data/docs/StreamBySDKLinksMetadata.md +0 -10
- data/docs/StreamLinks.md +0 -10
- data/docs/StreamSDKVersion.md +0 -9
- data/docs/StreamSDKVersionData.md +0 -9
- data/docs/StreamUsageError.md +0 -9
- data/docs/StreamUsageLinks.md +0 -10
- data/docs/StreamUsageMetadata.md +0 -10
- data/docs/StreamUsageSeries.md +0 -9
- data/docs/Streams.md +0 -8
- data/docs/SubscriptionBody.md +0 -12
- data/docs/TeamMembersApi.md +0 -329
- data/docs/TokenBody.md +0 -13
- data/docs/Usage.md +0 -9
- data/docs/UsageError.md +0 -8
- data/docs/UsageLinks.md +0 -10
- data/docs/UserSegmentBody.md +0 -12
- data/docs/UserSegmentsApi.md +0 -488
- data/docs/UserSettingsBody.md +0 -8
- data/docs/UserTargetingExpirationForFlag.md +0 -14
- data/docs/UserTargetingExpirationForFlags.md +0 -9
- data/docs/UserTargetingExpirationForSegment.md +0 -14
- data/docs/UserTargetingExpirationOnFlagsForUser.md +0 -9
- data/docs/UserTargetingExpirationResourceIdForFlag.md +0 -12
- data/docs/WebhookBody.md +0 -14
- data/lib/launchdarkly_api/api/customer_metrics_api.rb +0 -519
- data/lib/launchdarkly_api/api/integrations_api.rb +0 -358
- data/lib/launchdarkly_api/api/root_api.rb +0 -69
- data/lib/launchdarkly_api/api/team_members_api.rb +0 -340
- data/lib/launchdarkly_api/api/user_segments_api.rb +0 -548
- data/lib/launchdarkly_api/models/approval_request.rb +0 -346
- data/lib/launchdarkly_api/models/approval_request_apply_config_body.rb +0 -185
- data/lib/launchdarkly_api/models/approval_request_config_body.rb +0 -250
- data/lib/launchdarkly_api/models/approval_request_flag_config_copy_body.rb +0 -254
- data/lib/launchdarkly_api/models/approval_request_review.rb +0 -212
- data/lib/launchdarkly_api/models/approval_request_review_config_body.rb +0 -234
- data/lib/launchdarkly_api/models/approval_request_review_status.rb +0 -31
- data/lib/launchdarkly_api/models/approval_requests.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entries.rb +0 -195
- data/lib/launchdarkly_api/models/audit_log_entry.rb +0 -283
- data/lib/launchdarkly_api/models/audit_log_entry_target.rb +0 -204
- data/lib/launchdarkly_api/models/big_segment_target_changes.rb +0 -199
- data/lib/launchdarkly_api/models/big_segment_targets_body.rb +0 -193
- data/lib/launchdarkly_api/models/copy_actions.rb +0 -34
- data/lib/launchdarkly_api/models/custom_property_values.rb +0 -176
- data/lib/launchdarkly_api/models/custom_role_body.rb +0 -231
- data/lib/launchdarkly_api/models/dependent_flag__links.rb +0 -184
- data/lib/launchdarkly_api/models/dependent_flag_environment__links.rb +0 -193
- data/lib/launchdarkly_api/models/dependent_flags_links.rb +0 -193
- data/lib/launchdarkly_api/models/destination_amazon_kinesis.rb +0 -202
- data/lib/launchdarkly_api/models/destination_body.rb +0 -264
- data/lib/launchdarkly_api/models/destination_google_pub_sub.rb +0 -193
- data/lib/launchdarkly_api/models/destination_m_particle.rb +0 -211
- data/lib/launchdarkly_api/models/destination_segment.rb +0 -184
- data/lib/launchdarkly_api/models/environment_approval_settings.rb +0 -272
- data/lib/launchdarkly_api/models/evaluation_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/events.rb +0 -184
- data/lib/launchdarkly_api/models/fallthrough.rb +0 -193
- data/lib/launchdarkly_api/models/feature_flag_copy_body.rb +0 -227
- data/lib/launchdarkly_api/models/feature_flag_copy_object.rb +0 -200
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb +0 -186
- data/lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb +0 -196
- data/lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb +0 -237
- data/lib/launchdarkly_api/models/feature_flag_status_links.rb +0 -193
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_conflicts_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_patch_body.rb +0 -194
- data/lib/launchdarkly_api/models/flag_config_scheduled_changes_post_body.rb +0 -204
- data/lib/launchdarkly_api/models/flag_list_item.rb +0 -211
- data/lib/launchdarkly_api/models/hierarchical_links.rb +0 -193
- data/lib/launchdarkly_api/models/id.rb +0 -176
- data/lib/launchdarkly_api/models/integration.rb +0 -195
- data/lib/launchdarkly_api/models/integration_subscription.rb +0 -265
- data/lib/launchdarkly_api/models/integration_subscription__status.rb +0 -203
- data/lib/launchdarkly_api/models/integrations.rb +0 -196
- data/lib/launchdarkly_api/models/links.rb +0 -193
- data/lib/launchdarkly_api/models/ma_uby_category.rb +0 -206
- data/lib/launchdarkly_api/models/mau.rb +0 -206
- data/lib/launchdarkly_api/models/mau_metadata.rb +0 -175
- data/lib/launchdarkly_api/models/member__last_seen_metadata.rb +0 -185
- data/lib/launchdarkly_api/models/members_body.rb +0 -238
- data/lib/launchdarkly_api/models/patch_comment.rb +0 -195
- data/lib/launchdarkly_api/models/policy.rb +0 -231
- data/lib/launchdarkly_api/models/project_body.rb +0 -243
- data/lib/launchdarkly_api/models/relay_proxy_config.rb +0 -289
- data/lib/launchdarkly_api/models/relay_proxy_config_body.rb +0 -196
- data/lib/launchdarkly_api/models/relay_proxy_configs.rb +0 -186
- data/lib/launchdarkly_api/models/role.rb +0 -32
- data/lib/launchdarkly_api/models/scheduled_changes_feature_flag_conflict.rb +0 -195
- data/lib/launchdarkly_api/models/semantic_patch_instruction.rb +0 -175
- data/lib/launchdarkly_api/models/semantic_patch_instruction_inner.rb +0 -185
- data/lib/launchdarkly_api/models/semantic_patch_operation.rb +0 -198
- data/lib/launchdarkly_api/models/site.rb +0 -193
- data/lib/launchdarkly_api/models/source.rb +0 -195
- data/lib/launchdarkly_api/models/stream.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk.rb +0 -206
- data/lib/launchdarkly_api/models/stream_by_sdk_links.rb +0 -193
- data/lib/launchdarkly_api/models/stream_by_sdk_links_metadata.rb +0 -202
- data/lib/launchdarkly_api/models/stream_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_sdk_version.rb +0 -195
- data/lib/launchdarkly_api/models/stream_sdk_version_data.rb +0 -195
- data/lib/launchdarkly_api/models/stream_usage_error.rb +0 -193
- data/lib/launchdarkly_api/models/stream_usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/stream_usage_metadata.rb +0 -204
- data/lib/launchdarkly_api/models/stream_usage_series.rb +0 -195
- data/lib/launchdarkly_api/models/streams.rb +0 -184
- data/lib/launchdarkly_api/models/subscription_body.rb +0 -238
- data/lib/launchdarkly_api/models/token_body.rb +0 -238
- data/lib/launchdarkly_api/models/usage.rb +0 -195
- data/lib/launchdarkly_api/models/usage_error.rb +0 -184
- data/lib/launchdarkly_api/models/usage_links.rb +0 -205
- data/lib/launchdarkly_api/models/user_segment_body.rb +0 -237
- data/lib/launchdarkly_api/models/user_settings_body.rb +0 -185
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb +0 -241
- data/lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb +0 -195
- data/lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb +0 -220
- data/lib/launchdarkly_api/models/webhook_body.rb +0 -263
- data/openapi.yml +0 -4922
- data/spec/api/customer_metrics_api_spec.rb +0 -141
- data/spec/api/integrations_api_spec.rb +0 -105
- data/spec/api/root_api_spec.rb +0 -45
- data/spec/api/team_members_api_spec.rb +0 -104
- data/spec/api/user_segments_api_spec.rb +0 -142
- data/spec/models/approval_request_apply_config_body_spec.rb +0 -41
- data/spec/models/approval_request_config_body_spec.rb +0 -71
- data/spec/models/approval_request_flag_config_copy_body_spec.rb +0 -71
- data/spec/models/approval_request_review_config_body_spec.rb +0 -51
- data/spec/models/approval_request_review_spec.rb +0 -59
- data/spec/models/approval_request_review_status_spec.rb +0 -35
- data/spec/models/approval_request_spec.rb +0 -123
- data/spec/models/approval_requests_spec.rb +0 -47
- data/spec/models/audit_log_entries_spec.rb +0 -47
- data/spec/models/audit_log_entry_spec.rb +0 -107
- data/spec/models/audit_log_entry_target_spec.rb +0 -53
- data/spec/models/big_segment_target_changes_spec.rb +0 -47
- data/spec/models/big_segment_targets_body_spec.rb +0 -47
- data/spec/models/copy_actions_spec.rb +0 -35
- data/spec/models/custom_property_values_spec.rb +0 -35
- data/spec/models/custom_role_body_spec.rb +0 -59
- data/spec/models/dependent_flag__links_spec.rb +0 -41
- data/spec/models/dependent_flag_environment__links_spec.rb +0 -47
- data/spec/models/dependent_flags_links_spec.rb +0 -47
- data/spec/models/destination_amazon_kinesis_spec.rb +0 -53
- data/spec/models/destination_body_spec.rb +0 -63
- data/spec/models/destination_google_pub_sub_spec.rb +0 -47
- data/spec/models/destination_m_particle_spec.rb +0 -59
- data/spec/models/destination_segment_spec.rb +0 -41
- data/spec/models/environment_approval_settings_spec.rb +0 -75
- data/spec/models/evaluation_usage_error_spec.rb +0 -47
- data/spec/models/events_spec.rb +0 -41
- data/spec/models/fallthrough_spec.rb +0 -47
- data/spec/models/feature_flag_copy_body_spec.rb +0 -65
- data/spec/models/feature_flag_copy_object_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb +0 -47
- data/spec/models/feature_flag_scheduled_changes_conflicts_spec.rb +0 -41
- data/spec/models/feature_flag_status_for_queried_environment_spec.rb +0 -57
- data/spec/models/feature_flag_status_links_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_conflicts_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_patch_body_spec.rb +0 -47
- data/spec/models/flag_config_scheduled_changes_post_body_spec.rb +0 -53
- data/spec/models/flag_list_item_spec.rb +0 -59
- data/spec/models/hierarchical_links_spec.rb +0 -47
- data/spec/models/id_spec.rb +0 -35
- data/spec/models/integration_spec.rb +0 -47
- data/spec/models/integration_subscription__status_spec.rb +0 -53
- data/spec/models/integration_subscription_spec.rb +0 -89
- data/spec/models/integrations_spec.rb +0 -47
- data/spec/models/links_spec.rb +0 -47
- data/spec/models/ma_uby_category_spec.rb +0 -53
- data/spec/models/mau_metadata_spec.rb +0 -35
- data/spec/models/mau_spec.rb +0 -53
- data/spec/models/member__last_seen_metadata_spec.rb +0 -41
- data/spec/models/members_body_spec.rb +0 -71
- data/spec/models/patch_comment_spec.rb +0 -47
- data/spec/models/policy_spec.rb +0 -65
- data/spec/models/project_body_spec.rb +0 -71
- data/spec/models/relay_proxy_config_body_spec.rb +0 -47
- data/spec/models/relay_proxy_config_spec.rb +0 -83
- data/spec/models/relay_proxy_configs_spec.rb +0 -41
- data/spec/models/role_spec.rb +0 -35
- data/spec/models/scheduled_changes_feature_flag_conflict_spec.rb +0 -47
- data/spec/models/semantic_patch_instruction_inner_spec.rb +0 -41
- data/spec/models/semantic_patch_instruction_spec.rb +0 -35
- data/spec/models/semantic_patch_operation_spec.rb +0 -47
- data/spec/models/site_spec.rb +0 -47
- data/spec/models/source_spec.rb +0 -47
- data/spec/models/stream_by_sdk_links_metadata_spec.rb +0 -53
- data/spec/models/stream_by_sdk_links_spec.rb +0 -47
- data/spec/models/stream_by_sdk_spec.rb +0 -53
- data/spec/models/stream_links_spec.rb +0 -53
- data/spec/models/stream_sdk_version_data_spec.rb +0 -47
- data/spec/models/stream_sdk_version_spec.rb +0 -47
- data/spec/models/stream_spec.rb +0 -53
- data/spec/models/stream_usage_error_spec.rb +0 -47
- data/spec/models/stream_usage_links_spec.rb +0 -53
- data/spec/models/stream_usage_metadata_spec.rb +0 -53
- data/spec/models/stream_usage_series_spec.rb +0 -47
- data/spec/models/streams_spec.rb +0 -41
- data/spec/models/subscription_body_spec.rb +0 -65
- data/spec/models/token_body_spec.rb +0 -71
- data/spec/models/usage_error_spec.rb +0 -41
- data/spec/models/usage_links_spec.rb +0 -53
- data/spec/models/usage_spec.rb +0 -47
- data/spec/models/user_segment_body_spec.rb +0 -65
- data/spec/models/user_settings_body_spec.rb +0 -41
- data/spec/models/user_targeting_expiration_for_flag_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_for_flags_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_for_segment_spec.rb +0 -77
- data/spec/models/user_targeting_expiration_on_flags_for_user_spec.rb +0 -47
- data/spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb +0 -65
- data/spec/models/webhook_body_spec.rb +0 -77
@@ -0,0 +1,52 @@
|
|
1
|
+
=begin
|
2
|
+
#LaunchDarkly REST API
|
3
|
+
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
|
+
Contact: support@launchdarkly.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for LaunchDarklyApi::VersionsRep
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe LaunchDarklyApi::VersionsRep do
|
21
|
+
let(:instance) { LaunchDarklyApi::VersionsRep.new }
|
22
|
+
|
23
|
+
describe 'test an instance of VersionsRep' do
|
24
|
+
it 'should create an instance of VersionsRep' do
|
25
|
+
expect(instance).to be_instance_of(LaunchDarklyApi::VersionsRep)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
describe 'test attribute "valid_versions"' do
|
29
|
+
it 'should work' do
|
30
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
describe 'test attribute "latest_version"' do
|
35
|
+
it 'should work' do
|
36
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
describe 'test attribute "current_version"' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
describe 'test attribute "beta"' do
|
47
|
+
it 'should work' do
|
48
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
end
|
@@ -0,0 +1,70 @@
|
|
1
|
+
=begin
|
2
|
+
#LaunchDarkly REST API
|
3
|
+
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
|
+
Contact: support@launchdarkly.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
require 'date'
|
16
|
+
|
17
|
+
# Unit tests for LaunchDarklyApi::WebhookPost
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
|
+
# Please update as you see appropriate
|
20
|
+
describe LaunchDarklyApi::WebhookPost do
|
21
|
+
let(:instance) { LaunchDarklyApi::WebhookPost.new }
|
22
|
+
|
23
|
+
describe 'test an instance of WebhookPost' do
|
24
|
+
it 'should create an instance of WebhookPost' do
|
25
|
+
expect(instance).to be_instance_of(LaunchDarklyApi::WebhookPost)
|
26
|
+
end
|
27
|
+
end
|
28
|
+
describe 'test attribute "name"' do
|
29
|
+
it 'should work' do
|
30
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
describe 'test attribute "url"' do
|
35
|
+
it 'should work' do
|
36
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
describe 'test attribute "secret"' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
46
|
+
describe 'test attribute "statements"' do
|
47
|
+
it 'should work' do
|
48
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
describe 'test attribute "sign"' do
|
53
|
+
it 'should work' do
|
54
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
describe 'test attribute "on"' do
|
59
|
+
it 'should work' do
|
60
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
61
|
+
end
|
62
|
+
end
|
63
|
+
|
64
|
+
describe 'test attribute "tags"' do
|
65
|
+
it 'should work' do
|
66
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
end
|
data/spec/models/webhook_spec.rb
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#LaunchDarkly REST API
|
3
3
|
|
4
|
-
#Build custom integrations with the LaunchDarkly REST API
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
7
|
Contact: support@launchdarkly.com
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -15,21 +15,14 @@ require 'json'
|
|
15
15
|
require 'date'
|
16
16
|
|
17
17
|
# Unit tests for LaunchDarklyApi::Webhook
|
18
|
-
# Automatically generated by
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
19
|
# Please update as you see appropriate
|
20
|
-
describe
|
21
|
-
|
22
|
-
# run before each test
|
23
|
-
@instance = LaunchDarklyApi::Webhook.new
|
24
|
-
end
|
25
|
-
|
26
|
-
after do
|
27
|
-
# run after each test
|
28
|
-
end
|
20
|
+
describe LaunchDarklyApi::Webhook do
|
21
|
+
let(:instance) { LaunchDarklyApi::Webhook.new }
|
29
22
|
|
30
23
|
describe 'test an instance of Webhook' do
|
31
24
|
it 'should create an instance of Webhook' do
|
32
|
-
expect(
|
25
|
+
expect(instance).to be_instance_of(LaunchDarklyApi::Webhook)
|
33
26
|
end
|
34
27
|
end
|
35
28
|
describe 'test attribute "_links"' do
|
@@ -44,6 +37,12 @@ describe 'Webhook' do
|
|
44
37
|
end
|
45
38
|
end
|
46
39
|
|
40
|
+
describe 'test attribute "name"' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
47
46
|
describe 'test attribute "url"' do
|
48
47
|
it 'should work' do
|
49
48
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
@@ -56,25 +55,25 @@ describe 'Webhook' do
|
|
56
55
|
end
|
57
56
|
end
|
58
57
|
|
59
|
-
describe 'test attribute "
|
58
|
+
describe 'test attribute "statements"' do
|
60
59
|
it 'should work' do
|
61
60
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
62
61
|
end
|
63
62
|
end
|
64
63
|
|
65
|
-
describe 'test attribute "
|
64
|
+
describe 'test attribute "on"' do
|
66
65
|
it 'should work' do
|
67
66
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
68
67
|
end
|
69
68
|
end
|
70
69
|
|
71
|
-
describe 'test attribute "
|
70
|
+
describe 'test attribute "tags"' do
|
72
71
|
it 'should work' do
|
73
72
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
74
73
|
end
|
75
74
|
end
|
76
75
|
|
77
|
-
describe 'test attribute "
|
76
|
+
describe 'test attribute "_access"' do
|
78
77
|
it 'should work' do
|
79
78
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
80
79
|
end
|
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#LaunchDarkly REST API
|
3
3
|
|
4
|
-
#Build custom integrations with the LaunchDarkly REST API
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
7
|
Contact: support@launchdarkly.com
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -15,21 +15,14 @@ require 'json'
|
|
15
15
|
require 'date'
|
16
16
|
|
17
17
|
# Unit tests for LaunchDarklyApi::Webhooks
|
18
|
-
# Automatically generated by
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
19
|
# Please update as you see appropriate
|
20
|
-
describe
|
21
|
-
|
22
|
-
# run before each test
|
23
|
-
@instance = LaunchDarklyApi::Webhooks.new
|
24
|
-
end
|
25
|
-
|
26
|
-
after do
|
27
|
-
# run after each test
|
28
|
-
end
|
20
|
+
describe LaunchDarklyApi::Webhooks do
|
21
|
+
let(:instance) { LaunchDarklyApi::Webhooks.new }
|
29
22
|
|
30
23
|
describe 'test an instance of Webhooks' do
|
31
24
|
it 'should create an instance of Webhooks' do
|
32
|
-
expect(
|
25
|
+
expect(instance).to be_instance_of(LaunchDarklyApi::Webhooks)
|
33
26
|
end
|
34
27
|
end
|
35
28
|
describe 'test attribute "_links"' do
|
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#LaunchDarkly REST API
|
3
3
|
|
4
|
-
#Build custom integrations with the LaunchDarkly REST API
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
7
|
Contact: support@launchdarkly.com
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -15,21 +15,14 @@ require 'json'
|
|
15
15
|
require 'date'
|
16
16
|
|
17
17
|
# Unit tests for LaunchDarklyApi::WeightedVariation
|
18
|
-
# Automatically generated by
|
18
|
+
# Automatically generated by openapi-generator (https://openapi-generator.tech)
|
19
19
|
# Please update as you see appropriate
|
20
|
-
describe
|
21
|
-
|
22
|
-
# run before each test
|
23
|
-
@instance = LaunchDarklyApi::WeightedVariation.new
|
24
|
-
end
|
25
|
-
|
26
|
-
after do
|
27
|
-
# run after each test
|
28
|
-
end
|
20
|
+
describe LaunchDarklyApi::WeightedVariation do
|
21
|
+
let(:instance) { LaunchDarklyApi::WeightedVariation.new }
|
29
22
|
|
30
23
|
describe 'test an instance of WeightedVariation' do
|
31
24
|
it 'should create an instance of WeightedVariation' do
|
32
|
-
expect(
|
25
|
+
expect(instance).to be_instance_of(LaunchDarklyApi::WeightedVariation)
|
33
26
|
end
|
34
27
|
end
|
35
28
|
describe 'test attribute "variation"' do
|
@@ -44,4 +37,10 @@ describe 'WeightedVariation' do
|
|
44
37
|
end
|
45
38
|
end
|
46
39
|
|
40
|
+
describe 'test attribute "_untracked"' do
|
41
|
+
it 'should work' do
|
42
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
43
|
+
end
|
44
|
+
end
|
45
|
+
|
47
46
|
end
|
data/spec/spec_helper.rb
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#LaunchDarkly REST API
|
3
3
|
|
4
|
-
#Build custom integrations with the LaunchDarkly REST API
|
4
|
+
## Authentication All REST API resources are authenticated with either [personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens), or session cookies. Other authentication mechanisms are not supported. You can manage personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens) page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These keys cannot be used to access our REST API**. These keys are environment-specific, and can only perform read-only operations (fetching feature flag settings). | Auth mechanism | Allowed resources | Use cases | | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens) | Can be customized on a per-token basis | Building scripts, custom integrations, data export | | SDK keys | Can only access read-only SDK-specific resources and the firehose, restricted to a single environment | Server-side SDKs, Firehose API | | Mobile keys | Can only access read-only mobile SDK-specific resources, restricted to a single environment | Mobile SDKs | | Client-side ID | Single environment, only flags marked available to client-side | Client-side JavaScript | > ### Keep your access tokens and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts. Never put an access token in client-side JavaScript, or embed it in a mobile application. LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens) page. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Via request header The preferred way to authenticate with the API is by adding an `Authorization` header containing your access token to your requests. The value of the `Authorization` header must be your access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens) page. ## Via session cookie For testing purposes, you can make API calls directly from your web browser. If you're logged in to the application, the API will use your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles) other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles) defined, you may not have permission to perform some API calls. You will receive a `401` response code in that case. > ### Modifying the Origin header causes an error > > LaunchDarkly validates that the Origin header for any API request authenticated by a session cookie matches the expected Origin header. The expected Origin header is `https://app.launchdarkly.com`. > > If the Origin header does not match what's expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly app from working correctly. > > Any browser extension that intentionally changes the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin: *` Chrome extension changes the Origin header to `http://evil.com` and causes the app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly does not require origin matching when authenticating with an access token, so this issue does not affect normal API usage. # Representations All resources expect and return JSON response bodies. Error responses will also send a JSON body. Read [Errors](#section/Errors) for a more detailed description of the error format used by the API. In practice this means that you always get a response with a `Content-Type` header set to `application/json`. In addition, request bodies for `PUT`, `POST`, `REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header set to `application/json`. ## Summary and detailed representations When you fetch a list of resources, the response includes only the most important attributes of each resource. This is a _summary representation_ of the resource. When you fetch an individual resource (for example, a single feature flag), you receive a _detailed representation_ containing all of the attributes of the resource. The best way to find a detailed representation is to follow links. Every summary representation includes a link to its detailed representation. ## Links and addressability The best way to navigate the API is by following links. These are attributes in representations that link to other resources. The API always uses the same format for links: - Links to other resources within the API are encapsulated in a `_links` object. - If the resource has a corresponding link to HTML content on the site, it is stored in a special `_site` link. Each link has two attributes: an href (the URL) and a type (the content type). For example, a feature resource might return the following: ```json { \"_links\": { \"parent\": { \"href\": \"/api/features\", \"type\": \"application/json\" }, \"self\": { \"href\": \"/api/features/sort.order\", \"type\": \"application/json\" } }, \"_site\": { \"href\": \"/features/sort.order\", \"type\": \"text/html\" } } ``` From this, you can navigate to the parent collection of features by following the `parent` link, or navigate to the site page for the feature by following the `_site` link. Collections are always represented as a JSON object with an `items` attribute containing an array of representations. Like all other representations, collections have `_links` defined at the top level. Paginated collections include `first`, `last`, `next`, and `prev` links containing a URL with the respective set of elements in the collection. # Updates Resources that accept partial updates use the `PATCH` verb, and support the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition, some resources support optional comments that can be submitted with updates. Comments appear in outgoing webhooks, the audit log, and other integrations. ## Updates via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify the modifications to perform on a resource. For example, in this feature flag representation: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"description\": \"This is the description\", ... } ``` You can change the feature flag's description with the following patch document: ```json [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"This is the new description\" }] ``` JSON Patch documents are always arrays. You can specify multiple modifications to perform in a single request. You can also test that certain preconditions are met before applying the patch: ```json [ { \"op\": \"test\", \"path\": \"/version\", \"value\": 10 }, { \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" } ] ``` The above patch request tests whether the feature flag's `version` is `10`, and if so, changes the feature flag's description. Attributes that aren't editable, like a resource's `_links`, have names that start with an underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch is less expressive than JSON Patch but in many cases, it is simpler to construct a merge patch document. For example, you can change a feature flag's description with the following merge patch document: ```json { \"description\": \"New flag description\" } ``` ## Updates with comments You can submit optional comments with `PATCH` changes. The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource supports comments. To submit a comment along with a JSON Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"patch\": [{ \"op\": \"replace\", \"path\": \"/description\", \"value\": \"The new description\" }] } ``` To submit a comment along with a JSON Merge Patch document, use the following format: ```json { \"comment\": \"This is a comment string\", \"merge\": { \"description\": \"New flag description\" } } ``` ## Updates via semantic patches The API also supports the Semantic patch format. A semantic `PATCH` is a way to specify the modifications to perform on a resource as a set of executable instructions. JSON Patch uses paths and a limited set of operations to describe how to transform the current state of the resource into a new state. Semantic patch allows you to be explicit about intent using precise, custom instructions. In many cases, semantic patch instructions can also be defined independently of the current state of the resource. This can be useful when defining a change that may be applied at a future date. For example, in this feature flag configuration in environment Production: ```json { \"name\": \"Alternate sort order\", \"kind\": \"boolean\", \"key\": \"sort.order\", ... \"environments\": { \"production\": { \"on\": true, \"archived\": false, \"salt\": \"c29ydC5vcmRlcg==\", \"sel\": \"8de1085cb7354b0ab41c0e778376dfd3\", \"lastModified\": 1469131558260, \"version\": 81, \"targets\": [ { \"values\": [ \"Gerhard.Little@yahoo.com\" ], \"variation\": 0 }, { \"values\": [ \"1461797806429-33-861961230\", \"438580d8-02ee-418d-9eec-0085cab2bdf0\" ], \"variation\": 1 } ], \"rules\": [], \"fallthrough\": { \"variation\": 0 }, \"offVariation\": 1, \"prerequisites\": [], \"_site\": { \"href\": \"/default/production/features/sort.order\", \"type\": \"text/html\" } } } } ``` You can add a date you want a user to be removed from the feature flag's user targets. For example, “remove user 1461797806429-33-861961230 from the user target for variation 0 on the Alternate sort order flag in the production environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json { \"comment\": \"update expiring user targets\", \"instructions\": [ { \"kind\": \"removeExpireUserTargetDate\", \"userKey\": \"userKey\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\" }, { \"kind\": \"updateExpireUserTargetDate\", \"userKey\": \"userKey2\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1587582000000 }, { \"kind\": \"addExpireUserTargetDate\", \"userKey\": \"userKey3\", \"variationId\": \"978d53f9-7fe3-4a63-992d-97bcb4535dc8\", \"value\": 1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json { \"name\": \"New recommendations engine\", \"key\": \"engine.enable\", \"environments\": { \"test\": { \"on\": true } } } ``` You can change the feature flag's description with the following patch document as a set of executable instructions. For example, “add user X to targets for variation Y and remove user A from targets for variation B for test flag”: ```json { \"comment\": \"\", \"instructions\": [ { \"kind\": \"removeUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"852cb784-54ff-46b9-8c35-5498d2e4f270\" }, { \"kind\": \"addUserTargets\", \"values\": [\"438580d8-02ee-418d-9eec-0085cab2bdf0\"], \"variationId\": \"1bb18465-33b6-49aa-a3bd-eeb6650b33ad\" } ] } ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) > - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets) > - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser) > - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) # Errors The API always returns errors in a common format. Here's an example: ```json { \"code\": \"invalid_request\", \"message\": \"A feature with that key already exists\", \"id\": \"30ce6058-87da-11e4-b116-123b93f75cba\" } ``` The general class of error is indicated by the `code`. The `message` is a human-readable explanation of what went wrong. The `id` is a unique identifier. Use it when you're working with LaunchDarkly support to debug a problem with a specific API call. ## HTTP Status - Error Response Codes | Code | Definition | Desc. | Possible Solution | | ---- | ----------------- | ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | 400 | Bad Request | A request that fails may return this HTTP response code. | Ensure JSON syntax in request body is correct. | | 401 | Unauthorized | User doesn't have permission to an API call. | Ensure your SDK key is good. | | 403 | Forbidden | User does not have permission for operation. | Ensure that the user or access token has proper permissions set. | | 409 | Conflict | The API request could not be completed because it conflicted with a concurrent API request. | Retry your request. | | 429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). | Wait and try again later. | # CORS The LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests from any origin. If an `Origin` header is given in a request, it will be echoed as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin: *`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors). Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept, Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods: OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age: 300 ``` You can make authenticated CORS calls just as you would make same-origin calls, using either [token or session-based authentication](#section/Authentication). If you’re using session auth, you should set the `withCredentials` property for your `xhr` request to `true`. You should never expose your access tokens to untrusted users. # Rate limiting We use several rate limiting strategies to ensure the availability of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls to our APIs will include headers indicating the current rate limit status. The specific headers returned depend on the API route being called. The limits differ based on the route, authentication mechanism, and other factors. Routes that are not rate limited may not contain any of the headers described below. > ### Rate limiting and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent events and a global CDN, to ensure availability to the routes used by LaunchDarkly SDKs. > > The client-side ID is safe to embed in untrusted contexts. It's designed for use in client-side JavaScript. ## Global rate limits Authenticated requests are subject to a global limit. This is the maximum number of calls that can be made to the API per ten seconds. All personal access tokens on the account share this limit, so exceeding the limit with one access token will impact other tokens. Calls that are subject to global rate limits will return the headers below: | Header name | Description | | ------------------------------ | -------------------------------------------------------------------------------- | | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | We do not publicly document the specific number of calls that can be made globally. This limit may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limit. ## Route-level rate limits Some authenticated routes have custom rate limits. These also reset every ten seconds. Any access tokens hitting the same route share this limit, so exceeding the limit with one access token may impact other tokens. Calls that are subject to route-level rate limits will return the headers below: | Header name | Description | | ----------------------------- | ----------------------------------------------------------------------------------------------------- | | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time at which the current rate limit window resets in epoch milliseconds. | A _route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment) endpoint is considered a single route, and each call to delete an environment counts against your route-level rate limit for that route. We do not publicly document the specific number of calls that can be made to each endpoint per ten seconds. These limits may change, and we encourage clients to program against the specification, relying on the two headers defined above, rather than hardcoding to the current limits. ## IP-based rate limiting We also employ IP-based rate limiting on some API routes. If you hit an IP-based rate limit, your API response will include a `Retry-After` header indicating how long to wait before re-trying the call. Clients must wait at least `Retry-After` seconds before making additional calls to our API, and should employ jitter and backoff strategies to avoid triggering rate limits again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json) for our API. You can use this specification to generate client libraries to interact with our REST API in your language of choice. This specification is supported by several API-based tools such as Postman and Insomnia. In many cases, you can directly import our specification to ease use in navigating the APIs in the tooling. # Client libraries We auto-generate multiple client libraries based on our OpenAPI specification. To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). # Method Overriding Some firewalls and HTTP clients restrict the use of verbs other than `GET` and `POST`. In those environments, our API endpoints that use `PUT`, `PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API supports the `X-HTTP-Method-Override` header, allowing clients to \"tunnel\" `PUT`, `PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH` as a header. # Beta resources We sometimes release new API resources in **beta** status before we release them with general availability. Resources that are in beta are still undergoing testing and development. They may change without notice, including becoming backwards incompatible. We try to promote resources into general availability as quickly as possible. This happens after sufficient testing and when we're satisfied that we no longer need to make backwards-incompatible changes. We mark beta resources with a \"Beta\" callout in our documentation, pictured below: > ### This feature is in beta > > To use this feature, pass in a header including the `LD-API-Version` key with value set to `beta`. Use this header with each call. To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To use a beta resource, you must include a header in the request. If you call a beta resource without this header, you'll receive a `403` response. Use this header: ``` LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards compatible, but we occasionally have to make backwards-incompatible changes in the process of shipping new features. These breaking changes can cause unexpected behavior if you don't prepare for them accordingly. Updates to our REST API include support for the latest features in LaunchDarkly. We also release a new version of our REST API every time we make a breaking change. We provide simultaneous support for multiple API versions so you can migrate from your current API version to a new version at your own pace. ## Setting the API version per request You can set the API version on a specific request by sending an `LD-API-Version` header, as shown in the example below: ``` LD-API-Version: 20191212 ``` The header value is the version number of the API version you'd like to request. The number for each version corresponds to the date the version was released. In the example above the version `20191212` corresponds to December 12, 2019. ## Setting the API version per access token When creating an access token, you must specify a specific version of the API to use. This ensures that integrations using this token cannot be broken by version changes. Tokens created before versioning was released have their version set to `20160426` (the version of the API that existed before versioning) so that they continue working the same way they did before versioning. If you would like to upgrade your integration to use a new API version, you can explicitly set the header described above. > ### Best practice: Set the header for every client or integration > > We recommend that you set the API version header explicitly in any client or integration you build. > > Only rely on the access token API version during manual testing.
|
5
5
|
|
6
|
-
OpenAPI
|
6
|
+
The version of the OpenAPI document: 2.0
|
7
7
|
Contact: support@launchdarkly.com
|
8
|
-
Generated by: https://
|
9
|
-
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.3.0-SNAPSHOT
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: launchdarkly_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version:
|
4
|
+
version: 6.0.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- LaunchDarkly
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2021-
|
11
|
+
date: 2021-09-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -30,46 +30,6 @@ dependencies:
|
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 1.0.1
|
33
|
-
- !ruby/object:Gem::Dependency
|
34
|
-
name: json
|
35
|
-
requirement: !ruby/object:Gem::Requirement
|
36
|
-
requirements:
|
37
|
-
- - "~>"
|
38
|
-
- !ruby/object:Gem::Version
|
39
|
-
version: '2.1'
|
40
|
-
- - ">="
|
41
|
-
- !ruby/object:Gem::Version
|
42
|
-
version: 2.1.0
|
43
|
-
type: :runtime
|
44
|
-
prerelease: false
|
45
|
-
version_requirements: !ruby/object:Gem::Requirement
|
46
|
-
requirements:
|
47
|
-
- - "~>"
|
48
|
-
- !ruby/object:Gem::Version
|
49
|
-
version: '2.1'
|
50
|
-
- - ">="
|
51
|
-
- !ruby/object:Gem::Version
|
52
|
-
version: 2.1.0
|
53
|
-
- !ruby/object:Gem::Dependency
|
54
|
-
name: addressable
|
55
|
-
requirement: !ruby/object:Gem::Requirement
|
56
|
-
requirements:
|
57
|
-
- - "~>"
|
58
|
-
- !ruby/object:Gem::Version
|
59
|
-
version: '2.3'
|
60
|
-
- - ">="
|
61
|
-
- !ruby/object:Gem::Version
|
62
|
-
version: 2.3.0
|
63
|
-
type: :runtime
|
64
|
-
prerelease: false
|
65
|
-
version_requirements: !ruby/object:Gem::Requirement
|
66
|
-
requirements:
|
67
|
-
- - "~>"
|
68
|
-
- !ruby/object:Gem::Version
|
69
|
-
version: '2.3'
|
70
|
-
- - ">="
|
71
|
-
- !ruby/object:Gem::Version
|
72
|
-
version: 2.3.0
|
73
33
|
- !ruby/object:Gem::Dependency
|
74
34
|
name: rspec
|
75
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -90,127 +50,272 @@ dependencies:
|
|
90
50
|
- - ">="
|
91
51
|
- !ruby/object:Gem::Version
|
92
52
|
version: 3.6.0
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
|
168
|
-
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
|
53
|
+
description: '# Authentication All REST API resources are authenticated with either
|
54
|
+
[personal or service access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens),
|
55
|
+
or session cookies. Other authentication mechanisms are not supported. You can manage
|
56
|
+
personal access tokens on your [Account settings](https://app.launchdarkly.com/settings/tokens)
|
57
|
+
page. LaunchDarkly also has SDK keys, mobile keys, and client-side IDs that are
|
58
|
+
used by our server-side SDKs, mobile SDKs, and client-side SDKs, respectively. **These
|
59
|
+
keys cannot be used to access our REST API**. These keys are environment-specific,
|
60
|
+
and can only perform read-only operations (fetching feature flag settings). | Auth
|
61
|
+
mechanism |
|
62
|
+
Allowed resources |
|
63
|
+
Use cases | | -----------------------------------------------------------------------------------------------
|
64
|
+
| -----------------------------------------------------------------------------------------------------
|
65
|
+
| -------------------------------------------------- | | [Personal access tokens](https://docs.launchdarkly.com/home/account-security/api-access-tokens)
|
66
|
+
| Can be customized on a per-token basis |
|
67
|
+
Building scripts, custom integrations, data export | | SDK keys |
|
68
|
+
Can only access read-only SDK-specific resources and the firehose, restricted to
|
69
|
+
a single environment | Server-side SDKs, Firehose API | | Mobile
|
70
|
+
keys |
|
71
|
+
Can only access read-only mobile SDK-specific resources, restricted to a single
|
72
|
+
environment | Mobile SDKs | | Client-side
|
73
|
+
ID |
|
74
|
+
Single environment, only flags marked available to client-side |
|
75
|
+
Client-side JavaScript | > ### Keep your access tokens
|
76
|
+
and SDK keys private > > Access tokens should _never_ be exposed in untrusted contexts.
|
77
|
+
Never put an access token in client-side JavaScript, or embed it in a mobile application.
|
78
|
+
LaunchDarkly has special mobile keys that you can embed in mobile apps. If you accidentally
|
79
|
+
expose an access token or SDK key, you can reset it from your [Account Settings](https://app.launchdarkly.com/settings#/tokens)
|
80
|
+
page. > > The client-side ID is safe to embed in untrusted contexts. It''s designed
|
81
|
+
for use in client-side JavaScript. ## Via request header The preferred way to
|
82
|
+
authenticate with the API is by adding an `Authorization` header containing your
|
83
|
+
access token to your requests. The value of the `Authorization` header must be your
|
84
|
+
access token. Manage personal access tokens from the [Account Settings](https://app.launchdarkly.com/settings/tokens)
|
85
|
+
page. ## Via session cookie For testing purposes, you can make API calls directly
|
86
|
+
from your web browser. If you''re logged in to the application, the API will use
|
87
|
+
your existing session to authenticate calls. If you have a [role](https://docs.launchdarkly.com/home/team/built-in-roles)
|
88
|
+
other than Admin, or have a [custom role](https://docs.launchdarkly.com/home/team/custom-roles)
|
89
|
+
defined, you may not have permission to perform some API calls. You will receive
|
90
|
+
a `401` response code in that case. > ### Modifying the Origin header causes an
|
91
|
+
error > > LaunchDarkly validates that the Origin header for any API request authenticated
|
92
|
+
by a session cookie matches the expected Origin header. The expected Origin header
|
93
|
+
is `https://app.launchdarkly.com`. > > If the Origin header does not match what''s
|
94
|
+
expected, LaunchDarkly returns an error. This error can prevent the LaunchDarkly
|
95
|
+
app from working correctly. > > Any browser extension that intentionally changes
|
96
|
+
the Origin header can cause this problem. For example, the `Allow-Control-Allow-Origin:
|
97
|
+
*` Chrome extension changes the Origin header to `http://evil.com` and causes the
|
98
|
+
app to fail. > > To prevent this error, do not modify your Origin header. > > LaunchDarkly
|
99
|
+
does not require origin matching when authenticating with an access token, so this
|
100
|
+
issue does not affect normal API usage. # Representations All resources expect
|
101
|
+
and return JSON response bodies. Error responses will also send a JSON body. Read
|
102
|
+
[Errors](#section/Errors) for a more detailed description of the error format used
|
103
|
+
by the API. In practice this means that you always get a response with a `Content-Type`
|
104
|
+
header set to `application/json`. In addition, request bodies for `PUT`, `POST`,
|
105
|
+
`REPORT` and `PATCH` requests must be encoded as JSON with a `Content-Type` header
|
106
|
+
set to `application/json`. ## Summary and detailed representations When you fetch
|
107
|
+
a list of resources, the response includes only the most important attributes of
|
108
|
+
each resource. This is a _summary representation_ of the resource. When you fetch
|
109
|
+
an individual resource (for example, a single feature flag), you receive a _detailed
|
110
|
+
representation_ containing all of the attributes of the resource. The best way
|
111
|
+
to find a detailed representation is to follow links. Every summary representation
|
112
|
+
includes a link to its detailed representation. ## Links and addressability The
|
113
|
+
best way to navigate the API is by following links. These are attributes in representations
|
114
|
+
that link to other resources. The API always uses the same format for links: -
|
115
|
+
Links to other resources within the API are encapsulated in a `_links` object. -
|
116
|
+
If the resource has a corresponding link to HTML content on the site, it is stored
|
117
|
+
in a special `_site` link. Each link has two attributes: an href (the URL) and
|
118
|
+
a type (the content type). For example, a feature resource might return the following: ```json
|
119
|
+
{ "_links": { "parent": { "href": "/api/features", "type": "application/json" }, "self":
|
120
|
+
{ "href": "/api/features/sort.order", "type": "application/json" } }, "_site":
|
121
|
+
{ "href": "/features/sort.order", "type": "text/html" } } ``` From this,
|
122
|
+
you can navigate to the parent collection of features by following the `parent`
|
123
|
+
link, or navigate to the site page for the feature by following the `_site` link. Collections
|
124
|
+
are always represented as a JSON object with an `items` attribute containing an
|
125
|
+
array of representations. Like all other representations, collections have `_links`
|
126
|
+
defined at the top level. Paginated collections include `first`, `last`, `next`,
|
127
|
+
and `prev` links containing a URL with the respective set of elements in the collection. #
|
128
|
+
Updates Resources that accept partial updates use the `PATCH` verb, and support
|
129
|
+
the [JSON Patch](http://tools.ietf.org/html/rfc6902) format. Some resources also
|
130
|
+
support the [JSON Merge Patch](https://tools.ietf.org/html/rfc7386) format. In addition,
|
131
|
+
some resources support optional comments that can be submitted with updates. Comments
|
132
|
+
appear in outgoing webhooks, the audit log, and other integrations. ## Updates
|
133
|
+
via JSON Patch [JSON Patch](http://tools.ietf.org/html/rfc6902) is a way to specify
|
134
|
+
the modifications to perform on a resource. For example, in this feature flag representation: ```json
|
135
|
+
{ "name": "New recommendations engine", "key": "engine.enable", "description":
|
136
|
+
"This is the description", ... } ``` You can change the feature flag''s description
|
137
|
+
with the following patch document: ```json [{ "op": "replace", "path": "/description",
|
138
|
+
"value": "This is the new description" }] ``` JSON Patch documents are always arrays.
|
139
|
+
You can specify multiple modifications to perform in a single request. You can also
|
140
|
+
test that certain preconditions are met before applying the patch: ```json [ {
|
141
|
+
"op": "test", "path": "/version", "value": 10 }, { "op": "replace", "path": "/description",
|
142
|
+
"value": "The new description" } ] ``` The above patch request tests whether the
|
143
|
+
feature flag''s `version` is `10`, and if so, changes the feature flag''s description. Attributes
|
144
|
+
that aren''t editable, like a resource''s `_links`, have names that start with an
|
145
|
+
underscore. ## Updates via JSON Merge Patch The API also supports the [JSON Merge
|
146
|
+
Patch](https://tools.ietf.org/html/rfc7386) format, as well as the [Update feature
|
147
|
+
flag](/tag/Feature-flags#operation/patchFeatureFlag) resource. JSON Merge Patch
|
148
|
+
is less expressive than JSON Patch but in many cases, it is simpler to construct
|
149
|
+
a merge patch document. For example, you can change a feature flag''s description
|
150
|
+
with the following merge patch document: ```json { "description": "New flag description"
|
151
|
+
} ``` ## Updates with comments You can submit optional comments with `PATCH` changes.
|
152
|
+
The [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag) resource
|
153
|
+
supports comments. To submit a comment along with a JSON Patch document, use the
|
154
|
+
following format: ```json { "comment": "This is a comment string", "patch":
|
155
|
+
[{ "op": "replace", "path": "/description", "value": "The new description" }] }
|
156
|
+
``` To submit a comment along with a JSON Merge Patch document, use the following
|
157
|
+
format: ```json { "comment": "This is a comment string", "merge": { "description":
|
158
|
+
"New flag description" } } ``` ## Updates via semantic patches The API also supports
|
159
|
+
the Semantic patch format. A semantic `PATCH` is a way to specify the modifications
|
160
|
+
to perform on a resource as a set of executable instructions. JSON Patch uses paths
|
161
|
+
and a limited set of operations to describe how to transform the current state of
|
162
|
+
the resource into a new state. Semantic patch allows you to be explicit about intent
|
163
|
+
using precise, custom instructions. In many cases, semantic patch instructions can
|
164
|
+
also be defined independently of the current state of the resource. This can be
|
165
|
+
useful when defining a change that may be applied at a future date. For example,
|
166
|
+
in this feature flag configuration in environment Production: ```json { "name":
|
167
|
+
"Alternate sort order", "kind": "boolean", "key": "sort.order", ... "environments":
|
168
|
+
{ "production": { "on": true, "archived": false, "salt":
|
169
|
+
"c29ydC5vcmRlcg==", "sel": "8de1085cb7354b0ab41c0e778376dfd3", "lastModified":
|
170
|
+
1469131558260, "version": 81, "targets": [ { "values":
|
171
|
+
[ "Gerhard.Little@yahoo.com" ], "variation":
|
172
|
+
0 }, { "values": [ "1461797806429-33-861961230", "438580d8-02ee-418d-9eec-0085cab2bdf0" ], "variation":
|
173
|
+
1 } ], "rules": [], "fallthrough":
|
174
|
+
{ "variation": 0 }, "offVariation": 1, "prerequisites":
|
175
|
+
[], "_site": { "href": "/default/production/features/sort.order", "type":
|
176
|
+
"text/html" } } } } ``` You can add a date you want a user
|
177
|
+
to be removed from the feature flag''s user targets. For example, “remove user 1461797806429-33-861961230
|
178
|
+
from the user target for variation 0 on the Alternate sort order flag in the production
|
179
|
+
environment on Wed Jul 08 2020 at 15:27:41 pm”. This is done using the following: ```json
|
180
|
+
{ "comment": "update expiring user targets", "instructions": [ { "kind":
|
181
|
+
"removeExpireUserTargetDate", "userKey": "userKey", "variationId": "978d53f9-7fe3-4a63-992d-97bcb4535dc8" }, { "kind":
|
182
|
+
"updateExpireUserTargetDate", "userKey": "userKey2", "variationId":
|
183
|
+
"978d53f9-7fe3-4a63-992d-97bcb4535dc8", "value": 1587582000000 }, { "kind":
|
184
|
+
"addExpireUserTargetDate", "userKey": "userKey3", "variationId": "978d53f9-7fe3-4a63-992d-97bcb4535dc8", "value":
|
185
|
+
1594247266386 } ] } ``` Here is another example. In this feature flag configuration: ```json
|
186
|
+
{ "name": "New recommendations engine", "key": "engine.enable", "environments":
|
187
|
+
{ "test": { "on": true } } } ``` You can change the feature flag''s
|
188
|
+
description with the following patch document as a set of executable instructions.
|
189
|
+
For example, “add user X to targets for variation Y and remove user A from targets
|
190
|
+
for variation B for test flag”: ```json { "comment": "", "instructions": [ { "kind":
|
191
|
+
"removeUserTargets", "values": ["438580d8-02ee-418d-9eec-0085cab2bdf0"], "variationId":
|
192
|
+
"852cb784-54ff-46b9-8c35-5498d2e4f270" }, { "kind": "addUserTargets", "values":
|
193
|
+
["438580d8-02ee-418d-9eec-0085cab2bdf0"], "variationId": "1bb18465-33b6-49aa-a3bd-eeb6650b33ad" } ]
|
194
|
+
} ``` > ### Supported semantic patch API endpoints > > - [Update feature flag](/tag/Feature-flags#operation/patchFeatureFlag)
|
195
|
+
> - [Update expiring user targets on feature flag](/tag/Feature-flags#operation/patchExpiringUserTargets)
|
196
|
+
> - [Update expiring user target for flags](/tag/User-Settings#operation/patchExpiringFlagsForUser)
|
197
|
+
> - [Update expiring user targets on segment](/tag/Segments#operation/patchExpiringUserTargetsOnSegment) #
|
198
|
+
Errors The API always returns errors in a common format. Here''s an example: ```json
|
199
|
+
{ "code": "invalid_request", "message": "A feature with that key already exists", "id":
|
200
|
+
"30ce6058-87da-11e4-b116-123b93f75cba" } ``` The general class of error is indicated
|
201
|
+
by the `code`. The `message` is a human-readable explanation of what went wrong.
|
202
|
+
The `id` is a unique identifier. Use it when you''re working with LaunchDarkly support
|
203
|
+
to debug a problem with a specific API call. ## HTTP Status - Error Response Codes |
|
204
|
+
Code | Definition | Desc. |
|
205
|
+
Possible Solution | | ---- | -----------------
|
206
|
+
| -------------------------------------------------------------------------------------------
|
207
|
+
| ---------------------------------------------------------------- | | 400 | Bad
|
208
|
+
Request | A request that fails may return this HTTP response code. |
|
209
|
+
Ensure JSON syntax in request body is correct. | | 401 | Unauthorized |
|
210
|
+
User doesn''t have permission to an API call. |
|
211
|
+
Ensure your SDK key is good. | | 403 | Forbidden |
|
212
|
+
User does not have permission for operation. |
|
213
|
+
Ensure that the user or access token has proper permissions set. | | 409 | Conflict |
|
214
|
+
The API request could not be completed because it conflicted with a concurrent API
|
215
|
+
request. | Retry your request. | |
|
216
|
+
429 | Too many requests | See [Rate limiting](/#section/Rate-limiting). |
|
217
|
+
Wait and try again later. | # CORS The
|
218
|
+
LaunchDarkly API supports Cross Origin Resource Sharing (CORS) for AJAX requests
|
219
|
+
from any origin. If an `Origin` header is given in a request, it will be echoed
|
220
|
+
as an explicitly allowed origin. Otherwise, a wildcard is returned: `Access-Control-Allow-Origin:
|
221
|
+
*`. For more information on CORS, see the [CORS W3C Recommendation](http://www.w3.org/TR/cors).
|
222
|
+
Example CORS headers might look like: ```http Access-Control-Allow-Headers: Accept,
|
223
|
+
Content-Type, Content-Length, Accept-Encoding, Authorization Access-Control-Allow-Methods:
|
224
|
+
OPTIONS, GET, DELETE, PATCH Access-Control-Allow-Origin: * Access-Control-Max-Age:
|
225
|
+
300 ``` You can make authenticated CORS calls just as you would make same-origin
|
226
|
+
calls, using either [token or session-based authentication](#section/Authentication).
|
227
|
+
If you’re using session auth, you should set the `withCredentials` property for
|
228
|
+
your `xhr` request to `true`. You should never expose your access tokens to untrusted
|
229
|
+
users. # Rate limiting We use several rate limiting strategies to ensure the availability
|
230
|
+
of our APIs. Rate-limited calls to our APIs will return a `429` status code. Calls
|
231
|
+
to our APIs will include headers indicating the current rate limit status. The specific
|
232
|
+
headers returned depend on the API route being called. The limits differ based on
|
233
|
+
the route, authentication mechanism, and other factors. Routes that are not rate
|
234
|
+
limited may not contain any of the headers described below. > ### Rate limiting
|
235
|
+
and SDKs > > LaunchDarkly SDKs are never rate limited and do not use the API endpoints
|
236
|
+
defined here. LaunchDarkly uses a different set of approaches, including streaming/server-sent
|
237
|
+
events and a global CDN, to ensure availability to the routes used by LaunchDarkly
|
238
|
+
SDKs. > > The client-side ID is safe to embed in untrusted contexts. It''s designed
|
239
|
+
for use in client-side JavaScript. ## Global rate limits Authenticated requests
|
240
|
+
are subject to a global limit. This is the maximum number of calls that can be made
|
241
|
+
to the API per ten seconds. All personal access tokens on the account share this
|
242
|
+
limit, so exceeding the limit with one access token will impact other tokens. Calls
|
243
|
+
that are subject to global rate limits will return the headers below: | Header
|
244
|
+
name | Description |
|
245
|
+
| ------------------------------ | --------------------------------------------------------------------------------
|
246
|
+
| | `X-Ratelimit-Global-Remaining` | The maximum number of requests the account
|
247
|
+
is permitted to make per ten seconds. | | `X-Ratelimit-Reset` | The time
|
248
|
+
at which the current rate limit window resets in epoch milliseconds. | We do
|
249
|
+
not publicly document the specific number of calls that can be made globally. This
|
250
|
+
limit may change, and we encourage clients to program against the specification,
|
251
|
+
relying on the two headers defined above, rather than hardcoding to the current
|
252
|
+
limit. ## Route-level rate limits Some authenticated routes have custom rate limits.
|
253
|
+
These also reset every ten seconds. Any access tokens hitting the same route share
|
254
|
+
this limit, so exceeding the limit with one access token may impact other tokens.
|
255
|
+
Calls that are subject to route-level rate limits will return the headers below: |
|
256
|
+
Header name | Description |
|
257
|
+
| ----------------------------- | -----------------------------------------------------------------------------------------------------
|
258
|
+
| | `X-Ratelimit-Route-Remaining` | The maximum number of requests to the current
|
259
|
+
route the account is permitted to make per ten seconds. | | `X-Ratelimit-Reset` |
|
260
|
+
The time at which the current rate limit window resets in epoch milliseconds. | A
|
261
|
+
_route_ represents a specific URL pattern and verb. For example, the [Delete environment](/tag/Environments#operation/deleteEnvironment)
|
262
|
+
endpoint is considered a single route, and each call to delete an environment counts
|
263
|
+
against your route-level rate limit for that route. We do not publicly document
|
264
|
+
the specific number of calls that can be made to each endpoint per ten seconds.
|
265
|
+
These limits may change, and we encourage clients to program against the specification,
|
266
|
+
relying on the two headers defined above, rather than hardcoding to the current
|
267
|
+
limits. ## IP-based rate limiting We also employ IP-based rate limiting on some
|
268
|
+
API routes. If you hit an IP-based rate limit, your API response will include a
|
269
|
+
`Retry-After` header indicating how long to wait before re-trying the call. Clients
|
270
|
+
must wait at least `Retry-After` seconds before making additional calls to our API,
|
271
|
+
and should employ jitter and backoff strategies to avoid triggering rate limits
|
272
|
+
again. # OpenAPI (Swagger) We have a [complete OpenAPI (Swagger) specification](https://app.launchdarkly.com/api/v2/openapi.json)
|
273
|
+
for our API. You can use this specification to generate client libraries to interact
|
274
|
+
with our REST API in your language of choice. This specification is supported by
|
275
|
+
several API-based tools such as Postman and Insomnia. In many cases, you can directly
|
276
|
+
import our specification to ease use in navigating the APIs in the tooling. # Client
|
277
|
+
libraries We auto-generate multiple client libraries based on our OpenAPI specification.
|
278
|
+
To learn more, visit [GitHub](https://github.com/search?q=topic%3Alaunchdarkly-api+org%3Alaunchdarkly&type=Repositories). #
|
279
|
+
Method Overriding Some firewalls and HTTP clients restrict the use of verbs other
|
280
|
+
than `GET` and `POST`. In those environments, our API endpoints that use `PUT`,
|
281
|
+
`PATCH`, and `DELETE` verbs will be inaccessible. To avoid this issue, our API
|
282
|
+
supports the `X-HTTP-Method-Override` header, allowing clients to "tunnel" `PUT`,
|
283
|
+
`PATCH`, and `DELETE` requests via a `POST` request. For example, if you wish to
|
284
|
+
call one of our `PATCH` resources via a `POST` request, you can include `X-HTTP-Method-Override:PATCH`
|
285
|
+
as a header. # Beta resources We sometimes release new API resources in **beta**
|
286
|
+
status before we release them with general availability. Resources that are in
|
287
|
+
beta are still undergoing testing and development. They may change without notice,
|
288
|
+
including becoming backwards incompatible. We try to promote resources into general
|
289
|
+
availability as quickly as possible. This happens after sufficient testing and when
|
290
|
+
we''re satisfied that we no longer need to make backwards-incompatible changes. We
|
291
|
+
mark beta resources with a "Beta" callout in our documentation, pictured below: >
|
292
|
+
### This feature is in beta > > To use this feature, pass in a header including
|
293
|
+
the `LD-API-Version` key with value set to `beta`. Use this header with each call.
|
294
|
+
To learn more, read [Beta resources](/#section/Beta-resources). ## Using beta resources To
|
295
|
+
use a beta resource, you must include a header in the request. If you call a beta
|
296
|
+
resource without this header, you''ll receive a `403` response. Use this header: ```
|
297
|
+
LD-API-Version: beta ``` # Versioning We try hard to keep our REST API backwards
|
298
|
+
compatible, but we occasionally have to make backwards-incompatible changes in the
|
299
|
+
process of shipping new features. These breaking changes can cause unexpected behavior
|
300
|
+
if you don''t prepare for them accordingly. Updates to our REST API include support
|
301
|
+
for the latest features in LaunchDarkly. We also release a new version of our REST
|
302
|
+
API every time we make a breaking change. We provide simultaneous support for multiple
|
303
|
+
API versions so you can migrate from your current API version to a new version at
|
304
|
+
your own pace. ## Setting the API version per request You can set the API version
|
305
|
+
on a specific request by sending an `LD-API-Version` header, as shown in the example
|
306
|
+
below: ``` LD-API-Version: 20191212 ``` The header value is the version number
|
307
|
+
of the API version you''d like to request. The number for each version corresponds
|
308
|
+
to the date the version was released. In the example above the version `20191212`
|
309
|
+
corresponds to December 12, 2019. ## Setting the API version per access token When
|
310
|
+
creating an access token, you must specify a specific version of the API to use.
|
311
|
+
This ensures that integrations using this token cannot be broken by version changes. Tokens
|
312
|
+
created before versioning was released have their version set to `20160426` (the
|
313
|
+
version of the API that existed before versioning) so that they continue working
|
314
|
+
the same way they did before versioning. If you would like to upgrade your integration
|
315
|
+
to use a new API version, you can explicitly set the header described above. >
|
316
|
+
### Best practice: Set the header for every client or integration > > We recommend
|
317
|
+
that you set the API version header explicitly in any client or integration you
|
318
|
+
build. > > Only rely on the access token API version during manual testing. '
|
214
319
|
email:
|
215
320
|
- support@launchdarkly.com
|
216
321
|
executables: []
|
@@ -221,156 +326,188 @@ files:
|
|
221
326
|
- LICENSE.txt
|
222
327
|
- README.md
|
223
328
|
- Rakefile
|
329
|
+
- docs/AccessDeniedReasonRep.md
|
330
|
+
- docs/AccessDeniedRep.md
|
331
|
+
- docs/AccessRep.md
|
332
|
+
- docs/AccessTokenPost.md
|
224
333
|
- docs/AccessTokensApi.md
|
225
|
-
- docs/
|
226
|
-
- docs/
|
227
|
-
- docs/
|
228
|
-
- docs/
|
229
|
-
- docs/ApprovalRequestReview.md
|
230
|
-
- docs/ApprovalRequestReviewConfigBody.md
|
231
|
-
- docs/ApprovalRequestReviewStatus.md
|
232
|
-
- docs/ApprovalRequests.md
|
334
|
+
- docs/AccountMembersApi.md
|
335
|
+
- docs/AccountUsageBetaApi.md
|
336
|
+
- docs/ApprovalSettings.md
|
337
|
+
- docs/ApprovalsApi.md
|
233
338
|
- docs/AuditLogApi.md
|
234
|
-
- docs/
|
235
|
-
- docs/
|
236
|
-
- docs/
|
237
|
-
- docs/
|
238
|
-
- docs/
|
339
|
+
- docs/AuditLogEntryListingRep.md
|
340
|
+
- docs/AuditLogEntryListingRepCollection.md
|
341
|
+
- docs/AuditLogEntryRep.md
|
342
|
+
- docs/AuthorizedAppDataRep.md
|
343
|
+
- docs/BigSegmentTarget.md
|
344
|
+
- docs/BranchCollectionRep.md
|
345
|
+
- docs/BranchRep.md
|
239
346
|
- docs/Clause.md
|
240
347
|
- docs/ClientSideAvailability.md
|
241
|
-
- docs/
|
348
|
+
- docs/ClientSideAvailabilityPost.md
|
349
|
+
- docs/CodeReferencesApi.md
|
350
|
+
- docs/ConfidenceIntervalRep.md
|
351
|
+
- docs/Conflict.md
|
352
|
+
- docs/CopiedFromEnv.md
|
353
|
+
- docs/CreateCopyFlagConfigApprovalRequestRequest.md
|
354
|
+
- docs/CreateFlagConfigApprovalRequestRequest.md
|
242
355
|
- docs/CustomProperty.md
|
243
|
-
- docs/CustomPropertyValues.md
|
244
356
|
- docs/CustomRole.md
|
245
|
-
- docs/
|
357
|
+
- docs/CustomRolePost.md
|
358
|
+
- docs/CustomRolePostData.md
|
246
359
|
- docs/CustomRoles.md
|
247
360
|
- docs/CustomRolesApi.md
|
248
|
-
- docs/CustomerMetricsApi.md
|
249
361
|
- docs/DataExportDestinationsApi.md
|
362
|
+
- docs/DefaultClientSideAvailabilityPost.md
|
250
363
|
- docs/Defaults.md
|
251
364
|
- docs/DependentFlag.md
|
252
365
|
- docs/DependentFlagEnvironment.md
|
253
|
-
- docs/DependentFlagEnvironmentLinks.md
|
254
|
-
- docs/DependentFlagLinks.md
|
255
366
|
- docs/DependentFlagsByEnvironment.md
|
256
|
-
- docs/DependentFlagsLinks.md
|
257
367
|
- docs/Destination.md
|
258
|
-
- docs/
|
259
|
-
- docs/DestinationBody.md
|
260
|
-
- docs/DestinationGooglePubSub.md
|
261
|
-
- docs/DestinationMParticle.md
|
262
|
-
- docs/DestinationSegment.md
|
368
|
+
- docs/DestinationPost.md
|
263
369
|
- docs/Destinations.md
|
264
370
|
- docs/Environment.md
|
265
|
-
- docs/EnvironmentApprovalSettings.md
|
266
371
|
- docs/EnvironmentPost.md
|
267
372
|
- docs/EnvironmentsApi.md
|
268
|
-
- docs/
|
269
|
-
- docs/
|
270
|
-
- docs/
|
373
|
+
- docs/ExperimentAllocationRep.md
|
374
|
+
- docs/ExperimentEnabledPeriodRep.md
|
375
|
+
- docs/ExperimentEnvironmentSettingRep.md
|
376
|
+
- docs/ExperimentInfoRep.md
|
377
|
+
- docs/ExperimentMetadataRep.md
|
378
|
+
- docs/ExperimentRep.md
|
379
|
+
- docs/ExperimentResultsRep.md
|
380
|
+
- docs/ExperimentStatsRep.md
|
381
|
+
- docs/ExperimentTimeSeriesSlice.md
|
382
|
+
- docs/ExperimentTimeSeriesVariationSlice.md
|
383
|
+
- docs/ExperimentTotalsRep.md
|
384
|
+
- docs/ExperimentsBetaApi.md
|
385
|
+
- docs/ExpiringUserTargetError.md
|
386
|
+
- docs/ExpiringUserTargetGetResponse.md
|
387
|
+
- docs/ExpiringUserTargetItem.md
|
388
|
+
- docs/ExpiringUserTargetPatchResponse.md
|
389
|
+
- docs/Extinction.md
|
390
|
+
- docs/ExtinctionCollectionRep.md
|
391
|
+
- docs/ExtinctionRep.md
|
271
392
|
- docs/FeatureFlag.md
|
272
393
|
- docs/FeatureFlagBody.md
|
273
394
|
- docs/FeatureFlagConfig.md
|
274
|
-
- docs/FeatureFlagCopyBody.md
|
275
|
-
- docs/FeatureFlagCopyObject.md
|
276
395
|
- docs/FeatureFlagScheduledChange.md
|
277
396
|
- docs/FeatureFlagScheduledChanges.md
|
278
|
-
- docs/FeatureFlagScheduledChangesConflicts.md
|
279
|
-
- docs/FeatureFlagScheduledChangesConflictsInstructions.md
|
280
397
|
- docs/FeatureFlagStatus.md
|
281
398
|
- docs/FeatureFlagStatusAcrossEnvironments.md
|
282
|
-
- docs/FeatureFlagStatusForQueriedEnvironment.md
|
283
|
-
- docs/FeatureFlagStatusLinks.md
|
284
399
|
- docs/FeatureFlagStatuses.md
|
285
400
|
- docs/FeatureFlags.md
|
286
401
|
- docs/FeatureFlagsApi.md
|
287
|
-
- docs/
|
288
|
-
- docs/
|
289
|
-
- docs/
|
290
|
-
- docs/
|
291
|
-
- docs/
|
292
|
-
- docs/
|
293
|
-
- docs/
|
294
|
-
- docs/
|
295
|
-
- docs/
|
296
|
-
- docs/
|
297
|
-
- docs/
|
402
|
+
- docs/FeatureFlagsBetaApi.md
|
403
|
+
- docs/FlagConfigApprovalRequestResponse.md
|
404
|
+
- docs/FlagConfigApprovalRequestsResponse.md
|
405
|
+
- docs/FlagCopyConfigEnvironment.md
|
406
|
+
- docs/FlagCopyConfigPost.md
|
407
|
+
- docs/FlagGlobalAttributesRep.md
|
408
|
+
- docs/FlagListingRep.md
|
409
|
+
- docs/FlagScheduledChangesInput.md
|
410
|
+
- docs/FlagStatusRep.md
|
411
|
+
- docs/FlagSummary.md
|
412
|
+
- docs/HunkRep.md
|
413
|
+
- docs/InlineObject.md
|
414
|
+
- docs/InlineObject1.md
|
415
|
+
- docs/InlineResponse200.md
|
416
|
+
- docs/IntegrationMetadata.md
|
417
|
+
- docs/IntegrationStatus.md
|
418
|
+
- docs/IpList.md
|
419
|
+
- docs/LastSeenMetadata.md
|
298
420
|
- docs/Link.md
|
299
|
-
- docs/Links.md
|
300
|
-
- docs/MAU.md
|
301
|
-
- docs/MAUMetadata.md
|
302
|
-
- docs/MAUbyCategory.md
|
303
421
|
- docs/Member.md
|
304
|
-
- docs/
|
422
|
+
- docs/MemberDataRep.md
|
423
|
+
- docs/MemberPermissionGrantSummaryRep.md
|
424
|
+
- docs/MemberSummaryRep.md
|
425
|
+
- docs/MemberTeamSummaryRep.md
|
305
426
|
- docs/Members.md
|
306
|
-
- docs/
|
427
|
+
- docs/MetricCollectionRep.md
|
428
|
+
- docs/MetricListingRep.md
|
429
|
+
- docs/MetricPost.md
|
430
|
+
- docs/MetricRep.md
|
431
|
+
- docs/MetricsApi.md
|
432
|
+
- docs/Modification.md
|
307
433
|
- docs/MultiEnvironmentDependentFlag.md
|
308
434
|
- docs/MultiEnvironmentDependentFlags.md
|
309
|
-
- docs/
|
435
|
+
- docs/NewMemberForm.md
|
436
|
+
- docs/OtherApi.md
|
437
|
+
- docs/ParentResourceRep.md
|
310
438
|
- docs/PatchOperation.md
|
311
|
-
- docs/
|
439
|
+
- docs/PatchSegmentInstruction.md
|
440
|
+
- docs/PatchSegmentRequest.md
|
441
|
+
- docs/PatchWithComment.md
|
442
|
+
- docs/PostApprovalRequestApplyRequest.md
|
443
|
+
- docs/PostApprovalRequestReviewRequest.md
|
444
|
+
- docs/PostFlagScheduledChangesInput.md
|
312
445
|
- docs/Prerequisite.md
|
313
446
|
- docs/Project.md
|
314
|
-
- docs/
|
447
|
+
- docs/ProjectListingRep.md
|
448
|
+
- docs/ProjectPost.md
|
315
449
|
- docs/Projects.md
|
316
450
|
- docs/ProjectsApi.md
|
317
|
-
- docs/
|
318
|
-
- docs/
|
319
|
-
- docs/
|
451
|
+
- docs/PubNubDetailRep.md
|
452
|
+
- docs/ReferenceRep.md
|
453
|
+
- docs/RelayAutoConfigCollectionRep.md
|
454
|
+
- docs/RelayAutoConfigPost.md
|
455
|
+
- docs/RelayAutoConfigRep.md
|
320
456
|
- docs/RelayProxyConfigurationsApi.md
|
321
|
-
- docs/
|
457
|
+
- docs/RepositoryCollectionRep.md
|
458
|
+
- docs/RepositoryPost.md
|
459
|
+
- docs/RepositoryRep.md
|
460
|
+
- docs/ResourceAccess.md
|
461
|
+
- docs/ResourceIDResponse.md
|
462
|
+
- docs/ReviewResponse.md
|
322
463
|
- docs/Rollout.md
|
323
|
-
- docs/RootApi.md
|
324
464
|
- docs/Rule.md
|
325
|
-
- docs/
|
326
|
-
- docs/
|
327
|
-
- docs/
|
328
|
-
- docs/
|
329
|
-
- docs/
|
330
|
-
- docs/
|
465
|
+
- docs/ScheduledChangesApi.md
|
466
|
+
- docs/SdkListRep.md
|
467
|
+
- docs/SdkVersionListRep.md
|
468
|
+
- docs/SdkVersionRep.md
|
469
|
+
- docs/SegmentBody.md
|
470
|
+
- docs/SegmentMetadata.md
|
471
|
+
- docs/SegmentUserList.md
|
472
|
+
- docs/SegmentUserState.md
|
473
|
+
- docs/SegmentsApi.md
|
474
|
+
- docs/SeriesListRep.md
|
475
|
+
- docs/SourceFlag.md
|
331
476
|
- docs/Statement.md
|
332
|
-
- docs/
|
333
|
-
- docs/
|
334
|
-
- docs/
|
335
|
-
- docs/
|
336
|
-
- docs/
|
337
|
-
- docs/
|
338
|
-
- docs/
|
339
|
-
- docs/StreamUsageError.md
|
340
|
-
- docs/StreamUsageLinks.md
|
341
|
-
- docs/StreamUsageMetadata.md
|
342
|
-
- docs/StreamUsageSeries.md
|
343
|
-
- docs/Streams.md
|
344
|
-
- docs/SubscriptionBody.md
|
477
|
+
- docs/StatementPost.md
|
478
|
+
- docs/StatementPostData.md
|
479
|
+
- docs/StatementRep.md
|
480
|
+
- docs/StatisticCollectionRep.md
|
481
|
+
- docs/StatisticRep.md
|
482
|
+
- docs/StatisticsRoot.md
|
483
|
+
- docs/SubjectDataRep.md
|
345
484
|
- docs/Target.md
|
346
|
-
- docs/
|
485
|
+
- docs/TargetResourceRep.md
|
486
|
+
- docs/TitleRep.md
|
347
487
|
- docs/Token.md
|
348
|
-
- docs/
|
488
|
+
- docs/TokenDataRep.md
|
349
489
|
- docs/Tokens.md
|
350
|
-
- docs/
|
351
|
-
- docs/UsageError.md
|
352
|
-
- docs/UsageLinks.md
|
490
|
+
- docs/UrlPost.md
|
353
491
|
- docs/User.md
|
492
|
+
- docs/UserAttributeNamesRep.md
|
354
493
|
- docs/UserFlagSetting.md
|
355
494
|
- docs/UserFlagSettings.md
|
356
495
|
- docs/UserRecord.md
|
357
496
|
- docs/UserSegment.md
|
358
|
-
- docs/UserSegmentBody.md
|
359
497
|
- docs/UserSegmentRule.md
|
360
498
|
- docs/UserSegments.md
|
361
|
-
- docs/UserSegmentsApi.md
|
362
499
|
- docs/UserSettingsApi.md
|
363
|
-
- docs/UserSettingsBody.md
|
364
|
-
- docs/UserTargetingExpirationForFlag.md
|
365
|
-
- docs/UserTargetingExpirationForFlags.md
|
366
|
-
- docs/UserTargetingExpirationForSegment.md
|
367
|
-
- docs/UserTargetingExpirationOnFlagsForUser.md
|
368
|
-
- docs/UserTargetingExpirationResourceIdForFlag.md
|
369
500
|
- docs/Users.md
|
370
501
|
- docs/UsersApi.md
|
502
|
+
- docs/UsersBetaApi.md
|
503
|
+
- docs/ValuePut.md
|
504
|
+
- docs/Variate.md
|
371
505
|
- docs/Variation.md
|
506
|
+
- docs/VariationOrRolloutRep.md
|
507
|
+
- docs/VariationSummary.md
|
508
|
+
- docs/VersionsRep.md
|
372
509
|
- docs/Webhook.md
|
373
|
-
- docs/
|
510
|
+
- docs/WebhookPost.md
|
374
511
|
- docs/Webhooks.md
|
375
512
|
- docs/WebhooksApi.md
|
376
513
|
- docs/WeightedVariation.md
|
@@ -378,315 +515,378 @@ files:
|
|
378
515
|
- launchdarkly_api.gemspec
|
379
516
|
- lib/launchdarkly_api.rb
|
380
517
|
- lib/launchdarkly_api/api/access_tokens_api.rb
|
518
|
+
- lib/launchdarkly_api/api/account_members_api.rb
|
519
|
+
- lib/launchdarkly_api/api/account_usage_beta_api.rb
|
520
|
+
- lib/launchdarkly_api/api/approvals_api.rb
|
381
521
|
- lib/launchdarkly_api/api/audit_log_api.rb
|
522
|
+
- lib/launchdarkly_api/api/code_references_api.rb
|
382
523
|
- lib/launchdarkly_api/api/custom_roles_api.rb
|
383
|
-
- lib/launchdarkly_api/api/customer_metrics_api.rb
|
384
524
|
- lib/launchdarkly_api/api/data_export_destinations_api.rb
|
385
525
|
- lib/launchdarkly_api/api/environments_api.rb
|
526
|
+
- lib/launchdarkly_api/api/experiments_beta_api.rb
|
386
527
|
- lib/launchdarkly_api/api/feature_flags_api.rb
|
387
|
-
- lib/launchdarkly_api/api/
|
528
|
+
- lib/launchdarkly_api/api/feature_flags_beta_api.rb
|
529
|
+
- lib/launchdarkly_api/api/metrics_api.rb
|
530
|
+
- lib/launchdarkly_api/api/other_api.rb
|
388
531
|
- lib/launchdarkly_api/api/projects_api.rb
|
389
532
|
- lib/launchdarkly_api/api/relay_proxy_configurations_api.rb
|
390
|
-
- lib/launchdarkly_api/api/
|
391
|
-
- lib/launchdarkly_api/api/
|
392
|
-
- lib/launchdarkly_api/api/user_segments_api.rb
|
533
|
+
- lib/launchdarkly_api/api/scheduled_changes_api.rb
|
534
|
+
- lib/launchdarkly_api/api/segments_api.rb
|
393
535
|
- lib/launchdarkly_api/api/user_settings_api.rb
|
394
536
|
- lib/launchdarkly_api/api/users_api.rb
|
537
|
+
- lib/launchdarkly_api/api/users_beta_api.rb
|
395
538
|
- lib/launchdarkly_api/api/webhooks_api.rb
|
396
539
|
- lib/launchdarkly_api/api_client.rb
|
397
540
|
- lib/launchdarkly_api/api_error.rb
|
398
541
|
- lib/launchdarkly_api/configuration.rb
|
399
|
-
- lib/launchdarkly_api/models/
|
400
|
-
- lib/launchdarkly_api/models/
|
401
|
-
- lib/launchdarkly_api/models/
|
402
|
-
- lib/launchdarkly_api/models/
|
403
|
-
- lib/launchdarkly_api/models/
|
404
|
-
- lib/launchdarkly_api/models/
|
405
|
-
- lib/launchdarkly_api/models/
|
406
|
-
- lib/launchdarkly_api/models/
|
407
|
-
- lib/launchdarkly_api/models/
|
408
|
-
- lib/launchdarkly_api/models/
|
409
|
-
- lib/launchdarkly_api/models/
|
410
|
-
- lib/launchdarkly_api/models/
|
411
|
-
- lib/launchdarkly_api/models/big_segment_targets_body.rb
|
542
|
+
- lib/launchdarkly_api/models/access_denied_reason_rep.rb
|
543
|
+
- lib/launchdarkly_api/models/access_denied_rep.rb
|
544
|
+
- lib/launchdarkly_api/models/access_rep.rb
|
545
|
+
- lib/launchdarkly_api/models/access_token_post.rb
|
546
|
+
- lib/launchdarkly_api/models/approval_settings.rb
|
547
|
+
- lib/launchdarkly_api/models/audit_log_entry_listing_rep.rb
|
548
|
+
- lib/launchdarkly_api/models/audit_log_entry_listing_rep_collection.rb
|
549
|
+
- lib/launchdarkly_api/models/audit_log_entry_rep.rb
|
550
|
+
- lib/launchdarkly_api/models/authorized_app_data_rep.rb
|
551
|
+
- lib/launchdarkly_api/models/big_segment_target.rb
|
552
|
+
- lib/launchdarkly_api/models/branch_collection_rep.rb
|
553
|
+
- lib/launchdarkly_api/models/branch_rep.rb
|
412
554
|
- lib/launchdarkly_api/models/clause.rb
|
413
555
|
- lib/launchdarkly_api/models/client_side_availability.rb
|
414
|
-
- lib/launchdarkly_api/models/
|
556
|
+
- lib/launchdarkly_api/models/client_side_availability_post.rb
|
557
|
+
- lib/launchdarkly_api/models/confidence_interval_rep.rb
|
558
|
+
- lib/launchdarkly_api/models/conflict.rb
|
559
|
+
- lib/launchdarkly_api/models/copied_from_env.rb
|
560
|
+
- lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb
|
561
|
+
- lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb
|
415
562
|
- lib/launchdarkly_api/models/custom_property.rb
|
416
|
-
- lib/launchdarkly_api/models/custom_property_values.rb
|
417
563
|
- lib/launchdarkly_api/models/custom_role.rb
|
418
|
-
- lib/launchdarkly_api/models/
|
564
|
+
- lib/launchdarkly_api/models/custom_role_post.rb
|
565
|
+
- lib/launchdarkly_api/models/custom_role_post_data.rb
|
419
566
|
- lib/launchdarkly_api/models/custom_roles.rb
|
567
|
+
- lib/launchdarkly_api/models/default_client_side_availability_post.rb
|
420
568
|
- lib/launchdarkly_api/models/defaults.rb
|
421
569
|
- lib/launchdarkly_api/models/dependent_flag.rb
|
422
|
-
- lib/launchdarkly_api/models/dependent_flag__links.rb
|
423
570
|
- lib/launchdarkly_api/models/dependent_flag_environment.rb
|
424
|
-
- lib/launchdarkly_api/models/dependent_flag_environment__links.rb
|
425
571
|
- lib/launchdarkly_api/models/dependent_flags_by_environment.rb
|
426
|
-
- lib/launchdarkly_api/models/dependent_flags_links.rb
|
427
572
|
- lib/launchdarkly_api/models/destination.rb
|
428
|
-
- lib/launchdarkly_api/models/
|
429
|
-
- lib/launchdarkly_api/models/destination_body.rb
|
430
|
-
- lib/launchdarkly_api/models/destination_google_pub_sub.rb
|
431
|
-
- lib/launchdarkly_api/models/destination_m_particle.rb
|
432
|
-
- lib/launchdarkly_api/models/destination_segment.rb
|
573
|
+
- lib/launchdarkly_api/models/destination_post.rb
|
433
574
|
- lib/launchdarkly_api/models/destinations.rb
|
434
575
|
- lib/launchdarkly_api/models/environment.rb
|
435
|
-
- lib/launchdarkly_api/models/environment_approval_settings.rb
|
436
576
|
- lib/launchdarkly_api/models/environment_post.rb
|
437
|
-
- lib/launchdarkly_api/models/
|
438
|
-
- lib/launchdarkly_api/models/
|
439
|
-
- lib/launchdarkly_api/models/
|
577
|
+
- lib/launchdarkly_api/models/experiment_allocation_rep.rb
|
578
|
+
- lib/launchdarkly_api/models/experiment_enabled_period_rep.rb
|
579
|
+
- lib/launchdarkly_api/models/experiment_environment_setting_rep.rb
|
580
|
+
- lib/launchdarkly_api/models/experiment_info_rep.rb
|
581
|
+
- lib/launchdarkly_api/models/experiment_metadata_rep.rb
|
582
|
+
- lib/launchdarkly_api/models/experiment_rep.rb
|
583
|
+
- lib/launchdarkly_api/models/experiment_results_rep.rb
|
584
|
+
- lib/launchdarkly_api/models/experiment_stats_rep.rb
|
585
|
+
- lib/launchdarkly_api/models/experiment_time_series_slice.rb
|
586
|
+
- lib/launchdarkly_api/models/experiment_time_series_variation_slice.rb
|
587
|
+
- lib/launchdarkly_api/models/experiment_totals_rep.rb
|
588
|
+
- lib/launchdarkly_api/models/expiring_user_target_error.rb
|
589
|
+
- lib/launchdarkly_api/models/expiring_user_target_get_response.rb
|
590
|
+
- lib/launchdarkly_api/models/expiring_user_target_item.rb
|
591
|
+
- lib/launchdarkly_api/models/expiring_user_target_patch_response.rb
|
592
|
+
- lib/launchdarkly_api/models/extinction.rb
|
593
|
+
- lib/launchdarkly_api/models/extinction_collection_rep.rb
|
594
|
+
- lib/launchdarkly_api/models/extinction_rep.rb
|
440
595
|
- lib/launchdarkly_api/models/feature_flag.rb
|
441
596
|
- lib/launchdarkly_api/models/feature_flag_body.rb
|
442
597
|
- lib/launchdarkly_api/models/feature_flag_config.rb
|
443
|
-
- lib/launchdarkly_api/models/feature_flag_copy_body.rb
|
444
|
-
- lib/launchdarkly_api/models/feature_flag_copy_object.rb
|
445
598
|
- lib/launchdarkly_api/models/feature_flag_scheduled_change.rb
|
446
599
|
- lib/launchdarkly_api/models/feature_flag_scheduled_changes.rb
|
447
|
-
- lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts.rb
|
448
|
-
- lib/launchdarkly_api/models/feature_flag_scheduled_changes_conflicts_instructions.rb
|
449
600
|
- lib/launchdarkly_api/models/feature_flag_status.rb
|
450
601
|
- lib/launchdarkly_api/models/feature_flag_status_across_environments.rb
|
451
|
-
- lib/launchdarkly_api/models/feature_flag_status_for_queried_environment.rb
|
452
|
-
- lib/launchdarkly_api/models/feature_flag_status_links.rb
|
453
602
|
- lib/launchdarkly_api/models/feature_flag_statuses.rb
|
454
603
|
- lib/launchdarkly_api/models/feature_flags.rb
|
455
|
-
- lib/launchdarkly_api/models/
|
456
|
-
- lib/launchdarkly_api/models/
|
457
|
-
- lib/launchdarkly_api/models/
|
458
|
-
- lib/launchdarkly_api/models/
|
459
|
-
- lib/launchdarkly_api/models/
|
460
|
-
- lib/launchdarkly_api/models/
|
461
|
-
- lib/launchdarkly_api/models/
|
462
|
-
- lib/launchdarkly_api/models/
|
463
|
-
- lib/launchdarkly_api/models/
|
464
|
-
- lib/launchdarkly_api/models/
|
604
|
+
- lib/launchdarkly_api/models/flag_config_approval_request_response.rb
|
605
|
+
- lib/launchdarkly_api/models/flag_config_approval_requests_response.rb
|
606
|
+
- lib/launchdarkly_api/models/flag_copy_config_environment.rb
|
607
|
+
- lib/launchdarkly_api/models/flag_copy_config_post.rb
|
608
|
+
- lib/launchdarkly_api/models/flag_global_attributes_rep.rb
|
609
|
+
- lib/launchdarkly_api/models/flag_listing_rep.rb
|
610
|
+
- lib/launchdarkly_api/models/flag_scheduled_changes_input.rb
|
611
|
+
- lib/launchdarkly_api/models/flag_status_rep.rb
|
612
|
+
- lib/launchdarkly_api/models/flag_summary.rb
|
613
|
+
- lib/launchdarkly_api/models/hunk_rep.rb
|
614
|
+
- lib/launchdarkly_api/models/inline_object.rb
|
615
|
+
- lib/launchdarkly_api/models/inline_object1.rb
|
616
|
+
- lib/launchdarkly_api/models/inline_response200.rb
|
617
|
+
- lib/launchdarkly_api/models/integration_metadata.rb
|
618
|
+
- lib/launchdarkly_api/models/integration_status.rb
|
619
|
+
- lib/launchdarkly_api/models/ip_list.rb
|
620
|
+
- lib/launchdarkly_api/models/last_seen_metadata.rb
|
465
621
|
- lib/launchdarkly_api/models/link.rb
|
466
|
-
- lib/launchdarkly_api/models/links.rb
|
467
|
-
- lib/launchdarkly_api/models/ma_uby_category.rb
|
468
|
-
- lib/launchdarkly_api/models/mau.rb
|
469
|
-
- lib/launchdarkly_api/models/mau_metadata.rb
|
470
622
|
- lib/launchdarkly_api/models/member.rb
|
471
|
-
- lib/launchdarkly_api/models/
|
623
|
+
- lib/launchdarkly_api/models/member_data_rep.rb
|
624
|
+
- lib/launchdarkly_api/models/member_permission_grant_summary_rep.rb
|
625
|
+
- lib/launchdarkly_api/models/member_summary_rep.rb
|
626
|
+
- lib/launchdarkly_api/models/member_team_summary_rep.rb
|
472
627
|
- lib/launchdarkly_api/models/members.rb
|
473
|
-
- lib/launchdarkly_api/models/
|
628
|
+
- lib/launchdarkly_api/models/metric_collection_rep.rb
|
629
|
+
- lib/launchdarkly_api/models/metric_listing_rep.rb
|
630
|
+
- lib/launchdarkly_api/models/metric_post.rb
|
631
|
+
- lib/launchdarkly_api/models/metric_rep.rb
|
632
|
+
- lib/launchdarkly_api/models/modification.rb
|
474
633
|
- lib/launchdarkly_api/models/multi_environment_dependent_flag.rb
|
475
634
|
- lib/launchdarkly_api/models/multi_environment_dependent_flags.rb
|
476
|
-
- lib/launchdarkly_api/models/
|
635
|
+
- lib/launchdarkly_api/models/new_member_form.rb
|
636
|
+
- lib/launchdarkly_api/models/parent_resource_rep.rb
|
477
637
|
- lib/launchdarkly_api/models/patch_operation.rb
|
478
|
-
- lib/launchdarkly_api/models/
|
638
|
+
- lib/launchdarkly_api/models/patch_segment_instruction.rb
|
639
|
+
- lib/launchdarkly_api/models/patch_segment_request.rb
|
640
|
+
- lib/launchdarkly_api/models/patch_with_comment.rb
|
641
|
+
- lib/launchdarkly_api/models/post_approval_request_apply_request.rb
|
642
|
+
- lib/launchdarkly_api/models/post_approval_request_review_request.rb
|
643
|
+
- lib/launchdarkly_api/models/post_flag_scheduled_changes_input.rb
|
479
644
|
- lib/launchdarkly_api/models/prerequisite.rb
|
480
645
|
- lib/launchdarkly_api/models/project.rb
|
481
|
-
- lib/launchdarkly_api/models/
|
646
|
+
- lib/launchdarkly_api/models/project_listing_rep.rb
|
647
|
+
- lib/launchdarkly_api/models/project_post.rb
|
482
648
|
- lib/launchdarkly_api/models/projects.rb
|
483
|
-
- lib/launchdarkly_api/models/
|
484
|
-
- lib/launchdarkly_api/models/
|
485
|
-
- lib/launchdarkly_api/models/
|
486
|
-
- lib/launchdarkly_api/models/
|
649
|
+
- lib/launchdarkly_api/models/pub_nub_detail_rep.rb
|
650
|
+
- lib/launchdarkly_api/models/reference_rep.rb
|
651
|
+
- lib/launchdarkly_api/models/relay_auto_config_collection_rep.rb
|
652
|
+
- lib/launchdarkly_api/models/relay_auto_config_post.rb
|
653
|
+
- lib/launchdarkly_api/models/relay_auto_config_rep.rb
|
654
|
+
- lib/launchdarkly_api/models/repository_collection_rep.rb
|
655
|
+
- lib/launchdarkly_api/models/repository_post.rb
|
656
|
+
- lib/launchdarkly_api/models/repository_rep.rb
|
657
|
+
- lib/launchdarkly_api/models/resource_access.rb
|
658
|
+
- lib/launchdarkly_api/models/resource_id_response.rb
|
659
|
+
- lib/launchdarkly_api/models/review_response.rb
|
487
660
|
- lib/launchdarkly_api/models/rollout.rb
|
488
661
|
- lib/launchdarkly_api/models/rule.rb
|
489
|
-
- lib/launchdarkly_api/models/
|
490
|
-
- lib/launchdarkly_api/models/
|
491
|
-
- lib/launchdarkly_api/models/
|
492
|
-
- lib/launchdarkly_api/models/
|
493
|
-
- lib/launchdarkly_api/models/
|
494
|
-
- lib/launchdarkly_api/models/
|
662
|
+
- lib/launchdarkly_api/models/sdk_list_rep.rb
|
663
|
+
- lib/launchdarkly_api/models/sdk_version_list_rep.rb
|
664
|
+
- lib/launchdarkly_api/models/sdk_version_rep.rb
|
665
|
+
- lib/launchdarkly_api/models/segment_body.rb
|
666
|
+
- lib/launchdarkly_api/models/segment_metadata.rb
|
667
|
+
- lib/launchdarkly_api/models/segment_user_list.rb
|
668
|
+
- lib/launchdarkly_api/models/segment_user_state.rb
|
669
|
+
- lib/launchdarkly_api/models/series_list_rep.rb
|
670
|
+
- lib/launchdarkly_api/models/source_flag.rb
|
495
671
|
- lib/launchdarkly_api/models/statement.rb
|
496
|
-
- lib/launchdarkly_api/models/
|
497
|
-
- lib/launchdarkly_api/models/
|
498
|
-
- lib/launchdarkly_api/models/
|
499
|
-
- lib/launchdarkly_api/models/
|
500
|
-
- lib/launchdarkly_api/models/
|
501
|
-
- lib/launchdarkly_api/models/
|
502
|
-
- lib/launchdarkly_api/models/
|
503
|
-
- lib/launchdarkly_api/models/stream_usage_error.rb
|
504
|
-
- lib/launchdarkly_api/models/stream_usage_links.rb
|
505
|
-
- lib/launchdarkly_api/models/stream_usage_metadata.rb
|
506
|
-
- lib/launchdarkly_api/models/stream_usage_series.rb
|
507
|
-
- lib/launchdarkly_api/models/streams.rb
|
508
|
-
- lib/launchdarkly_api/models/subscription_body.rb
|
672
|
+
- lib/launchdarkly_api/models/statement_post.rb
|
673
|
+
- lib/launchdarkly_api/models/statement_post_data.rb
|
674
|
+
- lib/launchdarkly_api/models/statement_rep.rb
|
675
|
+
- lib/launchdarkly_api/models/statistic_collection_rep.rb
|
676
|
+
- lib/launchdarkly_api/models/statistic_rep.rb
|
677
|
+
- lib/launchdarkly_api/models/statistics_root.rb
|
678
|
+
- lib/launchdarkly_api/models/subject_data_rep.rb
|
509
679
|
- lib/launchdarkly_api/models/target.rb
|
680
|
+
- lib/launchdarkly_api/models/target_resource_rep.rb
|
681
|
+
- lib/launchdarkly_api/models/title_rep.rb
|
510
682
|
- lib/launchdarkly_api/models/token.rb
|
511
|
-
- lib/launchdarkly_api/models/
|
683
|
+
- lib/launchdarkly_api/models/token_data_rep.rb
|
512
684
|
- lib/launchdarkly_api/models/tokens.rb
|
513
|
-
- lib/launchdarkly_api/models/
|
514
|
-
- lib/launchdarkly_api/models/usage_error.rb
|
515
|
-
- lib/launchdarkly_api/models/usage_links.rb
|
685
|
+
- lib/launchdarkly_api/models/url_post.rb
|
516
686
|
- lib/launchdarkly_api/models/user.rb
|
687
|
+
- lib/launchdarkly_api/models/user_attribute_names_rep.rb
|
517
688
|
- lib/launchdarkly_api/models/user_flag_setting.rb
|
518
689
|
- lib/launchdarkly_api/models/user_flag_settings.rb
|
519
690
|
- lib/launchdarkly_api/models/user_record.rb
|
520
691
|
- lib/launchdarkly_api/models/user_segment.rb
|
521
|
-
- lib/launchdarkly_api/models/user_segment_body.rb
|
522
692
|
- lib/launchdarkly_api/models/user_segment_rule.rb
|
523
693
|
- lib/launchdarkly_api/models/user_segments.rb
|
524
|
-
- lib/launchdarkly_api/models/user_settings_body.rb
|
525
|
-
- lib/launchdarkly_api/models/user_targeting_expiration_for_flag.rb
|
526
|
-
- lib/launchdarkly_api/models/user_targeting_expiration_for_flags.rb
|
527
|
-
- lib/launchdarkly_api/models/user_targeting_expiration_for_segment.rb
|
528
|
-
- lib/launchdarkly_api/models/user_targeting_expiration_on_flags_for_user.rb
|
529
|
-
- lib/launchdarkly_api/models/user_targeting_expiration_resource_id_for_flag.rb
|
530
694
|
- lib/launchdarkly_api/models/users.rb
|
695
|
+
- lib/launchdarkly_api/models/value_put.rb
|
696
|
+
- lib/launchdarkly_api/models/variate.rb
|
531
697
|
- lib/launchdarkly_api/models/variation.rb
|
698
|
+
- lib/launchdarkly_api/models/variation_or_rollout_rep.rb
|
699
|
+
- lib/launchdarkly_api/models/variation_summary.rb
|
700
|
+
- lib/launchdarkly_api/models/versions_rep.rb
|
532
701
|
- lib/launchdarkly_api/models/webhook.rb
|
533
|
-
- lib/launchdarkly_api/models/
|
702
|
+
- lib/launchdarkly_api/models/webhook_post.rb
|
534
703
|
- lib/launchdarkly_api/models/webhooks.rb
|
535
704
|
- lib/launchdarkly_api/models/weighted_variation.rb
|
536
705
|
- lib/launchdarkly_api/version.rb
|
537
|
-
- openapi.yml
|
538
706
|
- spec/api/access_tokens_api_spec.rb
|
707
|
+
- spec/api/account_members_api_spec.rb
|
708
|
+
- spec/api/account_usage_beta_api_spec.rb
|
709
|
+
- spec/api/approvals_api_spec.rb
|
539
710
|
- spec/api/audit_log_api_spec.rb
|
711
|
+
- spec/api/code_references_api_spec.rb
|
540
712
|
- spec/api/custom_roles_api_spec.rb
|
541
|
-
- spec/api/customer_metrics_api_spec.rb
|
542
713
|
- spec/api/data_export_destinations_api_spec.rb
|
543
714
|
- spec/api/environments_api_spec.rb
|
715
|
+
- spec/api/experiments_beta_api_spec.rb
|
544
716
|
- spec/api/feature_flags_api_spec.rb
|
545
|
-
- spec/api/
|
717
|
+
- spec/api/feature_flags_beta_api_spec.rb
|
718
|
+
- spec/api/metrics_api_spec.rb
|
719
|
+
- spec/api/other_api_spec.rb
|
546
720
|
- spec/api/projects_api_spec.rb
|
547
721
|
- spec/api/relay_proxy_configurations_api_spec.rb
|
548
|
-
- spec/api/
|
549
|
-
- spec/api/
|
550
|
-
- spec/api/user_segments_api_spec.rb
|
722
|
+
- spec/api/scheduled_changes_api_spec.rb
|
723
|
+
- spec/api/segments_api_spec.rb
|
551
724
|
- spec/api/user_settings_api_spec.rb
|
552
725
|
- spec/api/users_api_spec.rb
|
726
|
+
- spec/api/users_beta_api_spec.rb
|
553
727
|
- spec/api/webhooks_api_spec.rb
|
554
728
|
- spec/api_client_spec.rb
|
555
729
|
- spec/configuration_spec.rb
|
556
|
-
- spec/models/
|
557
|
-
- spec/models/
|
558
|
-
- spec/models/
|
559
|
-
- spec/models/
|
560
|
-
- spec/models/
|
561
|
-
- spec/models/
|
562
|
-
- spec/models/
|
563
|
-
- spec/models/
|
564
|
-
- spec/models/
|
565
|
-
- spec/models/
|
566
|
-
- spec/models/
|
567
|
-
- spec/models/
|
568
|
-
- spec/models/big_segment_targets_body_spec.rb
|
730
|
+
- spec/models/access_denied_reason_rep_spec.rb
|
731
|
+
- spec/models/access_denied_rep_spec.rb
|
732
|
+
- spec/models/access_rep_spec.rb
|
733
|
+
- spec/models/access_token_post_spec.rb
|
734
|
+
- spec/models/approval_settings_spec.rb
|
735
|
+
- spec/models/audit_log_entry_listing_rep_collection_spec.rb
|
736
|
+
- spec/models/audit_log_entry_listing_rep_spec.rb
|
737
|
+
- spec/models/audit_log_entry_rep_spec.rb
|
738
|
+
- spec/models/authorized_app_data_rep_spec.rb
|
739
|
+
- spec/models/big_segment_target_spec.rb
|
740
|
+
- spec/models/branch_collection_rep_spec.rb
|
741
|
+
- spec/models/branch_rep_spec.rb
|
569
742
|
- spec/models/clause_spec.rb
|
743
|
+
- spec/models/client_side_availability_post_spec.rb
|
570
744
|
- spec/models/client_side_availability_spec.rb
|
571
|
-
- spec/models/
|
745
|
+
- spec/models/confidence_interval_rep_spec.rb
|
746
|
+
- spec/models/conflict_spec.rb
|
747
|
+
- spec/models/copied_from_env_spec.rb
|
748
|
+
- spec/models/create_copy_flag_config_approval_request_request_spec.rb
|
749
|
+
- spec/models/create_flag_config_approval_request_request_spec.rb
|
572
750
|
- spec/models/custom_property_spec.rb
|
573
|
-
- spec/models/
|
574
|
-
- spec/models/
|
751
|
+
- spec/models/custom_role_post_data_spec.rb
|
752
|
+
- spec/models/custom_role_post_spec.rb
|
575
753
|
- spec/models/custom_role_spec.rb
|
576
754
|
- spec/models/custom_roles_spec.rb
|
755
|
+
- spec/models/default_client_side_availability_post_spec.rb
|
577
756
|
- spec/models/defaults_spec.rb
|
578
|
-
- spec/models/dependent_flag__links_spec.rb
|
579
|
-
- spec/models/dependent_flag_environment__links_spec.rb
|
580
757
|
- spec/models/dependent_flag_environment_spec.rb
|
581
758
|
- spec/models/dependent_flag_spec.rb
|
582
759
|
- spec/models/dependent_flags_by_environment_spec.rb
|
583
|
-
- spec/models/
|
584
|
-
- spec/models/destination_amazon_kinesis_spec.rb
|
585
|
-
- spec/models/destination_body_spec.rb
|
586
|
-
- spec/models/destination_google_pub_sub_spec.rb
|
587
|
-
- spec/models/destination_m_particle_spec.rb
|
588
|
-
- spec/models/destination_segment_spec.rb
|
760
|
+
- spec/models/destination_post_spec.rb
|
589
761
|
- spec/models/destination_spec.rb
|
590
762
|
- spec/models/destinations_spec.rb
|
591
|
-
- spec/models/environment_approval_settings_spec.rb
|
592
763
|
- spec/models/environment_post_spec.rb
|
593
764
|
- spec/models/environment_spec.rb
|
594
|
-
- spec/models/
|
595
|
-
- spec/models/
|
596
|
-
- spec/models/
|
765
|
+
- spec/models/experiment_allocation_rep_spec.rb
|
766
|
+
- spec/models/experiment_enabled_period_rep_spec.rb
|
767
|
+
- spec/models/experiment_environment_setting_rep_spec.rb
|
768
|
+
- spec/models/experiment_info_rep_spec.rb
|
769
|
+
- spec/models/experiment_metadata_rep_spec.rb
|
770
|
+
- spec/models/experiment_rep_spec.rb
|
771
|
+
- spec/models/experiment_results_rep_spec.rb
|
772
|
+
- spec/models/experiment_stats_rep_spec.rb
|
773
|
+
- spec/models/experiment_time_series_slice_spec.rb
|
774
|
+
- spec/models/experiment_time_series_variation_slice_spec.rb
|
775
|
+
- spec/models/experiment_totals_rep_spec.rb
|
776
|
+
- spec/models/expiring_user_target_error_spec.rb
|
777
|
+
- spec/models/expiring_user_target_get_response_spec.rb
|
778
|
+
- spec/models/expiring_user_target_item_spec.rb
|
779
|
+
- spec/models/expiring_user_target_patch_response_spec.rb
|
780
|
+
- spec/models/extinction_collection_rep_spec.rb
|
781
|
+
- spec/models/extinction_rep_spec.rb
|
782
|
+
- spec/models/extinction_spec.rb
|
597
783
|
- spec/models/feature_flag_body_spec.rb
|
598
784
|
- spec/models/feature_flag_config_spec.rb
|
599
|
-
- spec/models/feature_flag_copy_body_spec.rb
|
600
|
-
- spec/models/feature_flag_copy_object_spec.rb
|
601
785
|
- spec/models/feature_flag_scheduled_change_spec.rb
|
602
|
-
- spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb
|
603
|
-
- spec/models/feature_flag_scheduled_changes_conflicts_spec.rb
|
604
786
|
- spec/models/feature_flag_scheduled_changes_spec.rb
|
605
787
|
- spec/models/feature_flag_spec.rb
|
606
788
|
- spec/models/feature_flag_status_across_environments_spec.rb
|
607
|
-
- spec/models/feature_flag_status_for_queried_environment_spec.rb
|
608
|
-
- spec/models/feature_flag_status_links_spec.rb
|
609
789
|
- spec/models/feature_flag_status_spec.rb
|
610
790
|
- spec/models/feature_flag_statuses_spec.rb
|
611
791
|
- spec/models/feature_flags_spec.rb
|
612
|
-
- spec/models/
|
613
|
-
- spec/models/
|
614
|
-
- spec/models/
|
615
|
-
- spec/models/
|
616
|
-
- spec/models/
|
617
|
-
- spec/models/
|
618
|
-
- spec/models/
|
619
|
-
- spec/models/
|
620
|
-
- spec/models/
|
621
|
-
- spec/models/
|
792
|
+
- spec/models/flag_config_approval_request_response_spec.rb
|
793
|
+
- spec/models/flag_config_approval_requests_response_spec.rb
|
794
|
+
- spec/models/flag_copy_config_environment_spec.rb
|
795
|
+
- spec/models/flag_copy_config_post_spec.rb
|
796
|
+
- spec/models/flag_global_attributes_rep_spec.rb
|
797
|
+
- spec/models/flag_listing_rep_spec.rb
|
798
|
+
- spec/models/flag_scheduled_changes_input_spec.rb
|
799
|
+
- spec/models/flag_status_rep_spec.rb
|
800
|
+
- spec/models/flag_summary_spec.rb
|
801
|
+
- spec/models/hunk_rep_spec.rb
|
802
|
+
- spec/models/inline_object1_spec.rb
|
803
|
+
- spec/models/inline_object_spec.rb
|
804
|
+
- spec/models/inline_response200_spec.rb
|
805
|
+
- spec/models/integration_metadata_spec.rb
|
806
|
+
- spec/models/integration_status_spec.rb
|
807
|
+
- spec/models/ip_list_spec.rb
|
808
|
+
- spec/models/last_seen_metadata_spec.rb
|
622
809
|
- spec/models/link_spec.rb
|
623
|
-
- spec/models/
|
624
|
-
- spec/models/
|
625
|
-
- spec/models/mau_metadata_spec.rb
|
626
|
-
- spec/models/mau_spec.rb
|
627
|
-
- spec/models/member__last_seen_metadata_spec.rb
|
810
|
+
- spec/models/member_data_rep_spec.rb
|
811
|
+
- spec/models/member_permission_grant_summary_rep_spec.rb
|
628
812
|
- spec/models/member_spec.rb
|
629
|
-
- spec/models/
|
813
|
+
- spec/models/member_summary_rep_spec.rb
|
814
|
+
- spec/models/member_team_summary_rep_spec.rb
|
630
815
|
- spec/models/members_spec.rb
|
816
|
+
- spec/models/metric_collection_rep_spec.rb
|
817
|
+
- spec/models/metric_listing_rep_spec.rb
|
818
|
+
- spec/models/metric_post_spec.rb
|
819
|
+
- spec/models/metric_rep_spec.rb
|
820
|
+
- spec/models/modification_spec.rb
|
631
821
|
- spec/models/multi_environment_dependent_flag_spec.rb
|
632
822
|
- spec/models/multi_environment_dependent_flags_spec.rb
|
633
|
-
- spec/models/
|
823
|
+
- spec/models/new_member_form_spec.rb
|
824
|
+
- spec/models/parent_resource_rep_spec.rb
|
634
825
|
- spec/models/patch_operation_spec.rb
|
635
|
-
- spec/models/
|
826
|
+
- spec/models/patch_segment_instruction_spec.rb
|
827
|
+
- spec/models/patch_segment_request_spec.rb
|
828
|
+
- spec/models/patch_with_comment_spec.rb
|
829
|
+
- spec/models/post_approval_request_apply_request_spec.rb
|
830
|
+
- spec/models/post_approval_request_review_request_spec.rb
|
831
|
+
- spec/models/post_flag_scheduled_changes_input_spec.rb
|
636
832
|
- spec/models/prerequisite_spec.rb
|
637
|
-
- spec/models/
|
833
|
+
- spec/models/project_listing_rep_spec.rb
|
834
|
+
- spec/models/project_post_spec.rb
|
638
835
|
- spec/models/project_spec.rb
|
639
836
|
- spec/models/projects_spec.rb
|
640
|
-
- spec/models/
|
641
|
-
- spec/models/
|
642
|
-
- spec/models/
|
643
|
-
- spec/models/
|
837
|
+
- spec/models/pub_nub_detail_rep_spec.rb
|
838
|
+
- spec/models/reference_rep_spec.rb
|
839
|
+
- spec/models/relay_auto_config_collection_rep_spec.rb
|
840
|
+
- spec/models/relay_auto_config_post_spec.rb
|
841
|
+
- spec/models/relay_auto_config_rep_spec.rb
|
842
|
+
- spec/models/repository_collection_rep_spec.rb
|
843
|
+
- spec/models/repository_post_spec.rb
|
844
|
+
- spec/models/repository_rep_spec.rb
|
845
|
+
- spec/models/resource_access_spec.rb
|
846
|
+
- spec/models/resource_id_response_spec.rb
|
847
|
+
- spec/models/review_response_spec.rb
|
644
848
|
- spec/models/rollout_spec.rb
|
645
849
|
- spec/models/rule_spec.rb
|
646
|
-
- spec/models/
|
647
|
-
- spec/models/
|
648
|
-
- spec/models/
|
649
|
-
- spec/models/
|
650
|
-
- spec/models/
|
651
|
-
- spec/models/
|
850
|
+
- spec/models/sdk_list_rep_spec.rb
|
851
|
+
- spec/models/sdk_version_list_rep_spec.rb
|
852
|
+
- spec/models/sdk_version_rep_spec.rb
|
853
|
+
- spec/models/segment_body_spec.rb
|
854
|
+
- spec/models/segment_metadata_spec.rb
|
855
|
+
- spec/models/segment_user_list_spec.rb
|
856
|
+
- spec/models/segment_user_state_spec.rb
|
857
|
+
- spec/models/series_list_rep_spec.rb
|
858
|
+
- spec/models/source_flag_spec.rb
|
859
|
+
- spec/models/statement_post_data_spec.rb
|
860
|
+
- spec/models/statement_post_spec.rb
|
861
|
+
- spec/models/statement_rep_spec.rb
|
652
862
|
- spec/models/statement_spec.rb
|
653
|
-
- spec/models/
|
654
|
-
- spec/models/
|
655
|
-
- spec/models/
|
656
|
-
- spec/models/
|
657
|
-
- spec/models/
|
658
|
-
- spec/models/stream_sdk_version_spec.rb
|
659
|
-
- spec/models/stream_spec.rb
|
660
|
-
- spec/models/stream_usage_error_spec.rb
|
661
|
-
- spec/models/stream_usage_links_spec.rb
|
662
|
-
- spec/models/stream_usage_metadata_spec.rb
|
663
|
-
- spec/models/stream_usage_series_spec.rb
|
664
|
-
- spec/models/streams_spec.rb
|
665
|
-
- spec/models/subscription_body_spec.rb
|
863
|
+
- spec/models/statistic_collection_rep_spec.rb
|
864
|
+
- spec/models/statistic_rep_spec.rb
|
865
|
+
- spec/models/statistics_root_spec.rb
|
866
|
+
- spec/models/subject_data_rep_spec.rb
|
867
|
+
- spec/models/target_resource_rep_spec.rb
|
666
868
|
- spec/models/target_spec.rb
|
667
|
-
- spec/models/
|
869
|
+
- spec/models/title_rep_spec.rb
|
870
|
+
- spec/models/token_data_rep_spec.rb
|
668
871
|
- spec/models/token_spec.rb
|
669
872
|
- spec/models/tokens_spec.rb
|
670
|
-
- spec/models/
|
671
|
-
- spec/models/
|
672
|
-
- spec/models/usage_spec.rb
|
873
|
+
- spec/models/url_post_spec.rb
|
874
|
+
- spec/models/user_attribute_names_rep_spec.rb
|
673
875
|
- spec/models/user_flag_setting_spec.rb
|
674
876
|
- spec/models/user_flag_settings_spec.rb
|
675
877
|
- spec/models/user_record_spec.rb
|
676
|
-
- spec/models/user_segment_body_spec.rb
|
677
878
|
- spec/models/user_segment_rule_spec.rb
|
678
879
|
- spec/models/user_segment_spec.rb
|
679
880
|
- spec/models/user_segments_spec.rb
|
680
|
-
- spec/models/user_settings_body_spec.rb
|
681
881
|
- spec/models/user_spec.rb
|
682
|
-
- spec/models/user_targeting_expiration_for_flag_spec.rb
|
683
|
-
- spec/models/user_targeting_expiration_for_flags_spec.rb
|
684
|
-
- spec/models/user_targeting_expiration_for_segment_spec.rb
|
685
|
-
- spec/models/user_targeting_expiration_on_flags_for_user_spec.rb
|
686
|
-
- spec/models/user_targeting_expiration_resource_id_for_flag_spec.rb
|
687
882
|
- spec/models/users_spec.rb
|
883
|
+
- spec/models/value_put_spec.rb
|
884
|
+
- spec/models/variate_spec.rb
|
885
|
+
- spec/models/variation_or_rollout_rep_spec.rb
|
688
886
|
- spec/models/variation_spec.rb
|
689
|
-
- spec/models/
|
887
|
+
- spec/models/variation_summary_spec.rb
|
888
|
+
- spec/models/versions_rep_spec.rb
|
889
|
+
- spec/models/webhook_post_spec.rb
|
690
890
|
- spec/models/webhook_spec.rb
|
691
891
|
- spec/models/webhooks_spec.rb
|
692
892
|
- spec/models/weighted_variation_spec.rb
|
@@ -703,171 +903,204 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
703
903
|
requirements:
|
704
904
|
- - ">="
|
705
905
|
- !ruby/object:Gem::Version
|
706
|
-
version: '
|
906
|
+
version: '2.4'
|
707
907
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
708
908
|
requirements:
|
709
909
|
- - ">="
|
710
910
|
- !ruby/object:Gem::Version
|
711
911
|
version: '0'
|
712
912
|
requirements: []
|
713
|
-
|
913
|
+
rubyforge_project:
|
914
|
+
rubygems_version: 2.5.2.3
|
714
915
|
signing_key:
|
715
916
|
specification_version: 4
|
716
917
|
summary: LaunchDarkly REST API Ruby Gem
|
717
918
|
test_files:
|
718
|
-
- spec/api/
|
719
|
-
- spec/api/
|
919
|
+
- spec/api/feature_flags_beta_api_spec.rb
|
920
|
+
- spec/api/metrics_api_spec.rb
|
921
|
+
- spec/api/scheduled_changes_api_spec.rb
|
720
922
|
- spec/api/custom_roles_api_spec.rb
|
721
|
-
- spec/api/
|
722
|
-
- spec/api/
|
923
|
+
- spec/api/approvals_api_spec.rb
|
924
|
+
- spec/api/user_settings_api_spec.rb
|
925
|
+
- spec/api/users_beta_api_spec.rb
|
926
|
+
- spec/api/webhooks_api_spec.rb
|
723
927
|
- spec/api/environments_api_spec.rb
|
724
|
-
- spec/api/feature_flags_api_spec.rb
|
725
|
-
- spec/api/integrations_api_spec.rb
|
726
928
|
- spec/api/projects_api_spec.rb
|
727
929
|
- spec/api/relay_proxy_configurations_api_spec.rb
|
728
|
-
- spec/api/
|
729
|
-
- spec/api/
|
730
|
-
- spec/api/
|
731
|
-
- spec/api/
|
930
|
+
- spec/api/account_members_api_spec.rb
|
931
|
+
- spec/api/data_export_destinations_api_spec.rb
|
932
|
+
- spec/api/other_api_spec.rb
|
933
|
+
- spec/api/code_references_api_spec.rb
|
732
934
|
- spec/api/users_api_spec.rb
|
733
|
-
- spec/api/
|
935
|
+
- spec/api/feature_flags_api_spec.rb
|
936
|
+
- spec/api/experiments_beta_api_spec.rb
|
937
|
+
- spec/api/access_tokens_api_spec.rb
|
938
|
+
- spec/api/segments_api_spec.rb
|
939
|
+
- spec/api/account_usage_beta_api_spec.rb
|
940
|
+
- spec/api/audit_log_api_spec.rb
|
734
941
|
- spec/api_client_spec.rb
|
735
942
|
- spec/configuration_spec.rb
|
736
|
-
- spec/models/
|
737
|
-
- spec/models/
|
738
|
-
- spec/models/approval_request_config_body_spec.rb
|
739
|
-
- spec/models/approval_request_flag_config_copy_body_spec.rb
|
740
|
-
- spec/models/approval_request_review_spec.rb
|
741
|
-
- spec/models/approval_request_review_config_body_spec.rb
|
742
|
-
- spec/models/approval_request_review_status_spec.rb
|
743
|
-
- spec/models/approval_requests_spec.rb
|
744
|
-
- spec/models/audit_log_entries_spec.rb
|
745
|
-
- spec/models/audit_log_entry_spec.rb
|
746
|
-
- spec/models/audit_log_entry_target_spec.rb
|
747
|
-
- spec/models/big_segment_target_changes_spec.rb
|
748
|
-
- spec/models/big_segment_targets_body_spec.rb
|
749
|
-
- spec/models/clause_spec.rb
|
750
|
-
- spec/models/client_side_availability_spec.rb
|
751
|
-
- spec/models/copy_actions_spec.rb
|
752
|
-
- spec/models/custom_property_spec.rb
|
753
|
-
- spec/models/custom_property_values_spec.rb
|
754
|
-
- spec/models/custom_role_spec.rb
|
755
|
-
- spec/models/custom_role_body_spec.rb
|
756
|
-
- spec/models/custom_roles_spec.rb
|
757
|
-
- spec/models/defaults_spec.rb
|
943
|
+
- spec/models/branch_rep_spec.rb
|
944
|
+
- spec/models/modification_spec.rb
|
758
945
|
- spec/models/dependent_flag_spec.rb
|
759
|
-
- spec/models/dependent_flag_environment_spec.rb
|
760
|
-
- spec/models/dependent_flag_environment__links_spec.rb
|
761
|
-
- spec/models/dependent_flag__links_spec.rb
|
762
|
-
- spec/models/dependent_flags_by_environment_spec.rb
|
763
|
-
- spec/models/dependent_flags_links_spec.rb
|
764
|
-
- spec/models/destination_spec.rb
|
765
|
-
- spec/models/destination_amazon_kinesis_spec.rb
|
766
|
-
- spec/models/destination_body_spec.rb
|
767
|
-
- spec/models/destination_google_pub_sub_spec.rb
|
768
|
-
- spec/models/destination_m_particle_spec.rb
|
769
|
-
- spec/models/destination_segment_spec.rb
|
770
|
-
- spec/models/destinations_spec.rb
|
771
|
-
- spec/models/environment_spec.rb
|
772
|
-
- spec/models/environment_approval_settings_spec.rb
|
773
|
-
- spec/models/environment_post_spec.rb
|
774
|
-
- spec/models/evaluation_usage_error_spec.rb
|
775
|
-
- spec/models/events_spec.rb
|
776
|
-
- spec/models/fallthrough_spec.rb
|
777
|
-
- spec/models/feature_flag_spec.rb
|
778
|
-
- spec/models/feature_flag_body_spec.rb
|
779
|
-
- spec/models/feature_flag_config_spec.rb
|
780
|
-
- spec/models/feature_flag_copy_body_spec.rb
|
781
|
-
- spec/models/feature_flag_copy_object_spec.rb
|
782
|
-
- spec/models/feature_flag_scheduled_change_spec.rb
|
783
|
-
- spec/models/feature_flag_scheduled_changes_spec.rb
|
784
|
-
- spec/models/feature_flag_scheduled_changes_conflicts_spec.rb
|
785
|
-
- spec/models/feature_flag_scheduled_changes_conflicts_instructions_spec.rb
|
786
|
-
- spec/models/feature_flag_status_spec.rb
|
787
946
|
- spec/models/feature_flag_status_across_environments_spec.rb
|
788
|
-
- spec/models/
|
789
|
-
- spec/models/
|
790
|
-
- spec/models/
|
947
|
+
- spec/models/webhook_spec.rb
|
948
|
+
- spec/models/experiment_enabled_period_rep_spec.rb
|
949
|
+
- spec/models/access_token_post_spec.rb
|
950
|
+
- spec/models/post_flag_scheduled_changes_input_spec.rb
|
951
|
+
- spec/models/experiment_environment_setting_rep_spec.rb
|
952
|
+
- spec/models/custom_property_spec.rb
|
953
|
+
- spec/models/client_side_availability_post_spec.rb
|
954
|
+
- spec/models/feature_flag_config_spec.rb
|
955
|
+
- spec/models/user_segment_spec.rb
|
956
|
+
- spec/models/client_side_availability_spec.rb
|
957
|
+
- spec/models/conflict_spec.rb
|
958
|
+
- spec/models/statement_rep_spec.rb
|
959
|
+
- spec/models/variation_summary_spec.rb
|
960
|
+
- spec/models/relay_auto_config_rep_spec.rb
|
961
|
+
- spec/models/member_data_rep_spec.rb
|
962
|
+
- spec/models/resource_id_response_spec.rb
|
963
|
+
- spec/models/big_segment_target_spec.rb
|
791
964
|
- spec/models/feature_flags_spec.rb
|
792
|
-
- spec/models/
|
793
|
-
- spec/models/
|
794
|
-
- spec/models/
|
795
|
-
- spec/models/
|
796
|
-
- spec/models/
|
797
|
-
- spec/models/
|
798
|
-
- spec/models/
|
799
|
-
- spec/models/integration_subscription_spec.rb
|
800
|
-
- spec/models/integration_subscription__status_spec.rb
|
801
|
-
- spec/models/integrations_spec.rb
|
802
|
-
- spec/models/link_spec.rb
|
803
|
-
- spec/models/links_spec.rb
|
804
|
-
- spec/models/mau_spec.rb
|
805
|
-
- spec/models/mau_metadata_spec.rb
|
806
|
-
- spec/models/ma_uby_category_spec.rb
|
807
|
-
- spec/models/member_spec.rb
|
808
|
-
- spec/models/member__last_seen_metadata_spec.rb
|
809
|
-
- spec/models/members_spec.rb
|
810
|
-
- spec/models/members_body_spec.rb
|
811
|
-
- spec/models/multi_environment_dependent_flag_spec.rb
|
965
|
+
- spec/models/audit_log_entry_listing_rep_collection_spec.rb
|
966
|
+
- spec/models/experiment_totals_rep_spec.rb
|
967
|
+
- spec/models/project_spec.rb
|
968
|
+
- spec/models/feature_flag_statuses_spec.rb
|
969
|
+
- spec/models/resource_access_spec.rb
|
970
|
+
- spec/models/feature_flag_scheduled_changes_spec.rb
|
971
|
+
- spec/models/expiring_user_target_get_response_spec.rb
|
812
972
|
- spec/models/multi_environment_dependent_flags_spec.rb
|
813
|
-
- spec/models/patch_comment_spec.rb
|
814
|
-
- spec/models/patch_operation_spec.rb
|
815
|
-
- spec/models/policy_spec.rb
|
816
973
|
- spec/models/prerequisite_spec.rb
|
817
|
-
- spec/models/
|
818
|
-
- spec/models/
|
819
|
-
- spec/models/
|
820
|
-
- spec/models/
|
821
|
-
- spec/models/
|
822
|
-
- spec/models/relay_proxy_configs_spec.rb
|
823
|
-
- spec/models/role_spec.rb
|
974
|
+
- spec/models/post_approval_request_apply_request_spec.rb
|
975
|
+
- spec/models/integration_metadata_spec.rb
|
976
|
+
- spec/models/project_listing_rep_spec.rb
|
977
|
+
- spec/models/tokens_spec.rb
|
978
|
+
- spec/models/subject_data_rep_spec.rb
|
824
979
|
- spec/models/rollout_spec.rb
|
980
|
+
- spec/models/environment_spec.rb
|
981
|
+
- spec/models/series_list_rep_spec.rb
|
982
|
+
- spec/models/flag_scheduled_changes_input_spec.rb
|
983
|
+
- spec/models/user_flag_settings_spec.rb
|
984
|
+
- spec/models/member_summary_rep_spec.rb
|
985
|
+
- spec/models/repository_post_spec.rb
|
986
|
+
- spec/models/experiment_time_series_slice_spec.rb
|
987
|
+
- spec/models/token_spec.rb
|
988
|
+
- spec/models/patch_segment_instruction_spec.rb
|
989
|
+
- spec/models/inline_object_spec.rb
|
990
|
+
- spec/models/repository_rep_spec.rb
|
991
|
+
- spec/models/environment_post_spec.rb
|
992
|
+
- spec/models/expiring_user_target_item_spec.rb
|
993
|
+
- spec/models/dependent_flag_environment_spec.rb
|
994
|
+
- spec/models/default_client_side_availability_post_spec.rb
|
995
|
+
- spec/models/access_denied_reason_rep_spec.rb
|
996
|
+
- spec/models/custom_role_post_data_spec.rb
|
997
|
+
- spec/models/relay_auto_config_collection_rep_spec.rb
|
998
|
+
- spec/models/experiment_time_series_variation_slice_spec.rb
|
999
|
+
- spec/models/approval_settings_spec.rb
|
1000
|
+
- spec/models/project_post_spec.rb
|
1001
|
+
- spec/models/segment_metadata_spec.rb
|
1002
|
+
- spec/models/variate_spec.rb
|
1003
|
+
- spec/models/experiment_metadata_rep_spec.rb
|
1004
|
+
- spec/models/experiment_results_rep_spec.rb
|
1005
|
+
- spec/models/sdk_list_rep_spec.rb
|
1006
|
+
- spec/models/segment_user_state_spec.rb
|
825
1007
|
- spec/models/rule_spec.rb
|
826
|
-
- spec/models/
|
827
|
-
- spec/models/
|
828
|
-
- spec/models/
|
829
|
-
- spec/models/
|
830
|
-
- spec/models/
|
831
|
-
- spec/models/
|
832
|
-
- spec/models/
|
833
|
-
- spec/models/
|
834
|
-
- spec/models/
|
835
|
-
- spec/models/
|
836
|
-
- spec/models/
|
837
|
-
- spec/models/
|
838
|
-
- spec/models/
|
839
|
-
- spec/models/
|
840
|
-
- spec/models/
|
841
|
-
- spec/models/
|
842
|
-
- spec/models/
|
843
|
-
- spec/models/
|
844
|
-
- spec/models/
|
845
|
-
- spec/models/
|
1008
|
+
- spec/models/experiment_allocation_rep_spec.rb
|
1009
|
+
- spec/models/last_seen_metadata_spec.rb
|
1010
|
+
- spec/models/authorized_app_data_rep_spec.rb
|
1011
|
+
- spec/models/create_copy_flag_config_approval_request_request_spec.rb
|
1012
|
+
- spec/models/statement_post_spec.rb
|
1013
|
+
- spec/models/extinction_spec.rb
|
1014
|
+
- spec/models/patch_operation_spec.rb
|
1015
|
+
- spec/models/custom_roles_spec.rb
|
1016
|
+
- spec/models/hunk_rep_spec.rb
|
1017
|
+
- spec/models/feature_flag_spec.rb
|
1018
|
+
- spec/models/user_attribute_names_rep_spec.rb
|
1019
|
+
- spec/models/pub_nub_detail_rep_spec.rb
|
1020
|
+
- spec/models/destinations_spec.rb
|
1021
|
+
- spec/models/extinction_collection_rep_spec.rb
|
1022
|
+
- spec/models/flag_config_approval_requests_response_spec.rb
|
1023
|
+
- spec/models/experiment_rep_spec.rb
|
1024
|
+
- spec/models/defaults_spec.rb
|
1025
|
+
- spec/models/feature_flag_status_spec.rb
|
1026
|
+
- spec/models/post_approval_request_review_request_spec.rb
|
1027
|
+
- spec/models/experiment_info_rep_spec.rb
|
1028
|
+
- spec/models/clause_spec.rb
|
1029
|
+
- spec/models/custom_role_spec.rb
|
1030
|
+
- spec/models/members_spec.rb
|
1031
|
+
- spec/models/metric_collection_rep_spec.rb
|
1032
|
+
- spec/models/title_rep_spec.rb
|
1033
|
+
- spec/models/access_rep_spec.rb
|
1034
|
+
- spec/models/member_permission_grant_summary_rep_spec.rb
|
1035
|
+
- spec/models/metric_listing_rep_spec.rb
|
1036
|
+
- spec/models/parent_resource_rep_spec.rb
|
1037
|
+
- spec/models/integration_status_spec.rb
|
1038
|
+
- spec/models/confidence_interval_rep_spec.rb
|
846
1039
|
- spec/models/target_spec.rb
|
847
|
-
- spec/models/
|
848
|
-
- spec/models/
|
849
|
-
- spec/models/
|
850
|
-
- spec/models/
|
851
|
-
- spec/models/
|
852
|
-
- spec/models/
|
853
|
-
- spec/models/
|
854
|
-
- spec/models/
|
855
|
-
- spec/models/
|
1040
|
+
- spec/models/statistic_rep_spec.rb
|
1041
|
+
- spec/models/source_flag_spec.rb
|
1042
|
+
- spec/models/flag_copy_config_post_spec.rb
|
1043
|
+
- spec/models/url_post_spec.rb
|
1044
|
+
- spec/models/copied_from_env_spec.rb
|
1045
|
+
- spec/models/audit_log_entry_rep_spec.rb
|
1046
|
+
- spec/models/flag_summary_spec.rb
|
1047
|
+
- spec/models/projects_spec.rb
|
1048
|
+
- spec/models/reference_rep_spec.rb
|
1049
|
+
- spec/models/sdk_version_rep_spec.rb
|
1050
|
+
- spec/models/expiring_user_target_patch_response_spec.rb
|
1051
|
+
- spec/models/webhook_post_spec.rb
|
1052
|
+
- spec/models/member_team_summary_rep_spec.rb
|
856
1053
|
- spec/models/user_record_spec.rb
|
857
|
-
- spec/models/
|
858
|
-
- spec/models/
|
859
|
-
- spec/models/
|
860
|
-
- spec/models/
|
861
|
-
- spec/models/
|
862
|
-
- spec/models/
|
863
|
-
- spec/models/
|
864
|
-
- spec/models/
|
865
|
-
- spec/models/
|
866
|
-
- spec/models/
|
1054
|
+
- spec/models/branch_collection_rep_spec.rb
|
1055
|
+
- spec/models/value_put_spec.rb
|
1056
|
+
- spec/models/flag_copy_config_environment_spec.rb
|
1057
|
+
- spec/models/statistics_root_spec.rb
|
1058
|
+
- spec/models/flag_status_rep_spec.rb
|
1059
|
+
- spec/models/access_denied_rep_spec.rb
|
1060
|
+
- spec/models/create_flag_config_approval_request_request_spec.rb
|
1061
|
+
- spec/models/extinction_rep_spec.rb
|
1062
|
+
- spec/models/metric_post_spec.rb
|
1063
|
+
- spec/models/segment_user_list_spec.rb
|
1064
|
+
- spec/models/flag_config_approval_request_response_spec.rb
|
1065
|
+
- spec/models/new_member_form_spec.rb
|
1066
|
+
- spec/models/target_resource_rep_spec.rb
|
1067
|
+
- spec/models/weighted_variation_spec.rb
|
867
1068
|
- spec/models/users_spec.rb
|
868
|
-
- spec/models/
|
869
|
-
- spec/models/
|
870
|
-
- spec/models/
|
1069
|
+
- spec/models/destination_spec.rb
|
1070
|
+
- spec/models/user_flag_setting_spec.rb
|
1071
|
+
- spec/models/inline_response200_spec.rb
|
1072
|
+
- spec/models/flag_listing_rep_spec.rb
|
1073
|
+
- spec/models/feature_flag_scheduled_change_spec.rb
|
1074
|
+
- spec/models/metric_rep_spec.rb
|
871
1075
|
- spec/models/webhooks_spec.rb
|
872
|
-
- spec/models/
|
1076
|
+
- spec/models/statement_post_data_spec.rb
|
1077
|
+
- spec/models/repository_collection_rep_spec.rb
|
1078
|
+
- spec/models/user_spec.rb
|
1079
|
+
- spec/models/relay_auto_config_post_spec.rb
|
1080
|
+
- spec/models/expiring_user_target_error_spec.rb
|
1081
|
+
- spec/models/user_segments_spec.rb
|
1082
|
+
- spec/models/destination_post_spec.rb
|
1083
|
+
- spec/models/statement_spec.rb
|
1084
|
+
- spec/models/review_response_spec.rb
|
1085
|
+
- spec/models/segment_body_spec.rb
|
1086
|
+
- spec/models/user_segment_rule_spec.rb
|
1087
|
+
- spec/models/dependent_flags_by_environment_spec.rb
|
1088
|
+
- spec/models/custom_role_post_spec.rb
|
1089
|
+
- spec/models/patch_segment_request_spec.rb
|
1090
|
+
- spec/models/sdk_version_list_rep_spec.rb
|
1091
|
+
- spec/models/flag_global_attributes_rep_spec.rb
|
1092
|
+
- spec/models/versions_rep_spec.rb
|
1093
|
+
- spec/models/multi_environment_dependent_flag_spec.rb
|
1094
|
+
- spec/models/experiment_stats_rep_spec.rb
|
1095
|
+
- spec/models/patch_with_comment_spec.rb
|
1096
|
+
- spec/models/inline_object1_spec.rb
|
1097
|
+
- spec/models/variation_spec.rb
|
1098
|
+
- spec/models/feature_flag_body_spec.rb
|
1099
|
+
- spec/models/ip_list_spec.rb
|
1100
|
+
- spec/models/link_spec.rb
|
1101
|
+
- spec/models/audit_log_entry_listing_rep_spec.rb
|
1102
|
+
- spec/models/token_data_rep_spec.rb
|
1103
|
+
- spec/models/member_spec.rb
|
1104
|
+
- spec/models/statistic_collection_rep_spec.rb
|
1105
|
+
- spec/models/variation_or_rollout_rep_spec.rb
|
873
1106
|
- spec/spec_helper.rb
|