Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update property descriptions for Dashboard RBAC release #544

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Update property descriptions for Dashboard RBAC release #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed2b861
Regenerate client from commit 0b58986 of spec repo
Oct 27, 2021
12212d2
Merge branch 'master' into datadog-api-spec/generated/1221
api-clients-generation-pipeline[bot] Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-10-27 09:02:32.043203",
"spec_repo_commit": "5f2ff0f"
"regenerated": "2021-10-27 12:50:06.114952",
"spec_repo_commit": "0b58986"
},
"v2": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-10-27 09:02:32.072483",
"spec_repo_commit": "5f2ff0f"
"regenerated": "2021-10-27 12:50:06.145709",
"spec_repo_commit": "0b58986"
}
}
}
8 changes: 4 additions & 4 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,8 +907,10 @@ components:
type: string
is_read_only:
default: false
deprecated: true
description: Whether this dashboard is read-only. If True, only the author
and admins can make changes to it.
and admins can make changes to it. Prefer using `restricted_roles` to
manage write authorization.
example: false
type: boolean
layout_type:
Expand All @@ -930,9 +932,7 @@ components:
$ref: '#/components/schemas/DashboardReflowType'
restricted_roles:
description: A list of role identifiers. Only the author and users associated
with at least one of these roles can edit this dashboard. Overrides the
`is_read_only` property if both are present. **This feature is currently
in beta.**
with at least one of these roles can edit this dashboard.
items:
description: A role UUID.
type: string
Expand Down
7 changes: 3 additions & 4 deletions docs/v1/APIErrorResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **errors** | **Array<String>** | Array of errors returned by the API. | |
| Name | Type | Description | Notes |
| ---------- | ----------------------- | ------------------------------------ | ----- |
| **errors** | **Array<String>** | Array of errors returned by the API. | |

## Example

Expand All @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::APIErrorResponse.new(
errors: null
)
```

27 changes: 13 additions & 14 deletions docs/v1/AWSAccount.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] |
| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] |
| **account_specific_namespace_rules** | **Hash<String, Boolean>** | An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. | [optional] |
| **cspm_resource_collection_enabled** | **Boolean** | Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. | [optional][default to false] |
| **excluded_regions** | **Array<String>** | An array of AWS regions to exclude from metrics collection. | [optional] |
| **filter_tags** | **Array<String>** | The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `*` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1.*,!region:us-east-1` | [optional] |
| **host_tags** | **Array<String>** | Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. | [optional] |
| **metrics_collection_enabled** | **Boolean** | Whether Datadog collects metrics for this AWS account. | [optional][default to true] |
| **resource_collection_enabled** | **Boolean** | Whether Datadog collects a standard set of resources from your AWS account. | [optional][default to false] |
| **role_name** | **String** | Your Datadog role delegation name. | [optional] |
| **secret_access_key** | **String** | Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. | [optional] |
| Name | Type | Description | Notes |
| ------------------------------------ | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] |
| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] |
| **account_specific_namespace_rules** | **Hash<String, Boolean>** | An object, (in the form `{\"namespace1\":true/false, \"namespace2\":true/false}`), that enables or disables metric collection for specific AWS namespaces for this AWS account only. | [optional] |
| **cspm_resource_collection_enabled** | **Boolean** | Whether Datadog collects cloud security posture management resources from your AWS account. This includes additional resources not covered under the general `resource_collection`. | [optional][default to false] |
| **excluded_regions** | **Array<String>** | An array of AWS regions to exclude from metrics collection. | [optional] |
| **filter_tags** | **Array<String>** | The array of EC2 tags (in the form `key:value`) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as `?` (for single characters) and `_` (for multiple characters) can also be used. Only hosts that match one of the defined tags will be imported into Datadog. The rest will be ignored. Host matching a given tag can also be excluded by adding `!` before the tag. For example, `env:production,instance-type:c1._,!region:us-east-1` | [optional] |
| **host_tags** | **Array<String>** | Array of tags (in the form `key:value`) to add to all hosts and metrics reporting through this integration. | [optional] |
| **metrics_collection_enabled** | **Boolean** | Whether Datadog collects metrics for this AWS account. | [optional][default to true] |
| **resource_collection_enabled** | **Boolean** | Whether Datadog collects a standard set of resources from your AWS account. | [optional][default to false] |
| **role_name** | **String** | Your Datadog role delegation name. | [optional] |
| **secret_access_key** | **String** | Your AWS secret access key. Only required if your AWS account is a GovCloud or China account. | [optional] |

## Example

Expand All @@ -35,4 +35,3 @@ instance = DatadogAPIClient::V1::AWSAccount.new(
secret_access_key: null
)
```

9 changes: 4 additions & 5 deletions docs/v1/AWSAccountAndLambdaRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **account_id** | **String** | Your AWS Account ID without dashes. | |
| **lambda_arn** | **String** | ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. | |
| Name | Type | Description | Notes |
| -------------- | ---------- | ---------------------------------------------------------------------------------------------- | ----- |
| **account_id** | **String** | Your AWS Account ID without dashes. | |
| **lambda_arn** | **String** | ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup. | |

## Example

Expand All @@ -17,4 +17,3 @@ instance = DatadogAPIClient::V1::AWSAccountAndLambdaRequest.new(
lambda_arn: arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest
)
```

5 changes: 2 additions & 3 deletions docs/v1/AWSAccountCreateResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| Name | Type | Description | Notes |
| --------------- | ---------- | ---------------- | ---------- |
| **external_id** | **String** | AWS external_id. | [optional] |

## Example
Expand All @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSAccountCreateResponse.new(
external_id: null
)
```

9 changes: 4 additions & 5 deletions docs/v1/AWSAccountDeleteRequest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| Name | Type | Description | Notes |
| ----------------- | ---------- | ----------------------------------------------------------------------------------------- | ---------- |
| **access_key_id** | **String** | Your AWS access key ID. Only required if your AWS account is a GovCloud or China account. | [optional] |
| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] |
| **role_name** | **String** | Your Datadog role delegation name. | [optional] |
| **account_id** | **String** | Your AWS Account ID without dashes. | [optional] |
| **role_name** | **String** | Your Datadog role delegation name. | [optional] |

## Example

Expand All @@ -19,4 +19,3 @@ instance = DatadogAPIClient::V1::AWSAccountDeleteRequest.new(
role_name: DatadogAWSIntegrationRole
)
```

5 changes: 2 additions & 3 deletions docs/v1/AWSAccountListResponse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| Name | Type | Description | Notes |
| ------------ | -------------------------------------------- | ----------------------------- | ---------- |
| **accounts** | [**Array<AWSAccount>**](AWSAccount.md) | List of enabled AWS accounts. | [optional] |

## Example
Expand All @@ -15,4 +15,3 @@ instance = DatadogAPIClient::V1::AWSAccountListResponse.new(
accounts: null
)
```

Loading