Skip to content

Commit d7c21ca

Browse files
author
LaunchDarklyReleaseBot
committed
Version 18.1.0 automatically generated from ld-openapi.
1 parent 2aa5fe5 commit d7c21ca

File tree

7 files changed

+30
-15
lines changed

7 files changed

+30
-15
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This REST API is for custom integrations, data export, or automating your featur
66
This client library is only compatible with the latest version of our REST API. Previous versions of this client library are compatible with earlier versions of our REST API. When you create an access token, you can set the REST API version associated with the token. By default, API requests you send using the token will use the specified API version. To learn more, read [Versioning](https://apidocs.launchdarkly.com/#section/Overview/Versioning).
77
View our [sample code](#sample-code) for example usage.
88

9-
## launchdarkly-api-typescript@18.0.2
9+
## launchdarkly-api-typescript@18.1.0
1010

1111
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
1212

@@ -44,7 +44,7 @@ navigate to the folder of your consuming project and run one of the following co
4444
_published:_
4545

4646
```
47-
npm install launchdarkly-api-typescript@18.0.2 --save
47+
npm install launchdarkly-api-typescript@18.1.0 --save
4848
```
4949

5050
_unPublished (not recommended):_

api.ts

Lines changed: 17 additions & 8 deletions
Large diffs are not rendered by default.

docs/Environment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
1414
**color** | **string** | The color used to indicate this environment in the UI | [default to undefined]
1515
**defaultTtl** | **number** | The default time (in minutes) that the PHP SDK can cache feature flag rules locally | [default to undefined]
1616
**secureMode** | **boolean** | Ensures that one end user of the client-side SDK cannot inspect the variations for another end user | [default to undefined]
17+
**_access** | [**Access**](Access.md) | | [optional] [default to undefined]
1718
**defaultTrackEvents** | **boolean** | Enables tracking detailed information for new flags by default | [default to undefined]
1819
**requireComments** | **boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment | [default to undefined]
1920
**confirmChanges** | **boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to confirm those changes | [default to undefined]
@@ -37,6 +38,7 @@ const instance: Environment = {
3738
color,
3839
defaultTtl,
3940
secureMode,
41+
_access,
4042
defaultTrackEvents,
4143
requireComments,
4244
confirmChanges,

docs/Experiment.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
1313
**_creationDate** | **number** | | [default to undefined]
1414
**environmentKey** | **string** | | [default to undefined]
1515
**archivedDate** | **number** | | [optional] [default to undefined]
16+
**tags** | **Array<string>** | Tags for the experiment | [optional] [default to undefined]
1617
**_links** | [**{ [key: string]: Link; }**](Link.md) | The location and content type of related resources | [default to undefined]
1718
**holdoutId** | **string** | The holdout ID | [optional] [default to undefined]
1819
**currentIteration** | [**IterationRep**](IterationRep.md) | | [optional] [default to undefined]
@@ -33,6 +34,7 @@ const instance: Experiment = {
3334
_creationDate,
3435
environmentKey,
3536
archivedDate,
37+
tags,
3638
_links,
3739
holdoutId,
3840
currentIteration,

docs/ExperimentPost.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**key** | **string** | The experiment key | [default to undefined]
1212
**iteration** | [**IterationInput**](IterationInput.md) | | [default to undefined]
1313
**holdoutId** | **string** | The ID of the holdout | [optional] [default to undefined]
14+
**tags** | **Array<string>** | Tags for the experiment | [optional] [default to undefined]
1415

1516
## Example
1617

@@ -24,6 +25,7 @@ const instance: ExperimentPost = {
2425
key,
2526
iteration,
2627
holdoutId,
28+
tags,
2729
};
2830
```
2931

docs/MetricsBetaApi.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ const { status, data } = await apiInstance.getMetricGroup(
197197
# **getMetricGroups**
198198
> MetricGroupCollectionRep getMetricGroups()
199199
200-
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\'`
200+
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\'`
201201

202202
### Example
203203

@@ -213,7 +213,7 @@ const apiInstance = new MetricsBetaApi(configuration);
213213
let projectKey: string; //The project key (default to undefined)
214214
let filter: string; //Accepts filter by `experimentStatus`, `query`, `kind`, `hasConnections`, `maintainerIds`, and `maintainerTeamKey`. Example: `filter=experimentStatus equals \'running\' and query equals \'test\'`. (optional) (default to undefined)
215215
let 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) (default to undefined)
216-
let expand: string; //A comma-separated list of properties that can reveal additional information in the response. (optional) (default to undefined)
216+
let expand: string; //This parameter is reserved for future use and is not currently supported on this endpoint. (optional) (default to undefined)
217217
let limit: number; //The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. (optional) (default to undefined)
218218
let offset: number; //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. (optional) (default to undefined)
219219

@@ -234,7 +234,7 @@ const { status, data } = await apiInstance.getMetricGroups(
234234
| **projectKey** | [**string**] | The project key | defaults to undefined|
235235
| **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) defaults to undefined|
236236
| **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) defaults to undefined|
237-
| **expand** | [**string**] | A comma-separated list of properties that can reveal additional information in the response. | (optional) defaults to undefined|
237+
| **expand** | [**string**] | This parameter is reserved for future use and is not currently supported on this endpoint. | (optional) defaults to undefined|
238238
| **limit** | [**number**] | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. | (optional) defaults to undefined|
239239
| **offset** | [**number**] | 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) defaults to undefined|
240240

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "launchdarkly-api-typescript",
3-
"version": "18.0.2",
3+
"version": "18.1.0",
44
"description": "OpenAPI client for launchdarkly-api-typescript",
55
"author": "OpenAPI-Generator Contributors",
66
"repository": {
@@ -24,7 +24,7 @@
2424
"prepare": "npm run build"
2525
},
2626
"dependencies": {
27-
"axios": "^1.6.1"
27+
"axios": "^1.13.1"
2828
},
2929
"devDependencies": {
3030
"@types/node": "12.11.5 - 12.20.42",

0 commit comments

Comments
 (0)