Skip to content

Commit 65b2cc9

Browse files
author
LaunchDarklyReleaseBot
committed
Version 18.1.0 automatically generated from ld-openapi.
1 parent cf69462 commit 65b2cc9

18 files changed

+82
-25
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ script:
88
- bundle install --path vendor/bundle
99
- bundle exec rspec
1010
- gem build launchdarkly_api.gemspec
11-
- gem install ./launchdarkly_api-18.0.2.gem
11+
- gem install ./launchdarkly_api-18.1.0.gem

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ To learn more about how EOL is determined, read LaunchDarkly's [End of Life (EOL
450450
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
451451

452452
- API version: 2.0
453-
- Package version: 18.0.2
453+
- Package version: 18.1.0
454454
- Generator version: 7.16.0
455455
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
456456
For more information, please visit [https://support.launchdarkly.com](https://support.launchdarkly.com)
@@ -468,16 +468,16 @@ gem build launchdarkly_api.gemspec
468468
Then either install the gem locally:
469469

470470
```shell
471-
gem install ./launchdarkly_api-18.0.2.gem
471+
gem install ./launchdarkly_api-18.1.0.gem
472472
```
473473

474-
(for development, run `gem install --dev ./launchdarkly_api-18.0.2.gem` to install the development dependencies)
474+
(for development, run `gem install --dev ./launchdarkly_api-18.1.0.gem` to install the development dependencies)
475475

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

478478
Finally add this to the Gemfile:
479479

480-
gem 'launchdarkly_api', '~> 18.0.2'
480+
gem 'launchdarkly_api', '~> 18.1.0'
481481

482482
### Install from Git
483483

docs/Environment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
| **color** | **String** | The color used to indicate this environment in the UI | |
1414
| **default_ttl** | **Integer** | The default time (in minutes) that the PHP SDK can cache feature flag rules locally | |
1515
| **secure_mode** | **Boolean** | Ensures that one end user of the client-side SDK cannot inspect the variations for another end user | |
16+
| **_access** | [**Access**](Access.md) | | [optional] |
1617
| **default_track_events** | **Boolean** | Enables tracking detailed information for new flags by default | |
1718
| **require_comments** | **Boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment | |
1819
| **confirm_changes** | **Boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes | |
@@ -36,6 +37,7 @@ instance = LaunchDarklyApi::Environment.new(
3637
color: F5A623,
3738
default_ttl: 5,
3839
secure_mode: true,
40+
_access: null,
3941
default_track_events: false,
4042
require_comments: true,
4143
confirm_changes: true,

docs/Experiment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
| **_creation_date** | **Integer** | | |
1313
| **environment_key** | **String** | | |
1414
| **archived_date** | **Integer** | | [optional] |
15+
| **tags** | **Array<String>** | Tags for the experiment | [optional] |
1516
| **_links** | [**Hash<String, Link>**](Link.md) | The location and content type of related resources | |
1617
| **holdout_id** | **String** | The holdout ID | [optional] |
1718
| **current_iteration** | [**IterationRep**](IterationRep.md) | | [optional] |
@@ -32,6 +33,7 @@ instance = LaunchDarklyApi::Experiment.new(
3233
_creation_date: null,
3334
environment_key: null,
3435
archived_date: null,
36+
tags: ["experiment","feature"],
3537
_links: {"parent":{"href":"/api/v2/projects/my-project/environments/my-environment","type":"application/json"},"self":{"href":"/api/v2/projects/my-project/environments/my-environment/experiments/my-experiment","type":"application/json"}},
3638
holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,
3739
current_iteration: null,

docs/ExperimentPost.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
| **key** | **String** | The experiment key | |
1111
| **iteration** | [**IterationInput**](IterationInput.md) | | |
1212
| **holdout_id** | **String** | The ID of the holdout | [optional] |
13+
| **tags** | **Array<String>** | Tags for the experiment | [optional] |
1314

1415
## Example
1516

@@ -22,7 +23,8 @@ instance = LaunchDarklyApi::ExperimentPost.new(
2223
maintainer_id: 12ab3c45de678910fgh12345,
2324
key: experiment-key-123abc,
2425
iteration: null,
25-
holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40
26+
holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,
27+
tags: null
2628
)
2729
```
2830

docs/MetricsBetaApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ end
239239
240240
List metric groups
241241

242-
Get a list of all metric groups for the specified project. ### Expanding the metric groups response LaunchDarkly supports one field for expanding the \"Get metric groups\" response. By default, these fields are **not** included in the response. To expand the response, append the `expand` query parameter and add a comma-separated list with the following field: - `experiments` includes all experiments from the specific project that use the metric group For example, `expand=experiments` includes the `experiments` field in the response. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
242+
Get a list of all metric groups for the specified project. ### Expanding the metric groups response This endpoint does not support response expansion. Although the API accepts an `expand` query parameter for compatibility reasons, it does not currently modify the response. The parameter is reserved for future use. ### Filtering metric groups The `filter` parameter supports the following operators: `contains`, `equals`, `anyOf`. #### Supported fields and operators You can only filter certain fields in metrics when using the `filter` parameter. Additionally, you can only filter some fields with certain operators. When you search for metrics, the `filter` parameter supports the following fields and operators: |<div style=\"width:120px\">Field</div> |Description |Supported operators | |---|---|---| | `experimentStatus` | The experiment's status. One of `not_started`, `running`, `stopped`, `started`. | `equals` | | `hasConnections` | Whether the metric group has connections to experiments or guarded rollouts. One of `true`, `false`. | `equals` | | `kind` | The metric group kind. One of `funnel`, `standard`. | `equals` | | `maintainerIds` | The metric maintainer IDs. | `anyOf` | | `maintainerTeamKey` | The metric maintainer team key. | `equals` | | `query` | A \"fuzzy\" search across metric group key and name. Supply a string or list of strings to the operator. | `equals` | ### Sorting metric groups LaunchDarkly supports the following fields for sorting: - `name` sorts by metric group name. - `createdAt` sorts by the creation date of the metric group. - `connectionCount` sorts by the number of connections to experiments the metric group has. By default, the sort is in ascending order. Use `-` to sort in descending order. For example, `?sort=name` sorts the response by metric group name in ascending order, and `?sort=-name` sorts in descending order. #### Sample query `filter=experimentStatus equals 'not_started' and query equals 'metric name'`
243243

244244
### Examples
245245

@@ -259,7 +259,7 @@ project_key = 'project_key_example' # String | The project key
259259
opts = {
260260
filter: 'filter_example', # String | Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals 'running' and query equals 'test'`.
261261
sort: 'sort_example', # String | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields.
262-
expand: 'expand_example', # String | A comma-separated list of properties that can reveal additional information in the response.
262+
expand: 'expand_example', # String | This parameter is reserved for future use and is not currently supported on this endpoint.
263263
limit: 789, # Integer | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.
264264
offset: 789 # Integer | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next `limit` items.
265265
}
@@ -298,7 +298,7 @@ end
298298
| **project_key** | **String** | The project key | |
299299
| **filter** | **String** | Accepts filter by &#x60;experimentStatus&#x60;, &#x60;query&#x60;, &#x60;kind&#x60;, &#x60;hasConnections&#x60;, &#x60;maintainerIds&#x60;, and &#x60;maintainerTeamKey&#x60;. Example: &#x60;filter&#x3D;experimentStatus equals &#39;running&#39; and query equals &#39;test&#39;&#x60;. | [optional] |
300300
| **sort** | **String** | A comma-separated list of fields to sort by. Fields prefixed by a dash ( - ) sort in descending order. Read the endpoint description for a full list of available sort fields. | [optional] |
301-
| **expand** | **String** | A comma-separated list of properties that can reveal additional information in the response. | [optional] |
301+
| **expand** | **String** | This parameter is reserved for future use and is not currently supported on this endpoint. | [optional] |
302302
| **limit** | **Integer** | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. | [optional] |
303303
| **offset** | **Integer** | Where to start in the list. Use this with pagination. For example, an offset of 10 skips the first ten items and returns the next &#x60;limit&#x60; items. | [optional] |
304304

docs/PostReleasePolicyRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ instance = LaunchDarklyApi::PostReleasePolicyRequest.new(
2020
scope: null,
2121
release_method: null,
2222
guarded_release_config: null,
23-
progressive_release_config: null,
23+
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
2424
name: Production Release,
2525
key: production-release
2626
)

docs/PutReleasePolicyRequest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ instance = LaunchDarklyApi::PutReleasePolicyRequest.new(
1919
scope: null,
2020
release_method: null,
2121
guarded_release_config: null,
22-
progressive_release_config: null,
22+
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
2323
name: Production Release
2424
)
2525
```

docs/ReleasePolicy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ instance = LaunchDarklyApi::ReleasePolicy.new(
2626
rank: 1,
2727
release_method: null,
2828
guarded_release_config: null,
29-
progressive_release_config: null,
29+
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
3030
name: Production Release,
3131
key: production-release
3232
)

0 commit comments

Comments
 (0)