Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details
Socket
Book a DemoInstallSign in
Socket

launchdarkly_api

Package Overview
Dependencies
Maintainers
1
Versions
62
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

launchdarkly_api - npm Package Compare versions

Comparing version
18.0.2
to
18.1.0
+2
-0
docs/Environment.md

@@ -16,2 +16,3 @@ # LaunchDarklyApi::Environment

| **secure_mode** | **Boolean** | Ensures that one end user of the client-side SDK cannot inspect the variations for another end user | |
| **_access** | [**Access**](Access.md) | | [optional] |
| **default_track_events** | **Boolean** | Enables tracking detailed information for new flags by default | |

@@ -40,2 +41,3 @@ | **require_comments** | **Boolean** | Whether members who modify flags and segments through the LaunchDarkly user interface are required to add a comment | |

secure_mode: true,
_access: null,
default_track_events: false,

@@ -42,0 +44,0 @@ require_comments: true,

@@ -15,2 +15,3 @@ # LaunchDarklyApi::Experiment

| **archived_date** | **Integer** | | [optional] |
| **tags** | **Array<String>** | Tags for the experiment | [optional] |
| **_links** | [**Hash<String, Link>**](Link.md) | The location and content type of related resources | |

@@ -36,2 +37,3 @@ | **holdout_id** | **String** | The holdout ID | [optional] |

archived_date: null,
tags: ["experiment","feature"],
_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"}},

@@ -38,0 +40,0 @@ holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,

+3
-1

@@ -13,2 +13,3 @@ # LaunchDarklyApi::ExperimentPost

| **holdout_id** | **String** | The ID of the holdout | [optional] |
| **tags** | **Array<String>** | Tags for the experiment | [optional] |

@@ -26,5 +27,6 @@ ## Example

iteration: null,
holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40
holdout_id: f3b74309-d581-44e1-8a2b-bb2933b4fe40,
tags: null
)
```

@@ -242,3 +242,3 @@ # LaunchDarklyApi::MetricsBetaApi

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'`
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'`

@@ -263,3 +263,3 @@ ### Examples

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.
expand: 'expand_example', # String | A comma-separated list of properties that can reveal additional information in the response.
expand: 'expand_example', # String | This parameter is reserved for future use and is not currently supported on this endpoint.
limit: 789, # Integer | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.

@@ -303,3 +303,3 @@ 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.

| **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] |
| **expand** | **String** | A comma-separated list of properties that can reveal additional information in the response. | [optional] |
| **expand** | **String** | This parameter is reserved for future use and is not currently supported on this endpoint. | [optional] |
| **limit** | **Integer** | The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50. | [optional] |

@@ -306,0 +306,0 @@ | **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] |

@@ -23,3 +23,3 @@ # LaunchDarklyApi::PostReleasePolicyRequest

guarded_release_config: null,
progressive_release_config: null,
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
name: Production Release,

@@ -26,0 +26,0 @@ key: production-release

@@ -22,3 +22,3 @@ # LaunchDarklyApi::PutReleasePolicyRequest

guarded_release_config: null,
progressive_release_config: null,
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
name: Production Release

@@ -25,0 +25,0 @@ )

@@ -29,3 +29,3 @@ # LaunchDarklyApi::ReleasePolicy

guarded_release_config: null,
progressive_release_config: null,
progressive_release_config: {&quot;rolloutContextKindKey&quot;:&quot;user&quot;},
name: Production Release,

@@ -32,0 +32,0 @@ key: production-release

@@ -238,3 +238,3 @@ =begin

# List metric groups
# 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'`
# 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'`
# @param project_key [String] The project key

@@ -244,3 +244,3 @@ # @param [Hash] opts the optional parameters

# @option opts [String] :sort 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.
# @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
# @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
# @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.

@@ -255,3 +255,3 @@ # @option opts [Integer] :offset 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.

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

@@ -261,3 +261,3 @@ # @param [Hash] opts the optional parameters

# @option opts [String] :sort 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.
# @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
# @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
# @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.

@@ -264,0 +264,0 @@ # @option opts [Integer] :offset 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.

@@ -45,2 +45,4 @@ =begin

attr_accessor :_access
# Enables tracking detailed information for new flags by default

@@ -78,2 +80,3 @@ attr_accessor :default_track_events

:'secure_mode' => :'secureMode',
:'_access' => :'_access',
:'default_track_events' => :'defaultTrackEvents',

@@ -111,2 +114,3 @@ :'require_comments' => :'requireComments',

:'secure_mode' => :'Boolean',
:'_access' => :'Access',
:'default_track_events' => :'Boolean',

@@ -200,2 +204,6 @@ :'require_comments' => :'Boolean',

