Skip to content

Commit ceb2eef

Browse files
author
LaunchDarklyReleaseBot
committed
Version 12.1.0 automatically generated from ld-openapi.
1 parent 847ceb3 commit ceb2eef

File tree

850 files changed

+2453
-987
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

850 files changed

+2453
-987
lines changed

.openapi-generator/FILES

+6
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ docs/ContextSettingsBetaApi.md
7171
docs/Contexts.md
7272
docs/ContextsBetaApi.md
7373
docs/CopiedFromEnv.md
74+
docs/CreateApprovalRequestRequest.md
7475
docs/CreateCopyFlagConfigApprovalRequestRequest.md
7576
docs/CreateFlagConfigApprovalRequestRequest.md
7677
docs/CreateWorkflowTemplateInput.md
@@ -79,6 +80,7 @@ docs/CustomProperty.md
7980
docs/CustomRole.md
8081
docs/CustomRolePost.md
8182
docs/CustomRolePostData.md
83+
docs/CustomRoleSummary.md
8284
docs/CustomRoles.md
8385
docs/CustomRolesApi.md
8486
docs/CustomWorkflowInput.md
@@ -483,6 +485,7 @@ lib/launchdarkly_api/models/context_record.rb
483485
lib/launchdarkly_api/models/context_search.rb
484486
lib/launchdarkly_api/models/contexts.rb
485487
lib/launchdarkly_api/models/copied_from_env.rb
488+
lib/launchdarkly_api/models/create_approval_request_request.rb
486489
lib/launchdarkly_api/models/create_copy_flag_config_approval_request_request.rb
487490
lib/launchdarkly_api/models/create_flag_config_approval_request_request.rb
488491
lib/launchdarkly_api/models/create_workflow_template_input.rb
@@ -491,6 +494,7 @@ lib/launchdarkly_api/models/custom_property.rb
491494
lib/launchdarkly_api/models/custom_role.rb
492495
lib/launchdarkly_api/models/custom_role_post.rb
493496
lib/launchdarkly_api/models/custom_role_post_data.rb
497+
lib/launchdarkly_api/models/custom_role_summary.rb
494498
lib/launchdarkly_api/models/custom_roles.rb
495499
lib/launchdarkly_api/models/custom_workflow_input.rb
496500
lib/launchdarkly_api/models/custom_workflow_meta.rb
@@ -864,6 +868,7 @@ spec/models/context_record_spec.rb
864868
spec/models/context_search_spec.rb
865869
spec/models/contexts_spec.rb
866870
spec/models/copied_from_env_spec.rb
871+
spec/models/create_approval_request_request_spec.rb
867872
spec/models/create_copy_flag_config_approval_request_request_spec.rb
868873
spec/models/create_flag_config_approval_request_request_spec.rb
869874
spec/models/create_workflow_template_input_spec.rb
@@ -872,6 +877,7 @@ spec/models/custom_property_spec.rb
872877
spec/models/custom_role_post_data_spec.rb
873878
spec/models/custom_role_post_spec.rb
874879
spec/models/custom_role_spec.rb
880+
spec/models/custom_role_summary_spec.rb
875881
spec/models/custom_roles_spec.rb
876882
spec/models/custom_workflow_input_spec.rb
877883
spec/models/custom_workflow_meta_spec.rb

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ script:
1111
- bundle install --path vendor/bundle
1212
- bundle exec rspec
1313
- gem build launchdarkly_api.gemspec
14-
- gem install ./launchdarkly_api-12.0.0.gem
14+
- gem install ./launchdarkly_api-12.1.0.gem

README.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ We use several rate limiting strategies to ensure the availability of our APIs.
275275
276276
### Global rate limits
277277

278-
Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make 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 return the headers below:
278+
Authenticated requests are subject to a global limit. This is the maximum number of calls that your account can make 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 may return the headers below:
279279