if attributes.key?(:'_access')
self._access = attributes[:'_access']
end
if attributes.key?(:'default_track_events')

@@ -483,2 +491,3 @@ self.default_track_events = attributes[:'default_track_events']

secure_mode == o.secure_mode &&
_access == o._access &&
default_track_events == o.default_track_events &&

@@ -502,3 +511,3 @@ require_comments == o.require_comments &&

def hash
[_links, _id, key, name, api_key, mobile_key, color, default_ttl, secure_mode, default_track_events, require_comments, confirm_changes, tags, approval_settings, resource_approval_settings, critical].hash
[_links, _id, key, name, api_key, mobile_key, color, default_ttl, secure_mode, _access, default_track_events, require_comments, confirm_changes, tags, approval_settings, resource_approval_settings, critical].hash
end

@@ -505,0 +514,0 @@

@@ -35,2 +35,5 @@ =begin

# Tags for the experiment
attr_accessor :tags
# Attribute mapping from ruby-style variable name to JSON key.

@@ -44,3 +47,4 @@ def self.attribute_map

:'iteration' => :'iteration',
:'holdout_id' => :'holdoutId'
:'holdout_id' => :'holdoutId',
:'tags' => :'tags'
}

@@ -67,3 +71,4 @@ end

:'iteration' => :'IterationInput',
:'holdout_id' => :'String'
:'holdout_id' => :'String',
:'tags' => :'Array<String>'
}

@@ -123,2 +128,8 @@ end

end
if attributes.key?(:'tags')
if (value = attributes[:'tags']).is_a?(Array)
self.tags = value
end
end
end

@@ -196,3 +207,4 @@

iteration == o.iteration &&
holdout_id == o.holdout_id
holdout_id == o.holdout_id &&
tags == o.tags
end

@@ -209,3 +221,3 @@

def hash
[name, description, maintainer_id, key, iteration, holdout_id].hash
[name, description, maintainer_id, key, iteration, holdout_id, tags].hash
end

@@ -212,0 +224,0 @@

@@ -39,2 +39,5 @@ =begin

# Tags for the experiment
attr_accessor :tags
# The location and content type of related resources

@@ -64,2 +67,3 @@ attr_accessor :_links

:'archived_date' => :'archivedDate',
:'tags' => :'tags',
:'_links' => :'_links',

@@ -94,2 +98,3 @@ :'holdout_id' => :'holdoutId',

:'archived_date' => :'Integer',
:'tags' => :'Array<String>',
:'_links' => :'Hash<String, Link>',

@@ -167,2 +172,8 @@ :'holdout_id' => :'String',

if attributes.key?(:'tags')
if (value = attributes[:'tags']).is_a?(Array)
self.tags = value
end
end
if attributes.key?(:'_links')

@@ -313,2 +324,3 @@ if (value = attributes[:'_links']).is_a?(Hash)

archived_date == o.archived_date &&
tags == o.tags &&
_links == o._links &&

@@ -330,3 +342,3 @@ holdout_id == o.holdout_id &&

def hash
[_id, key, name, description, _maintainer_id, _creation_date, environment_key, archived_date, _links, holdout_id, current_iteration, draft_iteration, previous_iterations].hash
[_id, key, name, description, _maintainer_id, _creation_date, environment_key, archived_date, tags, _links, holdout_id, current_iteration, draft_iteration, previous_iterations].hash
end

@@ -333,0 +345,0 @@

@@ -14,3 +14,3 @@ =begin

module LaunchDarklyApi
VERSION = '18.0.2'
VERSION = '18.1.0'
end

@@ -77,3 +77,3 @@ =begin

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

@@ -83,3 +83,3 @@ # @param [Hash] opts the optional parameters

# @option opts [String] :sort 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.
# @option opts [String] :expand A comma-separated list of properties that can reveal additional information in the response.
# @option opts [String] :expand This parameter is reserved for future use and is not currently supported on this endpoint.
# @option opts [Integer] :limit The number of metric groups to return in the response. Defaults to 20. Maximum limit is 50.

@@ -86,0 +86,0 @@ # @option opts [Integer] :offset 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.

@@ -84,2 +84,8 @@ =begin

describe 'test attribute "_access"' do
it 'should work' do
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
end
end
describe 'test attribute "default_track_events"' do

@@ -86,0 +92,0 @@ it 'should work' do

@@ -66,2 +66,8 @@ =begin

describe 'test attribute "tags"' do
it 'should work' do
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
end
end
end

@@ -78,2 +78,8 @@ =begin

describe 'test attribute "tags"' do
it 'should work' do
# assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
end
end
describe 'test attribute "_links"' do

@@ -80,0 +86,0 @@ it 'should work' do

Sorry, the diff of this file is too big to display