280280
| Header name | Description |
281281
| ------------------------------ | -------------------------------------------------------------------------------- |
@@ -343,6 +343,14 @@ Use this header:
343343
LD-API-Version: beta
344344
```
345345

346+
## Federal environments
347+
348+
The version of LaunchDarkly that is available on domains controlled by the United States government is different from the version of LaunchDarkly available to the general public. If you are an employee or contractor for a United States federal agency and use LaunchDarkly in your work, you likely use the federal instance of LaunchDarkly.
349+
350+
If you are working in the federal instance of LaunchDarkly, the base URI for each request is `https://app.launchdarkly.us`. In the \"Try it\" sandbox for each request, click the request path to view the complete resource path for the federal environment.
351+
352+
To learn more, read [LaunchDarkly in federal environments](https://docs.launchdarkly.com/home/advanced/federal).
353+
346354
## Versioning
347355

348356
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.
@@ -386,7 +394,7 @@ If you would like to upgrade your integration to use a new API version, you can
386394
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
387395

388396
- API version: 2.0
389-
- Package version: 12.0.0
397+
- Package version: 12.1.0
390398
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
391399
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
392400

@@ -403,16 +411,16 @@ gem build launchdarkly_api.gemspec
403411
Then either install the gem locally:
404412

405413
```shell
406-
gem install ./launchdarkly_api-12.0.0.gem
414+
gem install ./launchdarkly_api-12.1.0.gem
407415
```
408416

409-
(for development, run `gem install --dev ./launchdarkly_api-12.0.0.gem` to install the development dependencies)
417+
(for development, run `gem install --dev ./launchdarkly_api-12.1.0.gem` to install the development dependencies)
410418

411419
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
412420

413421
Finally add this to the Gemfile:
414422

415-
gem 'launchdarkly_api', '~> 12.0.0'
423+
gem 'launchdarkly_api', '~> 12.1.0'
416424

417425
### Install from Git
418426

@@ -491,8 +499,12 @@ Class | Method | HTTP request | Description
491499
*LaunchDarklyApi::ApprovalsApi* | [**post_approval_request_for_flag**](docs/ApprovalsApi.md#post_approval_request_for_flag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests | Create approval request for a flag
492500
*LaunchDarklyApi::ApprovalsApi* | [**post_approval_request_review_for_flag**](docs/ApprovalsApi.md#post_approval_request_review_for_flag) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests/{id}/reviews | Review approval request for a flag
493501
*LaunchDarklyApi::ApprovalsApi* | [**post_flag_copy_config_approval_request**](docs/ApprovalsApi.md#post_flag_copy_config_approval_request) | **POST** /api/v2/projects/{projectKey}/flags/{featureFlagKey}/environments/{environmentKey}/approval-requests-flag-copy | Create approval request to copy flag configurations across environments
502+
*LaunchDarklyApi::ApprovalsBetaApi* | [**delete_approval_request**](docs/ApprovalsBetaApi.md#delete_approval_request) | **DELETE** /api/v2/approval-requests/{id} | Delete approval request
494503
*LaunchDarklyApi::ApprovalsBetaApi* | [**get_approval_request**](docs/ApprovalsBetaApi.md#get_approval_request) | **GET** /api/v2/approval-requests/{id} | Get approval request
495504
*LaunchDarklyApi::ApprovalsBetaApi* | [**get_approval_requests**](docs/ApprovalsBetaApi.md#get_approval_requests) | **GET** /api/v2/approval-requests | List approval requests
505+
*LaunchDarklyApi::ApprovalsBetaApi* | [**post_approval_request**](docs/ApprovalsBetaApi.md#post_approval_request) | **POST** /api/v2/approval-requests | Create approval request
506+
*LaunchDarklyApi::ApprovalsBetaApi* | [**post_approval_request_apply**](docs/ApprovalsBetaApi.md#post_approval_request_apply) | **POST** /api/v2/approval-requests/{id}/apply | Apply approval request
507+
*LaunchDarklyApi::ApprovalsBetaApi* | [**post_approval_request_review**](docs/ApprovalsBetaApi.md#post_approval_request_review) | **POST** /api/v2/approval-requests/{id}/reviews | Review approval request
496508
*LaunchDarklyApi::AuditLogApi* | [**get_audit_log_entries**](docs/AuditLogApi.md#get_audit_log_entries) | **GET** /api/v2/auditlog | List audit log entries
497509
*LaunchDarklyApi::AuditLogApi* | [**get_audit_log_entry**](docs/AuditLogApi.md#get_audit_log_entry) | **GET** /api/v2/auditlog/{id} | Get audit log entry
498510
*LaunchDarklyApi::CodeReferencesApi* | [**delete_branches**](docs/CodeReferencesApi.md#delete_branches) | **POST** /api/v2/code-refs/repositories/{repo}/branch-delete-tasks | Delete branches
@@ -728,6 +740,7 @@ Class | Method | HTTP request | Description
728740
- [LaunchDarklyApi::ContextSearch](docs/ContextSearch.md)
729741
- [LaunchDarklyApi::Contexts](docs/Contexts.md)
730742
- [LaunchDarklyApi::CopiedFromEnv](docs/CopiedFromEnv.md)
743+
- [LaunchDarklyApi::CreateApprovalRequestRequest](docs/CreateApprovalRequestRequest.md)
731744
- [LaunchDarklyApi::CreateCopyFlagConfigApprovalRequestRequest](docs/CreateCopyFlagConfigApprovalRequestRequest.md)
732745
- [LaunchDarklyApi::CreateFlagConfigApprovalRequestRequest](docs/CreateFlagConfigApprovalRequestRequest.md)
733746
- [LaunchDarklyApi::CreateWorkflowTemplateInput](docs/CreateWorkflowTemplateInput.md)
@@ -736,6 +749,7 @@ Class | Method | HTTP request | Description
736749
- [LaunchDarklyApi::CustomRole](docs/CustomRole.md)
737750
- [LaunchDarklyApi::CustomRolePost](docs/CustomRolePost.md)
738751
- [LaunchDarklyApi::CustomRolePostData](docs/CustomRolePostData.md)
752+
- [LaunchDarklyApi::CustomRoleSummary](docs/CustomRoleSummary.md)
739753
- [LaunchDarklyApi::CustomRoles](docs/CustomRoles.md)
740754
- [LaunchDarklyApi::CustomWorkflowInput](docs/CustomWorkflowInput.md)
741755
- [LaunchDarklyApi::CustomWorkflowMeta](docs/CustomWorkflowMeta.md)

docs/AccountUsageBetaApi.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ end
181181
182182
Get experimentation keys usage
183183

184-
Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a max of 31 days.
184+
Get a time-series array of the number of monthly experimentation keys from your account. The granularity is always daily, with a maximum of 31 days.
185185

186186
### Examples
187187

@@ -256,7 +256,7 @@ end
256256
257257
Get MAU SDKs by type
258258

259-
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
259+
Get a list of SDKs. These are all of the SDKs that have connected to LaunchDarkly by monthly active users (MAU) in the requested time period.<br/><br/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
260260

261261
### Examples
262262

@@ -333,7 +333,7 @@ end
333333
334334
Get MAU usage
335335

336-
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
336+
Get a time-series array of the number of monthly active users (MAU) seen by LaunchDarkly from your account. The granularity is always daily.<br/><br/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
337337

338338
### Examples
339339

@@ -420,7 +420,7 @@ end
420420
421421
Get MAU usage by category
422422

423-
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.<br/><br/>Endpoints for retrieving monthly active users (MAU) do not return information about active context instances. After you have upgraded your LaunchDarkly SDK to use contexts instead of users, you should not rely on this endpoint. Use [Get client-side monthly context instances uage](/tag/Account-usage-(beta)#operation/getCMCIUsage) instead. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
423+
Get time-series arrays of the number of monthly active users (MAU) seen by LaunchDarkly from your account, broken down by the category of users. The category is either `browser`, `mobile`, or `backend`.<br/><br/>LaunchDarkly's billing calculations will change on April 1, 2023. To learn more, read [Account usage metrics](https://docs.launchdarkly.com/home/billing/usage-metrics).
424424

425425
### Examples
426426

docs/ApprovalsApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -501,7 +501,7 @@ api_instance = LaunchDarklyApi::ApprovalsApi.new
501501
project_key = 'project_key_example' # String | The project key
502502
feature_flag_key = 'feature_flag_key_example' # String | The feature flag key
503503
environment_key = 'environment_key_example' # String | The environment key for the target environment
504-
create_copy_flag_config_approval_request_request = LaunchDarklyApi::CreateCopyFlagConfigApprovalRequestRequest.new({description: 'copy flag settings to another environment', source: LaunchDarklyApi::SourceFlag.new({key: 'example-environment-key'})}) # CreateCopyFlagConfigApprovalRequestRequest |
504+
create_copy_flag_config_approval_request_request = LaunchDarklyApi::CreateCopyFlagConfigApprovalRequestRequest.new({description: 'copy flag settings to another environment', source: LaunchDarklyApi::SourceFlag.new({key: 'environment-key-123abc'})}) # CreateCopyFlagConfigApprovalRequestRequest |
505505

506506
begin
507507
# Create approval request to copy flag configurations across environments

0 commit comments

Comments
 (0)