diff --git a/hugo/content/en/api/v2/deployment-gates/examples.json b/hugo/content/en/api/v2/deployment-gates/examples.json
index c48251bc81a..416926af7b8 100644
--- a/hugo/content/en/api/v2/deployment-gates/examples.json
+++ b/hugo/content/en/api/v2/deployment-gates/examples.json
@@ -236,7 +236,7 @@
"type": "list_deployment_rules"
}
},
- "html": "
\n
\n
\n
\n
\n
Data for a list of deployment rules.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Attributes of the response for listing deployment rules.
\n
\n
\n
\n
\n
\n
\n
The list of deployment rules.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
List deployment rule resource type. \nAllowed enum values: list_deployment_rules
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Data for a list of deployment rules.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Attributes of the response for listing deployment rules.
\n
\n
\n
\n
\n
\n
\n
The list of deployment rules.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
List deployment rule resource type. \nAllowed enum values: list_deployment_rules
\n
\n \n
\n
\n
\n
"
},
"400": {
"json": {
@@ -331,7 +331,7 @@
"type": "deployment_rule"
}
},
- "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
},
"400": {
"json": {
@@ -414,7 +414,7 @@
"type": "deployment_rule"
}
},
- "html": "\n
\n
\n
\n
\n
Parameters for creating a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Parameters for creating a deployment rule.
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule (faulty_deployment_detection or monitor).
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Parameters for creating a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Parameters for creating a deployment rule.
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule (faulty_deployment_detection or monitor).
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
}
},
"DeleteDeploymentRule": {
@@ -524,7 +524,7 @@
"type": "deployment_rule"
}
},
- "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
},
"400": {
"json": {
@@ -631,7 +631,7 @@
"type": "deployment_rule"
}
},
- "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Data for a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Basic information about a deployment rule.
\n
\n
\n
\n
\n
\n
created_at [required]
\n
\n
\n
The timestamp when the deployment rule was created.
\n
\n \n
\n
\n
\n
\n
\n
created_by [required]
\n
\n
\n
Information about the user who created the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who created the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Whether this rule is run in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the deployment gate.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
The type of the deployment rule. \nAllowed enum values: faulty_deployment_detection,monitor
\n
\n \n
\n
\n
\n
\n
\n
\n
The timestamp when the deployment rule was last updated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Information about the user who updated the deployment rule.
\n
\n
\n
\n
\n
\n
\n
The handle of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The ID of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the user who updated the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Unique identifier of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
},
"400": {
"json": {
@@ -725,7 +725,7 @@
"type": "deployment_rule"
}
},
- "html": "\n
\n
\n
\n
\n
Parameters for updating a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Parameters for updating a deployment rule.
\n
\n
\n
\n
\n
\n
\n
Whether to run this rule in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
Monitors that match this query are evaluated.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
+ "html": "\n
\n
\n
\n
\n
Parameters for updating a deployment rule.
\n
\n
\n
\n
\n
\n
attributes [required]
\n
\n
\n
Parameters for updating a deployment rule.
\n
\n
\n
\n
\n
\n
\n
Whether to run this rule in dry-run mode.
\n
\n \n
\n
\n
\n
\n
\n
\n
The name of the deployment rule.
\n
\n \n
\n
\n
\n
\n
\n
\n
Options for deployment rule response representing either faulty deployment detection or monitor options.
\n
\n
\n
\n
\n
\n
\n
Faulty deployment detection options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Resources to include in faulty deployment detection. Mutually exclusive with excluded_resources.
\n
\n \n
\n
\n
\n
\n
\n
\n
The duration for faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
Resources to exclude from faulty deployment detection.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Monitor query options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitor needs to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a matching monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the query.
\n
\n \n
\n
\n
\n
\n
\n
\n
A query that selects the monitors to evaluate.
\n
\n \n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitor's status.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Specific monitor options for deployment rules.
\n
\n
\n
\n
\n
\n
\n
Seconds the monitors need to stay in OK status for the rule to pass.
\n
\n \n
\n
\n
\n
\n
\n
\n
Whether the rule should fail if a selected monitor group is in a NO DATA state.
default: true
\n
\n \n
\n
\n
\n
\n
\n
fail_on_no_groups_found
\n
\n
\n
Whether the rule should fail if no monitor groups are found for the selected monitors.
\n
\n \n
\n
\n
\n
\n
\n
monitor_ids [required]
\n
\n
\n
A non-empty list of specific monitors to evaluate.
\n
\n
\n
\n
\n
\n
\n
The exact monitor group names to evaluate. An empty array evaluates all groups.
\n
\n \n
\n
\n
\n
\n
\n
\n
The monitor's decimal ID.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
Seconds to wait after a deployment starts before evaluating the monitors' statuses.
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
Deployment rule resource type. \nAllowed enum values: deployment_rule
\n
\n \n
\n
\n
\n
"
}
},
"DeleteDeploymentGate": {
diff --git a/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_2423265690.json b/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_2423265690.json
new file mode 100644
index 00000000000..becff36c443
--- /dev/null
+++ b/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_2423265690.json
@@ -0,0 +1,18 @@
+{
+ "data": {
+ "attributes": {
+ "dry_run": false,
+ "name": "Specific monitor deployment rule",
+ "options": {
+ "monitor_ids": [
+ {
+ "id": "7",
+ "groups": []
+ }
+ ]
+ },
+ "type": "monitor"
+ },
+ "type": "deployment_rule"
+ }
+}
\ No newline at end of file
diff --git a/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_4286388136.json b/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_4286388136.json
new file mode 100644
index 00000000000..634d18cce2d
--- /dev/null
+++ b/hugo/content/en/api/v2/deployment-gates/request.CreateDeploymentRule_4286388136.json
@@ -0,0 +1,13 @@
+{
+ "data": {
+ "attributes": {
+ "dry_run": false,
+ "name": "Query monitor deployment rule",
+ "options": {
+ "query": "service:transaction-backend env:production"
+ },
+ "type": "monitor"
+ },
+ "type": "deployment_rule"
+ }
+}
\ No newline at end of file
diff --git a/hugo/data/api/v1/full_spec.yaml b/hugo/data/api/v1/full_spec.yaml
index 5c3e9caa8de..5be1693074b 100644
--- a/hugo/data/api/v1/full_spec.yaml
+++ b/hugo/data/api/v1/full_spec.yaml
@@ -31,7 +31,7 @@ components:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
schemas:
APIErrorResponse:
@@ -176,7 +176,7 @@ components:
accounts:
description: List of enabled AWS accounts.
items:
- $ref: "#/components/schemas/AWSAccount"
+ $ref: '#/components/schemas/AWSAccount'
type: array
type: object
AWSEventBridgeAccountConfiguration:
@@ -189,7 +189,7 @@ components:
eventHubs:
description: Array of AWS event sources associated with this account.
items:
- $ref: "#/components/schemas/AWSEventBridgeSource"
+ $ref: '#/components/schemas/AWSEventBridgeSource'
type: array
tags:
description: |-
@@ -241,7 +241,7 @@ components:
example: us-east-1
type: string
status:
- $ref: "#/components/schemas/AWSEventBridgeCreateStatus"
+ $ref: '#/components/schemas/AWSEventBridgeCreateStatus'
type: object
AWSEventBridgeCreateStatus:
description: The event source status "created".
@@ -269,7 +269,7 @@ components:
description: An indicator of the successful deletion of an EventBridge source.
properties:
status:
- $ref: "#/components/schemas/AWSEventBridgeDeleteStatus"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteStatus'
type: object
AWSEventBridgeDeleteStatus:
description: The event source status "empty".
@@ -283,7 +283,7 @@ components:
accounts:
description: List of accounts with their event sources.
items:
- $ref: "#/components/schemas/AWSEventBridgeAccountConfiguration"
+ $ref: '#/components/schemas/AWSEventBridgeAccountConfiguration'
type: array
isInstalled:
description: True if the EventBridge sub-integration is enabled for your organization.
@@ -317,7 +317,7 @@ components:
errors:
description: List of errors.
items:
- $ref: "#/components/schemas/AWSLogsAsyncError"
+ $ref: '#/components/schemas/AWSLogsAsyncError'
type: array
status:
description: Status of the properties.
@@ -344,7 +344,7 @@ components:
List of ARNs configured in your Datadog account.
example: ["arn": "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"]
items:
- $ref: "#/components/schemas/AWSLogsLambda"
+ $ref: '#/components/schemas/AWSLogsLambda'
type: array
services:
description: >-
@@ -398,7 +398,7 @@ components:
description: A tag filter.
properties:
namespace:
- $ref: "#/components/schemas/AWSNamespace"
+ $ref: '#/components/schemas/AWSNamespace'
tag_filter_str:
description: The tag filter string.
example: "prod*"
@@ -412,7 +412,7 @@ components:
example: "123456789012"
type: string
namespace:
- $ref: "#/components/schemas/AWSNamespace"
+ $ref: '#/components/schemas/AWSNamespace'
tag_filter_str:
description: The tag filter string.
example: "prod*"
@@ -426,7 +426,7 @@ components:
example: "FAKEAC0FAKEAC2FAKEAC"
type: string
namespace:
- $ref: "#/components/schemas/AWSNamespace"
+ $ref: '#/components/schemas/AWSNamespace'
type: object
AWSTagFilterListResponse:
description: An array of tag filter rules by `namespace` and tag filter string.
@@ -434,7 +434,7 @@ components:
filters:
description: An array of tag filters.
items:
- $ref: "#/components/schemas/AWSTagFilter"
+ $ref: '#/components/schemas/AWSTagFilter'
type: array
type: object
AccessRole:
@@ -464,7 +464,7 @@ components:
format: int64
type: integer
version:
- $ref: "#/components/schemas/Version"
+ $ref: '#/components/schemas/Version'
required:
- incident_id
type: object
@@ -485,19 +485,19 @@ components:
description: The description of the widget.
type: string
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: The title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/AlertGraphWidgetDefinitionType"
+ $ref: '#/components/schemas/AlertGraphWidgetDefinitionType'
viz_type:
- $ref: "#/components/schemas/WidgetVizType"
+ $ref: '#/components/schemas/WidgetVizType'
required:
- type
- alert_id
@@ -527,17 +527,17 @@ components:
format: int64
type: integer
text_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of value in the widget.
type: string
type:
- $ref: "#/components/schemas/AlertValueWidgetDefinitionType"
+ $ref: '#/components/schemas/AlertValueWidgetDefinitionType'
unit:
description: Unit to display with the value.
type: string
@@ -587,7 +587,7 @@ components:
api_keys:
description: Array of API keys.
items:
- $ref: "#/components/schemas/ApiKey"
+ $ref: '#/components/schemas/ApiKey'
type: array
type: object
ApiKeyResponse:
@@ -595,7 +595,7 @@ components:
example: {"api_key": {"created_by": "test_user", "key": "1234512345123456abcabc912349abcd", "name": "app_key"}}
properties:
api_key:
- $ref: "#/components/schemas/ApiKey"
+ $ref: '#/components/schemas/ApiKey'
type: object
ApmStatsQueryColumnType:
description: Column properties.
@@ -605,13 +605,13 @@ components:
example: Requests
type: string
cell_display_mode:
- $ref: "#/components/schemas/TableWidgetCellDisplayMode"
+ $ref: '#/components/schemas/TableWidgetCellDisplayMode'
name:
description: Column name.
example: Reqs
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
required:
- name
type: object
@@ -621,7 +621,7 @@ components:
columns:
description: Column properties used by the front end for display.
items:
- $ref: "#/components/schemas/ApmStatsQueryColumnType"
+ $ref: '#/components/schemas/ApmStatsQueryColumnType'
type: array
env:
description: Environment name.
@@ -640,7 +640,7 @@ components:
example: CartsController
type: string
row_type:
- $ref: "#/components/schemas/ApmStatsQueryRowType"
+ $ref: '#/components/schemas/ApmStatsQueryRowType'
service:
description: Service name.
example: "web-store"
@@ -691,7 +691,7 @@ components:
application_keys:
description: Array of application keys.
items:
- $ref: "#/components/schemas/ApplicationKey"
+ $ref: '#/components/schemas/ApplicationKey'
type: array
type: object
ApplicationKeyResponse:
@@ -699,7 +699,7 @@ components:
example: {"application_key": {"hash": "1234512345123459cda4eb9ced49a3d84fd0138c", "name": "app_key", "owner": "test_user"}}
properties:
application_key:
- $ref: "#/components/schemas/ApplicationKey"
+ $ref: '#/components/schemas/ApplicationKey'
type: object
AuthenticationValidationResponse:
description: Represent validation endpoint responses.
@@ -789,7 +789,7 @@ components:
resource_provider_configs:
description: Configuration settings applied to resources from the specified Azure resource providers.
items:
- $ref: "#/components/schemas/ResourceProviderConfig"
+ $ref: '#/components/schemas/ResourceProviderConfig'
type: array
secretless_auth_enabled:
description: |-
@@ -809,7 +809,7 @@ components:
AzureAccountListResponse:
description: Accounts configured for your organization.
items:
- $ref: "#/components/schemas/AzureAccount"
+ $ref: '#/components/schemas/AzureAccount'
type: array
BarChartWidgetDefinition:
description: The bar chart visualization displays categorical data using vertical bars, allowing you to compare values across different groups.
@@ -817,7 +817,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -826,24 +826,24 @@ components:
description: List of bar chart widget requests.
example: ["q": "system.load.1"]
items:
- $ref: "#/components/schemas/BarChartWidgetRequest"
+ $ref: '#/components/schemas/BarChartWidgetRequest'
maxItems: 1
minItems: 1
type: array
style:
- $ref: "#/components/schemas/BarChartWidgetStyle"
+ $ref: '#/components/schemas/BarChartWidgetStyle'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/BarChartWidgetDefinitionType"
+ $ref: '#/components/schemas/BarChartWidgetDefinitionType'
required:
- type
- requests
@@ -860,13 +860,13 @@ components:
BarChartWidgetDisplay:
description: Bar chart widget display options.
oneOf:
- - $ref: "#/components/schemas/BarChartWidgetStacked"
- - $ref: "#/components/schemas/BarChartWidgetFlat"
+ - $ref: '#/components/schemas/BarChartWidgetStacked'
+ - $ref: '#/components/schemas/BarChartWidgetFlat'
BarChartWidgetFlat:
description: Bar chart widget flat display.
properties:
type:
- $ref: "#/components/schemas/BarChartWidgetFlatType"
+ $ref: '#/components/schemas/BarChartWidgetFlatType'
required:
- type
type: object
@@ -906,7 +906,7 @@ components:
description: List of conditional formats.
example: [{"comparator": ">=", "palette": "blue", "value": 1.0}]
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -915,7 +915,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -940,10 +940,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -953,9 +953,9 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
style:
- $ref: "#/components/schemas/WidgetRequestStyle"
+ $ref: '#/components/schemas/WidgetRequestStyle'
type: object
BarChartWidgetScaling:
description: Bar chart widget scaling definition.
@@ -970,9 +970,9 @@ components:
description: Bar chart widget stacked display options.
properties:
legend:
- $ref: "#/components/schemas/BarChartWidgetLegend"
+ $ref: '#/components/schemas/BarChartWidgetLegend'
type:
- $ref: "#/components/schemas/BarChartWidgetStackedType"
+ $ref: '#/components/schemas/BarChartWidgetStackedType'
required:
- type
type: object
@@ -989,12 +989,12 @@ components:
description: Style customization for a bar chart widget.
properties:
display:
- $ref: "#/components/schemas/BarChartWidgetDisplay"
+ $ref: '#/components/schemas/BarChartWidgetDisplay'
palette:
description: Color palette to apply to the widget.
type: string
scaling:
- $ref: "#/components/schemas/BarChartWidgetScaling"
+ $ref: '#/components/schemas/BarChartWidgetScaling'
type: object
CalendarInterval:
additionalProperties: false
@@ -1014,7 +1014,7 @@ components:
example: "UTC"
type: string
type:
- $ref: "#/components/schemas/CalendarIntervalType"
+ $ref: '#/components/schemas/CalendarIntervalType'
required:
- type
type: object
@@ -1069,7 +1069,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -1082,22 +1082,22 @@ components:
to learn how to build the `REQUEST_SCHEMA`.
example: ["q": "{}"]
items:
- $ref: "#/components/schemas/ChangeWidgetRequest"
+ $ref: '#/components/schemas/ChangeWidgetRequest'
maxItems: 1
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ChangeWidgetDefinitionType"
+ $ref: '#/components/schemas/ChangeWidgetDefinitionType'
required:
- type
- requests
@@ -1119,9 +1119,9 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
change_type:
- $ref: "#/components/schemas/WidgetChangeType"
+ $ref: '#/components/schemas/WidgetChangeType'
compare_to:
- $ref: "#/components/schemas/WidgetCompareTo"
+ $ref: '#/components/schemas/WidgetCompareTo'
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -1129,7 +1129,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
increase_good:
description: Whether to show increase as good.
@@ -1143,9 +1143,9 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
order_by:
- $ref: "#/components/schemas/WidgetOrderBy"
+ $ref: '#/components/schemas/WidgetOrderBy'
order_dir:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
process_query:
$ref: "#/components/schemas/ProcessQueryDefinition"
deprecated: true
@@ -1161,10 +1161,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -1181,7 +1181,7 @@ components:
description: Response of monitor IDs that can or can't be safely deleted.
properties:
data:
- $ref: "#/components/schemas/CheckCanDeleteMonitorResponseData"
+ $ref: '#/components/schemas/CheckCanDeleteMonitorResponseData'
errors:
additionalProperties:
description: Strings denoting where a monitor is used.
@@ -1211,7 +1211,7 @@ components:
description: A service level objective response containing the requested object.
properties:
data:
- $ref: "#/components/schemas/CheckCanDeleteSLOResponseData"
+ $ref: '#/components/schemas/CheckCanDeleteSLOResponseData'
errors:
additionalProperties:
description: Description of the service level objective reference.
@@ -1249,7 +1249,7 @@ components:
type: string
type: array
grouping:
- $ref: "#/components/schemas/WidgetGrouping"
+ $ref: '#/components/schemas/WidgetGrouping'
tags:
description: List of tags used to filter the groups reporting a cluster check.
items:
@@ -1257,17 +1257,17 @@ components:
type: string
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/CheckStatusWidgetDefinitionType"
+ $ref: '#/components/schemas/CheckStatusWidgetDefinitionType'
required:
- type
- check
@@ -1321,17 +1321,17 @@ components:
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/CohortWidgetDefinitionType"
+ $ref: '#/components/schemas/CohortWidgetDefinitionType'
required:
- type
- requests
@@ -1369,7 +1369,7 @@ components:
$ref: "#/components/schemas/ComparisonCustomTimeframe"
description: Required when `type` is `custom_timeframe`. Fixed time range to compare against.
type:
- $ref: "#/components/schemas/ComparisonDurationType"
+ $ref: '#/components/schemas/ComparisonDurationType'
required:
- type
type: object
@@ -1465,7 +1465,7 @@ components:
example: false
type: boolean
layout_type:
- $ref: "#/components/schemas/DashboardLayoutType"
+ $ref: '#/components/schemas/DashboardLayoutType'
modified_at:
description: Modification date of the dashboard.
format: date-time
@@ -1479,7 +1479,7 @@ components:
nullable: true
type: array
reflow_type:
- $ref: "#/components/schemas/DashboardReflowType"
+ $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.
@@ -1490,7 +1490,7 @@ components:
tabs:
description: List of tabs for organizing dashboard widgets into groups.
items:
- $ref: "#/components/schemas/DashboardTab"
+ $ref: '#/components/schemas/DashboardTab'
maxItems: 100
nullable: true
type: array
@@ -1505,13 +1505,13 @@ components:
template_variable_presets:
description: Array of template variables saved views.
items:
- $ref: "#/components/schemas/DashboardTemplateVariablePreset"
+ $ref: '#/components/schemas/DashboardTemplateVariablePreset'
nullable: true
type: array
template_variables:
description: List of template variables for this dashboard.
items:
- $ref: "#/components/schemas/DashboardTemplateVariable"
+ $ref: '#/components/schemas/DashboardTemplateVariable'
nullable: true
type: array
title:
@@ -1527,7 +1527,7 @@ components:
description: List of widgets to display on the dashboard.
example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}]
items:
- $ref: "#/components/schemas/Widget"
+ $ref: '#/components/schemas/Widget'
type: array
required:
- title
@@ -1539,9 +1539,9 @@ components:
example: {"id": "123-abc-456", "type": "dashboard"}
properties:
id:
- $ref: "#/components/schemas/DashboardID"
+ $ref: '#/components/schemas/DashboardID'
type:
- $ref: "#/components/schemas/DashboardResourceType"
+ $ref: '#/components/schemas/DashboardResourceType'
required:
- type
- id
@@ -1550,22 +1550,22 @@ components:
description: List of dashboard bulk action request data objects.
example: [{"id": "123-abc-456", "type": "dashboard"}]
items:
- $ref: "#/components/schemas/DashboardBulkActionData"
+ $ref: '#/components/schemas/DashboardBulkActionData'
type: array
DashboardBulkDeleteRequest:
description: Dashboard bulk delete request body.
example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]}
properties:
data:
- $ref: "#/components/schemas/DashboardBulkActionDataList"
+ $ref: '#/components/schemas/DashboardBulkActionDataList'
required:
- data
type: object
DashboardDefaultTimeframeSetting:
description: The default timeframe applied when opening the dashboard. Set to `null` to clear the dashboard's default timeframe.
oneOf:
- - $ref: "#/components/schemas/DashboardLiveTimeframe"
- - $ref: "#/components/schemas/DashboardFixedTimeframe"
+ - $ref: '#/components/schemas/DashboardLiveTimeframe'
+ - $ref: '#/components/schemas/DashboardFixedTimeframe'
DashboardDeleteResponse:
description: Response from the delete dashboard call.
properties:
@@ -1589,7 +1589,7 @@ components:
minimum: 0
type: integer
type:
- $ref: "#/components/schemas/DashboardFixedTimeframeType"
+ $ref: '#/components/schemas/DashboardFixedTimeframeType'
required:
- type
- from
@@ -1607,7 +1607,7 @@ components:
description: Object containing the live span selection for the dashboard.
properties:
live_span:
- $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan"
+ $ref: '#/components/schemas/DashboardGlobalTimeLiveSpan'
type: object
DashboardGlobalTimeLiveSpan:
description: Dashboard global time live_span selection
@@ -1657,7 +1657,7 @@ components:
description: Your Datadog Dashboards.
properties:
author:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
created:
description: Date of creation of the dashboard list.
format: date-time
@@ -1708,16 +1708,16 @@ components:
dashboard_lists:
description: List of all your dashboard lists.
items:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
type: array
type: object
DashboardLiveTimeframe:
description: A live dashboard timeframe.
properties:
type:
- $ref: "#/components/schemas/DashboardLiveTimeframeType"
+ $ref: '#/components/schemas/DashboardLiveTimeframeType'
unit:
- $ref: "#/components/schemas/WidgetLiveSpanUnit"
+ $ref: '#/components/schemas/WidgetLiveSpanUnit'
value:
description: Value of the live timeframe span.
example: 4
@@ -1763,7 +1763,7 @@ components:
example: {"data": [{"id": "123-abc-456", "type": "dashboard"}]}
properties:
data:
- $ref: "#/components/schemas/DashboardBulkActionDataList"
+ $ref: '#/components/schemas/DashboardBulkActionDataList'
required:
- data
type: object
@@ -1785,7 +1785,7 @@ components:
dashboards:
description: List of dashboard definitions.
items:
- $ref: "#/components/schemas/DashboardSummaryDefinition"
+ $ref: '#/components/schemas/DashboardSummaryDefinition'
type: array
type: object
DashboardSummaryDefinition:
@@ -1813,7 +1813,7 @@ components:
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
type: boolean
layout_type:
- $ref: "#/components/schemas/DashboardLayoutType"
+ $ref: '#/components/schemas/DashboardLayoutType'
modified_at:
description: Modification date of the dashboard.
format: date-time
@@ -1905,7 +1905,7 @@ components:
template_variables:
description: List of variables.
items:
- $ref: "#/components/schemas/DashboardTemplateVariablePresetValue"
+ $ref: '#/components/schemas/DashboardTemplateVariablePresetValue'
type: array
type: object
DashboardTemplateVariablePresetValue:
@@ -1973,13 +1973,13 @@ components:
description: Query that lists the rows of a published dataset (a DDSQL query) without aggregation.
properties:
data_source:
- $ref: "#/components/schemas/DatasetListQueryDataSourceType"
+ $ref: '#/components/schemas/DatasetListQueryDataSourceType'
dataset_id:
description: ID of the published dataset to query.
example: "abc-123-def"
type: string
dataset_provider:
- $ref: "#/components/schemas/PublishedDatasetProvider"
+ $ref: '#/components/schemas/PublishedDatasetProvider'
filter:
description: Filter applied to the dataset's rows, using events-style search syntax.
example: "service:web-store"
@@ -1989,7 +1989,7 @@ components:
format: int64
type: integer
sort:
- $ref: "#/components/schemas/DatasetListQuerySort"
+ $ref: '#/components/schemas/DatasetListQuerySort'
required:
- data_source
- dataset_provider
@@ -2012,7 +2012,7 @@ components:
- name: cpu_usage
order: desc
items:
- $ref: "#/components/schemas/DatasetListQuerySortField"
+ $ref: '#/components/schemas/DatasetListQuerySortField'
type: array
required:
- fields
@@ -2025,7 +2025,7 @@ components:
example: duration
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
required:
- name
- order
@@ -2053,8 +2053,8 @@ components:
items:
description: List of distribution point.
oneOf:
- - $ref: "#/components/schemas/DistributionPointTimestamp"
- - $ref: "#/components/schemas/DistributionPointData"
+ - $ref: '#/components/schemas/DistributionPointTimestamp'
+ - $ref: '#/components/schemas/DistributionPointData'
maxItems: 2
minItems: 2
type: array
@@ -2086,7 +2086,7 @@ components:
points:
- [1475317847.0, [1.0, 2.0]]
items:
- $ref: "#/components/schemas/DistributionPointsSeries"
+ $ref: '#/components/schemas/DistributionPointsSeries'
type: array
required:
- series
@@ -2107,7 +2107,7 @@ components:
example:
- [1575317847.0, [0.5, 1.0]]
items:
- $ref: "#/components/schemas/DistributionPoint"
+ $ref: '#/components/schemas/DistributionPoint'
type: array
tags:
description: A list of tags associated with the distribution point metric.
@@ -2117,7 +2117,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/DistributionPointsType"
+ $ref: '#/components/schemas/DistributionPointsType'
required:
- metric
- points
@@ -2140,7 +2140,7 @@ components:
custom_links:
description: A list of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -2153,7 +2153,7 @@ components:
description: List of markers.
example: [{"display_type": "percentile", "value": "90"}]
items:
- $ref: "#/components/schemas/WidgetMarker"
+ $ref: '#/components/schemas/WidgetMarker'
type: array
requests:
description: |-
@@ -2162,7 +2162,7 @@ components:
See the dedicated [Request JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/request_json)
to learn how to build the `REQUEST_SCHEMA`.
items:
- $ref: "#/components/schemas/DistributionWidgetRequest"
+ $ref: '#/components/schemas/DistributionWidgetRequest'
maxItems: 1
minItems: 1
type: array
@@ -2171,21 +2171,21 @@ components:
description: (Deprecated) The widget legend was replaced by a tooltip and sidebar.
type: boolean
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/DistributionWidgetDefinitionType"
+ $ref: '#/components/schemas/DistributionWidgetDefinitionType'
xaxis:
- $ref: "#/components/schemas/DistributionWidgetXAxis"
+ $ref: '#/components/schemas/DistributionWidgetXAxis'
yaxis:
- $ref: "#/components/schemas/DistributionWidgetYAxis"
+ $ref: '#/components/schemas/DistributionWidgetYAxis'
required:
- type
- requests
@@ -2203,10 +2203,10 @@ components:
description: Query definition for Distribution Widget Histogram Request
example: {"data_source": "metrics", "name": "query1", "query": "histogram:trace.Load{*}"}
oneOf:
- - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition"
+ - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition'
DistributionWidgetRequest:
description: Updated distribution widget.
properties:
@@ -2215,7 +2215,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
apm_stats_query:
- $ref: "#/components/schemas/ApmStatsQueryDefinition"
+ $ref: '#/components/schemas/ApmStatsQueryDefinition'
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -2223,7 +2223,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -2248,10 +2248,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
- $ref: "#/components/schemas/DistributionWidgetHistogramRequestQuery"
+ $ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery'
request_type:
$ref: "#/components/schemas/WidgetHistogramRequestType"
description: Distribution of point values for distribution metrics. Renders a histogram of raw metric data points.
@@ -2267,7 +2267,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
style:
- $ref: "#/components/schemas/WidgetStyle"
+ $ref: '#/components/schemas/WidgetStyle'
type: object
DistributionWidgetXAxis:
description: X Axis controls for the distribution widget.
@@ -2328,7 +2328,7 @@ components:
readOnly: true
type: boolean
active_child:
- $ref: "#/components/schemas/DowntimeChild"
+ $ref: '#/components/schemas/DowntimeChild'
canceled:
description: If a scheduled downtime is canceled.
example: 1412799983
@@ -2402,9 +2402,9 @@ components:
example: false
type: boolean
notify_end_states:
- $ref: "#/components/schemas/NotifyEndStates"
+ $ref: '#/components/schemas/NotifyEndStates'
notify_end_types:
- $ref: "#/components/schemas/NotifyEndTypes"
+ $ref: '#/components/schemas/NotifyEndTypes'
parent_id:
description: ID of the parent Downtime.
example: 123
@@ -2412,7 +2412,7 @@ components:
nullable: true
type: integer
recurrence:
- $ref: "#/components/schemas/DowntimeRecurrence"
+ $ref: '#/components/schemas/DowntimeRecurrence'
scope:
description: |-
The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
@@ -2527,9 +2527,9 @@ components:
example: false
type: boolean
notify_end_states:
- $ref: "#/components/schemas/NotifyEndStates"
+ $ref: '#/components/schemas/NotifyEndStates'
notify_end_types:
- $ref: "#/components/schemas/NotifyEndTypes"
+ $ref: '#/components/schemas/NotifyEndTypes'
parent_id:
description: ID of the parent Downtime.
example: 123
@@ -2537,7 +2537,7 @@ components:
nullable: true
type: integer
recurrence:
- $ref: "#/components/schemas/DowntimeRecurrence"
+ $ref: '#/components/schemas/DowntimeRecurrence'
scope:
description: |-
The scope(s) to which the downtime applies and must be in `key:value` format. For example, `host:app2`.
@@ -2670,11 +2670,11 @@ components:
example: ""
type: string
legend:
- $ref: "#/components/schemas/EmbeddableGraphLegend"
+ $ref: '#/components/schemas/EmbeddableGraphLegend'
size:
- $ref: "#/components/schemas/EmbeddableGraphSize"
+ $ref: '#/components/schemas/EmbeddableGraphSize'
timeframe:
- $ref: "#/components/schemas/EmbeddableGraphTimeframe"
+ $ref: '#/components/schemas/EmbeddableGraphTimeframe'
title:
default: Embed created through API
description: Determines graph title. Must be at least 1 character.
@@ -2719,7 +2719,7 @@ components:
embedded_graphs:
description: List of embeddable graphs.
items:
- $ref: "#/components/schemas/EmbeddableGraph"
+ $ref: '#/components/schemas/EmbeddableGraph'
type: array
type: object
EnableEmbeddableGraphResponseSchema:
@@ -2734,7 +2734,7 @@ components:
description: Object representing an event.
properties:
alert_type:
- $ref: "#/components/schemas/EventAlertType"
+ $ref: '#/components/schemas/EventAlertType'
date_happened:
description: |-
POSIX timestamp of the event. Must be sent as an integer (that is no quotes).
@@ -2766,7 +2766,7 @@ components:
readOnly: true
type: string
priority:
- $ref: "#/components/schemas/EventPriority"
+ $ref: '#/components/schemas/EventPriority'
source_type_name:
description: |-
The type of event being posted. Option examples include nagios, hudson, jenkins, my_apps, chef, puppet, git, bitbucket, etc.
@@ -2829,7 +2829,7 @@ components:
maxLength: 100
type: string
alert_type:
- $ref: "#/components/schemas/EventAlertType"
+ $ref: '#/components/schemas/EventAlertType'
date_happened:
description: |-
POSIX timestamp of the event. Must be sent as an integer (that is no quotes).
@@ -2845,7 +2845,7 @@ components:
Any tags associated with the host are also applied to this event.
type: string
priority:
- $ref: "#/components/schemas/EventPriority"
+ $ref: '#/components/schemas/EventPriority'
related_event_id:
description: ID of the parent event. Must be sent as an integer (that is no quotes).
format: int64
@@ -2882,7 +2882,7 @@ components:
description: Object containing an event response.
properties:
event:
- $ref: "#/components/schemas/Event"
+ $ref: '#/components/schemas/Event'
status:
description: A status.
type: string
@@ -2893,7 +2893,7 @@ components:
events:
description: An array of events.
items:
- $ref: "#/components/schemas/Event"
+ $ref: '#/components/schemas/Event'
type: array
status:
description: A status.
@@ -2929,7 +2929,7 @@ components:
description: Object containing an event response.
properties:
event:
- $ref: "#/components/schemas/Event"
+ $ref: '#/components/schemas/Event'
status:
description: A status.
type: string
@@ -2943,7 +2943,7 @@ components:
description: The description of the widget.
type: string
event_size:
- $ref: "#/components/schemas/WidgetEventSize"
+ $ref: '#/components/schemas/WidgetEventSize'
query:
description: Query to filter the event stream with.
example: ""
@@ -2952,17 +2952,17 @@ components:
description: The execution method for multi-value filters. Can be either and or or.
type: string
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/EventStreamWidgetDefinitionType"
+ $ref: '#/components/schemas/EventStreamWidgetDefinitionType'
required:
- type
- query
@@ -2990,17 +2990,17 @@ components:
description: The execution method for multi-value filters. Can be either and or or.
type: string
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/EventTimelineWidgetDefinitionType"
+ $ref: '#/components/schemas/EventTimelineWidgetDefinitionType'
required:
- type
- query
@@ -3018,8 +3018,8 @@ components:
description: The type of aggregation that can be performed on events-based queries.
example: avg
oneOf:
- - $ref: "#/components/schemas/EventsAggregationValue"
- - $ref: "#/components/schemas/EventsAggregationPercentile"
+ - $ref: '#/components/schemas/EventsAggregationValue'
+ - $ref: '#/components/schemas/EventsAggregationPercentile'
EventsAggregationPercentile:
description: Percentile aggregation.
pattern: '^pc[0-9]+(\.[0-9]+)?$'
@@ -3083,9 +3083,9 @@ components:
description: A formula and functions APM dependency stats query.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsDataSource'
env:
description: APM environment.
example: "staging"
@@ -3119,7 +3119,7 @@ components:
example: "cassandra"
type: string
stat:
- $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatName"
+ $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatName'
required:
- data_source
- env
@@ -3179,7 +3179,7 @@ components:
description: A formula and functions APM metrics query.
properties:
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionApmMetricsDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionApmMetricsDataSource'
group_by:
description: Optional fields to group the query results by.
items:
@@ -3223,9 +3223,9 @@ components:
example: "web-store"
type: string
span_kind:
- $ref: "#/components/schemas/FormulaAndFunctionApmMetricsSpanKind"
+ $ref: '#/components/schemas/FormulaAndFunctionApmMetricsSpanKind'
stat:
- $ref: "#/components/schemas/FormulaAndFunctionApmMetricStatName"
+ $ref: '#/components/schemas/FormulaAndFunctionApmMetricStatName'
required:
- data_source
- name
@@ -3288,9 +3288,9 @@ components:
description: APM resource stats query using formulas and functions. Deprecated - Use `apm_metrics` query type instead.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsDataSource'
env:
description: APM environment.
example: "staging"
@@ -3327,7 +3327,7 @@ components:
example: "web-store"
type: string
stat:
- $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatName"
+ $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatName'
required:
- data_source
- env
@@ -3351,11 +3351,11 @@ components:
query: "sum:aws.cost.amortized{*}"
properties:
aggregator:
- $ref: "#/components/schemas/WidgetAggregator"
+ $ref: '#/components/schemas/WidgetAggregator'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionCloudCostDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionCloudCostDataSource'
name:
description: Name of the query for use in formulas.
example: "my_query"
@@ -3403,13 +3403,13 @@ components:
description: A formula and functions events query.
properties:
compute:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionCompute"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinitionCompute'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionEventsDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionEventsDataSource'
group_by:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByConfig'
indexes:
description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
example: ["days-3", "days-7"]
@@ -3422,7 +3422,7 @@ components:
example: "query_errors"
type: string
search:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinitionSearch'
storage:
description: Option for storage location. Feature in Private Beta.
example: "indexes"
@@ -3436,7 +3436,7 @@ components:
description: Compute options.
properties:
aggregation:
- $ref: "#/components/schemas/FormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
interval:
description: A time interval in milliseconds.
example: 60000
@@ -3472,15 +3472,15 @@ components:
format: int64
type: integer
sort:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
required:
- facet
type: object
FormulaAndFunctionEventQueryGroupByConfig:
description: Group by configuration for a formula and functions events query. Accepts either a list of facet objects or a flat object that specifies a list of facet fields.
oneOf:
- - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByList"
- - $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupByFields"
+ - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByList'
+ - $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupByFields'
FormulaAndFunctionEventQueryGroupByFields:
description: Flat group by configuration using multiple event facet fields.
properties:
@@ -3497,25 +3497,25 @@ components:
format: int64
type: integer
sort:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
required:
- fields
type: object
FormulaAndFunctionEventQueryGroupByList:
description: List of objects used to group by.
items:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBy"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBy'
type: array
FormulaAndFunctionEventQueryGroupBySort:
description: Options for sorting group by results.
properties:
aggregation:
- $ref: "#/components/schemas/FormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
metric:
description: Metric used for sorting group by results.
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
required:
- aggregation
type: object
@@ -3593,11 +3593,11 @@ components:
query: "avg:system.cpu.user{*}"
properties:
aggregator:
- $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionMetricAggregation'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionMetricDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionMetricDataSource'
name:
description: Name of the query for use in formulas.
example: "my_query"
@@ -3607,7 +3607,7 @@ components:
example: "avg:system.cpu.user{*}"
type: string
semantic_mode:
- $ref: "#/components/schemas/FormulaAndFunctionMetricSemanticMode"
+ $ref: '#/components/schemas/FormulaAndFunctionMetricSemanticMode'
required:
- data_source
- query
@@ -3637,11 +3637,11 @@ components:
description: Process query using formulas and functions.
properties:
aggregator:
- $ref: "#/components/schemas/FormulaAndFunctionMetricAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionMetricAggregation'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDataSource'
is_normalized_cpu:
description: Whether to normalize the CPU percentages.
type: boolean
@@ -3658,7 +3658,7 @@ components:
example: "query_errors"
type: string
sort:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: An array of tags to filter by.
items:
@@ -3685,11 +3685,11 @@ components:
description: A formula and functions Product Analytics Extended query for advanced analytics features.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
compute:
- $ref: "#/components/schemas/ProductAnalyticsExtendedCompute"
+ $ref: '#/components/schemas/ProductAnalyticsExtendedCompute'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedDataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedDataSource'
group_by:
description: Group by configuration.
items:
@@ -3700,14 +3700,14 @@ components:
description: Event indexes to query.
example: ["*"]
items:
- $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems"
+ $ref: '#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinitionIndexesItems'
type: array
name:
description: Name of the query for use in formulas.
example: "query1"
type: string
query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
required:
- data_source
- name
@@ -3724,17 +3724,17 @@ components:
FormulaAndFunctionQueryDefinition:
description: A formula and function query.
oneOf:
- - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionProcessQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionSLOQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionUserJourneyQueryDefinition"
- - $ref: "#/components/schemas/FormulaAndFunctionRetentionQueryDefinition"
+ - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionProcessQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionApmDependencyStatsQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionApmMetricsQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionSLOQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionCloudCostQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionProductAnalyticsExtendedQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionUserJourneyQueryDefinition'
+ - $ref: '#/components/schemas/FormulaAndFunctionRetentionQueryDefinition'
FormulaAndFunctionResponseFormat:
description: Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
enum:
@@ -3751,9 +3751,9 @@ components:
description: A formula and functions Retention query for defining timeseries and scalar visualizations.
properties:
compute:
- $ref: "#/components/schemas/RetentionCompute"
+ $ref: '#/components/schemas/RetentionCompute'
data_source:
- $ref: "#/components/schemas/RetentionDataSource"
+ $ref: '#/components/schemas/RetentionDataSource'
group_by:
description: Group by configuration.
items:
@@ -3765,7 +3765,7 @@ components:
example: "query1"
type: string
search:
- $ref: "#/components/schemas/RetentionSearch"
+ $ref: '#/components/schemas/RetentionSearch'
required:
- data_source
- name
@@ -3828,13 +3828,13 @@ components:
example: "host:host_a,env:prod"
type: string
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/FormulaAndFunctionSLODataSource"
+ $ref: '#/components/schemas/FormulaAndFunctionSLODataSource'
group_mode:
- $ref: "#/components/schemas/FormulaAndFunctionSLOGroupMode"
+ $ref: '#/components/schemas/FormulaAndFunctionSLOGroupMode'
measure:
- $ref: "#/components/schemas/FormulaAndFunctionSLOMeasure"
+ $ref: '#/components/schemas/FormulaAndFunctionSLOMeasure'
name:
description: Name of the query for use in formulas.
example: "my_slo"
@@ -3844,7 +3844,7 @@ components:
example: "12345678910"
type: string
slo_query_type:
- $ref: "#/components/schemas/FormulaAndFunctionSLOQueryType"
+ $ref: '#/components/schemas/FormulaAndFunctionSLOQueryType'
required:
- data_source
- slo_id
@@ -3866,9 +3866,9 @@ components:
description: A formula and functions User Journey query for defining funnel, timeseries, and scalar visualizations over journey data.
properties:
compute:
- $ref: "#/components/schemas/UserJourneyFormulaCompute"
+ $ref: '#/components/schemas/UserJourneyFormulaCompute'
data_source:
- $ref: "#/components/schemas/ProductAnalyticsFunnelDataSource"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelDataSource'
group_by:
description: Group by configuration.
items:
@@ -3880,7 +3880,7 @@ components:
example: "query1"
type: string
search:
- $ref: "#/components/schemas/UserJourneySearch"
+ $ref: '#/components/schemas/UserJourneySearch'
required:
- data_source
- name
@@ -3898,7 +3898,7 @@ components:
description: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
properties:
background_color:
- $ref: "#/components/schemas/WidgetBackgroundColor"
+ $ref: '#/components/schemas/WidgetBackgroundColor'
color:
description: Color of the text.
type: string
@@ -3910,9 +3910,9 @@ components:
example: ""
type: string
text_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
type:
- $ref: "#/components/schemas/FreeTextWidgetDefinitionType"
+ $ref: '#/components/schemas/FreeTextWidgetDefinitionType'
required:
- type
- text
@@ -3949,9 +3949,9 @@ components:
description: Comparison time configuration for funnel widgets.
properties:
custom_timeframe:
- $ref: "#/components/schemas/FunnelComparisonCustomTimeframe"
+ $ref: '#/components/schemas/FunnelComparisonCustomTimeframe'
type:
- $ref: "#/components/schemas/FunnelComparisonDurationType"
+ $ref: '#/components/schemas/FunnelComparisonDurationType'
required:
- type
type: object
@@ -3985,7 +3985,7 @@ components:
description: Updated funnel widget.
properties:
data_source:
- $ref: "#/components/schemas/FunnelSource"
+ $ref: '#/components/schemas/FunnelSource'
query_string:
description: The widget query.
example: "@browser.name:Chrome"
@@ -3993,7 +3993,7 @@ components:
steps:
description: List of funnel steps.
items:
- $ref: "#/components/schemas/FunnelStep"
+ $ref: '#/components/schemas/FunnelStep'
type: array
required:
- query_string
@@ -4040,26 +4040,26 @@ components:
description: The description of the widget.
type: string
grouped_display:
- $ref: "#/components/schemas/FunnelGroupedDisplay"
+ $ref: '#/components/schemas/FunnelGroupedDisplay'
requests:
description: Request payload used to query items.
example: [{"query": {"data_source": "rum", "query_string": "@browser.name:Chrome", "steps": [{"facet": "@view.name", "value": "/logs"}, {"facet": "@view.name", "value": "/apm/home"}]}, "request_type": "funnel"}]
items:
- $ref: "#/components/schemas/FunnelWidgetRequest"
+ $ref: '#/components/schemas/FunnelWidgetRequest'
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: The title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: The size of the title.
type: string
type:
- $ref: "#/components/schemas/FunnelWidgetDefinitionType"
+ $ref: '#/components/schemas/FunnelWidgetDefinitionType'
required:
- type
- requests
@@ -4077,9 +4077,9 @@ components:
description: Updated funnel widget.
properties:
query:
- $ref: "#/components/schemas/FunnelQuery"
+ $ref: '#/components/schemas/FunnelQuery'
request_type:
- $ref: "#/components/schemas/FunnelRequestType"
+ $ref: '#/components/schemas/FunnelRequestType'
required:
- query
- request_type
@@ -4165,7 +4165,7 @@ components:
description: Configurations for GCP monitored resources.
example: [{"filters": ["$KEY:$VALUE"], "type": "gce_instance"}]
items:
- $ref: "#/components/schemas/GCPMonitoredResourceConfig"
+ $ref: '#/components/schemas/GCPMonitoredResourceConfig'
type: array
private_key:
description: |-
@@ -4201,7 +4201,7 @@ components:
GCPAccountListResponse:
description: Array of GCP account responses.
items:
- $ref: "#/components/schemas/GCPAccount"
+ $ref: '#/components/schemas/GCPAccount'
type: array
GCPMonitoredResourceConfig:
description: Configuration for a GCP monitored resource.
@@ -4216,7 +4216,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/GCPMonitoredResourceConfigType"
+ $ref: '#/components/schemas/GCPMonitoredResourceConfigType'
type: object
GCPMonitoredResourceConfigType:
description: The GCP monitored resource type. Only a subset of resource types are supported.
@@ -4233,7 +4233,7 @@ components:
custom_links:
description: A list of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -4245,26 +4245,26 @@ components:
for information about building the `REQUEST_SCHEMA`.
example: ["rum_query": {"search": {"query": "{}"}}]
items:
- $ref: "#/components/schemas/GeomapWidgetRequest"
+ $ref: '#/components/schemas/GeomapWidgetRequest'
maxItems: 2
minItems: 1
type: array
style:
- $ref: "#/components/schemas/GeomapWidgetDefinitionStyle"
+ $ref: '#/components/schemas/GeomapWidgetDefinitionStyle'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: The title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: The size of the title.
type: string
type:
- $ref: "#/components/schemas/GeomapWidgetDefinitionType"
+ $ref: '#/components/schemas/GeomapWidgetDefinitionType'
view:
- $ref: "#/components/schemas/GeomapWidgetDefinitionView"
+ $ref: '#/components/schemas/GeomapWidgetDefinitionView'
required:
- type
- requests
@@ -4314,17 +4314,17 @@ components:
description: Widget columns.
example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}]
items:
- $ref: "#/components/schemas/ListStreamColumn"
+ $ref: '#/components/schemas/ListStreamColumn'
type: array
conditional_formats:
description: Threshold (numeric) conditional formatting rules may be used by a regions layer.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -4337,12 +4337,12 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
- $ref: "#/components/schemas/ListStreamQuery"
+ $ref: '#/components/schemas/ListStreamQuery'
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -4352,13 +4352,13 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
style:
- $ref: "#/components/schemas/GeomapWidgetRequestStyle"
+ $ref: '#/components/schemas/GeomapWidgetRequestStyle'
text_formats:
description: Text formatting rules may be used by a points layer.
items:
- $ref: "#/components/schemas/TableWidgetTextFormatRule"
+ $ref: '#/components/schemas/TableWidgetTextFormatRule'
type: array
type: object
GeomapWidgetRequestStyle:
@@ -4398,12 +4398,12 @@ components:
description: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
properties:
background_color:
- $ref: "#/components/schemas/WidgetBackgroundColor"
+ $ref: '#/components/schemas/WidgetBackgroundColor'
banner_img:
description: URL of image to display as a banner for the group.
type: string
layout_type:
- $ref: "#/components/schemas/WidgetLayoutType"
+ $ref: '#/components/schemas/WidgetLayoutType'
show_title:
default: true
description: Whether to show the title or not.
@@ -4412,14 +4412,14 @@ components:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
type:
- $ref: "#/components/schemas/GroupWidgetDefinitionType"
+ $ref: '#/components/schemas/GroupWidgetDefinitionType'
widgets:
description: List of widget groups.
example: ["definition": {"requests": {"fill": {"q": "avg:system.cpu.user{*}"}}, "type": "hostmap"}]
items:
- $ref: "#/components/schemas/Widget"
+ $ref: '#/components/schemas/Widget'
type: array
required:
- type
@@ -4438,7 +4438,7 @@ components:
HTTPLog:
description: Structured log message.
items:
- $ref: "#/components/schemas/HTTPLogItem"
+ $ref: '#/components/schemas/HTTPLogItem'
type: array
HTTPLogError:
description: Invalid query performed.
@@ -4501,7 +4501,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -4510,21 +4510,21 @@ components:
deprecated: true
description: List of widget events. Deprecated - Use `overlay` request type instead.
items:
- $ref: "#/components/schemas/WidgetEvent"
+ $ref: '#/components/schemas/WidgetEvent'
type: array
legend_size:
- $ref: "#/components/schemas/WidgetLegendSize"
+ $ref: '#/components/schemas/WidgetLegendSize'
markers:
description: List of markers.
example: [{"display_type": "percentile", "value": "90"}]
items:
- $ref: "#/components/schemas/WidgetMarker"
+ $ref: '#/components/schemas/WidgetMarker'
type: array
requests:
description: List of widget types.
example: ["q": "jvm.heap.memory"]
items:
- $ref: "#/components/schemas/HeatMapWidgetRequest"
+ $ref: '#/components/schemas/HeatMapWidgetRequest'
maxItems: 1
minItems: 1
type: array
@@ -4532,21 +4532,21 @@ components:
description: Whether or not to display the legend on this widget.
type: boolean
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/HeatMapWidgetDefinitionType"
+ $ref: '#/components/schemas/HeatMapWidgetDefinitionType'
xaxis:
- $ref: "#/components/schemas/HeatMapWidgetXAxis"
+ $ref: '#/components/schemas/HeatMapWidgetXAxis'
yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
required:
- type
- requests
@@ -4574,7 +4574,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -4599,10 +4599,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
query:
- $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
request_type:
$ref: "#/components/schemas/WidgetHistogramRequestType"
description: Applicable only for distribution of point values for distribution metrics.
@@ -4618,7 +4618,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
style:
- $ref: "#/components/schemas/WidgetStyle"
+ $ref: '#/components/schemas/WidgetStyle'
type: object
HeatMapWidgetXAxis:
description: X Axis controls for the heat map widget.
@@ -4671,9 +4671,9 @@ components:
format: int64
type: integer
meta:
- $ref: "#/components/schemas/HostMeta"
+ $ref: '#/components/schemas/HostMeta'
metrics:
- $ref: "#/components/schemas/HostMetrics"
+ $ref: '#/components/schemas/HostMetrics'
mute_timeout:
description: Timeout of the mute applied to your host.
format: int64
@@ -4711,7 +4711,7 @@ components:
host_list:
description: Array of hosts.
items:
- $ref: "#/components/schemas/Host"
+ $ref: '#/components/schemas/Host'
type: array
total_matching:
description: Number of host matching the query.
@@ -4771,7 +4771,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -4803,7 +4803,7 @@ components:
description: Notes on the title.
type: string
requests:
- $ref: "#/components/schemas/HostMapWidgetDefinitionRequests"
+ $ref: '#/components/schemas/HostMapWidgetDefinitionRequests'
scope:
deprecated: true
description: >-
@@ -4821,12 +4821,12 @@ components:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/HostMapWidgetDefinitionType"
+ $ref: '#/components/schemas/HostMapWidgetDefinitionType'
required:
- type
- requests
@@ -4853,7 +4853,7 @@ components:
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
enrichments:
description: >-
@@ -4868,7 +4868,7 @@ components:
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
- $ref: "#/components/schemas/HostMapWidgetScalarRequest"
+ $ref: '#/components/schemas/HostMapWidgetScalarRequest'
type: array
fill:
$ref: "#/components/schemas/HostMapRequest"
@@ -4885,7 +4885,7 @@ components:
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy. Only used by the infrastructure-backed format.
items:
- $ref: "#/components/schemas/HostMapWidgetGroupBy"
+ $ref: '#/components/schemas/HostMapWidgetGroupBy'
type: array
limit:
description: Maximum number of rows to return from the dataset query. Only used by the DDSQL format.
@@ -4908,14 +4908,14 @@ components:
$ref: "#/components/schemas/DatasetListQuery"
description: Published-dataset query. Only used by the DDSQL format.
request_type:
- $ref: "#/components/schemas/HostMapWidgetDefinitionRequestType"
+ $ref: '#/components/schemas/HostMapWidgetDefinitionRequestType'
size:
$ref: "#/components/schemas/HostMapRequest"
deprecated: true
description: >-
Deprecated - Legacy metric-based format. Use the infrastructure-backed (`request_type: infrastructure_hostmap`) or DDSQL (`request_type: data_projection`) format instead.
style:
- $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
+ $ref: '#/components/schemas/HostMapWidgetInfrastructureStyle'
type: object
HostMapWidgetDefinitionStyle:
deprecated: true
@@ -4969,13 +4969,13 @@ components:
example: "my-metric"
type: string
dimension:
- $ref: "#/components/schemas/HostMapWidgetDimension"
+ $ref: '#/components/schemas/HostMapWidgetDimension'
formula:
description: String expression built from queries, formulas, and functions.
example: "query1"
type: string
number_format:
- $ref: "#/components/schemas/WidgetNumberFormat"
+ $ref: '#/components/schemas/WidgetNumberFormat'
required:
- formula
- dimension
@@ -5008,7 +5008,7 @@ components:
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
enrichments:
description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
@@ -5022,7 +5022,7 @@ components:
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
- $ref: "#/components/schemas/HostMapWidgetScalarRequest"
+ $ref: '#/components/schemas/HostMapWidgetScalarRequest'
type: array
filter:
description: Filter string for the entity set in tag format (for example, `env:prod`).
@@ -5033,7 +5033,7 @@ components:
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy.
items:
- $ref: "#/components/schemas/HostMapWidgetGroupBy"
+ $ref: '#/components/schemas/HostMapWidgetGroupBy'
type: array
no_group_hosts:
description: Whether to hide entities that have no group assignment.
@@ -5042,11 +5042,11 @@ components:
description: Whether to hide entities that have no enrichment data.
type: boolean
node_type:
- $ref: "#/components/schemas/HostMapWidgetNodeType"
+ $ref: '#/components/schemas/HostMapWidgetNodeType'
request_type:
- $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
+ $ref: '#/components/schemas/HostMapWidgetInfrastructureRequestRequestType'
style:
- $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
+ $ref: '#/components/schemas/HostMapWidgetInfrastructureStyle'
required:
- request_type
- node_type
@@ -5058,7 +5058,7 @@ components:
conditional_formats:
description: List of conditional formatting rules applied to fill values.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
enrichments:
description: Metric or event queries joined to the entity set. Each formula specifies a visual dimension.
@@ -5072,7 +5072,7 @@ components:
query: "avg:system.cpu.user{*} by {host}"
response_format: scalar
items:
- $ref: "#/components/schemas/HostMapWidgetScalarRequest"
+ $ref: '#/components/schemas/HostMapWidgetScalarRequest'
type: array
filter:
description: Filter string for the entity set in tag format (for example, `env:prod`).
@@ -5083,7 +5083,7 @@ components:
Defines how entities are grouped into tiles. The ordering of entries implies
the grouping hierarchy.
items:
- $ref: "#/components/schemas/HostMapWidgetGroupBy"
+ $ref: '#/components/schemas/HostMapWidgetGroupBy'
type: array
no_group_hosts:
description: Whether to hide entities that have no group assignment.
@@ -5092,11 +5092,11 @@ components:
description: Whether to hide entities that have no enrichment data.
type: boolean
node_type:
- $ref: "#/components/schemas/HostMapWidgetNodeType"
+ $ref: '#/components/schemas/HostMapWidgetNodeType'
request_type:
- $ref: "#/components/schemas/HostMapWidgetInfrastructureRequestRequestType"
+ $ref: '#/components/schemas/HostMapWidgetInfrastructureRequestRequestType'
style:
- $ref: "#/components/schemas/HostMapWidgetInfrastructureStyle"
+ $ref: '#/components/schemas/HostMapWidgetInfrastructureStyle'
required:
- request_type
- node_type
@@ -5157,10 +5157,10 @@ components:
- column: cpu_usage
dimension: fill
items:
- $ref: "#/components/schemas/HostMapWidgetProjectionDimensionMapping"
+ $ref: '#/components/schemas/HostMapWidgetProjectionDimensionMapping'
type: array
type:
- $ref: "#/components/schemas/HostMapWidgetProjectionType"
+ $ref: '#/components/schemas/HostMapWidgetProjectionType'
required:
- type
- dimensions
@@ -5176,9 +5176,9 @@ components:
example: entity_id
type: string
dimension:
- $ref: "#/components/schemas/HostMapWidgetDimension"
+ $ref: '#/components/schemas/HostMapWidgetDimension'
number_format:
- $ref: "#/components/schemas/WidgetNumberFormat"
+ $ref: '#/components/schemas/WidgetNumberFormat'
required:
- column
- dimension
@@ -5202,7 +5202,7 @@ components:
- dimension: fill
formula: "query1"
items:
- $ref: "#/components/schemas/HostMapWidgetFormula"
+ $ref: '#/components/schemas/HostMapWidgetFormula'
type: array
queries:
description: List of queries that can be returned directly or used in formulas.
@@ -5211,10 +5211,10 @@ components:
name: "my_query"
query: "avg:system.cpu.user{*}"
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/HostMapWidgetScalarRequestResponseFormat"
+ $ref: '#/components/schemas/HostMapWidgetScalarRequestResponseFormat'
required:
- response_format
- queries
@@ -5234,7 +5234,7 @@ components:
agent_checks:
description: A list of Agent checks running on the host.
items:
- $ref: "#/components/schemas/AgentCheck"
+ $ref: '#/components/schemas/AgentCheck'
type: array
agent_version:
description: The Datadog Agent version.
@@ -5257,7 +5257,7 @@ components:
SMP Tue Jul 17 15:39:52 UTC 2018","machine":"x86_64","os":"GNU/Linux","processor":"x86_64","pythonV":"2.7.15rc1"}}'
type: string
install_method:
- $ref: "#/components/schemas/HostMetaInstallMethod"
+ $ref: '#/components/schemas/HostMetaInstallMethod'
macV:
description: An array of Mac versions.
items:
@@ -5421,7 +5421,7 @@ components:
description: The source of the usage attribution tag configuration and the selected tags in the format of `::://////`.
type: string
tags:
- $ref: "#/components/schemas/UsageAttributionTagNames"
+ $ref: '#/components/schemas/UsageAttributionTagNames'
total_usage_sum:
description: Total product usage for the given tags within the hour.
format: double
@@ -5430,13 +5430,13 @@ components:
description: Shows the most recent hour in the current month for all organizations where usages are calculated.
type: string
usage_type:
- $ref: "#/components/schemas/HourlyUsageAttributionUsageType"
+ $ref: '#/components/schemas/HourlyUsageAttributionUsageType'
type: object
HourlyUsageAttributionMetadata:
description: The object containing document metadata.
properties:
pagination:
- $ref: "#/components/schemas/HourlyUsageAttributionPagination"
+ $ref: '#/components/schemas/HourlyUsageAttributionPagination'
type: object
HourlyUsageAttributionPagination:
description: The metadata for the current pagination.
@@ -5450,11 +5450,11 @@ components:
description: Response containing the hourly usage attribution by tag(s).
properties:
metadata:
- $ref: "#/components/schemas/HourlyUsageAttributionMetadata"
+ $ref: '#/components/schemas/HourlyUsageAttributionMetadata'
usage:
description: Get the hourly usage attribution by tag(s).
items:
- $ref: "#/components/schemas/HourlyUsageAttributionBody"
+ $ref: '#/components/schemas/HourlyUsageAttributionBody'
type: array
type: object
HourlyUsageAttributionUsageType:
@@ -5646,7 +5646,7 @@ components:
description: The iframe widget allows you to embed a portion of any other web page on your dashboard.
properties:
type:
- $ref: "#/components/schemas/IFrameWidgetDefinitionType"
+ $ref: '#/components/schemas/IFrameWidgetDefinitionType'
url:
description: URL of the iframe.
example: ""
@@ -5862,36 +5862,36 @@ components:
description: IP ranges.
properties:
agents:
- $ref: "#/components/schemas/IPPrefixesAgents"
+ $ref: '#/components/schemas/IPPrefixesAgents'
api:
- $ref: "#/components/schemas/IPPrefixesAPI"
+ $ref: '#/components/schemas/IPPrefixesAPI'
apm:
- $ref: "#/components/schemas/IPPrefixesAPM"
+ $ref: '#/components/schemas/IPPrefixesAPM'
global:
- $ref: "#/components/schemas/IPPrefixesGlobal"
+ $ref: '#/components/schemas/IPPrefixesGlobal'
logs:
- $ref: "#/components/schemas/IPPrefixesLogs"
+ $ref: '#/components/schemas/IPPrefixesLogs'
modified:
description: Date when last updated, in the form `YYYY-MM-DD-hh-mm-ss`.
example: 2019-10-31-20-00-00
type: string
orchestrator:
- $ref: "#/components/schemas/IPPrefixesOrchestrator"
+ $ref: '#/components/schemas/IPPrefixesOrchestrator'
process:
- $ref: "#/components/schemas/IPPrefixesProcess"
+ $ref: '#/components/schemas/IPPrefixesProcess'
remote-configuration:
- $ref: "#/components/schemas/IPPrefixesRemoteConfiguration"
+ $ref: '#/components/schemas/IPPrefixesRemoteConfiguration'
synthetics:
- $ref: "#/components/schemas/IPPrefixesSynthetics"
+ $ref: '#/components/schemas/IPPrefixesSynthetics'
synthetics-private-locations:
- $ref: "#/components/schemas/IPPrefixesSyntheticsPrivateLocations"
+ $ref: '#/components/schemas/IPPrefixesSyntheticsPrivateLocations'
version:
description: Version of the IP list.
example: 11
format: int64
type: integer
webhooks:
- $ref: "#/components/schemas/IPPrefixesWebhooks"
+ $ref: '#/components/schemas/IPPrefixesWebhooks'
type: object
IdpFormData:
description: Object describing the IdP configuration.
@@ -5928,13 +5928,13 @@ components:
example: true
type: boolean
horizontal_align:
- $ref: "#/components/schemas/WidgetHorizontalAlign"
+ $ref: '#/components/schemas/WidgetHorizontalAlign'
margin:
- $ref: "#/components/schemas/WidgetMargin"
+ $ref: '#/components/schemas/WidgetMargin'
sizing:
- $ref: "#/components/schemas/WidgetImageSizing"
+ $ref: '#/components/schemas/WidgetImageSizing'
type:
- $ref: "#/components/schemas/ImageWidgetDefinitionType"
+ $ref: '#/components/schemas/ImageWidgetDefinitionType'
url:
description: URL of the image.
example: "https://example.com/image.png"
@@ -5944,7 +5944,7 @@ components:
example: "https://example.com/image-dark-mode.png"
type: string
vertical_align:
- $ref: "#/components/schemas/WidgetVerticalAlign"
+ $ref: '#/components/schemas/WidgetVerticalAlign'
required:
- type
- url
@@ -5975,7 +5975,7 @@ components:
example: "content"
type: string
width:
- $ref: "#/components/schemas/ListStreamColumnWidth"
+ $ref: '#/components/schemas/ListStreamColumnWidth'
required:
- width
- field
@@ -6032,7 +6032,7 @@ components:
description: List of facets and aggregations which to compute.
properties:
aggregation:
- $ref: "#/components/schemas/ListStreamComputeAggregation"
+ $ref: '#/components/schemas/ListStreamComputeAggregation'
facet:
description: Facet name.
example: resource_name
@@ -6092,18 +6092,18 @@ components:
compute:
description: Compute configuration for the List Stream Widget. Compute can be used only with the logs_transaction_stream (from 1 to 5 items) list stream source.
items:
- $ref: "#/components/schemas/ListStreamComputeItems"
+ $ref: '#/components/schemas/ListStreamComputeItems'
maxItems: 5
minItems: 1
type: array
data_source:
- $ref: "#/components/schemas/ListStreamSource"
+ $ref: '#/components/schemas/ListStreamSource'
event_size:
- $ref: "#/components/schemas/WidgetEventSize"
+ $ref: '#/components/schemas/WidgetEventSize'
group_by:
description: Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 4 items) or logs_transaction_stream (one group by item is required) list stream source.
items:
- $ref: "#/components/schemas/ListStreamGroupByItems"
+ $ref: '#/components/schemas/ListStreamGroupByItems'
maxItems: 4
type: array
indexes:
@@ -6113,17 +6113,17 @@ components:
type: string
type: array
persona:
- $ref: "#/components/schemas/ListStreamIssuePersona"
+ $ref: '#/components/schemas/ListStreamIssuePersona'
query_string:
description: Widget query.
example: "@service:app"
type: string
sort:
- $ref: "#/components/schemas/WidgetFieldSort"
+ $ref: '#/components/schemas/WidgetFieldSort'
states:
description: Filter by issue states. Usable only with `issue_stream`.
items:
- $ref: "#/components/schemas/ListStreamIssueState"
+ $ref: '#/components/schemas/ListStreamIssueState'
type: array
storage:
description: Option for storage location. Feature in Private Beta.
@@ -6142,7 +6142,7 @@ components:
type: string
type: array
version:
- $ref: "#/components/schemas/ListStreamQueryVersion"
+ $ref: '#/components/schemas/ListStreamQueryVersion'
required:
- query_string
- data_source
@@ -6214,12 +6214,12 @@ components:
description: The description of the widget.
type: string
legend_size:
- $ref: "#/components/schemas/WidgetLegendSize"
+ $ref: '#/components/schemas/WidgetLegendSize'
requests:
description: Request payload used to query items.
example: [{"columns": [{"field": "timestamp", "width": "auto"}], "query": {"data_source": "apm_issue_stream", "query_string": "@data_source:APM"}, "response_format": "event_list"}]
items:
- $ref: "#/components/schemas/ListStreamWidgetRequest"
+ $ref: '#/components/schemas/ListStreamWidgetRequest'
maxItems: 1
minItems: 1
type: array
@@ -6227,17 +6227,17 @@ components:
description: Whether or not to display the legend on this widget.
type: boolean
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ListStreamWidgetDefinitionType"
+ $ref: '#/components/schemas/ListStreamWidgetDefinitionType'
required:
- type
- requests
@@ -6258,12 +6258,12 @@ components:
description: Widget columns.
example: [{"field": "timestamp", "width": "auto"}, {"field": "content", "width": "full"}]
items:
- $ref: "#/components/schemas/ListStreamColumn"
+ $ref: '#/components/schemas/ListStreamColumn'
type: array
query:
- $ref: "#/components/schemas/ListStreamQuery"
+ $ref: '#/components/schemas/ListStreamQuery'
response_format:
- $ref: "#/components/schemas/ListStreamResponseFormat"
+ $ref: '#/components/schemas/ListStreamResponseFormat'
required:
- columns
- query
@@ -6273,7 +6273,7 @@ components:
description: Object describing a log after being processed and stored by Datadog.
properties:
content:
- $ref: "#/components/schemas/LogContent"
+ $ref: '#/components/schemas/LogContent'
id:
description: ID of the Log.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
@@ -6323,11 +6323,11 @@ components:
description: The log query.
properties:
compute:
- $ref: "#/components/schemas/LogsQueryCompute"
+ $ref: '#/components/schemas/LogsQueryCompute'
group_by:
description: List of tag prefixes to group by in the case of a cluster check.
items:
- $ref: "#/components/schemas/LogQueryDefinitionGroupBy"
+ $ref: '#/components/schemas/LogQueryDefinitionGroupBy'
type: array
index:
description: A coma separated-list of index names. Use "*" query all indexes at once. [Multiple Indexes](https://docs.datadoghq.com/logs/indexes/#multiple-indexes)
@@ -6336,10 +6336,10 @@ components:
multi_compute:
description: This field is mutually exclusive with `compute`.
items:
- $ref: "#/components/schemas/LogsQueryCompute"
+ $ref: '#/components/schemas/LogsQueryCompute'
type: array
search:
- $ref: "#/components/schemas/LogQueryDefinitionSearch"
+ $ref: '#/components/schemas/LogQueryDefinitionSearch'
type: object
LogQueryDefinitionGroupBy:
description: Defined items in the group.
@@ -6354,7 +6354,7 @@ components:
format: int64
type: integer
sort:
- $ref: "#/components/schemas/LogQueryDefinitionGroupBySort"
+ $ref: '#/components/schemas/LogQueryDefinitionGroupBySort'
required:
- facet
type: object
@@ -6370,7 +6370,7 @@ components:
example: "@string_query.interval"
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
required:
- aggregation
- order
@@ -6409,7 +6409,7 @@ components:
description: ID of the log set to use.
type: string
message_display:
- $ref: "#/components/schemas/WidgetMessageDisplay"
+ $ref: '#/components/schemas/WidgetMessageDisplay'
query:
description: Query to filter the log stream with.
type: string
@@ -6420,19 +6420,19 @@ components:
description: Whether to show the message column or not
type: boolean
sort:
- $ref: "#/components/schemas/WidgetFieldSort"
+ $ref: '#/components/schemas/WidgetFieldSort'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/LogStreamWidgetDefinitionType"
+ $ref: '#/components/schemas/LogStreamWidgetDefinitionType'
required:
- type
type: object
@@ -6454,7 +6454,7 @@ components:
details:
description: Additional error details
items:
- $ref: "#/components/schemas/LogsAPIError"
+ $ref: '#/components/schemas/LogsAPIError'
type: array
message:
description: Error message
@@ -6464,13 +6464,13 @@ components:
description: Response returned by the Logs API when errors occur.
properties:
error:
- $ref: "#/components/schemas/LogsAPIError"
+ $ref: '#/components/schemas/LogsAPIError'
type: object
LogsAPILimitReachedResponse:
description: Response returned by the Logs API when the max limit has been reached.
properties:
error:
- $ref: "#/components/schemas/LogsAPIError"
+ $ref: '#/components/schemas/LogsAPIError'
type: object
LogsArithmeticProcessor:
description: |-
@@ -6518,7 +6518,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/LogsArithmeticProcessorType"
+ $ref: '#/components/schemas/LogsArithmeticProcessorType'
required:
- target
- expression
@@ -6554,7 +6554,7 @@ components:
example: $targetElem.doubled
type: string
type:
- $ref: "#/components/schemas/LogsArithmeticProcessorType"
+ $ref: '#/components/schemas/LogsArithmeticProcessorType'
required:
- expression
- target
@@ -6589,9 +6589,9 @@ components:
example: $targetElem.uid
type: string
target_format:
- $ref: "#/components/schemas/TargetFormatType"
+ $ref: '#/components/schemas/TargetFormatType'
type:
- $ref: "#/components/schemas/LogsAttributeRemapperType"
+ $ref: '#/components/schemas/LogsAttributeRemapperType'
required:
- sources
- target
@@ -6605,7 +6605,7 @@ components:
categories:
description: Array of filters to match against a log and the corresponding value to assign.
items:
- $ref: "#/components/schemas/LogsCategoryProcessorCategory"
+ $ref: '#/components/schemas/LogsCategoryProcessorCategory'
type: array
name:
description: Name of the sub-processor.
@@ -6615,7 +6615,7 @@ components:
example: $targetElem.level
type: string
type:
- $ref: "#/components/schemas/LogsCategoryProcessorType"
+ $ref: '#/components/schemas/LogsCategoryProcessorType'
required:
- categories
- target
@@ -6649,7 +6649,7 @@ components:
Sub-processors applied to each element. Allowed types: `attribute-remapper`,
`string-builder-processor`, `arithmetic-processor`, `category-processor`.
items:
- $ref: "#/components/schemas/LogsArrayMapSubProcessor"
+ $ref: '#/components/schemas/LogsArrayMapSubProcessor'
type: array
source:
description: |-
@@ -6664,7 +6664,7 @@ components:
example: ocsf.resources
type: string
type:
- $ref: "#/components/schemas/LogsArrayMapProcessorType"
+ $ref: '#/components/schemas/LogsArrayMapProcessorType'
required:
- source
- target
@@ -6701,7 +6701,7 @@ components:
example: item-%{$sourceElem.id}
type: string
type:
- $ref: "#/components/schemas/LogsStringBuilderProcessorType"
+ $ref: '#/components/schemas/LogsStringBuilderProcessorType'
required:
- template
- target
@@ -6713,10 +6713,10 @@ components:
Allowed types: `attribute-remapper`, `string-builder-processor`,
`arithmetic-processor`, `category-processor`.
oneOf:
- - $ref: "#/components/schemas/LogsArrayMapAttributeRemapper"
- - $ref: "#/components/schemas/LogsArrayMapArithmeticSubProcessor"
- - $ref: "#/components/schemas/LogsArrayMapStringBuilderSubProcessor"
- - $ref: "#/components/schemas/LogsArrayMapCategorySubProcessor"
+ - $ref: '#/components/schemas/LogsArrayMapAttributeRemapper'
+ - $ref: '#/components/schemas/LogsArrayMapArithmeticSubProcessor'
+ - $ref: '#/components/schemas/LogsArrayMapStringBuilderSubProcessor'
+ - $ref: '#/components/schemas/LogsArrayMapCategorySubProcessor'
LogsArrayProcessor:
description: |-
A processor for extracting, aggregating, or transforming values from JSON arrays within your logs.
@@ -6734,9 +6734,9 @@ components:
description: Name of the processor.
type: string
operation:
- $ref: "#/components/schemas/LogsArrayProcessorOperation"
+ $ref: '#/components/schemas/LogsArrayProcessorOperation'
type:
- $ref: "#/components/schemas/LogsArrayProcessorType"
+ $ref: '#/components/schemas/LogsArrayProcessorType'
required:
- operation
- type
@@ -6744,10 +6744,10 @@ components:
LogsArrayProcessorOperation:
description: Configuration of the array processor operation to perform.
oneOf:
- - $ref: "#/components/schemas/LogsArrayProcessorOperationAppend"
- - $ref: "#/components/schemas/LogsArrayProcessorOperationLength"
- - $ref: "#/components/schemas/LogsArrayProcessorOperationSelect"
- - $ref: "#/components/schemas/LogsArrayProcessorOperationExtractKeyValue"
+ - $ref: '#/components/schemas/LogsArrayProcessorOperationAppend'
+ - $ref: '#/components/schemas/LogsArrayProcessorOperationLength'
+ - $ref: '#/components/schemas/LogsArrayProcessorOperationSelect'
+ - $ref: '#/components/schemas/LogsArrayProcessorOperationExtractKeyValue'
LogsArrayProcessorOperationAppend:
description: Operation that appends a value to a target array attribute.
properties:
@@ -6764,7 +6764,7 @@ components:
example: sourceIps
type: string
type:
- $ref: "#/components/schemas/LogsArrayProcessorOperationAppendType"
+ $ref: '#/components/schemas/LogsArrayProcessorOperationAppendType'
required:
- type
- source
@@ -6797,7 +6797,7 @@ components:
example: extracted
type: string
type:
- $ref: "#/components/schemas/LogsArrayProcessorOperationExtractKeyValueType"
+ $ref: '#/components/schemas/LogsArrayProcessorOperationExtractKeyValueType'
value_to_extract:
description: Key of the attribute in each array element that holds the value to use for the extracted attribute.
example: value
@@ -6827,7 +6827,7 @@ components:
example: tagCount
type: string
type:
- $ref: "#/components/schemas/LogsArrayProcessorOperationLengthType"
+ $ref: '#/components/schemas/LogsArrayProcessorOperationLengthType'
required:
- type
- source
@@ -6856,7 +6856,7 @@ components:
example: referrer
type: string
type:
- $ref: "#/components/schemas/LogsArrayProcessorOperationSelectType"
+ $ref: '#/components/schemas/LogsArrayProcessorOperationSelectType'
value_to_extract:
description: Key of the value to extract from the matching element.
example: value
@@ -6921,13 +6921,13 @@ components:
example: operation_id
type: string
target_format:
- $ref: "#/components/schemas/TargetFormatType"
+ $ref: '#/components/schemas/TargetFormatType'
target_type:
default: attribute
description: Defines if the final attribute or tag name is from log `attribute` or `tag`.
type: string
type:
- $ref: "#/components/schemas/LogsAttributeRemapperType"
+ $ref: '#/components/schemas/LogsAttributeRemapperType'
required:
- sources
- target
@@ -6946,14 +6946,14 @@ components:
description: Object containing logs usage data broken down by retention period.
properties:
orgs:
- $ref: "#/components/schemas/LogsByRetentionOrgs"
+ $ref: '#/components/schemas/LogsByRetentionOrgs'
usage:
description: Aggregated index logs usage for each retention period with usage.
items:
- $ref: "#/components/schemas/LogsRetentionAggSumUsage"
+ $ref: '#/components/schemas/LogsRetentionAggSumUsage'
type: array
usage_by_month:
- $ref: "#/components/schemas/LogsByRetentionMonthlyUsage"
+ $ref: '#/components/schemas/LogsByRetentionMonthlyUsage'
type: object
LogsByRetentionMonthlyUsage:
description: Object containing a summary of indexed logs usage by retention period for a single month.
@@ -6965,7 +6965,7 @@ components:
usage:
description: Indexed logs usage for each active retention for the month.
items:
- $ref: "#/components/schemas/LogsRetentionSumUsage"
+ $ref: '#/components/schemas/LogsRetentionSumUsage'
type: array
type: object
LogsByRetentionOrgUsage:
@@ -6974,7 +6974,7 @@ components:
usage:
description: Indexed logs usage for each active retention for the organization.
items:
- $ref: "#/components/schemas/LogsRetentionSumUsage"
+ $ref: '#/components/schemas/LogsRetentionSumUsage'
type: array
type: object
LogsByRetentionOrgs:
@@ -6983,7 +6983,7 @@ components:
usage:
description: Indexed logs usage summary for each organization.
items:
- $ref: "#/components/schemas/LogsByRetentionOrgUsage"
+ $ref: '#/components/schemas/LogsByRetentionOrgUsage'
type: array
type: object
LogsCategoryProcessor:
@@ -7008,7 +7008,7 @@ components:
corresponding `name` to assign a custom value to the log.
example: []
items:
- $ref: "#/components/schemas/LogsCategoryProcessorCategory"
+ $ref: '#/components/schemas/LogsCategoryProcessorCategory'
type: array
is_enabled:
default: false
@@ -7022,7 +7022,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/LogsCategoryProcessorType"
+ $ref: '#/components/schemas/LogsCategoryProcessorType'
required:
- categories
- target
@@ -7032,7 +7032,7 @@ components:
description: Object describing the logs filter.
properties:
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
name:
description: Value to assign to the target attribute.
type: string
@@ -7095,7 +7095,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsDateRemapperType"
+ $ref: '#/components/schemas/LogsDateRemapperType'
required:
- sources
- type
@@ -7116,9 +7116,9 @@ components:
result in a target attribute.
properties:
binary_to_text_encoding:
- $ref: "#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding"
+ $ref: '#/components/schemas/LogsDecoderProcessorBinaryToTextEncoding'
input_representation:
- $ref: "#/components/schemas/LogsDecoderProcessorInputRepresentation"
+ $ref: '#/components/schemas/LogsDecoderProcessorInputRepresentation'
is_enabled:
default: false
description: Whether the processor is enabled.
@@ -7135,7 +7135,7 @@ components:
example: decoded.field
type: string
type:
- $ref: "#/components/schemas/LogsDecoderProcessorType"
+ $ref: '#/components/schemas/LogsDecoderProcessorType'
required:
- source
- target
@@ -7190,7 +7190,7 @@ components:
description: Name of the processor.
type: string
type:
- $ref: "#/components/schemas/LogsExcludeAttributeProcessorType"
+ $ref: '#/components/schemas/LogsExcludeAttributeProcessorType'
required:
- type
- attribute_to_exclude
@@ -7208,7 +7208,7 @@ components:
description: Represents the index exclusion filter object from configuration API.
properties:
filter:
- $ref: "#/components/schemas/LogsExclusionFilter"
+ $ref: '#/components/schemas/LogsExclusionFilter'
is_enabled:
description: Whether or not the exclusion filter is active.
type: boolean
@@ -7278,7 +7278,7 @@ components:
example: network.client.geoip
type: string
type:
- $ref: "#/components/schemas/LogsGeoIPParserType"
+ $ref: '#/components/schemas/LogsGeoIPParserType'
required:
- sources
- target
@@ -7299,7 +7299,7 @@ components:
For more information, see the [parsing section](https://docs.datadoghq.com/logs/log_configuration/parsing).
properties:
grok:
- $ref: "#/components/schemas/LogsGrokParserRules"
+ $ref: '#/components/schemas/LogsGrokParserRules'
is_enabled:
default: false
description: Whether or not the processor is enabled.
@@ -7321,7 +7321,7 @@ components:
example: message
type: string
type:
- $ref: "#/components/schemas/LogsGrokParserType"
+ $ref: '#/components/schemas/LogsGrokParserType'
required:
- source
- grok
@@ -7364,7 +7364,7 @@ components:
format: int64
type: integer
daily_limit_reset:
- $ref: "#/components/schemas/LogsDailyLimitReset"
+ $ref: '#/components/schemas/LogsDailyLimitReset'
daily_limit_warning_threshold_percentage:
description: A percentage threshold of the daily quota at which a Datadog warning event is generated.
example: 70
@@ -7378,10 +7378,10 @@ components:
following the order of the array. Only the first matching active exclusion matters,
others (if any) are ignored.
items:
- $ref: "#/components/schemas/LogsExclusion"
+ $ref: '#/components/schemas/LogsExclusion'
type: array
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
is_rate_limited:
description: |-
A boolean stating if the index is rate limited, meaning more logs than the daily limit have been sent.
@@ -7426,7 +7426,7 @@ components:
indexes:
description: Array of Log index configurations.
items:
- $ref: "#/components/schemas/LogsIndex"
+ $ref: '#/components/schemas/LogsIndex'
type: array
type: object
LogsIndexUpdateRequest:
@@ -7438,7 +7438,7 @@ components:
format: int64
type: integer
daily_limit_reset:
- $ref: "#/components/schemas/LogsDailyLimitReset"
+ $ref: '#/components/schemas/LogsDailyLimitReset'
daily_limit_warning_threshold_percentage:
description: A percentage threshold of the daily quota at which a Datadog warning event is generated.
example: 70
@@ -7459,10 +7459,10 @@ components:
following the order of the array. Only the first matching active exclusion matters,
others (if any) are ignored.
items:
- $ref: "#/components/schemas/LogsExclusion"
+ $ref: '#/components/schemas/LogsExclusion'
type: array
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
num_flex_logs_retention_days:
description: |-
The total number of days logs are stored in Standard and Flex Tier before being deleted from the index.
@@ -7528,7 +7528,7 @@ components:
example: "service:web* AND @http.status_code:[200 TO 299]"
type: string
sort:
- $ref: "#/components/schemas/LogsSort"
+ $ref: '#/components/schemas/LogsSort'
startAt:
description: |-
Hash identifier of the first log to return in the list, available in a log `id` attribute.
@@ -7538,7 +7538,7 @@ components:
is out of the scope of the specified time window.
type: string
time:
- $ref: "#/components/schemas/LogsListRequestTime"
+ $ref: '#/components/schemas/LogsListRequestTime'
required:
- time
type: object
@@ -7570,7 +7570,7 @@ components:
logs:
description: Array of logs matching the request and the `nextLogId` if sent.
items:
- $ref: "#/components/schemas/Log"
+ $ref: '#/components/schemas/Log'
type: array
nextLogId:
description: |-
@@ -7621,7 +7621,7 @@ components:
example: service
type: string
type:
- $ref: "#/components/schemas/LogsLookupProcessorType"
+ $ref: '#/components/schemas/LogsLookupProcessorType'
required:
- source
- target
@@ -7662,7 +7662,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsMessageRemapperType"
+ $ref: '#/components/schemas/LogsMessageRemapperType'
required:
- sources
- type
@@ -7688,7 +7688,7 @@ components:
description: A description of the pipeline.
type: string
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
id:
description: ID of the pipeline.
readOnly: true
@@ -7707,7 +7707,7 @@ components:
processors:
description: Ordered list of processors in this pipeline.
items:
- $ref: "#/components/schemas/LogsProcessor"
+ $ref: '#/components/schemas/LogsProcessor'
type: array
tags:
description: A list of tags associated with the pipeline.
@@ -7726,7 +7726,7 @@ components:
LogsPipelineList:
description: Array of all log pipeline objects configured for the organization.
items:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
type: array
LogsPipelineProcessor:
description: |-
@@ -7740,7 +7740,7 @@ components:
description: A description of the pipeline.
type: string
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
is_enabled:
default: false
description: Whether or not the processor is enabled.
@@ -7751,7 +7751,7 @@ components:
processors:
description: Ordered list of processors in this pipeline.
items:
- $ref: "#/components/schemas/LogsProcessor"
+ $ref: '#/components/schemas/LogsProcessor'
type: array
tags:
description: A list of tags associated with the pipeline.
@@ -7760,7 +7760,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsPipelineProcessorType"
+ $ref: '#/components/schemas/LogsPipelineProcessorType'
required:
- type
type: object
@@ -7791,28 +7791,28 @@ components:
LogsProcessor:
description: Definition of a logs processor.
oneOf:
- - $ref: "#/components/schemas/LogsGrokParser"
- - $ref: "#/components/schemas/LogsDateRemapper"
- - $ref: "#/components/schemas/LogsStatusRemapper"
- - $ref: "#/components/schemas/LogsServiceRemapper"
- - $ref: "#/components/schemas/LogsMessageRemapper"
- - $ref: "#/components/schemas/LogsAttributeRemapper"
- - $ref: "#/components/schemas/LogsURLParser"
- - $ref: "#/components/schemas/LogsUserAgentParser"
- - $ref: "#/components/schemas/LogsCategoryProcessor"
- - $ref: "#/components/schemas/LogsArithmeticProcessor"
- - $ref: "#/components/schemas/LogsStringBuilderProcessor"
- - $ref: "#/components/schemas/LogsPipelineProcessor"
- - $ref: "#/components/schemas/LogsGeoIPParser"
- - $ref: "#/components/schemas/LogsLookupProcessor"
- - $ref: "#/components/schemas/ReferenceTableLogsLookupProcessor"
- - $ref: "#/components/schemas/LogsTraceRemapper"
- - $ref: "#/components/schemas/LogsSpanRemapper"
- - $ref: "#/components/schemas/LogsArrayProcessor"
- - $ref: "#/components/schemas/LogsDecoderProcessor"
- - $ref: "#/components/schemas/LogsSchemaProcessor"
- - $ref: "#/components/schemas/LogsExcludeAttributeProcessor"
- - $ref: "#/components/schemas/LogsArrayMapProcessor"
+ - $ref: '#/components/schemas/LogsGrokParser'
+ - $ref: '#/components/schemas/LogsDateRemapper'
+ - $ref: '#/components/schemas/LogsStatusRemapper'
+ - $ref: '#/components/schemas/LogsServiceRemapper'
+ - $ref: '#/components/schemas/LogsMessageRemapper'
+ - $ref: '#/components/schemas/LogsAttributeRemapper'
+ - $ref: '#/components/schemas/LogsURLParser'
+ - $ref: '#/components/schemas/LogsUserAgentParser'
+ - $ref: '#/components/schemas/LogsCategoryProcessor'
+ - $ref: '#/components/schemas/LogsArithmeticProcessor'
+ - $ref: '#/components/schemas/LogsStringBuilderProcessor'
+ - $ref: '#/components/schemas/LogsPipelineProcessor'
+ - $ref: '#/components/schemas/LogsGeoIPParser'
+ - $ref: '#/components/schemas/LogsLookupProcessor'
+ - $ref: '#/components/schemas/ReferenceTableLogsLookupProcessor'
+ - $ref: '#/components/schemas/LogsTraceRemapper'
+ - $ref: '#/components/schemas/LogsSpanRemapper'
+ - $ref: '#/components/schemas/LogsArrayProcessor'
+ - $ref: '#/components/schemas/LogsDecoderProcessor'
+ - $ref: '#/components/schemas/LogsSchemaProcessor'
+ - $ref: '#/components/schemas/LogsExcludeAttributeProcessor'
+ - $ref: '#/components/schemas/LogsArrayMapProcessor'
LogsQueryCompute:
description: Define computation for a log query.
properties:
@@ -7900,18 +7900,18 @@ components:
id: 99
name: "Other"
items:
- $ref: "#/components/schemas/LogsSchemaCategoryMapperCategory"
+ $ref: '#/components/schemas/LogsSchemaCategoryMapperCategory'
type: array
fallback:
- $ref: "#/components/schemas/LogsSchemaCategoryMapperFallback"
+ $ref: '#/components/schemas/LogsSchemaCategoryMapperFallback'
name:
description: Name of the logs schema category mapper.
example: "activity_id and activity_name"
type: string
targets:
- $ref: "#/components/schemas/LogsSchemaCategoryMapperTargets"
+ $ref: '#/components/schemas/LogsSchemaCategoryMapperTargets'
type:
- $ref: "#/components/schemas/LogsSchemaCategoryMapperType"
+ $ref: '#/components/schemas/LogsSchemaCategoryMapperType'
required:
- categories
- targets
@@ -7922,7 +7922,7 @@ components:
description: Object describing the logs filter with corresponding category ID and name assignment.
properties:
filter:
- $ref: "#/components/schemas/LogsFilter"
+ $ref: '#/components/schemas/LogsFilter'
id:
description: ID to inject into the category.
example: 1
@@ -8012,8 +8012,8 @@ components:
LogsSchemaMapper:
description: Configuration of the schema processor mapper to use.
oneOf:
- - $ref: "#/components/schemas/LogsSchemaRemapper"
- - $ref: "#/components/schemas/LogsSchemaCategoryMapper"
+ - $ref: '#/components/schemas/LogsSchemaRemapper'
+ - $ref: '#/components/schemas/LogsSchemaCategoryMapper'
LogsSchemaProcessor:
description: |-
A processor that has additional validations and checks for a given schema. Currently supported schema types include OCSF.
@@ -8031,16 +8031,16 @@ components:
target: ocsf.user.uid
type: schema-remapper
items:
- $ref: "#/components/schemas/LogsSchemaMapper"
+ $ref: '#/components/schemas/LogsSchemaMapper'
type: array
name:
description: Name of the processor.
example: "Map additionalEventData.LoginTo to ocsf.dst_endpoint.svc_name"
type: string
schema:
- $ref: "#/components/schemas/LogsSchemaData"
+ $ref: '#/components/schemas/LogsSchemaData'
type:
- $ref: "#/components/schemas/LogsSchemaProcessorType"
+ $ref: '#/components/schemas/LogsSchemaProcessorType'
required:
- name
- mappers
@@ -8083,9 +8083,9 @@ components:
example: ocsf.user.uid
type: string
target_format:
- $ref: "#/components/schemas/TargetFormatType"
+ $ref: '#/components/schemas/TargetFormatType'
type:
- $ref: "#/components/schemas/LogsSchemaRemapperType"
+ $ref: '#/components/schemas/LogsSchemaRemapperType'
required:
- name
- sources
@@ -8122,7 +8122,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsServiceRemapperType"
+ $ref: '#/components/schemas/LogsServiceRemapperType'
required:
- sources
- type
@@ -8169,7 +8169,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsSpanRemapperType"
+ $ref: '#/components/schemas/LogsSpanRemapperType'
required:
- type
type: object
@@ -8218,7 +8218,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsStatusRemapperType"
+ $ref: '#/components/schemas/LogsStatusRemapperType'
required:
- sources
- type
@@ -8270,7 +8270,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/LogsStringBuilderProcessorType"
+ $ref: '#/components/schemas/LogsStringBuilderProcessorType'
required:
- target
- template
@@ -8309,7 +8309,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/LogsTraceRemapperType"
+ $ref: '#/components/schemas/LogsTraceRemapperType'
required:
- type
type: object
@@ -8351,7 +8351,7 @@ components:
example: "http.url_details"
type: string
type:
- $ref: "#/components/schemas/LogsURLParserType"
+ $ref: '#/components/schemas/LogsURLParserType'
required:
- sources
- target
@@ -8396,7 +8396,7 @@ components:
example: http.useragent_details
type: string
type:
- $ref: "#/components/schemas/LogsUserAgentParserType"
+ $ref: '#/components/schemas/LogsUserAgentParserType'
required:
- sources
- target
@@ -8489,7 +8489,7 @@ components:
description: Object containing the list of metrics matching the search query.
properties:
results:
- $ref: "#/components/schemas/MetricSearchResponseResults"
+ $ref: '#/components/schemas/MetricSearchResponseResults'
type: object
MetricSearchResponseResults:
description: Search result.
@@ -8530,7 +8530,7 @@ components:
points:
- [1475317847.0, 0.7]
items:
- $ref: "#/components/schemas/Series"
+ $ref: '#/components/schemas/Series'
type: array
required:
- series
@@ -8579,7 +8579,7 @@ components:
example:
- [1681683300000.0, 77.62145685254418]
items:
- $ref: "#/components/schemas/Point"
+ $ref: '#/components/schemas/Point'
readOnly: true
type: array
query_index:
@@ -8611,7 +8611,7 @@ components:
The second element describes the "per unit" (for example, `second` in `bytes per second`).
If the second element is not present, the API returns null.
items:
- $ref: "#/components/schemas/MetricsQueryUnit"
+ $ref: '#/components/schemas/MetricsQueryUnit'
maxItems: 2
minItems: 2
readOnly: true
@@ -8652,7 +8652,7 @@ components:
series:
description: List of timeseries queried.
items:
- $ref: "#/components/schemas/MetricsQueryMetadata"
+ $ref: '#/components/schemas/MetricsQueryMetadata'
readOnly: true
type: array
status:
@@ -8703,7 +8703,7 @@ components:
assets:
description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks).
items:
- $ref: "#/components/schemas/MonitorAsset"
+ $ref: '#/components/schemas/MonitorAsset'
type: array
created:
description: Timestamp of the monitor creation.
@@ -8711,7 +8711,7 @@ components:
readOnly: true
type: string
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
deleted:
description: Whether or not the monitor is deleted. (Always `null`)
format: date-time
@@ -8719,7 +8719,7 @@ components:
readOnly: true
type: string
draft_status:
- $ref: "#/components/schemas/MonitorDraftStatus"
+ $ref: '#/components/schemas/MonitorDraftStatus'
id:
description: ID of this monitor.
format: int64
@@ -8728,7 +8728,7 @@ components:
matching_downtimes:
description: A list of active v1 downtimes that match this monitor.
items:
- $ref: "#/components/schemas/MatchingDowntime"
+ $ref: '#/components/schemas/MatchingDowntime'
type: array
message:
description: A message to include with notifications for this monitor.
@@ -8747,9 +8747,9 @@ components:
example: "My monitor"
type: string
options:
- $ref: "#/components/schemas/MonitorOptions"
+ $ref: '#/components/schemas/MonitorOptions'
overall_state:
- $ref: "#/components/schemas/MonitorOverallStates"
+ $ref: '#/components/schemas/MonitorOverallStates'
priority:
description: Integer from 1 (high) to 5 (low) indicating alert severity.
format: int64
@@ -8767,7 +8767,7 @@ components:
nullable: true
type: array
state:
- $ref: "#/components/schemas/MonitorState"
+ $ref: '#/components/schemas/MonitorState'
tags:
description: Tags associated to your monitor.
items:
@@ -8775,7 +8775,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/MonitorType"
+ $ref: '#/components/schemas/MonitorType'
required:
- type
- query
@@ -8786,7 +8786,7 @@ components:
This feature is in Preview and only available to users with the feature enabled.
properties:
category:
- $ref: "#/components/schemas/MonitorAssetCategory"
+ $ref: '#/components/schemas/MonitorAssetCategory'
name:
description: Name for the monitor asset
example: "Monitor Runbook"
@@ -8796,7 +8796,7 @@ components:
example: "12345"
type: string
resource_type:
- $ref: "#/components/schemas/MonitorAssetResourceType"
+ $ref: '#/components/schemas/MonitorAssetResourceType'
url:
description: URL link for the asset. For links with an internal resource type set, this should be the relative path to where the Datadog domain is appended internally. For external links, this should be the full URL path.
example: "/notebooks/12345"
@@ -8863,8 +8863,8 @@ components:
MonitorFormulaAndFunctionAggregateAugmentQuery:
description: Augment query for aggregate augmented queries. Can be an events query or a reference table query.
oneOf:
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition"
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition'
MonitorFormulaAndFunctionAggregateAugmentedDataSource:
description: Data source for aggregate augmented queries.
enum:
@@ -8878,24 +8878,24 @@ components:
description: A formula and functions aggregate augmented query. Used to enrich base query results with data from a reference table.
properties:
augment_query:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentQuery"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentQuery'
base_query:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery'
compute:
description: Compute options for the query.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute'
minItems: 1
type: array
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedDataSource'
group_by:
description: Group by options for the query.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy'
type: array
join_condition:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinCondition"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinCondition'
name:
description: Name of the query for use in formulas.
example: "query1"
@@ -8911,13 +8911,13 @@ components:
MonitorFormulaAndFunctionAggregateBaseQuery:
description: Base query for aggregate queries. Can be an events query or a metrics query.
oneOf:
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsQueryDefinition"
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsQueryDefinition'
MonitorFormulaAndFunctionAggregateFilterQuery:
description: Filter query for aggregate filtered queries. Can be an events query or a reference table query.
oneOf:
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition"
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableQueryDefinition'
MonitorFormulaAndFunctionAggregateFilteredDataSource:
description: Data source for aggregate filtered queries.
enum:
@@ -8931,25 +8931,25 @@ components:
description: A formula and functions aggregate filtered query. Used to filter base query results using data from another source.
properties:
base_query:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateBaseQuery'
compute:
description: Compute options for the query.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute'
type: array
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredDataSource'
filter_query:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilterQuery"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilterQuery'
filters:
description: Filter conditions for the query.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryFilter"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryFilter'
type: array
group_by:
description: Group by options for the query.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy'
type: array
name:
description: Name of the query for use in formulas.
@@ -8994,7 +8994,7 @@ components:
example: "org_id"
type: string
join_type:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinType"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateQueryJoinType'
required:
- base_attribute
- augment_attribute
@@ -9050,9 +9050,9 @@ components:
description: A formula and functions cost query.
properties:
aggregator:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionCostAggregator"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionCostAggregator'
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionCostDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionCostDataSource'
name:
description: Name of the query for use in formulas.
example: "query1"
@@ -9200,7 +9200,7 @@ components:
example: true
type: boolean
function:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDiffFunction"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityDiffFunction'
min_lower_bound_size:
description: |-
Minimum distance between the predicted value and the lower bound. Widening the
@@ -9218,7 +9218,7 @@ components:
format: double
type: number
model_bounds_override:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityModelBoundsOverride"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityModelBoundsOverride'
type: object
MonitorFormulaAndFunctionDataQualityModelTypeOverride:
description: Override for the model type used in anomaly detection.
@@ -9254,9 +9254,9 @@ components:
type: string
type: array
model_configuration:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityModelConfiguration"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityModelConfiguration'
model_type_override:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityModelTypeOverride'
sensitivity:
description: |-
Sensitivity of the anomaly detection model, expressed as a multiplier on the width
@@ -9266,13 +9266,13 @@ components:
format: double
type: number
source_to_target_config:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualitySourceToTargetConfig"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualitySourceToTargetConfig'
type: object
MonitorFormulaAndFunctionDataQualityQueryDefinition:
description: A formula and functions data quality query.
properties:
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityDataSource'
filter:
description: |-
Filter expression used to match on data entities. Uses Aastra query syntax.
@@ -9286,9 +9286,9 @@ components:
type: string
type: array
measure:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMeasure'
monitor_options:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityMonitorOptions'
name:
description: Name of the query for use in formulas.
example: "query1"
@@ -9315,15 +9315,15 @@ components:
across two data entities and alerts on the difference between them.
properties:
diff_type:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityDiffType"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityDiffType'
entity_type:
description: Type of the data entities being compared.
example: "table"
type: string
source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityEntityMetricConfig"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityEntityMetricConfig'
target:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityEntityMetricConfig"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityEntityMetricConfig'
required:
- source
- target
@@ -9364,13 +9364,13 @@ components:
description: A formula and functions events query.
properties:
compute:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionCompute'
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventsDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventsDataSource'
group_by:
description: Group by options.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBy'
type: array
indexes:
description: An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.
@@ -9384,7 +9384,7 @@ components:
example: "query_errors"
type: string
search:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionSearch"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinitionSearch'
required:
- data_source
- compute
@@ -9394,7 +9394,7 @@ components:
description: Compute options.
properties:
aggregation:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventAggregation'
interval:
description: A time interval in milliseconds.
example: 60000
@@ -9438,7 +9438,7 @@ components:
format: int64
type: integer
sort:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBySort"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryGroupBySort'
source:
description: Source reference for composite query payloads.
example: "filter_query"
@@ -9450,12 +9450,12 @@ components:
description: Options for sorting group by results.
properties:
aggregation:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionEventAggregation'
metric:
description: Metric used for sorting group by results.
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
required:
- aggregation
type: object
@@ -9530,9 +9530,9 @@ components:
description: A formula and functions metrics query for use in aggregate queries.
properties:
aggregator:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsAggregator"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsAggregator'
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionMetricsDataSource'
name:
description: Name of the query for use in formulas.
example: "query1"
@@ -9548,12 +9548,12 @@ components:
MonitorFormulaAndFunctionQueryDefinition:
description: A formula and function query.
oneOf:
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionDataJobsQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition"
- - $ref: "#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition"
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionEventQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionCostQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataQualityQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionDataJobsQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateAugmentedQueryDefinition'
+ - $ref: '#/components/schemas/MonitorFormulaAndFunctionAggregateFilteredQueryDefinition'
MonitorFormulaAndFunctionReferenceTableColumn:
additionalProperties: false
description: A column definition for reference table queries.
@@ -9583,10 +9583,10 @@ components:
columns:
description: List of columns to retrieve from the reference table.
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableColumn"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableColumn'
type: array
data_source:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionReferenceTableDataSource"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionReferenceTableDataSource'
name:
description: Name of the query.
example: "filter_query"
@@ -9636,23 +9636,23 @@ components:
total_count: 2
properties:
counts:
- $ref: "#/components/schemas/MonitorGroupSearchResponseCounts"
+ $ref: '#/components/schemas/MonitorGroupSearchResponseCounts'
groups:
description: The list of found monitor groups.
items:
- $ref: "#/components/schemas/MonitorGroupSearchResult"
+ $ref: '#/components/schemas/MonitorGroupSearchResult'
readOnly: true
type: array
metadata:
- $ref: "#/components/schemas/MonitorSearchResponseMetadata"
+ $ref: '#/components/schemas/MonitorSearchResponseMetadata'
type: object
MonitorGroupSearchResponseCounts:
description: The counts of monitor groups per different criteria.
properties:
status:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
type:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
readOnly: true
type: object
MonitorGroupSearchResult:
@@ -9691,18 +9691,18 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/MonitorOverallStates"
+ $ref: '#/components/schemas/MonitorOverallStates'
type: object
MonitorOptions:
description: List of options associated with your monitor.
properties:
aggregation:
- $ref: "#/components/schemas/MonitorOptionsAggregation"
+ $ref: '#/components/schemas/MonitorOptionsAggregation'
device_ids:
deprecated: true
description: IDs of the device the Synthetics monitor is running on.
items:
- $ref: "#/components/schemas/MonitorDeviceID"
+ $ref: '#/components/schemas/MonitorDeviceID'
readOnly: true
type: array
enable_logs_sample:
@@ -9798,7 +9798,7 @@ components:
nullable: true
type: integer
notification_preset_name:
- $ref: "#/components/schemas/MonitorOptionsNotificationPresets"
+ $ref: '#/components/schemas/MonitorOptionsNotificationPresets'
notify_audit:
default: false
description: A Boolean indicating whether tagged users is notified on changes to this monitor.
@@ -9819,7 +9819,7 @@ components:
description: A Boolean indicating whether this monitor notifies when data stops reporting. Defaults to `false`.
type: boolean
on_missing_data:
- $ref: "#/components/schemas/OnMissingDataOption"
+ $ref: '#/components/schemas/OnMissingDataOption'
renotify_interval:
default:
description: |-
@@ -9840,7 +9840,7 @@ components:
Default: **null** if `renotify_interval` is **null**.
If `renotify_interval` is set, defaults to renotify on `Alert` and `No Data`.
items:
- $ref: "#/components/schemas/MonitorRenotifyStatusType"
+ $ref: '#/components/schemas/MonitorRenotifyStatusType'
nullable: true
type: array
require_full_window:
@@ -9851,7 +9851,7 @@ components:
metric monitors.
type: boolean
scheduling_options:
- $ref: "#/components/schemas/MonitorOptionsSchedulingOptions"
+ $ref: '#/components/schemas/MonitorOptionsSchedulingOptions'
silenced:
additionalProperties:
description: UTC epoch timestamp in seconds when the downtime for the group expires.
@@ -9867,9 +9867,9 @@ components:
nullable: true
type: string
threshold_windows:
- $ref: "#/components/schemas/MonitorThresholdWindowOptions"
+ $ref: '#/components/schemas/MonitorThresholdWindowOptions'
thresholds:
- $ref: "#/components/schemas/MonitorThresholds"
+ $ref: '#/components/schemas/MonitorThresholds'
timeout_h:
default:
description: The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
@@ -9879,7 +9879,7 @@ components:
variables:
description: List of requests that can be used in the monitor query. **This feature is currently in beta.**
items:
- $ref: "#/components/schemas/MonitorFormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/MonitorFormulaAndFunctionQueryDefinition'
type: array
type: object
MonitorOptionsAggregation:
@@ -9905,7 +9905,7 @@ components:
recurrences:
description: Array of custom schedule recurrences.
items:
- $ref: "#/components/schemas/MonitorOptionsCustomScheduleRecurrence"
+ $ref: '#/components/schemas/MonitorOptionsCustomScheduleRecurrence'
type: array
type: object
MonitorOptionsCustomScheduleRecurrence:
@@ -9948,9 +9948,9 @@ components:
description: Configuration options for scheduling.
properties:
custom_schedule:
- $ref: "#/components/schemas/MonitorOptionsCustomSchedule"
+ $ref: '#/components/schemas/MonitorOptionsCustomSchedule'
evaluation_window:
- $ref: "#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow"
+ $ref: '#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow'
type: object
MonitorOptionsSchedulingOptionsEvaluationWindow:
description: Configuration options for the evaluation window. If `hour_starts` is set, no other fields may be set. Otherwise, `day_starts` and `month_starts` must be set together.
@@ -10012,7 +10012,7 @@ components:
MonitorSearchCount:
description: Search facets.
items:
- $ref: "#/components/schemas/MonitorSearchCountItem"
+ $ref: '#/components/schemas/MonitorSearchCountItem'
type: array
MonitorSearchCountItem:
description: A facet item.
@@ -10077,13 +10077,13 @@ components:
type: query alert
properties:
counts:
- $ref: "#/components/schemas/MonitorSearchResponseCounts"
+ $ref: '#/components/schemas/MonitorSearchResponseCounts'
metadata:
- $ref: "#/components/schemas/MonitorSearchResponseMetadata"
+ $ref: '#/components/schemas/MonitorSearchResponseMetadata'
monitors:
description: The list of found monitors.
items:
- $ref: "#/components/schemas/MonitorSearchResult"
+ $ref: '#/components/schemas/MonitorSearchResult'
readOnly: true
type: array
type: object
@@ -10091,13 +10091,13 @@ components:
description: The counts of monitors per different criteria.
properties:
muted:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
status:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
tag:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
type:
- $ref: "#/components/schemas/MonitorSearchCount"
+ $ref: '#/components/schemas/MonitorSearchCount'
readOnly: true
type: object
MonitorSearchResponseMetadata:
@@ -10132,7 +10132,7 @@ components:
readOnly: true
type: string
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
id:
description: ID of the monitor.
format: int64
@@ -10159,7 +10159,7 @@ components:
notifications:
description: The notification triggered by the monitor.
items:
- $ref: "#/components/schemas/MonitorSearchResultNotification"
+ $ref: '#/components/schemas/MonitorSearchResultNotification'
readOnly: true
type: array
org_id:
@@ -10192,7 +10192,7 @@ components:
type: string
type: array
status:
- $ref: "#/components/schemas/MonitorOverallStates"
+ $ref: '#/components/schemas/MonitorOverallStates'
tags:
description: Tags associated with the monitor.
items:
@@ -10202,7 +10202,7 @@ components:
readOnly: true
type: array
type:
- $ref: "#/components/schemas/MonitorType"
+ $ref: '#/components/schemas/MonitorType'
type: object
MonitorSearchResultNotification:
description: A notification triggered by the monitor.
@@ -10222,7 +10222,7 @@ components:
properties:
groups:
additionalProperties:
- $ref: "#/components/schemas/MonitorStateGroup"
+ $ref: '#/components/schemas/MonitorStateGroup'
description: |-
Dictionary where the keys are groups (comma separated lists of tags) and the values are
the list of groups your monitor is broken down on.
@@ -10252,13 +10252,13 @@ components:
description: The name of the monitor.
type: string
status:
- $ref: "#/components/schemas/MonitorOverallStates"
+ $ref: '#/components/schemas/MonitorOverallStates'
type: object
MonitorSummaryWidgetDefinition:
description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
properties:
color_preference:
- $ref: "#/components/schemas/WidgetColorPreference"
+ $ref: '#/components/schemas/WidgetColorPreference'
count:
deprecated: true
description: The number of monitors to display.
@@ -10268,7 +10268,7 @@ components:
description: The description of the widget.
type: string
display_format:
- $ref: "#/components/schemas/WidgetMonitorSummaryDisplayFormat"
+ $ref: '#/components/schemas/WidgetMonitorSummaryDisplayFormat'
hide_zero_counts:
description: Whether to show counts of 0 or not.
type: boolean
@@ -10284,24 +10284,24 @@ components:
description: Whether to show the priorities column.
type: boolean
sort:
- $ref: "#/components/schemas/WidgetMonitorSummarySort"
+ $ref: '#/components/schemas/WidgetMonitorSummarySort'
start:
deprecated: true
description: The start of the list. Typically 0.
format: int64
type: integer
summary_type:
- $ref: "#/components/schemas/WidgetSummaryType"
+ $ref: '#/components/schemas/WidgetSummaryType'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/MonitorSummaryWidgetDefinitionType"
+ $ref: '#/components/schemas/MonitorSummaryWidgetDefinitionType'
required:
- type
- query
@@ -10426,7 +10426,7 @@ components:
assets:
description: The list of monitor assets tied to a monitor, which represents key links for users to take action on monitor alerts (for example, runbooks).
items:
- $ref: "#/components/schemas/MonitorAsset"
+ $ref: '#/components/schemas/MonitorAsset'
nullable: true
type: array
created:
@@ -10435,7 +10435,7 @@ components:
readOnly: true
type: string
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
deleted:
description: Whether or not the monitor is deleted. (Always `null`)
format: date-time
@@ -10443,7 +10443,7 @@ components:
readOnly: true
type: string
draft_status:
- $ref: "#/components/schemas/MonitorDraftStatus"
+ $ref: '#/components/schemas/MonitorDraftStatus'
id:
description: ID of this monitor.
format: int64
@@ -10465,9 +10465,9 @@ components:
description: The monitor name.
type: string
options:
- $ref: "#/components/schemas/MonitorOptions"
+ $ref: '#/components/schemas/MonitorOptions'
overall_state:
- $ref: "#/components/schemas/MonitorOverallStates"
+ $ref: '#/components/schemas/MonitorOverallStates'
priority:
description: Integer from 1 (high) to 5 (low) indicating alert severity.
format: int64
@@ -10484,7 +10484,7 @@ components:
nullable: true
type: array
state:
- $ref: "#/components/schemas/MonitorState"
+ $ref: '#/components/schemas/MonitorState'
tags:
description: Tags associated to your monitor.
items:
@@ -10492,7 +10492,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/MonitorType"
+ $ref: '#/components/schemas/MonitorType'
type: object
MonthlyUsageAttributionBody:
description: Usage Summary by tag for a given organization.
@@ -10514,21 +10514,21 @@ components:
description: The source of the usage attribution tag configuration and the selected tags in the format `::://////`.
type: string
tags:
- $ref: "#/components/schemas/UsageAttributionTagNames"
+ $ref: '#/components/schemas/UsageAttributionTagNames'
updated_at:
description: Datetime of the most recent update to the usage values.
format: date-time
type: string
values:
- $ref: "#/components/schemas/MonthlyUsageAttributionValues"
+ $ref: '#/components/schemas/MonthlyUsageAttributionValues'
type: object
MonthlyUsageAttributionMetadata:
description: The object containing document metadata.
properties:
aggregates:
- $ref: "#/components/schemas/UsageAttributionAggregates"
+ $ref: '#/components/schemas/UsageAttributionAggregates'
pagination:
- $ref: "#/components/schemas/MonthlyUsageAttributionPagination"
+ $ref: '#/components/schemas/MonthlyUsageAttributionPagination'
type: object
MonthlyUsageAttributionPagination:
description: The metadata for the current pagination.
@@ -10542,11 +10542,11 @@ components:
description: Response containing the monthly Usage Summary by tag(s).
properties:
metadata:
- $ref: "#/components/schemas/MonthlyUsageAttributionMetadata"
+ $ref: '#/components/schemas/MonthlyUsageAttributionMetadata'
usage:
description: Get usage summary by tag(s).
items:
- $ref: "#/components/schemas/MonthlyUsageAttributionBody"
+ $ref: '#/components/schemas/MonthlyUsageAttributionBody'
type: array
type: object
MonthlyUsageAttributionSupportedMetrics:
@@ -11604,16 +11604,16 @@ components:
description: Whether to show a tick or not.
type: boolean
text_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
tick_edge:
- $ref: "#/components/schemas/WidgetTickEdge"
+ $ref: '#/components/schemas/WidgetTickEdge'
tick_pos:
description: Where to position the tick on an edge.
type: string
type:
- $ref: "#/components/schemas/NoteWidgetDefinitionType"
+ $ref: '#/components/schemas/NoteWidgetDefinitionType'
vertical_align:
- $ref: "#/components/schemas/WidgetVerticalAlign"
+ $ref: '#/components/schemas/WidgetVerticalAlign'
required:
- type
- content
@@ -11689,9 +11689,9 @@ components:
description: The description of a notebook cell create request.
properties:
attributes:
- $ref: "#/components/schemas/NotebookCellCreateRequestAttributes"
+ $ref: '#/components/schemas/NotebookCellCreateRequestAttributes'
type:
- $ref: "#/components/schemas/NotebookCellResourceType"
+ $ref: '#/components/schemas/NotebookCellResourceType'
required:
- attributes
- type
@@ -11702,12 +11702,12 @@ components:
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)
example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}
oneOf:
- - $ref: "#/components/schemas/NotebookMarkdownCellAttributes"
- - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes"
- - $ref: "#/components/schemas/NotebookToplistCellAttributes"
- - $ref: "#/components/schemas/NotebookHeatMapCellAttributes"
- - $ref: "#/components/schemas/NotebookDistributionCellAttributes"
- - $ref: "#/components/schemas/NotebookLogStreamCellAttributes"
+ - $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
+ - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
+ - $ref: '#/components/schemas/NotebookToplistCellAttributes'
+ - $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
+ - $ref: '#/components/schemas/NotebookDistributionCellAttributes'
+ - $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
NotebookCellResourceType:
default: notebook_cells
description: Type of the Notebook Cell resource.
@@ -11721,13 +11721,13 @@ components:
description: The description of a notebook cell response.
properties:
attributes:
- $ref: "#/components/schemas/NotebookCellResponseAttributes"
+ $ref: '#/components/schemas/NotebookCellResponseAttributes'
id:
description: Notebook cell ID.
example: "abcd1234"
type: string
type:
- $ref: "#/components/schemas/NotebookCellResourceType"
+ $ref: '#/components/schemas/NotebookCellResourceType'
required:
- id
- type
@@ -11739,30 +11739,30 @@ components:
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)
example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}
oneOf:
- - $ref: "#/components/schemas/NotebookMarkdownCellAttributes"
- - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes"
- - $ref: "#/components/schemas/NotebookToplistCellAttributes"
- - $ref: "#/components/schemas/NotebookHeatMapCellAttributes"
- - $ref: "#/components/schemas/NotebookDistributionCellAttributes"
- - $ref: "#/components/schemas/NotebookLogStreamCellAttributes"
+ - $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
+ - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
+ - $ref: '#/components/schemas/NotebookToplistCellAttributes'
+ - $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
+ - $ref: '#/components/schemas/NotebookDistributionCellAttributes'
+ - $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
NotebookCellTime:
description: Timeframe for the notebook cell. When 'null', the notebook global time is used.
nullable: true
oneOf:
- - $ref: "#/components/schemas/NotebookRelativeTime"
- - $ref: "#/components/schemas/NotebookAbsoluteTime"
+ - $ref: '#/components/schemas/NotebookRelativeTime'
+ - $ref: '#/components/schemas/NotebookAbsoluteTime'
type: object
NotebookCellUpdateRequest:
description: The description of a notebook cell update request.
properties:
attributes:
- $ref: "#/components/schemas/NotebookCellUpdateRequestAttributes"
+ $ref: '#/components/schemas/NotebookCellUpdateRequestAttributes'
id:
description: Notebook cell ID.
example: "abcd1234"
type: string
type:
- $ref: "#/components/schemas/NotebookCellResourceType"
+ $ref: '#/components/schemas/NotebookCellResourceType'
required:
- id
- type
@@ -11774,19 +11774,19 @@ components:
`log_stream`. [More information on each graph visualization type.](https://docs.datadoghq.com/dashboards/widgets/)
example: {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}
oneOf:
- - $ref: "#/components/schemas/NotebookMarkdownCellAttributes"
- - $ref: "#/components/schemas/NotebookTimeseriesCellAttributes"
- - $ref: "#/components/schemas/NotebookToplistCellAttributes"
- - $ref: "#/components/schemas/NotebookHeatMapCellAttributes"
- - $ref: "#/components/schemas/NotebookDistributionCellAttributes"
- - $ref: "#/components/schemas/NotebookLogStreamCellAttributes"
+ - $ref: '#/components/schemas/NotebookMarkdownCellAttributes'
+ - $ref: '#/components/schemas/NotebookTimeseriesCellAttributes'
+ - $ref: '#/components/schemas/NotebookToplistCellAttributes'
+ - $ref: '#/components/schemas/NotebookHeatMapCellAttributes'
+ - $ref: '#/components/schemas/NotebookDistributionCellAttributes'
+ - $ref: '#/components/schemas/NotebookLogStreamCellAttributes'
NotebookCreateData:
description: The data for a notebook create request.
properties:
attributes:
- $ref: "#/components/schemas/NotebookCreateDataAttributes"
+ $ref: '#/components/schemas/NotebookCreateDataAttributes'
type:
- $ref: "#/components/schemas/NotebookResourceType"
+ $ref: '#/components/schemas/NotebookResourceType'
required:
- type
- attributes
@@ -11798,10 +11798,10 @@ components:
description: List of cells to display in the notebook.
example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}]
items:
- $ref: "#/components/schemas/NotebookCellCreateRequest"
+ $ref: '#/components/schemas/NotebookCellCreateRequest'
type: array
metadata:
- $ref: "#/components/schemas/NotebookMetadata"
+ $ref: '#/components/schemas/NotebookMetadata'
name:
description: The name of the notebook.
example: "Example Notebook"
@@ -11809,15 +11809,15 @@ components:
minLength: 0
type: string
status:
- $ref: "#/components/schemas/NotebookStatus"
+ $ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
items:
- $ref: "#/components/schemas/NotebookTemplateVariable"
+ $ref: '#/components/schemas/NotebookTemplateVariable'
nullable: true
type: array
time:
- $ref: "#/components/schemas/NotebookGlobalTime"
+ $ref: '#/components/schemas/NotebookGlobalTime'
required:
- name
- cells
@@ -11827,7 +11827,7 @@ components:
description: The description of a notebook create request.
properties:
data:
- $ref: "#/components/schemas/NotebookCreateData"
+ $ref: '#/components/schemas/NotebookCreateData'
required:
- data
type: object
@@ -11835,13 +11835,13 @@ components:
description: The attributes of a notebook `distribution` cell.
properties:
definition:
- $ref: "#/components/schemas/DistributionWidgetDefinition"
+ $ref: '#/components/schemas/DistributionWidgetDefinition'
graph_size:
- $ref: "#/components/schemas/NotebookGraphSize"
+ $ref: '#/components/schemas/NotebookGraphSize'
split_by:
- $ref: "#/components/schemas/NotebookSplitBy"
+ $ref: '#/components/schemas/NotebookSplitBy'
time:
- $ref: "#/components/schemas/NotebookCellTime"
+ $ref: '#/components/schemas/NotebookCellTime'
required:
- definition
type: object
@@ -11850,8 +11850,8 @@ components:
example:
live_span: 1h
oneOf:
- - $ref: "#/components/schemas/NotebookRelativeTime"
- - $ref: "#/components/schemas/NotebookAbsoluteTime"
+ - $ref: '#/components/schemas/NotebookRelativeTime'
+ - $ref: '#/components/schemas/NotebookAbsoluteTime'
NotebookGraphSize:
description: The size of the graph.
enum:
@@ -11872,13 +11872,13 @@ components:
description: The attributes of a notebook `heatmap` cell.
properties:
definition:
- $ref: "#/components/schemas/HeatMapWidgetDefinition"
+ $ref: '#/components/schemas/HeatMapWidgetDefinition'
graph_size:
- $ref: "#/components/schemas/NotebookGraphSize"
+ $ref: '#/components/schemas/NotebookGraphSize'
split_by:
- $ref: "#/components/schemas/NotebookSplitBy"
+ $ref: '#/components/schemas/NotebookSplitBy'
time:
- $ref: "#/components/schemas/NotebookCellTime"
+ $ref: '#/components/schemas/NotebookCellTime'
required:
- definition
type: object
@@ -11886,11 +11886,11 @@ components:
description: The attributes of a notebook `log_stream` cell.
properties:
definition:
- $ref: "#/components/schemas/LogStreamWidgetDefinition"
+ $ref: '#/components/schemas/LogStreamWidgetDefinition'
graph_size:
- $ref: "#/components/schemas/NotebookGraphSize"
+ $ref: '#/components/schemas/NotebookGraphSize'
time:
- $ref: "#/components/schemas/NotebookCellTime"
+ $ref: '#/components/schemas/NotebookCellTime'
required:
- definition
type: object
@@ -11898,7 +11898,7 @@ components:
description: The attributes of a notebook `markdown` cell.
properties:
definition:
- $ref: "#/components/schemas/NotebookMarkdownCellDefinition"
+ $ref: '#/components/schemas/NotebookMarkdownCellDefinition'
required:
- definition
type: object
@@ -11911,7 +11911,7 @@ components:
example: "# Example Header \nexample content"
type: string
type:
- $ref: "#/components/schemas/NotebookMarkdownCellDefinitionType"
+ $ref: '#/components/schemas/NotebookMarkdownCellDefinitionType'
required:
- type
- text
@@ -11939,7 +11939,7 @@ components:
example: false
type: boolean
type:
- $ref: "#/components/schemas/NotebookMetadataType"
+ $ref: '#/components/schemas/NotebookMetadataType'
type: object
NotebookMetadataType:
description: Metadata type of the notebook.
@@ -11965,7 +11965,7 @@ components:
nullable: true
properties:
live_span:
- $ref: "#/components/schemas/WidgetLiveSpan"
+ $ref: '#/components/schemas/WidgetLiveSpan'
required:
- live_span
type: object
@@ -11982,13 +11982,13 @@ components:
description: The description of a notebook response.
properties:
data:
- $ref: "#/components/schemas/NotebookResponseData"
+ $ref: '#/components/schemas/NotebookResponseData'
type: object
NotebookResponseData:
description: The data for a notebook.
properties:
attributes:
- $ref: "#/components/schemas/NotebookResponseDataAttributes"
+ $ref: '#/components/schemas/NotebookResponseDataAttributes'
id:
description: Unique notebook ID, assigned when you create the notebook.
example: 123456
@@ -11996,7 +11996,7 @@ components:
readOnly: true
type: integer
type:
- $ref: "#/components/schemas/NotebookResourceType"
+ $ref: '#/components/schemas/NotebookResourceType'
required:
- id
- type
@@ -12006,12 +12006,12 @@ components:
description: The attributes of a notebook.
properties:
author:
- $ref: "#/components/schemas/NotebookAuthor"
+ $ref: '#/components/schemas/NotebookAuthor'
cells:
description: List of cells to display in the notebook.
example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}]
items:
- $ref: "#/components/schemas/NotebookCellResponse"
+ $ref: '#/components/schemas/NotebookCellResponse'
type: array
created:
description: UTC time stamp for when the notebook was created.
@@ -12020,7 +12020,7 @@ components:
readOnly: true
type: string
metadata:
- $ref: "#/components/schemas/NotebookMetadata"
+ $ref: '#/components/schemas/NotebookMetadata'
modified:
description: UTC time stamp for when the notebook was last modified.
example: "2021-02-24T23:15:23.274966+00:00"
@@ -12034,15 +12034,15 @@ components:
minLength: 0
type: string
status:
- $ref: "#/components/schemas/NotebookStatus"
+ $ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
items:
- $ref: "#/components/schemas/NotebookTemplateVariable"
+ $ref: '#/components/schemas/NotebookTemplateVariable'
nullable: true
type: array
time:
- $ref: "#/components/schemas/NotebookGlobalTime"
+ $ref: '#/components/schemas/NotebookGlobalTime'
required:
- cells
- time
@@ -12098,7 +12098,7 @@ components:
type: array
uniqueItems: true
available_values_query:
- $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuery"
+ $ref: '#/components/schemas/NotebookTemplateVariableAvailableValuesQuery'
data_source_mappings:
additionalProperties:
description: The value for the given data source.
@@ -12145,8 +12145,8 @@ components:
NotebookTemplateVariableAvailableValuesQuery:
description: Query used to dynamically populate the list of available values for the template variable.
oneOf:
- - $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryLogRumSpans"
- - $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryMetrics"
+ - $ref: '#/components/schemas/NotebookTemplateVariableAvailableValuesQueryLogRumSpans'
+ - $ref: '#/components/schemas/NotebookTemplateVariableAvailableValuesQueryMetrics'
NotebookTemplateVariableAvailableValuesQueryGroupBy:
additionalProperties: false
description: A group-by facet for an available values query.
@@ -12169,10 +12169,10 @@ components:
group_by:
description: Group-by fields for the query.
items:
- $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQueryGroupBy"
+ $ref: '#/components/schemas/NotebookTemplateVariableAvailableValuesQueryGroupBy'
type: array
search:
- $ref: "#/components/schemas/NotebookTemplateVariableAvailableValuesQuerySearch"
+ $ref: '#/components/schemas/NotebookTemplateVariableAvailableValuesQuerySearch'
required:
- data_source
- search
@@ -12209,13 +12209,13 @@ components:
description: The attributes of a notebook `timeseries` cell.
properties:
definition:
- $ref: "#/components/schemas/TimeseriesWidgetDefinition"
+ $ref: '#/components/schemas/TimeseriesWidgetDefinition'
graph_size:
- $ref: "#/components/schemas/NotebookGraphSize"
+ $ref: '#/components/schemas/NotebookGraphSize'
split_by:
- $ref: "#/components/schemas/NotebookSplitBy"
+ $ref: '#/components/schemas/NotebookSplitBy'
time:
- $ref: "#/components/schemas/NotebookCellTime"
+ $ref: '#/components/schemas/NotebookCellTime'
required:
- definition
type: object
@@ -12223,13 +12223,13 @@ components:
description: The attributes of a notebook `toplist` cell.
properties:
definition:
- $ref: "#/components/schemas/ToplistWidgetDefinition"
+ $ref: '#/components/schemas/ToplistWidgetDefinition'
graph_size:
- $ref: "#/components/schemas/NotebookGraphSize"
+ $ref: '#/components/schemas/NotebookGraphSize'
split_by:
- $ref: "#/components/schemas/NotebookSplitBy"
+ $ref: '#/components/schemas/NotebookSplitBy'
time:
- $ref: "#/components/schemas/NotebookCellTime"
+ $ref: '#/components/schemas/NotebookCellTime'
required:
- definition
type: object
@@ -12238,15 +12238,15 @@ components:
Updating a notebook can either insert new cell(s) or update existing cell(s) by including the cell `id`.
To delete existing cell(s), simply omit it from the list of cells.
oneOf:
- - $ref: "#/components/schemas/NotebookCellCreateRequest"
- - $ref: "#/components/schemas/NotebookCellUpdateRequest"
+ - $ref: '#/components/schemas/NotebookCellCreateRequest'
+ - $ref: '#/components/schemas/NotebookCellUpdateRequest'
NotebookUpdateData:
description: The data for a notebook update request.
properties:
attributes:
- $ref: "#/components/schemas/NotebookUpdateDataAttributes"
+ $ref: '#/components/schemas/NotebookUpdateDataAttributes'
type:
- $ref: "#/components/schemas/NotebookResourceType"
+ $ref: '#/components/schemas/NotebookResourceType'
required:
- type
- attributes
@@ -12258,10 +12258,10 @@ components:
description: List of cells to display in the notebook.
example: [{"attributes": {"definition": {"text": "## Some test markdown\n\n```\nvar x, y;\nx = 5;\ny = 6;\n```", "type": "markdown"}}, "id": "bzbycoya", "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "9k6bc6xc", "type": "notebook_cells"}]
items:
- $ref: "#/components/schemas/NotebookUpdateCell"
+ $ref: '#/components/schemas/NotebookUpdateCell'
type: array
metadata:
- $ref: "#/components/schemas/NotebookMetadata"
+ $ref: '#/components/schemas/NotebookMetadata'
name:
description: The name of the notebook.
example: "Example Notebook"
@@ -12269,15 +12269,15 @@ components:
minLength: 0
type: string
status:
- $ref: "#/components/schemas/NotebookStatus"
+ $ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
items:
- $ref: "#/components/schemas/NotebookTemplateVariable"
+ $ref: '#/components/schemas/NotebookTemplateVariable'
nullable: true
type: array
time:
- $ref: "#/components/schemas/NotebookGlobalTime"
+ $ref: '#/components/schemas/NotebookGlobalTime'
required:
- name
- cells
@@ -12287,7 +12287,7 @@ components:
description: The description of a notebook update request.
properties:
data:
- $ref: "#/components/schemas/NotebookUpdateData"
+ $ref: '#/components/schemas/NotebookUpdateData'
required:
- data
type: object
@@ -12297,16 +12297,16 @@ components:
data:
description: List of notebook definitions.
items:
- $ref: "#/components/schemas/NotebooksResponseData"
+ $ref: '#/components/schemas/NotebooksResponseData'
type: array
meta:
- $ref: "#/components/schemas/NotebooksResponseMeta"
+ $ref: '#/components/schemas/NotebooksResponseMeta'
type: object
NotebooksResponseData:
description: The data for a notebook in get all response.
properties:
attributes:
- $ref: "#/components/schemas/NotebooksResponseDataAttributes"
+ $ref: '#/components/schemas/NotebooksResponseDataAttributes'
id:
description: Unique notebook ID, assigned when you create the notebook.
example: 123456
@@ -12314,7 +12314,7 @@ components:
readOnly: true
type: integer
type:
- $ref: "#/components/schemas/NotebookResourceType"
+ $ref: '#/components/schemas/NotebookResourceType'
required:
- id
- type
@@ -12324,11 +12324,11 @@ components:
description: The attributes of a notebook in get all response.
properties:
author:
- $ref: "#/components/schemas/NotebookAuthor"
+ $ref: '#/components/schemas/NotebookAuthor'
cells:
description: List of cells to display in the notebook.
items:
- $ref: "#/components/schemas/NotebookCellResponse"
+ $ref: '#/components/schemas/NotebookCellResponse'
type: array
created:
description: UTC time stamp for when the notebook was created.
@@ -12337,7 +12337,7 @@ components:
readOnly: true
type: string
metadata:
- $ref: "#/components/schemas/NotebookMetadata"
+ $ref: '#/components/schemas/NotebookMetadata'
modified:
description: UTC time stamp for when the notebook was last modified.
example: "2021-02-24T23:15:23.274966+00:00"
@@ -12351,15 +12351,15 @@ components:
minLength: 0
type: string
status:
- $ref: "#/components/schemas/NotebookStatus"
+ $ref: '#/components/schemas/NotebookStatus'
template_variables:
description: List of template variables for this notebook.
items:
- $ref: "#/components/schemas/NotebookTemplateVariable"
+ $ref: '#/components/schemas/NotebookTemplateVariable'
nullable: true
type: array
time:
- $ref: "#/components/schemas/NotebookGlobalTime"
+ $ref: '#/components/schemas/NotebookGlobalTime'
required:
- name
type: object
@@ -12367,7 +12367,7 @@ components:
description: Searches metadata returned by the API.
properties:
page:
- $ref: "#/components/schemas/NotebooksResponsePage"
+ $ref: '#/components/schemas/NotebooksResponsePage'
type: object
NotebooksResponsePage:
description: Pagination metadata returned by the API.
@@ -12399,7 +12399,7 @@ components:
description: States for which `notify_end_types` sends out notifications for.
example: ["alert", "no data", "warn"]
items:
- $ref: "#/components/schemas/NotifyEndState"
+ $ref: '#/components/schemas/NotifyEndState'
type: array
NotifyEndType:
description: A notification end type.
@@ -12420,13 +12420,13 @@ components:
already have an alert-worthy state when downtime begins.
example: ["canceled", "expired"]
items:
- $ref: "#/components/schemas/NotifyEndType"
+ $ref: '#/components/schemas/NotifyEndType'
type: array
NumberFormatUnit:
description: Number format unit.
oneOf:
- - $ref: "#/components/schemas/NumberFormatUnitCanonical"
- - $ref: "#/components/schemas/NumberFormatUnitCustom"
+ - $ref: '#/components/schemas/NumberFormatUnitCanonical'
+ - $ref: '#/components/schemas/NumberFormatUnitCustom'
NumberFormatUnitCanonical:
description: Canonical unit.
properties:
@@ -12435,7 +12435,7 @@ components:
example: "bytes"
type: string
type:
- $ref: "#/components/schemas/NumberFormatUnitScaleType"
+ $ref: '#/components/schemas/NumberFormatUnitScaleType'
unit_name:
description: The name of the unit.
example: "bytes"
@@ -12450,7 +12450,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/NumberFormatUnitCustomType"
+ $ref: '#/components/schemas/NumberFormatUnitCustomType'
type: object
NumberFormatUnitCustomType:
description: The type of custom unit.
@@ -12464,7 +12464,7 @@ components:
nullable: true
properties:
type:
- $ref: "#/components/schemas/NumberFormatUnitScaleType"
+ $ref: '#/components/schemas/NumberFormatUnitScaleType'
unit_name:
description: The name of the unit.
example: "bytes"
@@ -12508,7 +12508,7 @@ components:
description: Create, edit, and manage organizations.
properties:
billing:
- $ref: "#/components/schemas/OrganizationBilling"
+ $ref: '#/components/schemas/OrganizationBilling'
created:
description: Date of the organization creation.
example: "2019-09-26T17:28:28Z"
@@ -12528,9 +12528,9 @@ components:
example: "abcdef12345"
type: string
settings:
- $ref: "#/components/schemas/OrganizationSettings"
+ $ref: '#/components/schemas/OrganizationSettings'
subscription:
- $ref: "#/components/schemas/OrganizationSubscription"
+ $ref: '#/components/schemas/OrganizationSubscription'
trial:
description: Only available for MSP customers. Allows child organizations to be created on a trial plan.
example: false
@@ -12549,14 +12549,14 @@ components:
description: Object describing an organization to create.
properties:
billing:
- $ref: "#/components/schemas/OrganizationBilling"
+ $ref: '#/components/schemas/OrganizationBilling'
name:
description: The name of the new child-organization, limited to 32 characters.
example: "New child org"
maxLength: 32
type: string
subscription:
- $ref: "#/components/schemas/OrganizationSubscription"
+ $ref: '#/components/schemas/OrganizationSubscription'
required:
- name
type: object
@@ -12564,13 +12564,13 @@ components:
description: Response object for an organization creation.
properties:
api_key:
- $ref: "#/components/schemas/ApiKey"
+ $ref: '#/components/schemas/ApiKey'
application_key:
- $ref: "#/components/schemas/ApplicationKey"
+ $ref: '#/components/schemas/ApplicationKey'
org:
- $ref: "#/components/schemas/Organization"
+ $ref: '#/components/schemas/Organization'
user:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: object
OrganizationListResponse:
description: Response with the list of organizations.
@@ -12578,14 +12578,14 @@ components:
orgs:
description: Array of organization objects.
items:
- $ref: "#/components/schemas/Organization"
+ $ref: '#/components/schemas/Organization'
type: array
type: object
OrganizationResponse:
description: Response with an organization.
properties:
org:
- $ref: "#/components/schemas/Organization"
+ $ref: '#/components/schemas/Organization'
type: object
OrganizationSettings:
description: A JSON array of settings.
@@ -12595,11 +12595,11 @@ components:
example: false
type: boolean
saml:
- $ref: "#/components/schemas/OrganizationSettingsSaml"
+ $ref: '#/components/schemas/OrganizationSettingsSaml'
saml_autocreate_access_role:
- $ref: "#/components/schemas/AccessRole"
+ $ref: '#/components/schemas/AccessRole'
saml_autocreate_users_domains:
- $ref: "#/components/schemas/OrganizationSettingsSamlAutocreateUsersDomains"
+ $ref: '#/components/schemas/OrganizationSettingsSamlAutocreateUsersDomains'
saml_can_be_enabled:
description: Whether or not SAML can be enabled for this organization.
example: false
@@ -12609,7 +12609,7 @@ components:
example: "https://my.saml.endpoint"
type: string
saml_idp_initiated_login:
- $ref: "#/components/schemas/OrganizationSettingsSamlIdpInitiatedLogin"
+ $ref: '#/components/schemas/OrganizationSettingsSamlIdpInitiatedLogin'
saml_idp_metadata_uploaded:
description: Whether or not a SAML identity provider metadata file was provided to the Datadog organization.
example: false
@@ -12619,7 +12619,7 @@ components:
example: "https://my.saml.login.url"
type: string
saml_strict_mode:
- $ref: "#/components/schemas/OrganizationSettingsSamlStrictMode"
+ $ref: '#/components/schemas/OrganizationSettingsSamlStrictMode'
type: object
OrganizationSettingsSaml:
description: |-
@@ -12758,7 +12758,7 @@ components:
dimensions:
description: List of dimension mappings for the projection.
items:
- $ref: "#/components/schemas/PointPlotProjectionDimension"
+ $ref: '#/components/schemas/PointPlotProjectionDimension'
type: array
extra_columns:
description: Additional columns to include in the projection.
@@ -12767,7 +12767,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/PointPlotProjectionType"
+ $ref: '#/components/schemas/PointPlotProjectionType'
required:
- type
- dimensions
@@ -12783,7 +12783,7 @@ components:
example: duration
type: string
dimension:
- $ref: "#/components/schemas/PointPlotDimension"
+ $ref: '#/components/schemas/PointPlotDimension'
required:
- column
- dimension
@@ -12802,37 +12802,37 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
type: string
legend:
- $ref: "#/components/schemas/PointPlotWidgetLegend"
+ $ref: '#/components/schemas/PointPlotWidgetLegend'
markers:
description: List of markers for the widget.
items:
- $ref: "#/components/schemas/WidgetMarker"
+ $ref: '#/components/schemas/WidgetMarker'
type: array
requests:
description: List of request configurations for the widget.
items:
- $ref: "#/components/schemas/PointPlotWidgetRequest"
+ $ref: '#/components/schemas/PointPlotWidgetRequest'
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/PointPlotWidgetDefinitionType"
+ $ref: '#/components/schemas/PointPlotWidgetDefinitionType'
yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
required:
- type
- requests
@@ -12850,7 +12850,7 @@ components:
description: Legend configuration for the point plot widget.
properties:
type:
- $ref: "#/components/schemas/PointPlotWidgetLegendType"
+ $ref: '#/components/schemas/PointPlotWidgetLegendType'
required:
- type
type: object
@@ -12872,11 +12872,11 @@ components:
format: int64
type: integer
projection:
- $ref: "#/components/schemas/PointPlotProjection"
+ $ref: '#/components/schemas/PointPlotProjection'
query:
- $ref: "#/components/schemas/DataProjectionQuery"
+ $ref: '#/components/schemas/DataProjectionQuery'
request_type:
- $ref: "#/components/schemas/DataProjectionRequestType"
+ $ref: '#/components/schemas/DataProjectionRequestType'
required:
- request_type
- query
@@ -12913,12 +12913,12 @@ components:
controlled_by_powerpack:
description: Template variables controlled at the powerpack level.
items:
- $ref: "#/components/schemas/PowerpackTemplateVariableContents"
+ $ref: '#/components/schemas/PowerpackTemplateVariableContents'
type: array
controlled_externally:
description: "Template variables controlled by the external resource, such as the dashboard this powerpack is on."
items:
- $ref: "#/components/schemas/PowerpackTemplateVariableContents"
+ $ref: '#/components/schemas/PowerpackTemplateVariableContents'
type: array
type: object
PowerpackWidgetDefinition:
@@ -12939,12 +12939,12 @@ components:
description: Whether to show the title or not.
type: boolean
template_variables:
- $ref: "#/components/schemas/PowerpackTemplateVariables"
+ $ref: '#/components/schemas/PowerpackTemplateVariables'
title:
description: Title of the widget.
type: string
type:
- $ref: "#/components/schemas/PowerpackWidgetDefinitionType"
+ $ref: '#/components/schemas/PowerpackWidgetDefinitionType'
required:
- type
- powerpack_id
@@ -12997,18 +12997,18 @@ components:
properties:
accounts:
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceAccountSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceAccountSubquery'
type: array
filter_condition:
description: An optional filter condition applied to the audience subquery.
type: string
segments:
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceSegmentSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceSegmentSubquery'
type: array
users:
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceUserSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceUserSubquery'
type: array
type: object
ProductAnalyticsAudienceOccurrenceFilter:
@@ -13057,9 +13057,9 @@ components:
description: Product Analytics event query.
properties:
data_source:
- $ref: "#/components/schemas/ProductAnalyticsEventDataSource"
+ $ref: '#/components/schemas/ProductAnalyticsEventDataSource'
search:
- $ref: "#/components/schemas/ProductAnalyticsEventQuerySearch"
+ $ref: '#/components/schemas/ProductAnalyticsEventQuerySearch'
required:
- data_source
- search
@@ -13080,7 +13080,7 @@ components:
description: Compute configuration for Product Analytics Extended queries.
properties:
aggregation:
- $ref: "#/components/schemas/FormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
interval:
description: Fixed-width time bucket interval in milliseconds for time series queries. Mutually exclusive with `rollup`.
example: 60000
@@ -13117,7 +13117,7 @@ components:
description: Whether to exclude events missing the group-by facet.
type: boolean
sort:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
required:
- facet
type: object
@@ -13126,9 +13126,9 @@ components:
description: Compute configuration for user journey funnel.
properties:
aggregation:
- $ref: "#/components/schemas/ProductAnalyticsFunnelComputeAggregation"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelComputeAggregation'
metric:
- $ref: "#/components/schemas/ProductAnalyticsFunnelComputeMetric"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelComputeMetric'
required:
- aggregation
- metric
@@ -13176,9 +13176,9 @@ components:
description: Whether to exclude missing values.
type: boolean
sort:
- $ref: "#/components/schemas/ProductAnalyticsFunnelGroupBySort"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelGroupBySort'
target:
- $ref: "#/components/schemas/UserJourneySearchTarget"
+ $ref: '#/components/schemas/UserJourneySearchTarget'
required:
- facet
type: object
@@ -13195,7 +13195,7 @@ components:
example: "@session.id"
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
required:
- aggregation
type: object
@@ -13204,9 +13204,9 @@ components:
description: User journey funnel query definition.
properties:
compute:
- $ref: "#/components/schemas/ProductAnalyticsFunnelCompute"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelCompute'
data_source:
- $ref: "#/components/schemas/ProductAnalyticsFunnelDataSource"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelDataSource'
group_by:
description: Group by configuration.
items:
@@ -13214,7 +13214,7 @@ components:
description: A user journey funnel group by configuration.
type: array
search:
- $ref: "#/components/schemas/UserJourneySearch"
+ $ref: '#/components/schemas/UserJourneySearch'
subquery_id:
description: Subquery ID.
type: string
@@ -13235,11 +13235,11 @@ components:
minItems: 1
type: array
comparison_time:
- $ref: "#/components/schemas/FunnelComparisonDuration"
+ $ref: '#/components/schemas/FunnelComparisonDuration'
query:
- $ref: "#/components/schemas/ProductAnalyticsFunnelQuery"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelQuery'
request_type:
- $ref: "#/components/schemas/ProductAnalyticsFunnelRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsFunnelRequestType'
required:
- query
- request_type
@@ -13260,7 +13260,7 @@ components:
description: The description of the widget.
type: string
grouped_display:
- $ref: "#/components/schemas/FunnelGroupedDisplay"
+ $ref: '#/components/schemas/FunnelGroupedDisplay'
requests:
description: Request payload used to query items.
example:
@@ -13289,17 +13289,17 @@ components:
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: The title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: The size of the title.
type: string
type:
- $ref: "#/components/schemas/FunnelWidgetDefinitionType"
+ $ref: '#/components/schemas/FunnelWidgetDefinitionType'
required:
- type
- requests
@@ -13331,9 +13331,9 @@ components:
$ref: "#/components/schemas/QueryValueWidgetComparisonDirectionality"
description: Which direction of change is considered an improvement, determining the indicator color.
duration:
- $ref: "#/components/schemas/ComparisonDuration"
+ $ref: '#/components/schemas/ComparisonDuration'
type:
- $ref: "#/components/schemas/QueryValueWidgetComparisonType"
+ $ref: '#/components/schemas/QueryValueWidgetComparisonType'
required:
- duration
type: object
@@ -13370,7 +13370,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
custom_unit:
description: Display a unit of your choice on the widget.
@@ -13386,26 +13386,26 @@ components:
description: Widget definition.
example: ["q/apm_query/log_query": "{}"]
items:
- $ref: "#/components/schemas/QueryValueWidgetRequest"
+ $ref: '#/components/schemas/QueryValueWidgetRequest'
maxItems: 1
minItems: 1
type: array
text_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
timeseries_background:
- $ref: "#/components/schemas/TimeseriesBackground"
+ $ref: '#/components/schemas/TimeseriesBackground'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/QueryValueWidgetDefinitionType"
+ $ref: '#/components/schemas/QueryValueWidgetDefinitionType'
required:
- type
- requests
@@ -13423,7 +13423,7 @@ components:
description: Updated query value widget.
properties:
aggregator:
- $ref: "#/components/schemas/WidgetAggregator"
+ $ref: '#/components/schemas/WidgetAggregator'
apm_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -13438,7 +13438,7 @@ components:
conditional_formats:
description: List of conditional formats.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -13447,7 +13447,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -13472,10 +13472,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -13517,7 +13517,7 @@ components:
example: service
type: string
type:
- $ref: "#/components/schemas/LogsLookupProcessorType"
+ $ref: '#/components/schemas/LogsLookupProcessorType'
required:
- source
- target
@@ -13540,16 +13540,16 @@ components:
description: Object describing meta attributes of response.
properties:
page:
- $ref: "#/components/schemas/Pagination"
+ $ref: '#/components/schemas/Pagination'
type: object
RetentionCohortCriteria:
additionalProperties: false
description: Cohort criteria for retention queries.
properties:
base_query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
time_interval:
- $ref: "#/components/schemas/RetentionCohortCriteriaTimeInterval"
+ $ref: '#/components/schemas/RetentionCohortCriteriaTimeInterval'
required:
- base_query
- time_interval
@@ -13559,9 +13559,9 @@ components:
description: Time interval for cohort criteria.
properties:
type:
- $ref: "#/components/schemas/RetentionCohortCriteriaTimeIntervalType"
+ $ref: '#/components/schemas/RetentionCohortCriteriaTimeIntervalType'
value:
- $ref: "#/components/schemas/CalendarInterval"
+ $ref: '#/components/schemas/CalendarInterval'
required:
- type
- value
@@ -13579,9 +13579,9 @@ components:
description: Compute configuration for retention queries.
properties:
aggregation:
- $ref: "#/components/schemas/EventsAggregation"
+ $ref: '#/components/schemas/EventsAggregation'
metric:
- $ref: "#/components/schemas/RetentionComputeMetric"
+ $ref: '#/components/schemas/RetentionComputeMetric'
required:
- aggregation
- metric
@@ -13652,17 +13652,17 @@ components:
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/RetentionCurveWidgetDefinitionType"
+ $ref: '#/components/schemas/RetentionCurveWidgetDefinitionType'
required:
- type
- requests
@@ -13681,11 +13681,11 @@ components:
description: Retention curve widget request.
properties:
query:
- $ref: "#/components/schemas/RetentionQuery"
+ $ref: '#/components/schemas/RetentionQuery'
request_type:
- $ref: "#/components/schemas/RetentionCurveRequestType"
+ $ref: '#/components/schemas/RetentionCurveRequestType'
style:
- $ref: "#/components/schemas/RetentionCurveStyle"
+ $ref: '#/components/schemas/RetentionCurveStyle'
required:
- request_type
- query
@@ -13713,7 +13713,7 @@ components:
description: Filters for retention queries.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
string_filter:
description: String filter.
example: "@session.type:user"
@@ -13724,9 +13724,9 @@ components:
description: Retention grid widget request.
properties:
query:
- $ref: "#/components/schemas/RetentionQuery"
+ $ref: '#/components/schemas/RetentionQuery'
request_type:
- $ref: "#/components/schemas/RetentionGridRequestType"
+ $ref: '#/components/schemas/RetentionGridRequestType'
required:
- request_type
- query
@@ -13757,13 +13757,13 @@ components:
example: false
type: boolean
sort:
- $ref: "#/components/schemas/RetentionGroupBySort"
+ $ref: '#/components/schemas/RetentionGroupBySort'
source:
description: Source field.
example: "@geo.country"
type: string
target:
- $ref: "#/components/schemas/RetentionGroupByTarget"
+ $ref: '#/components/schemas/RetentionGroupByTarget'
required:
- target
- facet
@@ -13773,7 +13773,7 @@ components:
description: Sort configuration for retention group by.
properties:
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
type: object
RetentionGroupByTarget:
description: Target for retention group by.
@@ -13790,11 +13790,11 @@ components:
description: Retention query definition.
properties:
compute:
- $ref: "#/components/schemas/RetentionCompute"
+ $ref: '#/components/schemas/RetentionCompute'
data_source:
- $ref: "#/components/schemas/RetentionDataSource"
+ $ref: '#/components/schemas/RetentionDataSource'
filters:
- $ref: "#/components/schemas/RetentionFilters"
+ $ref: '#/components/schemas/RetentionFilters'
group_by:
description: Group by configuration.
items:
@@ -13806,7 +13806,7 @@ components:
example: "retention_query"
type: string
search:
- $ref: "#/components/schemas/RetentionSearch"
+ $ref: '#/components/schemas/RetentionSearch'
required:
- data_source
- search
@@ -13827,9 +13827,9 @@ components:
description: Return criteria for retention queries.
properties:
base_query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
time_interval:
- $ref: "#/components/schemas/RetentionReturnCriteriaTimeInterval"
+ $ref: '#/components/schemas/RetentionReturnCriteriaTimeInterval'
required:
- base_query
type: object
@@ -13838,9 +13838,9 @@ components:
description: Time interval for return criteria.
properties:
type:
- $ref: "#/components/schemas/RetentionReturnCriteriaTimeIntervalType"
+ $ref: '#/components/schemas/RetentionReturnCriteriaTimeIntervalType'
unit:
- $ref: "#/components/schemas/RetentionReturnCriteriaTimeIntervalUnit"
+ $ref: '#/components/schemas/RetentionReturnCriteriaTimeIntervalUnit'
value:
description: Value of the time interval.
example: 0.0
@@ -13876,15 +13876,15 @@ components:
description: Search configuration for retention queries.
properties:
cohort_criteria:
- $ref: "#/components/schemas/RetentionCohortCriteria"
+ $ref: '#/components/schemas/RetentionCohortCriteria'
filters:
- $ref: "#/components/schemas/RetentionFilters"
+ $ref: '#/components/schemas/RetentionFilters'
retention_entity:
- $ref: "#/components/schemas/RetentionEntity"
+ $ref: '#/components/schemas/RetentionEntity'
return_condition:
- $ref: "#/components/schemas/RetentionReturnCondition"
+ $ref: '#/components/schemas/RetentionReturnCondition'
return_criteria:
- $ref: "#/components/schemas/RetentionReturnCriteria"
+ $ref: '#/components/schemas/RetentionReturnCriteria'
required:
- cohort_criteria
- retention_entity
@@ -13896,7 +13896,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -13904,20 +13904,20 @@ components:
inputs:
description: Array of workflow inputs to map to dashboard template variables.
items:
- $ref: "#/components/schemas/RunWorkflowWidgetInput"
+ $ref: '#/components/schemas/RunWorkflowWidgetInput'
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/RunWorkflowWidgetDefinitionType"
+ $ref: '#/components/schemas/RunWorkflowWidgetDefinitionType'
workflow_id:
description: Workflow id.
example: ""
@@ -13954,7 +13954,7 @@ components:
additionalProperties:
description: An array of all SLO timeframes.
items:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
type: array
description: |-
A map of service level objective object IDs to arrays of timeframes,
@@ -13977,7 +13977,7 @@ components:
example: ""
type: string
timeframe:
- $ref: "#/components/schemas/SLOErrorTimeframe"
+ $ref: '#/components/schemas/SLOErrorTimeframe'
required:
- id
- timeframe
@@ -13993,11 +13993,11 @@ components:
fields in this response indicate which deletions succeeded and failed.
properties:
data:
- $ref: "#/components/schemas/SLOBulkDeleteResponseData"
+ $ref: '#/components/schemas/SLOBulkDeleteResponseData'
errors:
description: Array of errors object returned.
items:
- $ref: "#/components/schemas/SLOBulkDeleteError"
+ $ref: '#/components/schemas/SLOBulkDeleteError'
type: array
type: object
SLOBulkDeleteResponseData:
@@ -14026,12 +14026,12 @@ components:
The response object of a list of SLO corrections.
properties:
attributes:
- $ref: "#/components/schemas/SLOCorrectionResponseAttributes"
+ $ref: '#/components/schemas/SLOCorrectionResponseAttributes'
id:
description: The ID of the SLO correction.
type: string
type:
- $ref: "#/components/schemas/SLOCorrectionType"
+ $ref: '#/components/schemas/SLOCorrectionType'
type: object
SLOCorrectionCategory:
description: Category the SLO correction belongs to.
@@ -14051,9 +14051,9 @@ components:
description: The data object associated with the SLO correction to be created.
properties:
attributes:
- $ref: "#/components/schemas/SLOCorrectionCreateRequestAttributes"
+ $ref: '#/components/schemas/SLOCorrectionCreateRequestAttributes'
type:
- $ref: "#/components/schemas/SLOCorrectionType"
+ $ref: '#/components/schemas/SLOCorrectionType'
required:
- type
type: object
@@ -14062,7 +14062,7 @@ components:
An object that defines a correction to be applied to one or more SLOs.
properties:
data:
- $ref: "#/components/schemas/SLOCorrectionCreateData"
+ $ref: '#/components/schemas/SLOCorrectionCreateData'
type: object
SLOCorrectionCreateRequestAttributes:
description: |-
@@ -14071,7 +14071,7 @@ components:
Exactly one of `slo_id` or `slo_query` must be provided.
properties:
category:
- $ref: "#/components/schemas/SLOCorrectionCategory"
+ $ref: '#/components/schemas/SLOCorrectionCategory'
description:
description: Description of the correction being made.
type: string
@@ -14122,30 +14122,30 @@ components:
description: |-
The list of SLO corrections objects.
items:
- $ref: "#/components/schemas/SLOCorrection"
+ $ref: '#/components/schemas/SLOCorrection'
type: array
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
type: object
SLOCorrectionResponse:
description: |-
The response object of an SLO correction.
properties:
data:
- $ref: "#/components/schemas/SLOCorrection"
+ $ref: '#/components/schemas/SLOCorrection'
type: object
SLOCorrectionResponseAttributes:
description: The attribute object associated with the SLO correction.
properties:
category:
- $ref: "#/components/schemas/SLOCorrectionCategory"
+ $ref: '#/components/schemas/SLOCorrectionCategory'
created_at:
description: The epoch timestamp of when the correction was created at.
format: int64
nullable: true
type: integer
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
description:
description: Description of the correction being made.
type: string
@@ -14166,7 +14166,7 @@ components:
nullable: true
type: integer
modifier:
- $ref: "#/components/schemas/SLOCorrectionResponseAttributesModifier"
+ $ref: '#/components/schemas/SLOCorrectionResponseAttributesModifier'
rrule:
description: |-
The recurrence rules as defined in the iCalendar RFC 5545. The supported rules for SLO corrections
@@ -14217,22 +14217,22 @@ components:
description: The data object associated with the SLO correction to be updated.
properties:
attributes:
- $ref: "#/components/schemas/SLOCorrectionUpdateRequestAttributes"
+ $ref: '#/components/schemas/SLOCorrectionUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/SLOCorrectionType"
+ $ref: '#/components/schemas/SLOCorrectionType'
type: object
SLOCorrectionUpdateRequest:
description: |-
An object that defines a correction to be applied to an SLO.
properties:
data:
- $ref: "#/components/schemas/SLOCorrectionUpdateData"
+ $ref: '#/components/schemas/SLOCorrectionUpdateData'
type: object
SLOCorrectionUpdateRequestAttributes:
description: The attribute object associated with the SLO correction to be updated.
properties:
category:
- $ref: "#/components/schemas/SLOCorrectionCategory"
+ $ref: '#/components/schemas/SLOCorrectionCategory'
description:
description: Description of the correction being made.
type: string
@@ -14285,8 +14285,8 @@ components:
name: "query2"
query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()"
oneOf:
- - $ref: "#/components/schemas/SLOCountDefinitionWithTotalEventsFormula"
- - $ref: "#/components/schemas/SLOCountDefinitionWithBadEventsFormula"
+ - $ref: '#/components/schemas/SLOCountDefinitionWithTotalEventsFormula'
+ - $ref: '#/components/schemas/SLOCountDefinitionWithBadEventsFormula'
SLOCountDefinitionWithBadEventsFormula:
additionalProperties: false
description: SLO count definition using a bad events formula alongside a good events formula.
@@ -14296,7 +14296,7 @@ components:
description: |-
The bad events formula (recommended). Total events queries can be defined using the `total_events_formula` field as an alternative. Only one of `total_events_formula` or `bad_events_formula` must be provided.
good_events_formula:
- $ref: "#/components/schemas/SLOFormula"
+ $ref: '#/components/schemas/SLOFormula'
queries:
example:
- data_source: metrics
@@ -14306,7 +14306,7 @@ components:
name: "query2"
query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()"
items:
- $ref: "#/components/schemas/SLODataSourceQueryDefinition"
+ $ref: '#/components/schemas/SLODataSourceQueryDefinition'
minItems: 1
type: array
required:
@@ -14319,7 +14319,7 @@ components:
description: SLO count definition using a total events formula alongside a good events formula.
properties:
good_events_formula:
- $ref: "#/components/schemas/SLOFormula"
+ $ref: '#/components/schemas/SLOFormula'
queries:
example:
- data_source: metrics
@@ -14329,7 +14329,7 @@ components:
name: "query2"
query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()"
items:
- $ref: "#/components/schemas/SLODataSourceQueryDefinition"
+ $ref: '#/components/schemas/SLODataSourceQueryDefinition'
minItems: 1
type: array
total_events_formula:
@@ -14358,7 +14358,7 @@ components:
query: "sum:trace.servlet.request.hits{http.status_code:500} by {env}.as_count()"
properties:
count:
- $ref: "#/components/schemas/SLOCountDefinition"
+ $ref: '#/components/schemas/SLOCountDefinition'
required:
- count
type: object
@@ -14385,7 +14385,7 @@ components:
name: "query1"
query: "sum:trace.servlet.request.hits{*} by {env}.as_count()"
oneOf:
- - $ref: "#/components/schemas/FormulaAndFunctionMetricQueryDefinition"
+ - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition'
SLODeleteResponse:
description: A response list of all service level objective deleted.
properties:
@@ -14449,7 +14449,7 @@ components:
This is not included in responses for `monitor` based SLOs.
properties:
denominator:
- $ref: "#/components/schemas/SLOHistoryMetricsSeries"
+ $ref: '#/components/schemas/SLOHistoryMetricsSeries'
interval:
description: The aggregated query interval for the series data. It's implicit based on the query time window.
example: 0
@@ -14460,7 +14460,7 @@ components:
example: ""
type: string
numerator:
- $ref: "#/components/schemas/SLOHistoryMetricsSeries"
+ $ref: '#/components/schemas/SLOHistoryMetricsSeries'
query:
description: The combined numerator and denominator query CSV.
example: ""
@@ -14502,7 +14502,7 @@ components:
format: int64
type: integer
metadata:
- $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadata"
+ $ref: '#/components/schemas/SLOHistoryMetricsSeriesMetadata'
sum:
description: Total sum of the query.
example: 0.0
@@ -14553,7 +14553,7 @@ components:
If a metric query only has one unit object, the second array element is null.
example: [{"family": "bytes", "id": 2, "name": "byte", "plural": "bytes", "scale_factor": 1.0, "short_name": "B"}, null]
items:
- $ref: "#/components/schemas/SLOHistoryMetricsSeriesMetadataUnit"
+ $ref: '#/components/schemas/SLOHistoryMetricsSeriesMetadataUnit'
nullable: true
type: array
type: object
@@ -14591,11 +14591,11 @@ components:
This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.
properties:
error_budget_remaining:
- $ref: "#/components/schemas/SLOErrorBudgetRemainingData"
+ $ref: '#/components/schemas/SLOErrorBudgetRemainingData'
errors:
description: An array of error objects returned while querying the history data for the service level objective.
items:
- $ref: "#/components/schemas/SLOHistoryResponseErrorWithType"
+ $ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
type: array
group:
description: For groups in a grouped SLO, this is the group name.
@@ -14671,11 +14671,11 @@ components:
description: A service level objective history response.
properties:
data:
- $ref: "#/components/schemas/SLOHistoryResponseData"
+ $ref: '#/components/schemas/SLOHistoryResponseData'
errors:
description: A list of errors while querying the history data for the service level objective.
items:
- $ref: "#/components/schemas/SLOHistoryResponseError"
+ $ref: '#/components/schemas/SLOHistoryResponseError'
nullable: true
type: array
type: object
@@ -14702,7 +14702,7 @@ components:
This is not included in the responses for `metric` based SLOs.
items:
- $ref: "#/components/schemas/SLOHistoryMonitor"
+ $ref: '#/components/schemas/SLOHistoryMonitor'
type: array
monitors:
description: |-
@@ -14710,15 +14710,15 @@ components:
This is not included in the responses for `metric` based SLOs.
items:
- $ref: "#/components/schemas/SLOHistoryMonitor"
+ $ref: '#/components/schemas/SLOHistoryMonitor'
type: array
overall:
- $ref: "#/components/schemas/SLOHistorySLIData"
+ $ref: '#/components/schemas/SLOHistorySLIData'
series:
- $ref: "#/components/schemas/SLOHistoryMetrics"
+ $ref: '#/components/schemas/SLOHistoryMetrics'
thresholds:
additionalProperties:
- $ref: "#/components/schemas/SLOThreshold"
+ $ref: '#/components/schemas/SLOThreshold'
description: mapping of string timeframe to the SLO threshold.
example: {"my_service": {"target": 95, "timeframe": "7d"}}
type: object
@@ -14728,9 +14728,9 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/SLOType"
+ $ref: '#/components/schemas/SLOType'
type_id:
- $ref: "#/components/schemas/SLOTypeNumeric"
+ $ref: '#/components/schemas/SLOTypeNumeric'
type: object
SLOHistoryResponseError:
description: A list of errors while querying the history data for the service level objective.
@@ -14760,11 +14760,11 @@ components:
This can also represent the SLI value for a specific monitor in multi-monitor SLOs, or a group in grouped SLOs.
properties:
error_budget_remaining:
- $ref: "#/components/schemas/SLOErrorBudgetRemainingData"
+ $ref: '#/components/schemas/SLOErrorBudgetRemainingData'
errors:
description: An array of error objects returned while querying the history data for the service level objective.
items:
- $ref: "#/components/schemas/SLOHistoryResponseErrorWithType"
+ $ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
type: array
group:
description: For groups in a grouped SLO, this is the group name.
@@ -14849,7 +14849,7 @@ components:
data:
description: An array of service level objective objects.
items:
- $ref: "#/components/schemas/ServiceLevelObjective"
+ $ref: '#/components/schemas/ServiceLevelObjective'
type: array
errors:
description: |-
@@ -14860,14 +14860,14 @@ components:
type: string
type: array
metadata:
- $ref: "#/components/schemas/SLOListResponseMetadata"
+ $ref: '#/components/schemas/SLOListResponseMetadata'
type: object
SLOListResponseMetadata:
description: |-
The metadata object containing additional information about the list of SLOs.
properties:
page:
- $ref: "#/components/schemas/SLOListResponseMetadataPage"
+ $ref: '#/components/schemas/SLOListResponseMetadataPage'
type: object
SLOListResponseMetadataPage:
description: The object containing information about the pages of the list of SLOs.
@@ -14892,7 +14892,7 @@ components:
requests:
description: Array of one request object to display in the widget.
items:
- $ref: "#/components/schemas/SLOListWidgetRequest"
+ $ref: '#/components/schemas/SLOListWidgetRequest'
maxItems: 1
minItems: 1
type: array
@@ -14900,12 +14900,12 @@ components:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/SLOListWidgetDefinitionType"
+ $ref: '#/components/schemas/SLOListWidgetDefinitionType'
required:
- type
- requests
@@ -14936,7 +14936,7 @@ components:
sort:
description: Options for sorting results.
items:
- $ref: "#/components/schemas/WidgetFieldSort"
+ $ref: '#/components/schemas/WidgetFieldSort'
type: array
required:
- query_string
@@ -14945,9 +14945,9 @@ components:
description: Updated SLO List widget.
properties:
query:
- $ref: "#/components/schemas/SLOListWidgetQuery"
+ $ref: '#/components/schemas/SLOListWidgetQuery'
request_type:
- $ref: "#/components/schemas/SLOListWidgetRequestType"
+ $ref: '#/components/schemas/SLOListWidgetRequestType'
required:
- query
- request_type
@@ -14981,7 +14981,7 @@ components:
format: int64
type: integer
raw_error_budget_remaining:
- $ref: "#/components/schemas/SLORawErrorBudgetRemaining"
+ $ref: '#/components/schemas/SLORawErrorBudgetRemaining'
span_precision:
description: The amount of decimal places the SLI value is accurate to.
example: 2
@@ -14989,7 +14989,7 @@ components:
nullable: true
type: integer
state:
- $ref: "#/components/schemas/SLOState"
+ $ref: '#/components/schemas/SLOState'
status:
description: The status of the SLO.
example: 100
@@ -15002,7 +15002,7 @@ components:
format: double
type: number
timeframe:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
type: object
SLORawErrorBudgetRemaining:
description: Error budget remaining for an SLO.
@@ -15022,7 +15022,7 @@ components:
description: A service level objective response containing a single service level objective.
properties:
data:
- $ref: "#/components/schemas/SLOResponseData"
+ $ref: '#/components/schemas/SLOResponseData'
errors:
description: |-
An array of error messages. Each endpoint documents how/whether this field is
@@ -15054,7 +15054,7 @@ components:
readOnly: true
type: integer
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
description:
description: |-
A user-defined description of the service level objective.
@@ -15146,12 +15146,12 @@ components:
objective object.
example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}]
items:
- $ref: "#/components/schemas/SLOThreshold"
+ $ref: '#/components/schemas/SLOThreshold'
type: array
timeframe:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
type:
- $ref: "#/components/schemas/SLOType"
+ $ref: '#/components/schemas/SLOType'
warning_threshold:
description: |-
The optional warning threshold such that when the service level indicator is
@@ -15166,8 +15166,8 @@ components:
description: |-
A generic SLI specification. This is used for time-slice and count-based (metric) SLOs only.
oneOf:
- - $ref: "#/components/schemas/SLOTimeSliceSpec"
- - $ref: "#/components/schemas/SLOCountSpec"
+ - $ref: '#/components/schemas/SLOTimeSliceSpec'
+ - $ref: '#/components/schemas/SLOCountSpec'
SLOState:
description: State of the SLO.
enum:
@@ -15203,7 +15203,7 @@ components:
format: int64
type: integer
raw_error_budget_remaining:
- $ref: "#/components/schemas/SLORawErrorBudgetRemaining"
+ $ref: '#/components/schemas/SLORawErrorBudgetRemaining'
sli:
description: |-
The current service level indicator (SLI) of the SLO, also known as 'status'. This is a percentage value from 0-100 (inclusive).
@@ -15218,7 +15218,7 @@ components:
nullable: true
type: integer
state:
- $ref: "#/components/schemas/SLOState"
+ $ref: '#/components/schemas/SLOState'
type: object
SLOThreshold:
description: SLO thresholds (target and optionally warning) for a single time window.
@@ -15240,7 +15240,7 @@ components:
example: "99.9"
type: string
timeframe:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
warning:
description: |-
The warning value for the service level objective.
@@ -15294,11 +15294,11 @@ components:
threshold: 5
properties:
comparator:
- $ref: "#/components/schemas/SLOTimeSliceComparator"
+ $ref: '#/components/schemas/SLOTimeSliceComparator'
query:
- $ref: "#/components/schemas/SLOTimeSliceQuery"
+ $ref: '#/components/schemas/SLOTimeSliceQuery'
query_interval_seconds:
- $ref: "#/components/schemas/SLOTimeSliceInterval"
+ $ref: '#/components/schemas/SLOTimeSliceInterval'
threshold:
description: |-
The threshold value to which each SLI value will be compared.
@@ -15344,7 +15344,7 @@ components:
example:
- formula: "query1 - default_zero(query2)"
items:
- $ref: "#/components/schemas/SLOFormula"
+ $ref: '#/components/schemas/SLOFormula'
maxItems: 1
minItems: 1
type: array
@@ -15356,7 +15356,7 @@ components:
name: "query1"
query: "sum:trace.servlet.request.hits{*} by {env}.as_count()"
items:
- $ref: "#/components/schemas/SLODataSourceQueryDefinition"
+ $ref: '#/components/schemas/SLODataSourceQueryDefinition'
type: array
required:
- formulas
@@ -15382,7 +15382,7 @@ components:
threshold: 5
properties:
time_slice:
- $ref: "#/components/schemas/SLOTimeSliceCondition"
+ $ref: '#/components/schemas/SLOTimeSliceCondition'
required:
- time_slice
type: object
@@ -15451,20 +15451,20 @@ components:
time_windows:
description: Times being monitored.
items:
- $ref: "#/components/schemas/WidgetTimeWindows"
+ $ref: '#/components/schemas/WidgetTimeWindows'
type: array
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/SLOWidgetDefinitionType"
+ $ref: '#/components/schemas/SLOWidgetDefinitionType'
view_mode:
- $ref: "#/components/schemas/WidgetViewMode"
+ $ref: '#/components/schemas/WidgetViewMode'
view_type:
default: detail
description: Type of view displayed by the widget.
@@ -15516,9 +15516,9 @@ components:
description: Query configuration for Sankey network widget.
properties:
compute:
- $ref: "#/components/schemas/SankeyNetworkQueryCompute"
+ $ref: '#/components/schemas/SankeyNetworkQueryCompute'
data_source:
- $ref: "#/components/schemas/SankeyNetworkDataSource"
+ $ref: '#/components/schemas/SankeyNetworkDataSource'
group_by:
description: Fields to group by.
example: ["source", "destination"]
@@ -15532,7 +15532,7 @@ components:
format: int64
type: integer
mode:
- $ref: "#/components/schemas/SankeyNetworkQueryMode"
+ $ref: '#/components/schemas/SankeyNetworkQueryMode'
query_string:
description: Query string for filtering network data.
example: "*"
@@ -15541,7 +15541,7 @@ components:
description: Whether to exclude missing values.
type: boolean
sort:
- $ref: "#/components/schemas/SankeyNetworkQuerySort"
+ $ref: '#/components/schemas/SankeyNetworkQuerySort'
required:
- data_source
- query_string
@@ -15553,7 +15553,7 @@ components:
description: Compute aggregation for network queries.
properties:
aggregation:
- $ref: "#/components/schemas/EventsAggregation"
+ $ref: '#/components/schemas/EventsAggregation'
metric:
description: Metric to aggregate.
example: ""
@@ -15578,16 +15578,16 @@ components:
description: Field to sort by.
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
type: object
SankeyNetworkRequest:
additionalProperties: false
description: Sankey widget request for network data source.
properties:
query:
- $ref: "#/components/schemas/SankeyNetworkQuery"
+ $ref: '#/components/schemas/SankeyNetworkQuery'
request_type:
- $ref: "#/components/schemas/SankeyNetworkRequestType"
+ $ref: '#/components/schemas/SankeyNetworkRequestType'
required:
- query
- request_type
@@ -15617,23 +15617,23 @@ components:
description: Query configuration for Product Analytics or RUM Sankey widget.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
data_source:
- $ref: "#/components/schemas/SankeyRumDataSource"
+ $ref: '#/components/schemas/SankeyRumDataSource'
entries_per_step:
description: Entries per step.
format: int64
type: integer
join_keys:
- $ref: "#/components/schemas/SankeyJoinKeys"
+ $ref: '#/components/schemas/SankeyJoinKeys'
mode:
- $ref: "#/components/schemas/SankeyRumQueryMode"
+ $ref: '#/components/schemas/SankeyRumQueryMode'
number_of_steps:
description: Number of steps.
format: int64
type: integer
occurrences:
- $ref: "#/components/schemas/ProductAnalyticsAudienceOccurrenceFilter"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceOccurrenceFilter'
query_string:
description: RUM event search query used to filter views or actions.
example: "@type:view"
@@ -15668,9 +15668,9 @@ components:
description: Sankey widget request for Product Analytics or RUM data source.
properties:
query:
- $ref: "#/components/schemas/SankeyRumQuery"
+ $ref: '#/components/schemas/SankeyRumQuery'
request_type:
- $ref: "#/components/schemas/SankeyWidgetDefinitionType"
+ $ref: '#/components/schemas/SankeyWidgetDefinitionType'
required:
- query
- request_type
@@ -15688,7 +15688,7 @@ components:
query_string: "@type:view"
request_type: sankey
items:
- $ref: "#/components/schemas/SankeyWidgetRequest"
+ $ref: '#/components/schemas/SankeyWidgetRequest'
minItems: 1
type: array
show_other_links:
@@ -15698,17 +15698,17 @@ components:
description: Whether to sort nodes in the Sankey diagram.
type: boolean
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/SankeyWidgetDefinitionType"
+ $ref: '#/components/schemas/SankeyWidgetDefinitionType'
required:
- type
- requests
@@ -15725,13 +15725,13 @@ components:
SankeyWidgetRequest:
description: Request definition for Sankey widget.
oneOf:
- - $ref: "#/components/schemas/SankeyRumRequest"
- - $ref: "#/components/schemas/SankeyNetworkRequest"
+ - $ref: '#/components/schemas/SankeyRumRequest'
+ - $ref: '#/components/schemas/SankeyNetworkRequest'
ScatterPlotRequest:
description: Updated scatter plot.
properties:
aggregator:
- $ref: "#/components/schemas/ScatterplotWidgetAggregator"
+ $ref: '#/components/schemas/ScatterplotWidgetAggregator'
apm_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -15780,29 +15780,29 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
type: string
requests:
- $ref: "#/components/schemas/ScatterPlotWidgetDefinitionRequests"
+ $ref: '#/components/schemas/ScatterPlotWidgetDefinitionRequests'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ScatterPlotWidgetDefinitionType"
+ $ref: '#/components/schemas/ScatterPlotWidgetDefinitionType'
xaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
required:
- type
- requests
@@ -15812,11 +15812,11 @@ components:
example: {"x": {"q": "system.cpu.user"}, "y": {"q": "system.mem.used"}}
properties:
table:
- $ref: "#/components/schemas/ScatterplotTableRequest"
+ $ref: '#/components/schemas/ScatterplotTableRequest'
x:
- $ref: "#/components/schemas/ScatterPlotRequest"
+ $ref: '#/components/schemas/ScatterPlotRequest'
y:
- $ref: "#/components/schemas/ScatterPlotRequest"
+ $ref: '#/components/schemas/ScatterPlotRequest'
type: object
ScatterPlotWidgetDefinitionType:
default: scatterplot
@@ -15847,15 +15847,15 @@ components:
formulas:
description: List of Scatterplot formulas that operate on queries.
items:
- $ref: "#/components/schemas/ScatterplotWidgetFormula"
+ $ref: '#/components/schemas/ScatterplotWidgetFormula'
type: array
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
type: object
ScatterplotWidgetAggregator:
description: Aggregator used for the request.
@@ -15880,7 +15880,7 @@ components:
example: "my-query"
type: string
dimension:
- $ref: "#/components/schemas/ScatterplotDimension"
+ $ref: '#/components/schemas/ScatterplotDimension'
formula:
description: String expression built from queries, formulas, and functions.
example: "func(a) + b"
@@ -15919,17 +15919,17 @@ components:
description: A search SLO response containing results from the search query.
properties:
data:
- $ref: "#/components/schemas/SearchSLOResponseData"
+ $ref: '#/components/schemas/SearchSLOResponseData'
links:
- $ref: "#/components/schemas/SearchSLOResponseLinks"
+ $ref: '#/components/schemas/SearchSLOResponseLinks'
meta:
- $ref: "#/components/schemas/SearchSLOResponseMeta"
+ $ref: '#/components/schemas/SearchSLOResponseMeta'
type: object
SearchSLOResponseData:
description: Data from search SLO response.
properties:
attributes:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributes"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributes'
type:
description: Type of service level objective result.
example: ""
@@ -15939,11 +15939,11 @@ components:
description: Attributes
properties:
facets:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacets"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacets'
slos:
description: SLOs
items:
- $ref: "#/components/schemas/SearchServiceLevelObjective"
+ $ref: '#/components/schemas/SearchServiceLevelObjective'
type: array
type: object
SearchSLOResponseDataAttributesFacets:
@@ -15952,42 +15952,42 @@ components:
all_tags:
description: All tags associated with an SLO.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
creator_name:
description: Creator of an SLO.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
env_tags:
description: Tags with the `env` tag key.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
service_tags:
description: Tags with the `service` tag key.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
slo_type:
description: Type of SLO.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt'
type: array
target:
description: SLO Target
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectInt'
type: array
team_tags:
description: Tags with the `team` tag key.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
timeframe:
description: Timeframes of SLOs.
items:
- $ref: "#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString"
+ $ref: '#/components/schemas/SearchSLOResponseDataAttributesFacetsObjectString'
type: array
type: object
SearchSLOResponseDataAttributesFacetsObjectInt:
@@ -16038,7 +16038,7 @@ components:
description: Searches metadata returned by the API.
properties:
pagination:
- $ref: "#/components/schemas/SearchSLOResponseMetaPage"
+ $ref: '#/components/schemas/SearchSLOResponseMetaPage'
type: object
SearchSLOResponseMetaPage:
description: Pagination metadata returned by the API.
@@ -16095,7 +16095,7 @@ components:
example: "99.9"
type: string
timeframe:
- $ref: "#/components/schemas/SearchSLOTimeframe"
+ $ref: '#/components/schemas/SearchSLOTimeframe'
warning:
description: |-
The warning value for the service level objective.
@@ -16133,7 +16133,7 @@ components:
description: A service level objective data container.
properties:
data:
- $ref: "#/components/schemas/SearchServiceLevelObjectiveData"
+ $ref: '#/components/schemas/SearchServiceLevelObjectiveData'
type: object
SearchServiceLevelObjectiveAttributes:
description: |-
@@ -16158,7 +16158,7 @@ components:
readOnly: true
type: integer
creator:
- $ref: "#/components/schemas/SLOCreator"
+ $ref: '#/components/schemas/SLOCreator'
description:
description: |-
A user-defined description of the service level objective.
@@ -16208,10 +16208,10 @@ components:
overall_status:
description: calculated status and error budget remaining.
items:
- $ref: "#/components/schemas/SLOOverallStatuses"
+ $ref: '#/components/schemas/SLOOverallStatuses'
type: array
query:
- $ref: "#/components/schemas/SearchSLOQuery"
+ $ref: '#/components/schemas/SearchSLOQuery'
service_tags:
description: Tags with the `service` tag key.
items:
@@ -16219,9 +16219,9 @@ components:
type: string
type: array
slo_type:
- $ref: "#/components/schemas/SLOType"
+ $ref: '#/components/schemas/SLOType'
status:
- $ref: "#/components/schemas/SLOStatus"
+ $ref: '#/components/schemas/SLOStatus'
team_tags:
description: Tags with the `team` tag key.
items:
@@ -16234,14 +16234,14 @@ components:
objective object.
example: [{"target": 95, "target_display": "95", "timeframe": "7d"}, {"target": 95, "target_display": "95", "timeframe": "30d", "warning": 97, "warning_display": "97"}]
items:
- $ref: "#/components/schemas/SearchSLOThreshold"
+ $ref: '#/components/schemas/SearchSLOThreshold'
type: array
type: object
SearchServiceLevelObjectiveData:
description: A service level objective ID and attributes.
properties:
attributes:
- $ref: "#/components/schemas/SearchServiceLevelObjectiveAttributes"
+ $ref: '#/components/schemas/SearchServiceLevelObjectiveAttributes'
id:
description: |-
A unique identifier for the service level objective object.
@@ -16302,7 +16302,7 @@ components:
example:
- [1575317847.0, 0.5]
items:
- $ref: "#/components/schemas/Point"
+ $ref: '#/components/schemas/Point'
type: array
tags:
description: A list of tags associated with the metric.
@@ -16336,7 +16336,7 @@ components:
example: app is running
type: string
status:
- $ref: "#/components/schemas/ServiceCheckStatus"
+ $ref: '#/components/schemas/ServiceCheckStatus'
tags:
description: Tags related to a check.
example: ["environment:test"]
@@ -16372,11 +16372,11 @@ components:
ServiceChecks:
description: The service checks.
items:
- $ref: "#/components/schemas/ServiceCheck"
+ $ref: '#/components/schemas/ServiceCheck'
type: array
ServiceDependencies:
additionalProperties:
- $ref: "#/components/schemas/ServiceDependency"
+ $ref: '#/components/schemas/ServiceDependency'
description: An object containing a list of APM services and their dependencies.
example: {"servica_a": {"calls": ["service_b", "service_c"]}, "service_b": {"calls": ["service_o"]}, "service_c": {"calls": ["service_o"]}, "service_o": {"calls": []}}
type: object
@@ -16408,7 +16408,7 @@ components:
readOnly: true
type: integer
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
description:
description: |-
A user-defined description of the service level objective.
@@ -16470,9 +16470,9 @@ components:
example: "Custom Metric SLO"
type: string
query:
- $ref: "#/components/schemas/ServiceLevelObjectiveQuery"
+ $ref: '#/components/schemas/ServiceLevelObjectiveQuery'
sli_specification:
- $ref: "#/components/schemas/SLOSliSpec"
+ $ref: '#/components/schemas/SLOSliSpec'
tags:
description: |-
A list of tags associated with this service level objective.
@@ -16496,12 +16496,12 @@ components:
objective object.
example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}]
items:
- $ref: "#/components/schemas/SLOThreshold"
+ $ref: '#/components/schemas/SLOThreshold'
type: array
timeframe:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
type:
- $ref: "#/components/schemas/SLOType"
+ $ref: '#/components/schemas/SLOType'
warning_threshold:
description: |-
The optional warning threshold such that when the service level indicator is
@@ -16573,9 +16573,9 @@ components:
example: "Custom Metric SLO"
type: string
query:
- $ref: "#/components/schemas/ServiceLevelObjectiveQuery"
+ $ref: '#/components/schemas/ServiceLevelObjectiveQuery'
sli_specification:
- $ref: "#/components/schemas/SLOSliSpec"
+ $ref: '#/components/schemas/SLOSliSpec'
tags:
description: |-
A list of tags associated with this service level objective.
@@ -16599,12 +16599,12 @@ components:
objective object.
example: [{"target": 95, "timeframe": "7d"}, {"target": 95, "timeframe": "30d", "warning": 97}]
items:
- $ref: "#/components/schemas/SLOThreshold"
+ $ref: '#/components/schemas/SLOThreshold'
type: array
timeframe:
- $ref: "#/components/schemas/SLOTimeframe"
+ $ref: '#/components/schemas/SLOTimeframe'
type:
- $ref: "#/components/schemas/SLOType"
+ $ref: '#/components/schemas/SLOType'
warning_threshold:
description: |-
The optional warning threshold such that when the service level indicator is
@@ -16625,7 +16625,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -16646,12 +16646,12 @@ components:
description: The title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ServiceMapWidgetDefinitionType"
+ $ref: '#/components/schemas/ServiceMapWidgetDefinitionType'
required:
- type
- filters
@@ -16673,7 +16673,7 @@ components:
description: The description of the widget.
type: string
display_format:
- $ref: "#/components/schemas/WidgetServiceSummaryDisplayFormat"
+ $ref: '#/components/schemas/WidgetServiceSummaryDisplayFormat'
env:
description: APM environment.
example: ""
@@ -16701,23 +16701,23 @@ components:
description: Whether to show the resource list or not.
type: boolean
size_format:
- $ref: "#/components/schemas/WidgetSizeFormat"
+ $ref: '#/components/schemas/WidgetSizeFormat'
span_name:
description: APM span name.
example: ""
type: string
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ServiceSummaryWidgetDefinitionType"
+ $ref: '#/components/schemas/ServiceSummaryWidgetDefinitionType'
required:
- type
- env
@@ -16738,7 +16738,7 @@ components:
The metadata object associated with how a dashboard has been/will be shared.
properties:
author:
- $ref: "#/components/schemas/SharedDashboardAuthor"
+ $ref: '#/components/schemas/SharedDashboardAuthor'
created:
description: Date the dashboard was shared.
format: date-time
@@ -16749,7 +16749,7 @@ components:
example: "123-abc-456"
type: string
dashboard_type:
- $ref: "#/components/schemas/DashboardType"
+ $ref: '#/components/schemas/DashboardType'
embeddable_domains:
description: The `SharedDashboard` `embeddable_domains`.
example: ["https://domain.atlassian.net/", "http://myserver.com/"]
@@ -16763,7 +16763,7 @@ components:
nullable: true
type: string
global_time:
- $ref: "#/components/schemas/DashboardGlobalTime"
+ $ref: '#/components/schemas/DashboardGlobalTime'
global_time_selectable_enabled:
description: Whether to allow viewers to select a different global time setting for the shared dashboard.
nullable: true
@@ -16772,7 +16772,7 @@ components:
description: The `SharedDashboard` `invitees`.
example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}]
items:
- $ref: "#/components/schemas/SharedDashboardInviteesItems"
+ $ref: '#/components/schemas/SharedDashboardInviteesItems'
type: array
last_accessed:
description: The last time the shared dashboard was accessed. Null if never accessed.
@@ -16788,7 +16788,7 @@ components:
description: List of objects representing template variables on the shared dashboard which can have selectable values.
example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}]
items:
- $ref: "#/components/schemas/SelectableTemplateVariableItems"
+ $ref: '#/components/schemas/SelectableTemplateVariableItems'
nullable: true
type: array
share_list:
@@ -16801,9 +16801,9 @@ components:
nullable: true
type: array
share_type:
- $ref: "#/components/schemas/DashboardShareType"
+ $ref: '#/components/schemas/DashboardShareType'
status:
- $ref: "#/components/schemas/SharedDashboardStatus"
+ $ref: '#/components/schemas/SharedDashboardStatus'
title:
description: Title of the shared dashboard.
type: string
@@ -16812,7 +16812,7 @@ components:
readOnly: true
type: string
viewing_preferences:
- $ref: "#/components/schemas/ViewingPreferences"
+ $ref: '#/components/schemas/ViewingPreferences'
required:
- dashboard_id
- dashboard_type
@@ -16857,9 +16857,9 @@ components:
example: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
properties:
data:
- $ref: "#/components/schemas/SharedDashboardInvitesData"
+ $ref: '#/components/schemas/SharedDashboardInvitesData'
meta:
- $ref: "#/components/schemas/SharedDashboardInvitesMeta"
+ $ref: '#/components/schemas/SharedDashboardInvitesMeta'
required:
- data
type: object
@@ -16867,22 +16867,22 @@ components:
description: An object or list of objects containing the information for an invitation to a shared dashboard.
example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]
oneOf:
- - $ref: "#/components/schemas/SharedDashboardInvitesDataObject"
- - $ref: "#/components/schemas/SharedDashboardInvitesDataList"
+ - $ref: '#/components/schemas/SharedDashboardInvitesDataObject'
+ - $ref: '#/components/schemas/SharedDashboardInvitesDataList'
SharedDashboardInvitesDataList:
description: A list of objects containing the information for an invitation(s) to a shared dashboard.
example: [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]
items:
- $ref: "#/components/schemas/SharedDashboardInvitesDataObject"
+ $ref: '#/components/schemas/SharedDashboardInvitesDataObject'
type: array
SharedDashboardInvitesDataObject:
description: Object containing the information for an invitation to a shared dashboard.
example: {"attributes": {"created_at": "2020-12-07T20:16:27.846985+00:00", "email": "test@datadoghq.com", "has_session": false, "invitation_expiry": "2020-12-07T21:16:27.840542+00:00", "session_expiry": null, "share_token": "XXXXXX-123456abcedfg7890hijklmnopqrstuv"}, "type": "public_dashboard_invitation"}
properties:
attributes:
- $ref: "#/components/schemas/SharedDashboardInvitesDataObjectAttributes"
+ $ref: '#/components/schemas/SharedDashboardInvitesDataObjectAttributes'
type:
- $ref: "#/components/schemas/DashboardInviteType"
+ $ref: '#/components/schemas/DashboardInviteType'
required:
- type
- attributes
@@ -16924,7 +16924,7 @@ components:
description: Pagination metadata returned by the API.
properties:
page:
- $ref: "#/components/schemas/SharedDashboardInvitesMetaPage"
+ $ref: '#/components/schemas/SharedDashboardInvitesMetaPage'
readOnly: true
type: object
SharedDashboardInvitesMetaPage:
@@ -16963,7 +16963,7 @@ components:
nullable: true
type: string
global_time:
- $ref: "#/components/schemas/SharedDashboardUpdateRequestGlobalTime"
+ $ref: '#/components/schemas/SharedDashboardUpdateRequestGlobalTime'
global_time_selectable_enabled:
description: Whether to allow viewers to select a different global time setting for the shared dashboard.
nullable: true
@@ -16972,13 +16972,13 @@ components:
description: The `SharedDashboard` `invitees`.
example: [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}]
items:
- $ref: "#/components/schemas/SharedDashboardInviteesItems"
+ $ref: '#/components/schemas/SharedDashboardInviteesItems'
type: array
selectable_template_vars:
description: List of objects representing template variables on the shared dashboard which can have selectable values.
example: [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}]
items:
- $ref: "#/components/schemas/SelectableTemplateVariableItems"
+ $ref: '#/components/schemas/SelectableTemplateVariableItems'
nullable: true
type: array
share_list:
@@ -16991,14 +16991,14 @@ components:
nullable: true
type: array
share_type:
- $ref: "#/components/schemas/DashboardShareType"
+ $ref: '#/components/schemas/DashboardShareType'
status:
- $ref: "#/components/schemas/SharedDashboardStatus"
+ $ref: '#/components/schemas/SharedDashboardStatus'
title:
description: Title of the shared dashboard.
type: string
viewing_preferences:
- $ref: "#/components/schemas/ViewingPreferences"
+ $ref: '#/components/schemas/ViewingPreferences'
type: object
SharedDashboardUpdateRequestGlobalTime:
description: Timeframe setting for the shared dashboard.
@@ -17006,7 +17006,7 @@ components:
nullable: true
properties:
live_span:
- $ref: "#/components/schemas/DashboardGlobalTimeLiveSpan"
+ $ref: '#/components/schemas/DashboardGlobalTimeLiveSpan'
type: object
SignalArchiveReason:
description: Reason why a signal has been archived.
@@ -17035,7 +17035,7 @@ components:
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
type: string
version:
- $ref: "#/components/schemas/Version"
+ $ref: '#/components/schemas/Version'
required:
- assignee
type: object
@@ -17046,11 +17046,11 @@ components:
description: Optional comment to explain why a signal is being archived.
type: string
archiveReason:
- $ref: "#/components/schemas/SignalArchiveReason"
+ $ref: '#/components/schemas/SignalArchiveReason'
state:
- $ref: "#/components/schemas/SignalTriageState"
+ $ref: '#/components/schemas/SignalTriageState'
version:
- $ref: "#/components/schemas/Version"
+ $ref: '#/components/schemas/Version'
required:
- state
type: object
@@ -17117,7 +17117,7 @@ components:
channels:
description: An array of slack channel configurations.
items:
- $ref: "#/components/schemas/SlackChannel"
+ $ref: '#/components/schemas/SlackChannel'
type: array
type: object
SlackIntegration:
@@ -17127,14 +17127,14 @@ components:
description: The array of service hook objects.
example: [{"account": "Main_Account", "url": "https://hooks.slack.com/services/1/1/1"}, {"account": "doghouse", "url": "https://hooks.slack.com/services/2/2/2"}]
items:
- $ref: "#/components/schemas/SlackServiceHook"
+ $ref: '#/components/schemas/SlackServiceHook'
type: array
type: object
SlackIntegrationChannel:
description: The Slack channel configuration.
properties:
display:
- $ref: "#/components/schemas/SlackIntegrationChannelDisplay"
+ $ref: '#/components/schemas/SlackIntegrationChannelDisplay'
name:
description: Your channel name.
example: "#general"
@@ -17168,7 +17168,7 @@ components:
description: A list of configured Slack channels.
example: [{"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": true, "tags": true}, "name": "#channel_name_main_account"}, {"display": {"message": true, "mute_buttons": true, "notified": true, "snapshot": false, "tags": true}, "name": "#channel_name_doghouse"}]
items:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
type: array
SlackServiceHook:
description: |-
@@ -17198,20 +17198,20 @@ components:
minimum: 1
type: integer
sort:
- $ref: "#/components/schemas/SplitSort"
+ $ref: '#/components/schemas/SplitSort'
split_dimensions:
description: The dimension(s) on which to split the graph
example:
- {"one_graph_per": "service"}
items:
- $ref: "#/components/schemas/SplitDimension"
+ $ref: '#/components/schemas/SplitDimension'
maxItems: 1
minItems: 1
type: array
static_splits:
description: Manual selection of tags making split graph widget static
items:
- $ref: "#/components/schemas/SplitVectorEntry"
+ $ref: '#/components/schemas/SplitVectorEntry'
maxItems: 500
type: array
required:
@@ -17248,16 +17248,16 @@ components:
SplitGraphSourceWidgetDefinition:
description: The original widget we are splitting on.
oneOf:
- - $ref: "#/components/schemas/BarChartWidgetDefinition"
- - $ref: "#/components/schemas/ChangeWidgetDefinition"
- - $ref: "#/components/schemas/GeomapWidgetDefinition"
- - $ref: "#/components/schemas/QueryValueWidgetDefinition"
- - $ref: "#/components/schemas/ScatterPlotWidgetDefinition"
- - $ref: "#/components/schemas/SunburstWidgetDefinition"
- - $ref: "#/components/schemas/TableWidgetDefinition"
- - $ref: "#/components/schemas/TimeseriesWidgetDefinition"
- - $ref: "#/components/schemas/ToplistWidgetDefinition"
- - $ref: "#/components/schemas/TreeMapWidgetDefinition"
+ - $ref: '#/components/schemas/BarChartWidgetDefinition'
+ - $ref: '#/components/schemas/ChangeWidgetDefinition'
+ - $ref: '#/components/schemas/GeomapWidgetDefinition'
+ - $ref: '#/components/schemas/QueryValueWidgetDefinition'
+ - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
+ - $ref: '#/components/schemas/SunburstWidgetDefinition'
+ - $ref: '#/components/schemas/TableWidgetDefinition'
+ - $ref: '#/components/schemas/TimeseriesWidgetDefinition'
+ - $ref: '#/components/schemas/ToplistWidgetDefinition'
+ - $ref: '#/components/schemas/TreeMapWidgetDefinition'
SplitGraphVizSize:
description: Size of the individual graphs in the split.
enum:
@@ -17280,18 +17280,18 @@ components:
description: Normalize y axes across graphs
type: boolean
size:
- $ref: "#/components/schemas/SplitGraphVizSize"
+ $ref: '#/components/schemas/SplitGraphVizSize'
source_widget_definition:
- $ref: "#/components/schemas/SplitGraphSourceWidgetDefinition"
+ $ref: '#/components/schemas/SplitGraphSourceWidgetDefinition'
split_config:
- $ref: "#/components/schemas/SplitConfig"
+ $ref: '#/components/schemas/SplitConfig'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
type:
- $ref: "#/components/schemas/SplitGraphWidgetDefinitionType"
+ $ref: '#/components/schemas/SplitGraphWidgetDefinitionType'
required:
- size
- type
@@ -17311,9 +17311,9 @@ components:
description: Controls the order in which graphs appear in the split.
properties:
compute:
- $ref: "#/components/schemas/SplitConfigSortCompute"
+ $ref: '#/components/schemas/SplitConfigSortCompute'
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
required:
- order
type: object
@@ -17321,7 +17321,7 @@ components:
description: The widget displays one graph for each entry in this parameter.
example: [{"tag_key": "demo", "tag_values": ["env"]}]
items:
- $ref: "#/components/schemas/SplitVectorEntryItem"
+ $ref: '#/components/schemas/SplitVectorEntryItem'
minItems: 1
type: array
SplitVectorEntryItem:
@@ -17358,7 +17358,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -17367,26 +17367,26 @@ components:
description: Show the total value in this widget.
type: boolean
legend:
- $ref: "#/components/schemas/SunburstWidgetLegend"
+ $ref: '#/components/schemas/SunburstWidgetLegend'
requests:
description: List of sunburst widget requests.
example: ["q/apm_query/log_query": "{}"]
items:
- $ref: "#/components/schemas/SunburstWidgetRequest"
+ $ref: '#/components/schemas/SunburstWidgetRequest'
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/SunburstWidgetDefinitionType"
+ $ref: '#/components/schemas/SunburstWidgetDefinitionType'
required:
- type
- requests
@@ -17403,8 +17403,8 @@ components:
SunburstWidgetLegend:
description: Configuration of the legend.
oneOf:
- - $ref: "#/components/schemas/SunburstWidgetLegendTable"
- - $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomatic"
+ - $ref: '#/components/schemas/SunburstWidgetLegendTable'
+ - $ref: '#/components/schemas/SunburstWidgetLegendInlineAutomatic'
SunburstWidgetLegendInlineAutomatic:
description: Configuration of inline or automatic legends.
properties:
@@ -17415,7 +17415,7 @@ components:
description: Whether to hide the values of the groups.
type: boolean
type:
- $ref: "#/components/schemas/SunburstWidgetLegendInlineAutomaticType"
+ $ref: '#/components/schemas/SunburstWidgetLegendInlineAutomaticType'
required:
- type
type: object
@@ -17433,7 +17433,7 @@ components:
description: Configuration of table-based legend.
properties:
type:
- $ref: "#/components/schemas/SunburstWidgetLegendTableType"
+ $ref: '#/components/schemas/SunburstWidgetLegendTableType'
required:
- type
type: object
@@ -17465,7 +17465,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -17490,10 +17490,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -17503,16 +17503,16 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
style:
- $ref: "#/components/schemas/WidgetStyle"
+ $ref: '#/components/schemas/WidgetStyle'
type: object
SyntheticsAPIStep:
description: The steps used in a Synthetic multi-step API test.
oneOf:
- - $ref: "#/components/schemas/SyntheticsAPITestStep"
- - $ref: "#/components/schemas/SyntheticsAPIWaitStep"
- - $ref: "#/components/schemas/SyntheticsAPISubtestStep"
+ - $ref: '#/components/schemas/SyntheticsAPITestStep'
+ - $ref: '#/components/schemas/SyntheticsAPIWaitStep'
+ - $ref: '#/components/schemas/SyntheticsAPISubtestStep'
SyntheticsAPISubtestStep:
description: The subtest step used in a Synthetics multi-step API test.
properties:
@@ -17543,13 +17543,13 @@ components:
example: "Example step name"
type: string
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
subtestPublicId:
description: Public ID of the test to be played as part of a `playSubTest` step type.
example: ""
type: string
subtype:
- $ref: "#/components/schemas/SyntheticsAPISubtestStepSubtype"
+ $ref: '#/components/schemas/SyntheticsAPISubtestStepSubtype'
required:
- name
- subtype
@@ -17567,7 +17567,7 @@ components:
description: Object containing details about a Synthetic API test.
properties:
config:
- $ref: "#/components/schemas/SyntheticsAPITestConfig"
+ $ref: '#/components/schemas/SyntheticsAPITestConfig'
locations:
description: Array of locations used to run the test.
example: ["aws:eu-west-3"]
@@ -17590,16 +17590,16 @@ components:
example: "Example test name"
type: string
options:
- $ref: "#/components/schemas/SyntheticsTestOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptions'
public_id:
description: The public ID for the test.
example: 123-abc-456
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
subtype:
- $ref: "#/components/schemas/SyntheticsTestDetailsSubType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsSubType'
tags:
description: Array of tags attached to the test.
example: ["env:production"]
@@ -17608,7 +17608,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsAPITestType"
+ $ref: '#/components/schemas/SyntheticsAPITestType'
required:
- name
- config
@@ -17626,19 +17626,19 @@ components:
description: Array of assertions used for the test. Required for single API tests.
example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}]
items:
- $ref: "#/components/schemas/SyntheticsAssertion"
+ $ref: '#/components/schemas/SyntheticsAssertion'
type: array
configVariables:
description: Array of variables used for the test.
items:
- $ref: "#/components/schemas/SyntheticsConfigVariable"
+ $ref: '#/components/schemas/SyntheticsConfigVariable'
type: array
request:
- $ref: "#/components/schemas/SyntheticsTestRequest"
+ $ref: '#/components/schemas/SyntheticsTestRequest'
steps:
description: When the test subtype is `multi`, the steps of the test.
items:
- $ref: "#/components/schemas/SyntheticsAPIStep"
+ $ref: '#/components/schemas/SyntheticsAPIStep'
type: array
variablesFromScript:
description: Variables defined from JavaScript code.
@@ -17649,11 +17649,11 @@ components:
description: Object containing results for your Synthetic API test.
properties:
cert:
- $ref: "#/components/schemas/SyntheticsSSLCertificate"
+ $ref: '#/components/schemas/SyntheticsSSLCertificate'
eventType:
- $ref: "#/components/schemas/SyntheticsTestProcessStatus"
+ $ref: '#/components/schemas/SyntheticsTestProcessStatus'
failure:
- $ref: "#/components/schemas/SyntheticsApiTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsApiTestResultFailure'
httpStatusCode:
description: The API test HTTP status code.
format: int64
@@ -17677,13 +17677,13 @@ components:
format: int64
type: integer
timings:
- $ref: "#/components/schemas/SyntheticsTiming"
+ $ref: '#/components/schemas/SyntheticsTiming'
type: object
SyntheticsAPITestResultFull:
description: Object returned describing a API test result.
properties:
check:
- $ref: "#/components/schemas/SyntheticsAPITestResultFullCheck"
+ $ref: '#/components/schemas/SyntheticsAPITestResultFullCheck'
check_time:
description: When the API test was conducted.
format: double
@@ -17696,18 +17696,18 @@ components:
description: Locations for which to query the API test results.
type: string
result:
- $ref: "#/components/schemas/SyntheticsAPITestResultData"
+ $ref: '#/components/schemas/SyntheticsAPITestResultData'
result_id:
description: ID of the API test result.
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestMonitorStatus"
+ $ref: '#/components/schemas/SyntheticsTestMonitorStatus'
type: object
SyntheticsAPITestResultFullCheck:
description: Object describing the API test configuration.
properties:
config:
- $ref: "#/components/schemas/SyntheticsTestConfig"
+ $ref: '#/components/schemas/SyntheticsTestConfig'
required:
- config
type: object
@@ -17722,12 +17722,12 @@ components:
description: Location from which the API test was performed.
type: string
result:
- $ref: "#/components/schemas/SyntheticsAPITestResultShortResult"
+ $ref: '#/components/schemas/SyntheticsAPITestResultShortResult'
result_id:
description: ID of the API test result.
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestMonitorStatus"
+ $ref: '#/components/schemas/SyntheticsTestMonitorStatus'
type: object
SyntheticsAPITestResultShortResult:
description: Result of the last API test run.
@@ -17736,7 +17736,7 @@ components:
description: Describes if the test run has passed or failed.
type: boolean
timings:
- $ref: "#/components/schemas/SyntheticsTiming"
+ $ref: '#/components/schemas/SyntheticsTiming'
type: object
SyntheticsAPITestStep:
description: The Test step used in a Synthetic multi-step API test.
@@ -17749,7 +17749,7 @@ components:
description: Array of assertions used for the test.
example: [{"operator": "lessThan", "target": 1000, "type": "responseTime"}]
items:
- $ref: "#/components/schemas/SyntheticsAssertion"
+ $ref: '#/components/schemas/SyntheticsAssertion'
type: array
exitIfSucceed:
description: Determines whether or not to exit the test if the step succeeds.
@@ -17757,7 +17757,7 @@ components:
extractedValues:
description: Array of values to parse and save as variables from the response.
items:
- $ref: "#/components/schemas/SyntheticsParsingOptions"
+ $ref: '#/components/schemas/SyntheticsParsingOptions'
type: array
extractedValuesFromScript:
description: Generate variables using JavaScript.
@@ -17777,11 +17777,11 @@ components:
example: "Example step name"
type: string
request:
- $ref: "#/components/schemas/SyntheticsTestRequest"
+ $ref: '#/components/schemas/SyntheticsTestRequest'
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
subtype:
- $ref: "#/components/schemas/SyntheticsAPITestStepSubtype"
+ $ref: '#/components/schemas/SyntheticsAPITestStepSubtype'
required:
- assertions
- request
@@ -17835,7 +17835,7 @@ components:
example: "Example step name"
type: string
subtype:
- $ref: "#/components/schemas/SyntheticsAPIWaitStepSubtype"
+ $ref: '#/components/schemas/SyntheticsAPIWaitStepSubtype'
value:
description: "The time to wait in seconds. Minimum value: 0. Maximum value: 180."
example: 5
@@ -17918,7 +17918,7 @@ components:
description: The API test failure details.
properties:
code:
- $ref: "#/components/schemas/SyntheticsApiTestFailureCode"
+ $ref: '#/components/schemas/SyntheticsApiTestFailureCode'
message:
description: The API test error message.
example: "Error during DNS resolution (ENOTFOUND)."
@@ -17929,14 +17929,14 @@ components:
Object describing the assertions type, their associated operator,
which property they apply, and upon which target.
oneOf:
- - $ref: "#/components/schemas/SyntheticsAssertionTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionBodyHashTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionJSONPathTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionXPathTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionJavascript"
- - $ref: "#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesTarget"
- - $ref: "#/components/schemas/SyntheticsAssertionMCPRespectsSpecification"
+ - $ref: '#/components/schemas/SyntheticsAssertionTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionBodyHashTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionJSONPathTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionXPathTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionJavascript'
+ - $ref: '#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesTarget'
+ - $ref: '#/components/schemas/SyntheticsAssertionMCPRespectsSpecification'
SyntheticsAssertionBodyHashOperator:
description: Assertion operator to apply.
enum:
@@ -17953,12 +17953,12 @@ components:
description: An assertion which targets body hash.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionBodyHashOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionBodyHashOperator'
target:
$ref: "#/components/schemas/SyntheticsAssertionTargetValue"
description: Value used by the operator.
type:
- $ref: "#/components/schemas/SyntheticsAssertionBodyHashType"
+ $ref: '#/components/schemas/SyntheticsAssertionBodyHashType'
required:
- type
- operator
@@ -17984,14 +17984,14 @@ components:
description: An assertion for the `validatesJSONPath` operator.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionJSONPathOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionJSONPathOperator'
property:
description: The associated assertion property.
type: string
target:
- $ref: "#/components/schemas/SyntheticsAssertionJSONPathTargetTarget"
+ $ref: '#/components/schemas/SyntheticsAssertionJSONPathTargetTarget'
type:
- $ref: "#/components/schemas/SyntheticsAssertionType"
+ $ref: '#/components/schemas/SyntheticsAssertionType'
required:
- type
- operator
@@ -18033,11 +18033,11 @@ components:
description: An assertion for the `validatesJSONSchema` operator.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaOperator'
target:
- $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget"
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaTargetTarget'
type:
- $ref: "#/components/schemas/SyntheticsAssertionType"
+ $ref: '#/components/schemas/SyntheticsAssertionType'
required:
- type
- operator
@@ -18049,7 +18049,7 @@ components:
description: The JSON Schema to assert.
type: string
metaSchema:
- $ref: "#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema"
+ $ref: '#/components/schemas/SyntheticsAssertionJSONSchemaMetaSchema'
type: object
SyntheticsAssertionJavascript:
description: A JavaScript assertion.
@@ -18059,7 +18059,7 @@ components:
example: dd.expect(dd.response.statusCode).to.equal(200);
type: string
type:
- $ref: "#/components/schemas/SyntheticsAssertionJavascriptType"
+ $ref: '#/components/schemas/SyntheticsAssertionJavascriptType'
required:
- type
- code
@@ -18076,7 +18076,7 @@ components:
description: An assertion that verifies the MCP server response respects the MCP specification.
properties:
type:
- $ref: "#/components/schemas/SyntheticsAssertionMCPRespectsSpecificationType"
+ $ref: '#/components/schemas/SyntheticsAssertionMCPRespectsSpecificationType'
required:
- type
type: object
@@ -18092,16 +18092,16 @@ components:
description: An assertion that checks that an MCP server advertises the expected capabilities.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionOperator'
target:
description: List of MCP server capabilities to assert against.
example:
- completions
items:
- $ref: "#/components/schemas/SyntheticsMCPServerCapability"
+ $ref: '#/components/schemas/SyntheticsMCPServerCapability'
type: array
type:
- $ref: "#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesType"
+ $ref: '#/components/schemas/SyntheticsAssertionMCPServerCapabilitiesType'
required:
- type
- operator
@@ -18155,7 +18155,7 @@ components:
description: An assertion which uses a simple target.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionOperator'
property:
description: The associated assertion property.
type: string
@@ -18163,9 +18163,9 @@ components:
$ref: "#/components/schemas/SyntheticsAssertionTargetValue"
description: Value used by the operator.
timingsScope:
- $ref: "#/components/schemas/SyntheticsAssertionTimingsScope"
+ $ref: '#/components/schemas/SyntheticsAssertionTimingsScope'
type:
- $ref: "#/components/schemas/SyntheticsAssertionType"
+ $ref: '#/components/schemas/SyntheticsAssertionType'
required:
- type
- operator
@@ -18175,8 +18175,8 @@ components:
description: Value used by the operator in assertions. Can be either a number or string.
example: 0.0
oneOf:
- - $ref: "#/components/schemas/SyntheticsAssertionTargetValueNumber"
- - $ref: "#/components/schemas/SyntheticsAssertionTargetValueString"
+ - $ref: '#/components/schemas/SyntheticsAssertionTargetValueNumber'
+ - $ref: '#/components/schemas/SyntheticsAssertionTargetValueString'
SyntheticsAssertionTargetValueNumber:
description: Numeric value used by the operator in assertions.
format: double
@@ -18257,14 +18257,14 @@ components:
description: An assertion for the `validatesXPath` operator.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsAssertionXPathOperator"
+ $ref: '#/components/schemas/SyntheticsAssertionXPathOperator'
property:
description: The associated assertion property.
type: string
target:
- $ref: "#/components/schemas/SyntheticsAssertionXPathTargetTarget"
+ $ref: '#/components/schemas/SyntheticsAssertionXPathTargetTarget'
type:
- $ref: "#/components/schemas/SyntheticsAssertionType"
+ $ref: '#/components/schemas/SyntheticsAssertionType'
required:
- type
- operator
@@ -18285,13 +18285,13 @@ components:
SyntheticsBasicAuth:
description: Object to handle basic authentication when performing the test.
oneOf:
- - $ref: "#/components/schemas/SyntheticsBasicAuthWeb"
- - $ref: "#/components/schemas/SyntheticsBasicAuthSigv4"
- - $ref: "#/components/schemas/SyntheticsBasicAuthNTLM"
- - $ref: "#/components/schemas/SyntheticsBasicAuthDigest"
- - $ref: "#/components/schemas/SyntheticsBasicAuthOauthClient"
- - $ref: "#/components/schemas/SyntheticsBasicAuthOauthROP"
- - $ref: "#/components/schemas/SyntheticsBasicAuthJWT"
+ - $ref: '#/components/schemas/SyntheticsBasicAuthWeb'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthSigv4'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthNTLM'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthDigest'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthOauthClient'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthOauthROP'
+ - $ref: '#/components/schemas/SyntheticsBasicAuthJWT'
SyntheticsBasicAuthDigest:
description: Object to handle digest authentication when performing the test.
properties:
@@ -18300,7 +18300,7 @@ components:
example: "PaSSw0RD!"
type: string
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthDigestType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthDigestType'
username:
description: Username to use for the digest authentication.
example: "my_username"
@@ -18323,9 +18323,9 @@ components:
description: Object to handle JWT authentication when performing the test.
properties:
addClaims:
- $ref: "#/components/schemas/SyntheticsBasicAuthJWTAddClaims"
+ $ref: '#/components/schemas/SyntheticsBasicAuthJWTAddClaims'
algorithm:
- $ref: "#/components/schemas/SyntheticsBasicAuthJWTAlgorithm"
+ $ref: '#/components/schemas/SyntheticsBasicAuthJWTAlgorithm'
expiresIn:
description: Token time-to-live in seconds.
example: 3600
@@ -18351,7 +18351,7 @@ components:
example: "Bearer"
type: string
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthJWTType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthJWTType'
required:
- algorithm
- payload
@@ -18403,7 +18403,7 @@ components:
example: "examplepassword"
type: string
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthNTLMType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthNTLMType'
username:
description: Username for the authentication to use when performing the test.
example: "joedoe"
@@ -18452,9 +18452,9 @@ components:
example: "scope"
type: string
tokenApiAuthentication:
- $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication"
+ $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication'
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthOauthClientType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthOauthClientType'
required:
- accessTokenUrl
- tokenApiAuthentication
@@ -18503,9 +18503,9 @@ components:
example: "scope"
type: string
tokenApiAuthentication:
- $ref: "#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication"
+ $ref: '#/components/schemas/SyntheticsBasicAuthOauthTokenApiAuthentication'
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthOauthROPType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthOauthROPType'
username:
description: Username to use when performing the authentication.
example: "username"
@@ -18564,7 +18564,7 @@ components:
Z3CYWFXG8C5zqx37wnOE49mRl/+OtkIKGO7fAE
type: string
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthSigv4Type"
+ $ref: '#/components/schemas/SyntheticsBasicAuthSigv4Type'
required:
- accessKey
- secretKey
@@ -18587,7 +18587,7 @@ components:
example: "PaSSw0RD!"
type: string
type:
- $ref: "#/components/schemas/SyntheticsBasicAuthWebType"
+ $ref: '#/components/schemas/SyntheticsBasicAuthWebType'
username:
description: Username to use for the basic authentication.
example: "my_username"
@@ -18606,32 +18606,32 @@ components:
description: Details about a batch response.
properties:
data:
- $ref: "#/components/schemas/SyntheticsBatchDetailsData"
+ $ref: '#/components/schemas/SyntheticsBatchDetailsData'
type: object
SyntheticsBatchDetailsData:
description: Wrapper object that contains the details of a batch.
properties:
metadata:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadata"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadata'
results:
description: List of results for the batch.
items:
- $ref: "#/components/schemas/SyntheticsBatchResult"
+ $ref: '#/components/schemas/SyntheticsBatchResult'
type: array
status:
- $ref: "#/components/schemas/SyntheticsBatchStatus"
+ $ref: '#/components/schemas/SyntheticsBatchStatus'
type: object
SyntheticsBatchResult:
description: Object with the results of a Synthetic batch.
properties:
device:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
duration:
description: Total duration in millisecond of the test.
format: double
type: number
execution_rule:
- $ref: "#/components/schemas/SyntheticsTestExecutionRule"
+ $ref: '#/components/schemas/SyntheticsTestExecutionRule'
location:
description: Name of the location.
type: string
@@ -18643,7 +18643,7 @@ components:
format: double
type: number
status:
- $ref: "#/components/schemas/SyntheticsBatchStatus"
+ $ref: '#/components/schemas/SyntheticsBatchStatus'
test_name:
description: Name of the test.
type: string
@@ -18651,7 +18651,7 @@ components:
description: The public ID of the Synthetic test.
type: string
test_type:
- $ref: "#/components/schemas/SyntheticsTestDetailsType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsType'
type: object
SyntheticsBatchStatus:
description: Determines whether the batch has passed, failed, or is in progress.
@@ -18681,7 +18681,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/SyntheticsBrowserErrorType"
+ $ref: '#/components/schemas/SyntheticsBrowserErrorType'
required:
- description
- name
@@ -18701,7 +18701,7 @@ components:
description: Object containing details about a Synthetic browser test.
properties:
config:
- $ref: "#/components/schemas/SyntheticsBrowserTestConfig"
+ $ref: '#/components/schemas/SyntheticsBrowserTestConfig'
locations:
description: Array of locations used to run the test.
example: ["aws:eu-west-3"]
@@ -18723,17 +18723,17 @@ components:
example: "Example test name"
type: string
options:
- $ref: "#/components/schemas/SyntheticsTestOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptions'
public_id:
description: The public ID of the test.
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
steps:
description: Array of steps for the test.
items:
- $ref: "#/components/schemas/SyntheticsStep"
+ $ref: '#/components/schemas/SyntheticsStep'
type: array
tags:
description: Array of tags attached to the test.
@@ -18743,7 +18743,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsBrowserTestType"
+ $ref: '#/components/schemas/SyntheticsBrowserTestType'
required:
- config
- locations
@@ -18760,22 +18760,22 @@ components:
description: Array of assertions used for the test.
example: []
items:
- $ref: "#/components/schemas/SyntheticsAssertion"
+ $ref: '#/components/schemas/SyntheticsAssertion'
type: array
configVariables:
description: Array of variables used for the test.
items:
- $ref: "#/components/schemas/SyntheticsConfigVariable"
+ $ref: '#/components/schemas/SyntheticsConfigVariable'
type: array
request:
- $ref: "#/components/schemas/SyntheticsTestRequest"
+ $ref: '#/components/schemas/SyntheticsTestRequest'
setCookie:
description: Cookies to be used for the request, using the [Set-Cookie](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) syntax.
type: string
variables:
description: Array of variables used for the test steps.
items:
- $ref: "#/components/schemas/SyntheticsBrowserVariable"
+ $ref: '#/components/schemas/SyntheticsBrowserVariable'
type: array
required:
- request
@@ -18862,7 +18862,7 @@ components:
description: Browser version used for the browser test.
type: string
device:
- $ref: "#/components/schemas/SyntheticsDevice"
+ $ref: '#/components/schemas/SyntheticsDevice'
duration:
description: Global duration in second of the browser test.
format: double
@@ -18871,7 +18871,7 @@ components:
description: Error returned for the browser test.
type: string
failure:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure'
passed:
description: Whether or not the browser test was conducted.
type: boolean
@@ -18885,7 +18885,7 @@ components:
stepDetails:
description: Array containing the different browser test steps.
items:
- $ref: "#/components/schemas/SyntheticsStepDetail"
+ $ref: '#/components/schemas/SyntheticsStepDetail'
type: array
thumbnailsBucketKey:
description: Whether or not a thumbnail is associated with the browser test.
@@ -18901,7 +18901,7 @@ components:
description: The browser test failure details.
properties:
code:
- $ref: "#/components/schemas/SyntheticsBrowserTestFailureCode"
+ $ref: '#/components/schemas/SyntheticsBrowserTestFailureCode'
message:
description: The browser test error message.
example: "Error during DNS resolution (ENOTFOUND)."
@@ -18911,7 +18911,7 @@ components:
description: Object returned describing a browser test result.
properties:
check:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultFullCheck"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultFullCheck'
check_time:
description: When the browser test was conducted.
format: double
@@ -18924,18 +18924,18 @@ components:
description: Location from which the browser test was performed.
type: string
result:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultData"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultData'
result_id:
description: ID of the browser test result.
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestMonitorStatus"
+ $ref: '#/components/schemas/SyntheticsTestMonitorStatus'
type: object
SyntheticsBrowserTestResultFullCheck:
description: Object describing the browser test configuration.
properties:
config:
- $ref: "#/components/schemas/SyntheticsTestConfig"
+ $ref: '#/components/schemas/SyntheticsTestConfig'
required:
- config
type: object
@@ -18950,18 +18950,18 @@ components:
description: Location from which the Browser test was performed.
type: string
result:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultShortResult"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultShortResult'
result_id:
description: ID of the browser test result.
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestMonitorStatus"
+ $ref: '#/components/schemas/SyntheticsTestMonitorStatus'
type: object
SyntheticsBrowserTestResultShortResult:
description: Object with the result of the last browser test run.
properties:
device:
- $ref: "#/components/schemas/SyntheticsDevice"
+ $ref: '#/components/schemas/SyntheticsDevice'
duration:
description: Length in milliseconds of the browser test run.
format: double
@@ -19041,7 +19041,7 @@ components:
description: Determines whether or not the browser test variable is obfuscated. Can only be used with browser variables of type `text`.
type: boolean
type:
- $ref: "#/components/schemas/SyntheticsBrowserVariableType"
+ $ref: '#/components/schemas/SyntheticsBrowserVariableType'
required:
- type
- name
@@ -19064,17 +19064,17 @@ components:
description: Metadata for the Synthetic tests run.
properties:
ci:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadataCI"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadataCI'
git:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadataGit"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadataGit'
type: object
SyntheticsCIBatchMetadataCI:
description: Description of the CI provider.
properties:
pipeline:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadataPipeline"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadataPipeline'
provider:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadataProvider"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadataProvider'
type: object
SyntheticsCIBatchMetadataGit:
description: Git information.
@@ -19107,7 +19107,7 @@ components:
description: Disable certificate checks in API tests.
type: boolean
basicAuth:
- $ref: "#/components/schemas/SyntheticsBasicAuth"
+ $ref: '#/components/schemas/SyntheticsBasicAuth'
body:
description: Body to include in the test.
type: string
@@ -19120,13 +19120,13 @@ components:
deviceIds:
description: For browser test, array with the different device IDs used to run the test.
items:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
type: array
followRedirects:
description: For API HTTP test, whether or not the test should follow redirects.
type: boolean
headers:
- $ref: "#/components/schemas/SyntheticsTestHeaders"
+ $ref: '#/components/schemas/SyntheticsTestHeaders'
locations:
description: Array of locations used to run the test.
example: ["aws:eu-west-3"]
@@ -19135,13 +19135,13 @@ components:
type: string
type: array
metadata:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadata"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadata'
public_id:
description: The public ID of the Synthetic test to trigger.
example: aaa-aaa-aaa
type: string
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
startUrl:
description: Starting URL for the browser test.
type: string
@@ -19164,7 +19164,7 @@ components:
tests:
description: List of Synthetic tests with overrides.
items:
- $ref: "#/components/schemas/SyntheticsCITest"
+ $ref: '#/components/schemas/SyntheticsCITest'
type: array
type: object
SyntheticsCheckType:
@@ -19222,7 +19222,7 @@ components:
example: false
type: boolean
type:
- $ref: "#/components/schemas/SyntheticsConfigVariableType"
+ $ref: '#/components/schemas/SyntheticsConfigVariableType'
required:
- type
- name
@@ -19289,7 +19289,7 @@ components:
Array of objects containing a deleted Synthetic test ID with
the associated deletion timestamp.
items:
- $ref: "#/components/schemas/SyntheticsDeletedTest"
+ $ref: '#/components/schemas/SyntheticsDeletedTest'
type: array
type: object
SyntheticsDeletedTest:
@@ -19314,7 +19314,7 @@ components:
format: int64
type: integer
id:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
isMobile:
description: Whether or not the device is a mobile.
type: boolean
@@ -19374,7 +19374,7 @@ components:
results:
description: Result of the latest API test run.
items:
- $ref: "#/components/schemas/SyntheticsAPITestResultShort"
+ $ref: '#/components/schemas/SyntheticsAPITestResultShort'
type: array
type: object
SyntheticsGetBrowserTestLatestResultsResponse:
@@ -19387,14 +19387,14 @@ components:
results:
description: Result of the latest browser test run.
items:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultShort"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultShort'
type: array
type: object
SyntheticsGlobalVariable:
description: Synthetic global variable.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes'
description:
description: Description of the global variable.
example: "Example description"
@@ -19414,7 +19414,7 @@ components:
example: "MY_VARIABLE"
type: string
parse_test_options:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions'
parse_test_public_id:
description: A Synthetic test ID to use as a test to generate the variable value.
example: "abc-def-123"
@@ -19427,7 +19427,7 @@ components:
type: string
type: array
value:
- $ref: "#/components/schemas/SyntheticsGlobalVariableValue"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableValue'
required:
- description
- name
@@ -19438,13 +19438,13 @@ components:
description: Attributes of the global variable.
properties:
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
type: object
SyntheticsGlobalVariableOptions:
description: Options for the Global Variable for MFA.
properties:
totp_parameters:
- $ref: "#/components/schemas/SyntheticsGlobalVariableTOTPParameters"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableTOTPParameters'
type: object
SyntheticsGlobalVariableParseTestOptions:
description: Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`.
@@ -19458,9 +19458,9 @@ components:
example: "LOCAL_VARIABLE"
type: string
parser:
- $ref: "#/components/schemas/SyntheticsVariableParser"
+ $ref: '#/components/schemas/SyntheticsVariableParser'
type:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
required:
- type
type: object
@@ -19496,7 +19496,7 @@ components:
description: Details of the global variable to create.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes'
description:
description: Description of the global variable.
example: "Example description"
@@ -19516,7 +19516,7 @@ components:
example: "MY_VARIABLE"
type: string
parse_test_options:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions'
parse_test_public_id:
description: A Synthetic test ID to use as a test to generate the variable value.
example: "abc-def-123"
@@ -19529,7 +19529,7 @@ components:
type: string
type: array
value:
- $ref: "#/components/schemas/SyntheticsGlobalVariableValue"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableValue'
required:
- description
- name
@@ -19560,7 +19560,7 @@ components:
value: value
properties:
options:
- $ref: "#/components/schemas/SyntheticsGlobalVariableOptions"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableOptions'
secure:
description: Determines if the value of the variable is hidden.
type: boolean
@@ -19577,7 +19577,7 @@ components:
variables:
description: Array of Synthetic global variables.
items:
- $ref: "#/components/schemas/SyntheticsGlobalVariable"
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
type: array
type: object
SyntheticsListTestsResponse:
@@ -19586,7 +19586,7 @@ components:
tests:
description: Array of Synthetic tests configuration.
items:
- $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps"
+ $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps'
type: array
type: object
SyntheticsLocalVariableParsingOptionsType:
@@ -19623,7 +19623,7 @@ components:
locations:
description: List of Synthetic locations.
items:
- $ref: "#/components/schemas/SyntheticsLocation"
+ $ref: '#/components/schemas/SyntheticsLocation'
type: array
type: object
SyntheticsMCPProtocolVersion:
@@ -19672,7 +19672,7 @@ components:
description: A boolean set to not take a screenshot for the step.
type: boolean
params:
- $ref: "#/components/schemas/SyntheticsMobileStepParams"
+ $ref: '#/components/schemas/SyntheticsMobileStepParams'
publicId:
description: The public ID of the step.
example: "pub-lic-id0"
@@ -19682,7 +19682,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/SyntheticsMobileStepType"
+ $ref: '#/components/schemas/SyntheticsMobileStepType'
required:
- name
- params
@@ -19692,7 +19692,7 @@ components:
description: The parameters of a mobile step.
properties:
check:
- $ref: "#/components/schemas/SyntheticsCheckType"
+ $ref: '#/components/schemas/SyntheticsCheckType'
delay:
description: Number of milliseconds to wait between inputs in a `typeText` step type.
format: int64
@@ -19700,9 +19700,9 @@ components:
minimum: 0
type: integer
direction:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsDirection"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsDirection'
element:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElement"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElement'
enabled:
description: Boolean to change the state of the wifi for a `toggleWiFi` step type.
type: boolean
@@ -19711,14 +19711,14 @@ components:
format: int64
type: integer
positions:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsPositions"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositions'
subtestPublicId:
description: Public ID of the test to be played as part of a `playSubTest` step type.
type: string
value:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsValue"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsValue'
variable:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsVariable"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsVariable'
withEnter:
description: Boolean to indicate if `Enter` should be pressed at the end of the `typeText` step type.
type: boolean
@@ -19751,7 +19751,7 @@ components:
description: Context of the element.
type: string
contextType:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElementContextType"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementContextType'
elementDescription:
description: Description of the element.
type: string
@@ -19759,12 +19759,12 @@ components:
description: Multi-locator to find the element.
type: object
relativePosition:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementRelativePosition'
textContent:
description: Text content of the element.
type: string
userLocator:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocator"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocator'
viewName:
description: Name of the view of the element.
type: string
@@ -19799,14 +19799,14 @@ components:
values:
description: Values of the user locator.
items:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItems'
type: array
type: object
SyntheticsMobileStepParamsElementUserLocatorValuesItems:
description: A single user locator object.
properties:
type:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsElementUserLocatorValuesItemsType'
value:
description: Value of a user locator.
type: string
@@ -19829,7 +19829,7 @@ components:
SyntheticsMobileStepParamsPositions:
description: List of positions for the `flick` step type. The maximum is 10 flicks per step
items:
- $ref: "#/components/schemas/SyntheticsMobileStepParamsPositionsItems"
+ $ref: '#/components/schemas/SyntheticsMobileStepParamsPositionsItems'
type: array
SyntheticsMobileStepParamsPositionsItems:
description: A description of a single position for a `flick` step type.
@@ -19846,8 +19846,8 @@ components:
SyntheticsMobileStepParamsValue:
description: Values used in the step for in multiple step types.
oneOf:
- - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueString"
- - $ref: "#/components/schemas/SyntheticsMobileStepParamsValueNumber"
+ - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueString'
+ - $ref: '#/components/schemas/SyntheticsMobileStepParamsValueNumber'
SyntheticsMobileStepParamsValueNumber:
description: Value used in the step for in multiple step types.
format: int64
@@ -19914,11 +19914,11 @@ components:
description: Object containing details about a Synthetic mobile test.
properties:
config:
- $ref: "#/components/schemas/SyntheticsMobileTestConfig"
+ $ref: '#/components/schemas/SyntheticsMobileTestConfig'
device_ids:
description: Array with the different device IDs used to run the test.
items:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
type: array
message:
description: Notification message associated with the test.
@@ -19935,18 +19935,18 @@ components:
example: "Example test name"
type: string
options:
- $ref: "#/components/schemas/SyntheticsMobileTestOptions"
+ $ref: '#/components/schemas/SyntheticsMobileTestOptions'
public_id:
description: The public ID of the test.
example: 123-abc-456
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
steps:
description: Array of steps for the test.
items:
- $ref: "#/components/schemas/SyntheticsMobileStep"
+ $ref: '#/components/schemas/SyntheticsMobileStep'
type: array
tags:
description: Array of tags attached to the test.
@@ -19956,7 +19956,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsMobileTestType"
+ $ref: '#/components/schemas/SyntheticsMobileTestType'
required:
- config
- name
@@ -19968,11 +19968,11 @@ components:
description: Configuration object for a Synthetic mobile test.
properties:
initialApplicationArguments:
- $ref: "#/components/schemas/SyntheticsMobileTestInitialApplicationArguments"
+ $ref: '#/components/schemas/SyntheticsMobileTestInitialApplicationArguments'
variables:
description: Array of variables used for the test steps.
items:
- $ref: "#/components/schemas/SyntheticsConfigVariable"
+ $ref: '#/components/schemas/SyntheticsConfigVariable'
type: array
type: object
SyntheticsMobileTestInitialApplicationArguments:
@@ -19990,10 +19990,10 @@ components:
bindings:
description: Array of bindings used for the mobile test.
items:
- $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBinding"
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBinding'
type: array
ci:
- $ref: "#/components/schemas/SyntheticsTestCiOptions"
+ $ref: '#/components/schemas/SyntheticsTestCiOptions'
defaultStepTimeout:
description: The default timeout for steps in the test (in seconds).
format: int32
@@ -20005,7 +20005,7 @@ components:
example:
- synthetics:mobile:device:apple_ipad_10th_gen_2022_ios_16
items:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
type: array
disableAutoAcceptAlert:
description: A boolean to disable auto accepting alerts.
@@ -20017,12 +20017,12 @@ components:
minimum: 0
type: integer
mobileApplication:
- $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplication"
+ $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplication'
monitor_name:
description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
type: string
monitor_options:
- $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions'
monitor_priority:
description: Integer from 1 (high) to 5 (low) indicating alert severity.
format: int32
@@ -20033,11 +20033,11 @@ components:
description: A boolean set to not take a screenshot for the step.
type: boolean
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
scheduling:
- $ref: "#/components/schemas/SyntheticsTestOptionsScheduling"
+ $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
tick_every:
description: The frequency at which to run the Synthetic test (in seconds).
example: 300
@@ -20079,7 +20079,7 @@ components:
maxLength: 1500
type: string
referenceType:
- $ref: "#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType"
+ $ref: '#/components/schemas/SyntheticsMobileTestsMobileApplicationReferenceType'
required:
- applicationId
- referenceId
@@ -20107,12 +20107,12 @@ components:
description: Name of the variable to extract.
type: string
parser:
- $ref: "#/components/schemas/SyntheticsVariableParser"
+ $ref: '#/components/schemas/SyntheticsVariableParser'
secure:
description: Determines whether or not the extracted value will be obfuscated.
type: boolean
type:
- $ref: "#/components/schemas/SyntheticsLocalVariableParsingOptionsType"
+ $ref: '#/components/schemas/SyntheticsLocalVariableParsingOptionsType'
type: object
SyntheticsPatchTestBody:
description: Wrapper around an array of [JSON Patch](https://jsonpatch.com) operations to perform on the test
@@ -20121,14 +20121,14 @@ components:
description: Array of [JSON Patch](https://jsonpatch.com) operations to perform on the test
example: [{"op": "replace", "path": "/name", "value": "New test name"}, {"op": "remove", "path": "/config/assertions/0"}]
items:
- $ref: "#/components/schemas/SyntheticsPatchTestOperation"
+ $ref: '#/components/schemas/SyntheticsPatchTestOperation'
type: array
type: object
SyntheticsPatchTestOperation:
description: A single [JSON Patch](https://jsonpatch.com) operation to perform on the test
properties:
op:
- $ref: "#/components/schemas/SyntheticsPatchTestOperationName"
+ $ref: '#/components/schemas/SyntheticsPatchTestOperationName'
path:
description: The path to the value to modify
example: /name
@@ -20183,13 +20183,13 @@ components:
readOnly: true
type: string
metadata:
- $ref: "#/components/schemas/SyntheticsPrivateLocationMetadata"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationMetadata'
name:
description: Name of the private location.
example: New private location
type: string
secrets:
- $ref: "#/components/schemas/SyntheticsPrivateLocationSecrets"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationSecrets'
tags:
description: Array of tags attached to the private location.
example: ["team:front"]
@@ -20210,9 +20210,9 @@ components:
description: Configuration skeleton for the private location. See installation instructions of the private location on how to use this configuration.
type: object
private_location:
- $ref: "#/components/schemas/SyntheticsPrivateLocation"
+ $ref: '#/components/schemas/SyntheticsPrivateLocation'
result_encryption:
- $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponseResultEncryption'
type: object
SyntheticsPrivateLocationCreationResponseResultEncryption:
description: Public key for the result encryption.
@@ -20228,15 +20228,15 @@ components:
description: Object containing metadata about the private location.
properties:
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
type: object
SyntheticsPrivateLocationSecrets:
description: Secrets for the private location. Only present in the response when creating the private location.
properties:
authentication:
- $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationSecretsAuthentication'
config_decryption:
- $ref: "#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationSecretsConfigDecryption'
readOnly: true
type: object
SyntheticsPrivateLocationSecretsAuthentication:
@@ -20291,7 +20291,7 @@ components:
description: SHA-1 digest of the DER-encoded Certificate information.
type: string
issuer:
- $ref: "#/components/schemas/SyntheticsSSLCertificateIssuer"
+ $ref: '#/components/schemas/SyntheticsSSLCertificateIssuer'
modulus:
description: Modulus associated to the SSL certificate private key.
type: string
@@ -20302,7 +20302,7 @@ components:
description: Serial Number assigned by Symantec to the SSL certificate.
type: string
subject:
- $ref: "#/components/schemas/SyntheticsSSLCertificateSubject"
+ $ref: '#/components/schemas/SyntheticsSSLCertificateSubject'
validFrom:
description: Date from which the SSL certificate is valid.
format: date-time
@@ -20391,7 +20391,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/SyntheticsStepType"
+ $ref: '#/components/schemas/SyntheticsStepType'
type: object
SyntheticsStepDetail:
description: Object describing a step for a Synthetic test.
@@ -20402,10 +20402,10 @@ components:
browserErrors:
description: Array of errors collected for a browser test.
items:
- $ref: "#/components/schemas/SyntheticsBrowserError"
+ $ref: '#/components/schemas/SyntheticsBrowserError'
type: array
checkType:
- $ref: "#/components/schemas/SyntheticsCheckType"
+ $ref: '#/components/schemas/SyntheticsCheckType'
description:
description: Description of the test.
type: string
@@ -20417,9 +20417,9 @@ components:
description: Error returned by the test.
type: string
failure:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultFailure'
playingTab:
- $ref: "#/components/schemas/SyntheticsPlayingTab"
+ $ref: '#/components/schemas/SyntheticsPlayingTab'
screenshotBucketKey:
description: Whether or not screenshots where collected by the test.
type: boolean
@@ -20438,14 +20438,14 @@ components:
If this step includes a sub-test.
[Subtests documentation](https://docs.datadoghq.com/synthetics/browser_tests/advanced_options/#subtests).
items:
- $ref: "#/components/schemas/SyntheticsStepDetail"
+ $ref: '#/components/schemas/SyntheticsStepDetail'
type: array
timeToInteractive:
description: Time before starting the step.
format: double
type: number
type:
- $ref: "#/components/schemas/SyntheticsStepType"
+ $ref: '#/components/schemas/SyntheticsStepType'
url:
description: URL to perform the step against.
type: string
@@ -20454,12 +20454,12 @@ components:
vitalsMetrics:
description: Array of Core Web Vitals metrics for the step.
items:
- $ref: "#/components/schemas/SyntheticsCoreWebVitals"
+ $ref: '#/components/schemas/SyntheticsCoreWebVitals'
type: array
warnings:
description: Warning collected that didn't failed the step.
items:
- $ref: "#/components/schemas/SyntheticsStepDetailWarning"
+ $ref: '#/components/schemas/SyntheticsStepDetailWarning'
type: array
type: object
SyntheticsStepDetailWarning:
@@ -20470,7 +20470,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/SyntheticsWarningType"
+ $ref: '#/components/schemas/SyntheticsWarningType'
required:
- message
- type
@@ -20562,7 +20562,7 @@ components:
description: CI/CD options for a Synthetic test.
properties:
executionRule:
- $ref: "#/components/schemas/SyntheticsTestExecutionRule"
+ $ref: '#/components/schemas/SyntheticsTestExecutionRule'
required:
- executionRule
type: object
@@ -20574,28 +20574,28 @@ components:
description: Array of assertions used for the test. Required for single API tests.
example: []
items:
- $ref: "#/components/schemas/SyntheticsAssertion"
+ $ref: '#/components/schemas/SyntheticsAssertion'
type: array
configVariables:
description: Array of variables used for the test.
items:
- $ref: "#/components/schemas/SyntheticsConfigVariable"
+ $ref: '#/components/schemas/SyntheticsConfigVariable'
type: array
request:
- $ref: "#/components/schemas/SyntheticsTestRequest"
+ $ref: '#/components/schemas/SyntheticsTestRequest'
variables:
description: Browser tests only - array of variables used for the test steps.
items:
- $ref: "#/components/schemas/SyntheticsBrowserVariable"
+ $ref: '#/components/schemas/SyntheticsBrowserVariable'
type: array
type: object
SyntheticsTestDetails:
description: Object containing details about your Synthetic test.
properties:
config:
- $ref: "#/components/schemas/SyntheticsTestConfig"
+ $ref: '#/components/schemas/SyntheticsTestConfig'
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
locations:
description: Array of locations used to run the test.
example: ["aws:eu-west-3"]
@@ -20615,20 +20615,20 @@ components:
description: Name of the test.
type: string
options:
- $ref: "#/components/schemas/SyntheticsTestOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptions'
public_id:
description: The test public ID.
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
steps:
description: The steps of the test if they exist.
items:
- $ref: "#/components/schemas/SyntheticsStep"
+ $ref: '#/components/schemas/SyntheticsStep'
type: array
subtype:
- $ref: "#/components/schemas/SyntheticsTestDetailsSubType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsSubType'
tags:
description: Array of tags attached to the test.
items:
@@ -20636,7 +20636,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsTestDetailsType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsType'
type: object
SyntheticsTestDetailsSubType:
description: |-
@@ -20681,9 +20681,9 @@ components:
description: Object containing details about your Synthetic test, without test steps.
properties:
config:
- $ref: "#/components/schemas/SyntheticsTestConfig"
+ $ref: '#/components/schemas/SyntheticsTestConfig'
creator:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
locations:
description: Array of locations used to run the test.
example: ["aws:eu-west-3"]
@@ -20703,15 +20703,15 @@ components:
description: Name of the test.
type: string
options:
- $ref: "#/components/schemas/SyntheticsTestOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptions'
public_id:
description: The test public ID.
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
subtype:
- $ref: "#/components/schemas/SyntheticsTestDetailsSubType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsSubType'
tags:
description: Array of tags attached to the test.
items:
@@ -20719,7 +20719,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsTestDetailsType"
+ $ref: '#/components/schemas/SyntheticsTestDetailsType'
type: object
SyntheticsTestExecutionRule:
description: Execution rule for a Synthetic test.
@@ -20786,11 +20786,11 @@ components:
For SSL tests, whether or not the test should fail on revoked certificate in stapled OCSP.
type: boolean
ci:
- $ref: "#/components/schemas/SyntheticsTestCiOptions"
+ $ref: '#/components/schemas/SyntheticsTestCiOptions'
device_ids:
description: For browser test, array with the different device IDs used to run the test.
items:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
type: array
disableAiaIntermediateFetching:
description: |-
@@ -20813,7 +20813,7 @@ components:
description: For API HTTP test, whether or not the test should follow redirects.
type: boolean
httpVersion:
- $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion"
+ $ref: '#/components/schemas/SyntheticsTestOptionsHTTPVersion'
ignoreServerCertificateError:
description: Ignore server certificate error for browser tests.
type: boolean
@@ -20839,7 +20839,7 @@ components:
description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
type: string
monitor_options:
- $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions'
monitor_priority:
description: Integer from 1 (high) to 5 (low) indicating alert severity.
format: int32
@@ -20850,13 +20850,13 @@ components:
description: Prevents saving screenshots of the steps.
type: boolean
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
rumSettings:
- $ref: "#/components/schemas/SyntheticsBrowserTestRumSettings"
+ $ref: '#/components/schemas/SyntheticsBrowserTestRumSettings'
scheduling:
- $ref: "#/components/schemas/SyntheticsTestOptionsScheduling"
+ $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
tick_every:
description: The frequency at which to run the Synthetic test (in seconds).
format: int64
@@ -20884,7 +20884,7 @@ components:
description: Message to include in the escalation notification.
type: string
notification_preset_name:
- $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName"
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName'
renotify_interval:
description: |-
Time interval before renotifying if the test is still failing
@@ -20939,7 +20939,7 @@ components:
description: Array containing objects describing the scheduling pattern to apply to each day.
example: [{"day": 1, "from": "07:00", "to": "16:00"}, {"day": 3, "from": "07:00", "to": "16:00"}]
items:
- $ref: "#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe"
+ $ref: '#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe'
type: array
timezone:
description: Timezone in which the timeframe is based.
@@ -21004,16 +21004,16 @@ components:
description: Allows loading insecure content for an HTTP request in a multistep test step.
type: boolean
basicAuth:
- $ref: "#/components/schemas/SyntheticsBasicAuth"
+ $ref: '#/components/schemas/SyntheticsBasicAuth'
body:
description: Body to include in the test.
type: string
bodyType:
- $ref: "#/components/schemas/SyntheticsTestRequestBodyType"
+ $ref: '#/components/schemas/SyntheticsTestRequestBodyType'
callType:
- $ref: "#/components/schemas/SyntheticsTestCallType"
+ $ref: '#/components/schemas/SyntheticsTestCallType'
certificate:
- $ref: "#/components/schemas/SyntheticsTestRequestCertificate"
+ $ref: '#/components/schemas/SyntheticsTestRequestCertificate'
certificateDomains:
default: []
description: By default, the client certificate is applied on the domain of the starting URL for browser tests. If you want your client certificate to be applied on other domains instead, add them in `certificateDomains`.
@@ -21044,7 +21044,7 @@ components:
files:
description: Files to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`.
items:
- $ref: "#/components/schemas/SyntheticsTestRequestBodyFile"
+ $ref: '#/components/schemas/SyntheticsTestRequestBodyFile'
type: array
follow_redirects:
description: Specifies whether or not the request follows redirects.
@@ -21056,12 +21056,12 @@ components:
description: Form to be used as part of the request in the test. Only valid if `bodyType` is `multipart/form-data`.
type: object
headers:
- $ref: "#/components/schemas/SyntheticsTestHeaders"
+ $ref: '#/components/schemas/SyntheticsTestHeaders'
host:
description: Host name to perform the test with.
type: string
httpVersion:
- $ref: "#/components/schemas/SyntheticsTestOptionsHTTPVersion"
+ $ref: '#/components/schemas/SyntheticsTestOptionsHTTPVersion'
ignore_certificate_validation:
description: |-
For SSL tests, whether the test should ignore certificate validation.
@@ -21070,12 +21070,12 @@ components:
description: Whether the message is base64 encoded.
type: boolean
mcpProtocolVersion:
- $ref: "#/components/schemas/SyntheticsMCPProtocolVersion"
+ $ref: '#/components/schemas/SyntheticsMCPProtocolVersion'
message:
description: Message to send for UDP or WebSocket tests.
type: string
metadata:
- $ref: "#/components/schemas/SyntheticsTestMetadata"
+ $ref: '#/components/schemas/SyntheticsTestMetadata'
method:
description: Either the HTTP method/verb to use or a gRPC method available on the service set in the `service` field. Required if `subtype` is `HTTP` or if `subtype` is `grpc` and `callType` is `unary`.
type: string
@@ -21092,9 +21092,9 @@ components:
description: Persist cookies across redirects.
type: boolean
port:
- $ref: "#/components/schemas/SyntheticsTestRequestPort"
+ $ref: '#/components/schemas/SyntheticsTestRequestPort'
proxy:
- $ref: "#/components/schemas/SyntheticsTestRequestProxy"
+ $ref: '#/components/schemas/SyntheticsTestRequestProxy'
query:
description: Query to use for the test.
type: object
@@ -21186,9 +21186,9 @@ components:
description: Client certificate to use when performing the test request.
properties:
cert:
- $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem"
+ $ref: '#/components/schemas/SyntheticsTestRequestCertificateItem'
key:
- $ref: "#/components/schemas/SyntheticsTestRequestCertificateItem"
+ $ref: '#/components/schemas/SyntheticsTestRequestCertificateItem'
type: object
SyntheticsTestRequestCertificateItem:
description: Define a request certificate.
@@ -21206,8 +21206,8 @@ components:
SyntheticsTestRequestDNSServerPort:
description: DNS server port to use for DNS tests.
oneOf:
- - $ref: "#/components/schemas/SyntheticsTestRequestNumericalDNSServerPort"
- - $ref: "#/components/schemas/SyntheticsTestRequestVariableDNSServerPort"
+ - $ref: '#/components/schemas/SyntheticsTestRequestNumericalDNSServerPort'
+ - $ref: '#/components/schemas/SyntheticsTestRequestVariableDNSServerPort'
SyntheticsTestRequestNumericalDNSServerPort:
description: Integer DNS server port number to use when performing the test.
format: int64
@@ -21219,13 +21219,13 @@ components:
SyntheticsTestRequestPort:
description: Port to use when performing the test.
oneOf:
- - $ref: "#/components/schemas/SyntheticsTestRequestNumericalPort"
- - $ref: "#/components/schemas/SyntheticsTestRequestVariablePort"
+ - $ref: '#/components/schemas/SyntheticsTestRequestNumericalPort'
+ - $ref: '#/components/schemas/SyntheticsTestRequestVariablePort'
SyntheticsTestRequestProxy:
description: The proxy to perform the test.
properties:
headers:
- $ref: "#/components/schemas/SyntheticsTestHeaders"
+ $ref: '#/components/schemas/SyntheticsTestHeaders'
url:
description: URL of the proxy to perform the test.
example: "https://example.com"
@@ -21243,9 +21243,9 @@ components:
description: Objects describing the binding used for a mobile test.
properties:
principals:
- $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals"
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingPrincipals'
relation:
- $ref: "#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation"
+ $ref: '#/components/schemas/SyntheticsTestRestrictionPolicyBindingRelation'
type: object
SyntheticsTestRestrictionPolicyBindingPrincipals:
description: List of principals for a mobile test binding.
@@ -21272,7 +21272,7 @@ components:
format: int64
type: integer
overall:
- $ref: "#/components/schemas/SyntheticsUptime"
+ $ref: '#/components/schemas/SyntheticsUptime'
public_id:
description: A Synthetic test ID.
example: "abc-def-123"
@@ -21330,7 +21330,7 @@ components:
tests:
description: List of Synthetic tests.
items:
- $ref: "#/components/schemas/SyntheticsTriggerTest"
+ $ref: '#/components/schemas/SyntheticsTriggerTest'
type: array
required:
- tests
@@ -21350,7 +21350,7 @@ components:
description: Information about a single test run.
properties:
device:
- $ref: "#/components/schemas/SyntheticsDeviceID"
+ $ref: '#/components/schemas/SyntheticsDeviceID'
location:
description: The location ID of the test run.
format: int64
@@ -21372,12 +21372,12 @@ components:
locations:
description: List of Synthetic locations.
items:
- $ref: "#/components/schemas/SyntheticsTriggerCITestLocation"
+ $ref: '#/components/schemas/SyntheticsTriggerCITestLocation'
type: array
results:
description: Information about the tests runs.
items:
- $ref: "#/components/schemas/SyntheticsTriggerCITestRunResult"
+ $ref: '#/components/schemas/SyntheticsTriggerCITestRunResult'
type: array
triggered_check_ids:
description: The public IDs of the Synthetic test triggered.
@@ -21390,7 +21390,7 @@ components:
description: Test configuration for Synthetics
properties:
metadata:
- $ref: "#/components/schemas/SyntheticsCIBatchMetadata"
+ $ref: '#/components/schemas/SyntheticsCIBatchMetadata'
public_id:
description: The public ID of the Synthetic test to trigger.
example: aaa-aaa-aaa
@@ -21402,7 +21402,7 @@ components:
description: Object to start or pause an existing Synthetic test.
properties:
new_status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
type: object
SyntheticsUptime:
description: |-
@@ -21411,7 +21411,7 @@ components:
errors:
description: An array of error objects returned while querying the history data for the service level objective.
items:
- $ref: "#/components/schemas/SLOHistoryResponseErrorWithType"
+ $ref: '#/components/schemas/SLOHistoryResponseErrorWithType'
nullable: true
type: array
group:
@@ -21456,7 +21456,7 @@ components:
value: .*
properties:
type:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParserType"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
value:
description: Regex or JSON path used for the parser. Not used with type `raw`.
type: string
@@ -21489,31 +21489,31 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
type: string
has_search_bar:
- $ref: "#/components/schemas/TableWidgetHasSearchBar"
+ $ref: '#/components/schemas/TableWidgetHasSearchBar'
requests:
description: Widget definition.
example: ["q/apm_query/log_query": "{}"]
items:
- $ref: "#/components/schemas/TableWidgetRequest"
+ $ref: '#/components/schemas/TableWidgetRequest'
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/TableWidgetDefinitionType"
+ $ref: '#/components/schemas/TableWidgetDefinitionType'
required:
- type
- requests
@@ -21543,7 +21543,7 @@ components:
description: Updated table widget.
properties:
aggregator:
- $ref: "#/components/schemas/WidgetAggregator"
+ $ref: '#/components/schemas/WidgetAggregator'
alias:
description: The column name (defaults to the metric name).
type: string
@@ -21552,16 +21552,16 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
apm_stats_query:
- $ref: "#/components/schemas/ApmStatsQueryDefinition"
+ $ref: '#/components/schemas/ApmStatsQueryDefinition'
cell_display_mode:
description: A list of display modes for each table cell.
items:
- $ref: "#/components/schemas/TableWidgetCellDisplayMode"
+ $ref: '#/components/schemas/TableWidgetCellDisplayMode'
type: array
conditional_formats:
description: List of conditional formats.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -21570,7 +21570,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
limit:
description: For metric queries, the number of lines to show in the table. Only one request should have this property.
@@ -21585,7 +21585,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
process_query:
$ref: "#/components/schemas/ProcessQueryDefinition"
deprecated: true
@@ -21601,10 +21601,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -21614,18 +21614,18 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
text_formats:
description: List of text formats for columns produced by tags.
items:
- $ref: "#/components/schemas/TableWidgetTextFormat"
+ $ref: '#/components/schemas/TableWidgetTextFormat'
type: array
type: object
TableWidgetTextFormat:
description: Text format rules for a tag-based column within a table widget.
example: [{"match": {"type": "is", "value": "fruit"}, "replace": {"type": "all", "with": "vegetable"}}, {"match": {"type": "is", "value": "cake"}, "palette": "white_on_green"}]
items:
- $ref: "#/components/schemas/TableWidgetTextFormatRule"
+ $ref: '#/components/schemas/TableWidgetTextFormatRule'
minItems: 1
type: array
TableWidgetTextFormatMatch:
@@ -21633,7 +21633,7 @@ components:
example: {"type": "is", "value": "fruit"}
properties:
type:
- $ref: "#/components/schemas/TableWidgetTextFormatMatchType"
+ $ref: '#/components/schemas/TableWidgetTextFormatMatchType'
value:
description: Table Widget Match String.
example: "Match Value"
@@ -21692,14 +21692,14 @@ components:
description: Replace rule for the table widget text format.
example: {"type": "all", "with": "vegetable"}
oneOf:
- - $ref: "#/components/schemas/TableWidgetTextFormatReplaceAll"
- - $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstring"
+ - $ref: '#/components/schemas/TableWidgetTextFormatReplaceAll'
+ - $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstring'
TableWidgetTextFormatReplaceAll:
description: Match All definition.
example: {"type": "all", "with": "vegetable"}
properties:
type:
- $ref: "#/components/schemas/TableWidgetTextFormatReplaceAllType"
+ $ref: '#/components/schemas/TableWidgetTextFormatReplaceAllType'
with:
description: Replace All type.
example: all
@@ -21725,7 +21725,7 @@ components:
example: "string to replace"
type: string
type:
- $ref: "#/components/schemas/TableWidgetTextFormatReplaceSubstringType"
+ $ref: '#/components/schemas/TableWidgetTextFormatReplaceSubstringType'
with:
description: Text that will replace original sub-string.
example: "replacement"
@@ -21756,11 +21756,11 @@ components:
example: "#632ca6"
type: string
match:
- $ref: "#/components/schemas/TableWidgetTextFormatMatch"
+ $ref: '#/components/schemas/TableWidgetTextFormatMatch'
palette:
- $ref: "#/components/schemas/TableWidgetTextFormatPalette"
+ $ref: '#/components/schemas/TableWidgetTextFormatPalette'
replace:
- $ref: "#/components/schemas/TableWidgetTextFormatReplace"
+ $ref: '#/components/schemas/TableWidgetTextFormatReplace'
required:
- match
type: object
@@ -21798,9 +21798,9 @@ components:
description: Set a timeseries on the widget background.
properties:
type:
- $ref: "#/components/schemas/TimeseriesBackgroundType"
+ $ref: '#/components/schemas/TimeseriesBackgroundType'
yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
required:
- type
type: object
@@ -21822,11 +21822,11 @@ components:
description: If true, the value is displayed as a label relative to the data point.
type: boolean
line_type:
- $ref: "#/components/schemas/WidgetLineType"
+ $ref: '#/components/schemas/WidgetLineType'
line_width:
- $ref: "#/components/schemas/WidgetLineWidth"
+ $ref: '#/components/schemas/WidgetLineWidth'
order_by:
- $ref: "#/components/schemas/WidgetStyleOrderBy"
+ $ref: '#/components/schemas/WidgetStyleOrderBy'
palette:
description: Color palette to apply to the widget.
type: string
@@ -21837,7 +21837,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -21846,48 +21846,48 @@ components:
deprecated: true
description: List of widget events. Deprecated - Use `overlay` request type instead.
items:
- $ref: "#/components/schemas/WidgetEvent"
+ $ref: '#/components/schemas/WidgetEvent'
type: array
legend_columns:
description: Columns displayed in the legend.
items:
- $ref: "#/components/schemas/TimeseriesWidgetLegendColumn"
+ $ref: '#/components/schemas/TimeseriesWidgetLegendColumn'
type: array
legend_layout:
- $ref: "#/components/schemas/TimeseriesWidgetLegendLayout"
+ $ref: '#/components/schemas/TimeseriesWidgetLegendLayout'
legend_size:
- $ref: "#/components/schemas/WidgetLegendSize"
+ $ref: '#/components/schemas/WidgetLegendSize'
markers:
description: List of markers.
items:
- $ref: "#/components/schemas/WidgetMarker"
+ $ref: '#/components/schemas/WidgetMarker'
type: array
requests:
description: List of timeseries widget requests.
example: ["q/apm_query/log_query": "{}"]
items:
- $ref: "#/components/schemas/TimeseriesWidgetRequest"
+ $ref: '#/components/schemas/TimeseriesWidgetRequest'
minItems: 1
type: array
right_yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
show_legend:
description: (screenboard only) Show the legend for this widget.
type: boolean
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/TimeseriesWidgetDefinitionType"
+ $ref: '#/components/schemas/TimeseriesWidgetDefinitionType'
yaxis:
- $ref: "#/components/schemas/WidgetAxis"
+ $ref: '#/components/schemas/WidgetAxis'
required:
- type
- requests
@@ -21952,7 +21952,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
display_type:
- $ref: "#/components/schemas/WidgetDisplayType"
+ $ref: '#/components/schemas/WidgetDisplayType'
event_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -21960,7 +21960,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -21969,7 +21969,7 @@ components:
metadata:
description: Used to define expression aliases.
items:
- $ref: "#/components/schemas/TimeseriesWidgetExpressionAlias"
+ $ref: '#/components/schemas/TimeseriesWidgetExpressionAlias'
type: array
network_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -21993,10 +21993,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -22006,7 +22006,7 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
style:
- $ref: "#/components/schemas/TimeseriesRequestStyle"
+ $ref: '#/components/schemas/TimeseriesRequestStyle'
type: object
ToplistWidgetDefinition:
description: The top list visualization enables you to display a list of Tag value like hostname or service with the most or least of any metric value, such as highest consumers of CPU, hosts with the least disk space, etc.
@@ -22014,7 +22014,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -22023,22 +22023,22 @@ components:
description: List of top list widget requests.
example: ["q": "system.load.1"]
items:
- $ref: "#/components/schemas/ToplistWidgetRequest"
+ $ref: '#/components/schemas/ToplistWidgetRequest'
type: array
style:
- $ref: "#/components/schemas/ToplistWidgetStyle"
+ $ref: '#/components/schemas/ToplistWidgetStyle'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/ToplistWidgetDefinitionType"
+ $ref: '#/components/schemas/ToplistWidgetDefinitionType'
required:
- type
- requests
@@ -22055,13 +22055,13 @@ components:
ToplistWidgetDisplay:
description: Top list widget display options.
oneOf:
- - $ref: "#/components/schemas/ToplistWidgetStacked"
- - $ref: "#/components/schemas/ToplistWidgetFlat"
+ - $ref: '#/components/schemas/ToplistWidgetStacked'
+ - $ref: '#/components/schemas/ToplistWidgetFlat'
ToplistWidgetFlat:
description: Top list widget flat display.
properties:
type:
- $ref: "#/components/schemas/ToplistWidgetFlatType"
+ $ref: '#/components/schemas/ToplistWidgetFlatType'
required:
- type
type: object
@@ -22101,7 +22101,7 @@ components:
description: List of conditional formats.
example: [{"comparator": ">=", "palette": "blue", "value": 1.0}]
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
minItems: 1
type: array
event_query:
@@ -22111,7 +22111,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
log_query:
$ref: "#/components/schemas/LogQueryDefinition"
@@ -22136,10 +22136,10 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
rum_query:
$ref: "#/components/schemas/LogQueryDefinition"
deprecated: true
@@ -22149,9 +22149,9 @@ components:
deprecated: true
description: Deprecated - Use `queries` and `formulas` instead.
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
style:
- $ref: "#/components/schemas/WidgetRequestStyle"
+ $ref: '#/components/schemas/WidgetRequestStyle'
type: object
ToplistWidgetScaling:
description: Top list widget scaling definition.
@@ -22166,9 +22166,9 @@ components:
description: Top list widget stacked display options.
properties:
legend:
- $ref: "#/components/schemas/ToplistWidgetLegend"
+ $ref: '#/components/schemas/ToplistWidgetLegend'
type:
- $ref: "#/components/schemas/ToplistWidgetStackedType"
+ $ref: '#/components/schemas/ToplistWidgetStackedType'
required:
- type
type: object
@@ -22185,18 +22185,18 @@ components:
description: Style customization for a top list widget.
properties:
display:
- $ref: "#/components/schemas/ToplistWidgetDisplay"
+ $ref: '#/components/schemas/ToplistWidgetDisplay'
palette:
description: Color palette to apply to the widget.
type: string
scaling:
- $ref: "#/components/schemas/ToplistWidgetScaling"
+ $ref: '#/components/schemas/ToplistWidgetScaling'
type: object
TopologyMapWidgetDefinition:
description: This widget displays a topology of nodes and edges for different data sources. It replaces the service map widget.
oneOf:
- - $ref: "#/components/schemas/TopologyMapWidgetDefinitionDataStreams"
- - $ref: "#/components/schemas/TopologyMapWidgetDefinitionServiceMap"
+ - $ref: '#/components/schemas/TopologyMapWidgetDefinitionDataStreams'
+ - $ref: '#/components/schemas/TopologyMapWidgetDefinitionServiceMap'
TopologyMapWidgetDefinitionDataStreams:
additionalProperties: false
description: Topology map widget backed by the data streams data source.
@@ -22204,7 +22204,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -22212,21 +22212,21 @@ components:
requests:
description: One Topology request.
items:
- $ref: "#/components/schemas/TopologyRequestDataStreams"
+ $ref: '#/components/schemas/TopologyRequestDataStreams'
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/TopologyMapWidgetDefinitionType"
+ $ref: '#/components/schemas/TopologyMapWidgetDefinitionType'
required:
- type
- requests
@@ -22238,7 +22238,7 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
@@ -22246,21 +22246,21 @@ components:
requests:
description: One Topology request.
items:
- $ref: "#/components/schemas/TopologyRequestServiceMap"
+ $ref: '#/components/schemas/TopologyRequestServiceMap'
minItems: 1
type: array
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/TopologyMapWidgetDefinitionType"
+ $ref: '#/components/schemas/TopologyMapWidgetDefinitionType'
required:
- type
- requests
@@ -22279,7 +22279,7 @@ components:
description: Query to the data streams topology data source.
properties:
data_source:
- $ref: "#/components/schemas/TopologyQueryDataStreamsDataSource"
+ $ref: '#/components/schemas/TopologyQueryDataStreamsDataSource'
filters:
description: Your environment and primary tag (or * if enabled for your account).
example: ["env:prod", "az:us-east"]
@@ -22314,7 +22314,7 @@ components:
description: Query to the service map topology data source.
properties:
data_source:
- $ref: "#/components/schemas/TopologyQueryServiceMapDataSource"
+ $ref: '#/components/schemas/TopologyQueryServiceMapDataSource'
filters:
description: Your environment and primary tag (or * if enabled for your account).
example: ["env:prod", "az:us-east"]
@@ -22348,17 +22348,17 @@ components:
description: Request that returns nodes and edges from the data streams data source.
properties:
query:
- $ref: "#/components/schemas/TopologyQueryDataStreams"
+ $ref: '#/components/schemas/TopologyQueryDataStreams'
request_type:
- $ref: "#/components/schemas/TopologyRequestType"
+ $ref: '#/components/schemas/TopologyRequestType'
type: object
TopologyRequestServiceMap:
description: Request that returns nodes and edges from the service map data source.
properties:
query:
- $ref: "#/components/schemas/TopologyQueryServiceMap"
+ $ref: '#/components/schemas/TopologyQueryServiceMap'
request_type:
- $ref: "#/components/schemas/TopologyRequestType"
+ $ref: '#/components/schemas/TopologyRequestType'
type: object
TopologyRequestType:
description: Widget request type.
@@ -22405,34 +22405,34 @@ components:
description: The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.
properties:
color_by:
- $ref: "#/components/schemas/TreeMapColorBy"
+ $ref: '#/components/schemas/TreeMapColorBy'
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
description:
description: The description of the widget.
type: string
group_by:
- $ref: "#/components/schemas/TreeMapGroupBy"
+ $ref: '#/components/schemas/TreeMapGroupBy'
requests:
description: List of treemap widget requests.
example: [{"aggregator": "sum", "data_source": "metrics", "name": "query1", "query": "sum:system.mem.total{*} by {service}"}]
items:
- $ref: "#/components/schemas/TreeMapWidgetRequest"
+ $ref: '#/components/schemas/TreeMapWidgetRequest'
maxItems: 1
minItems: 1
type: array
size_by:
- $ref: "#/components/schemas/TreeMapSizeBy"
+ $ref: '#/components/schemas/TreeMapSizeBy'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of your widget.
type: string
type:
- $ref: "#/components/schemas/TreeMapWidgetDefinitionType"
+ $ref: '#/components/schemas/TreeMapWidgetDefinitionType'
required:
- type
- requests
@@ -22452,7 +22452,7 @@ components:
formulas:
description: List of formulas that operate on queries.
items:
- $ref: "#/components/schemas/WidgetFormula"
+ $ref: '#/components/schemas/WidgetFormula'
type: array
q:
deprecated: true
@@ -22461,14 +22461,14 @@ components:
queries:
description: List of queries that can be returned directly or used in formulas.
items:
- $ref: "#/components/schemas/FormulaAndFunctionQueryDefinition"
+ $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
type: array
response_format:
- $ref: "#/components/schemas/FormulaAndFunctionResponseFormat"
+ $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
sort:
- $ref: "#/components/schemas/WidgetSortBy"
+ $ref: '#/components/schemas/WidgetSortBy'
style:
- $ref: "#/components/schemas/WidgetRequestStyle"
+ $ref: '#/components/schemas/WidgetRequestStyle'
type: object
UsageAnalyzedLogsHour:
description: The number of analyzed logs for each hour for a given organization.
@@ -22495,13 +22495,13 @@ components:
usage:
description: Get hourly usage for analyzed logs.
items:
- $ref: "#/components/schemas/UsageAnalyzedLogsHour"
+ $ref: '#/components/schemas/UsageAnalyzedLogsHour'
type: array
type: object
UsageAttributionAggregates:
description: An array of available aggregates.
items:
- $ref: "#/components/schemas/UsageAttributionAggregatesBody"
+ $ref: '#/components/schemas/UsageAttributionAggregatesBody'
type: array
UsageAttributionAggregatesBody:
description: The object containing the aggregates.
@@ -22565,7 +22565,7 @@ components:
usage:
description: Get hourly usage for audit logs.
items:
- $ref: "#/components/schemas/UsageAuditLogsHour"
+ $ref: '#/components/schemas/UsageAuditLogsHour'
type: array
type: object
UsageBillableSummaryBody:
@@ -22646,189 +22646,189 @@ components:
format: date-time
type: string
usage:
- $ref: "#/components/schemas/UsageBillableSummaryKeys"
+ $ref: '#/components/schemas/UsageBillableSummaryKeys'
type: object
UsageBillableSummaryKeys:
description: Response with aggregated usage types.
properties:
apm_fargate_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_fargate_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_profiler_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_profiler_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
apm_trace_search_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
application_security_fargate_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
application_security_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
application_security_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_pipeline_indexed_spans_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_pipeline_maximum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_pipeline_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_test_indexed_spans_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_testing_maximum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ci_testing_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cloud_cost_management_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cloud_cost_management_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cspm_container_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cspm_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cspm_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
custom_event_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cws_container_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cws_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
cws_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
dbm_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
dbm_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
dbm_normalized_queries_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
dbm_normalized_queries_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_apm_and_profiler_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_apm_and_profiler_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_profiler_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_profiler_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
fargate_container_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
incident_management_maximum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
incident_management_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
infra_and_apm_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
infra_and_apm_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
infra_container_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
infra_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
infra_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ingested_spans_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ingested_timeseries_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
ingested_timeseries_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
iot_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
iot_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
lambda_function_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
lambda_function_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_forwarding_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_15day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_180day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_1day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_30day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_360day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_3day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_45day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_60day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_7day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_90day_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_custom_retention_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_indexed_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
logs_ingested_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
network_device_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
network_device_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
npm_flow_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
npm_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
npm_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
observability_pipeline_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
online_archive_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
prof_container_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
prof_host_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
prof_host_top99p:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
rum_lite_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
rum_replay_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
rum_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
rum_units_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
sensitive_data_scanner_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
serverless_apm_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
serverless_infra_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
serverless_infra_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
serverless_invocation_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
siem_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
standard_timeseries_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
synthetics_api_tests_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
synthetics_app_testing_maximum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
synthetics_browser_checks_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
timeseries_average:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
timeseries_sum:
- $ref: "#/components/schemas/UsageBillableSummaryBody"
+ $ref: '#/components/schemas/UsageBillableSummaryBody'
type: object
UsageBillableSummaryResponse:
description: Response with monthly summary of data billed by Datadog.
@@ -22836,7 +22836,7 @@ components:
usage:
description: An array of objects regarding usage of billable summary.
items:
- $ref: "#/components/schemas/UsageBillableSummaryHour"
+ $ref: '#/components/schemas/UsageBillableSummaryHour'
type: array
type: object
UsageCIVisibilityHour:
@@ -22880,7 +22880,7 @@ components:
usage:
description: Response containing CI visibility usage.
items:
- $ref: "#/components/schemas/UsageCIVisibilityHour"
+ $ref: '#/components/schemas/UsageCIVisibilityHour'
type: array
type: object
UsageCWSHour:
@@ -22913,7 +22913,7 @@ components:
usage:
description: Get hourly usage for Cloud Workload Security.
items:
- $ref: "#/components/schemas/UsageCWSHour"
+ $ref: '#/components/schemas/UsageCWSHour'
type: array
type: object
UsageCloudSecurityPostureManagementHour:
@@ -22971,7 +22971,7 @@ components:
usage:
description: Get hourly usage for Cloud Security Management Pro.
items:
- $ref: "#/components/schemas/UsageCloudSecurityPostureManagementHour"
+ $ref: '#/components/schemas/UsageCloudSecurityPostureManagementHour'
type: array
type: object
UsageCustomReportsAttributes:
@@ -23002,18 +23002,18 @@ components:
description: The response containing the date and type for custom reports.
properties:
attributes:
- $ref: "#/components/schemas/UsageCustomReportsAttributes"
+ $ref: '#/components/schemas/UsageCustomReportsAttributes'
id:
description: The date for specified custom reports.
type: string
type:
- $ref: "#/components/schemas/UsageReportsType"
+ $ref: '#/components/schemas/UsageReportsType'
type: object
UsageCustomReportsMeta:
description: The object containing document metadata.
properties:
page:
- $ref: "#/components/schemas/UsageCustomReportsPage"
+ $ref: '#/components/schemas/UsageCustomReportsPage'
type: object
UsageCustomReportsPage:
description: The object containing page total count.
@@ -23029,10 +23029,10 @@ components:
data:
description: An array of available custom reports.
items:
- $ref: "#/components/schemas/UsageCustomReportsData"
+ $ref: '#/components/schemas/UsageCustomReportsData'
type: array
meta:
- $ref: "#/components/schemas/UsageCustomReportsMeta"
+ $ref: '#/components/schemas/UsageCustomReportsMeta'
type: object
UsageDBMHour:
description: Database Monitoring usage for a given organization for a given hour.
@@ -23064,7 +23064,7 @@ components:
usage:
description: Get hourly usage for Database Monitoring
items:
- $ref: "#/components/schemas/UsageDBMHour"
+ $ref: '#/components/schemas/UsageDBMHour'
type: array
type: object
UsageFargateHour:
@@ -23107,7 +23107,7 @@ components:
usage:
description: Array with the number of hourly Fargate tasks recorded for a given organization.
items:
- $ref: "#/components/schemas/UsageFargateHour"
+ $ref: '#/components/schemas/UsageFargateHour'
type: array
type: object
UsageHostHour:
@@ -23219,7 +23219,7 @@ components:
usage:
description: An array of objects related to host usage.
items:
- $ref: "#/components/schemas/UsageHostHour"
+ $ref: '#/components/schemas/UsageHostHour'
type: array
type: object
UsageIncidentManagementHour:
@@ -23247,7 +23247,7 @@ components:
usage:
description: Get hourly usage for incident management.
items:
- $ref: "#/components/schemas/UsageIncidentManagementHour"
+ $ref: '#/components/schemas/UsageIncidentManagementHour'
type: array
type: object
UsageIndexedSpansHour:
@@ -23275,7 +23275,7 @@ components:
usage:
description: Array with the number of hourly traces indexed for a given organization.
items:
- $ref: "#/components/schemas/UsageIndexedSpansHour"
+ $ref: '#/components/schemas/UsageIndexedSpansHour'
type: array
type: object
UsageIngestedSpansHour:
@@ -23303,7 +23303,7 @@ components:
usage:
description: Get hourly usage for ingested spans.
items:
- $ref: "#/components/schemas/UsageIngestedSpansHour"
+ $ref: '#/components/schemas/UsageIngestedSpansHour'
type: array
type: object
UsageIoTHour:
@@ -23331,7 +23331,7 @@ components:
usage:
description: Get hourly usage for IoT.
items:
- $ref: "#/components/schemas/UsageIoTHour"
+ $ref: '#/components/schemas/UsageIoTHour'
type: array
type: object
UsageLambdaHour:
@@ -23368,7 +23368,7 @@ components:
usage:
description: Get hourly usage for Lambda.
items:
- $ref: "#/components/schemas/UsageLambdaHour"
+ $ref: '#/components/schemas/UsageLambdaHour'
type: array
type: object
UsageLogsByIndexHour:
@@ -23405,7 +23405,7 @@ components:
usage:
description: An array of objects regarding hourly usage of logs by index response.
items:
- $ref: "#/components/schemas/UsageLogsByIndexHour"
+ $ref: '#/components/schemas/UsageLogsByIndexHour'
type: array
type: object
UsageLogsByRetentionHour:
@@ -23443,7 +23443,7 @@ components:
usage:
description: Get hourly usage for indexed logs by retention period.
items:
- $ref: "#/components/schemas/UsageLogsByRetentionHour"
+ $ref: '#/components/schemas/UsageLogsByRetentionHour'
type: array
type: object
UsageLogsHour:
@@ -23506,7 +23506,7 @@ components:
usage:
description: An array of objects regarding hourly usage of logs.
items:
- $ref: "#/components/schemas/UsageLogsHour"
+ $ref: '#/components/schemas/UsageLogsHour'
type: array
type: object
UsageMetricCategory:
@@ -23543,7 +23543,7 @@ components:
usage:
description: Get hourly usage for Network Flows.
items:
- $ref: "#/components/schemas/UsageNetworkFlowsHour"
+ $ref: '#/components/schemas/UsageNetworkFlowsHour'
type: array
type: object
UsageNetworkHostsHour:
@@ -23571,7 +23571,7 @@ components:
usage:
description: Get hourly usage for NPM hosts.
items:
- $ref: "#/components/schemas/UsageNetworkHostsHour"
+ $ref: '#/components/schemas/UsageNetworkHostsHour'
type: array
type: object
UsageOnlineArchiveHour:
@@ -23599,7 +23599,7 @@ components:
usage:
description: Response containing Online Archive usage.
items:
- $ref: "#/components/schemas/UsageOnlineArchiveHour"
+ $ref: '#/components/schemas/UsageOnlineArchiveHour'
type: array
type: object
UsageProfilingHour:
@@ -23637,7 +23637,7 @@ components:
usage:
description: Get hourly usage for profiled hosts.
items:
- $ref: "#/components/schemas/UsageProfilingHour"
+ $ref: '#/components/schemas/UsageProfilingHour'
type: array
type: object
UsageReportsType:
@@ -23698,7 +23698,7 @@ components:
usage:
description: Get hourly usage for RUM sessions.
items:
- $ref: "#/components/schemas/UsageRumSessionsHour"
+ $ref: '#/components/schemas/UsageRumSessionsHour'
type: array
type: object
UsageRumUnitsHour:
@@ -23732,7 +23732,7 @@ components:
usage:
description: Get hourly usage for RUM Units.
items:
- $ref: "#/components/schemas/UsageRumUnitsHour"
+ $ref: '#/components/schemas/UsageRumUnitsHour'
type: array
type: object
UsageSDSHour:
@@ -23780,7 +23780,7 @@ components:
usage:
description: Get hourly usage for Sensitive Data Scanner.
items:
- $ref: "#/components/schemas/UsageSDSHour"
+ $ref: '#/components/schemas/UsageSDSHour'
type: array
type: object
UsageSNMPHour:
@@ -23808,7 +23808,7 @@ components:
usage:
description: Get hourly usage for SNMP devices.
items:
- $ref: "#/components/schemas/UsageSNMPHour"
+ $ref: '#/components/schemas/UsageSNMPHour'
type: array
type: object
UsageSort:
@@ -23867,18 +23867,18 @@ components:
description: Response containing date and type for specified custom reports.
properties:
attributes:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsAttributes"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsAttributes'
id:
description: The date for specified custom reports.
type: string
type:
- $ref: "#/components/schemas/UsageReportsType"
+ $ref: '#/components/schemas/UsageReportsType'
type: object
UsageSpecifiedCustomReportsMeta:
description: The object containing document metadata.
properties:
page:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsPage"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsPage'
type: object
UsageSpecifiedCustomReportsPage:
description: The object containing page total count for specified ID.
@@ -23892,9 +23892,9 @@ components:
description: Returns available specified custom reports.
properties:
data:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsData"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsData'
meta:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsMeta"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsMeta'
type: object
UsageSummaryDate:
description: |-
@@ -24761,7 +24761,7 @@ components:
orgs:
description: Organizations associated with a user.
items:
- $ref: "#/components/schemas/UsageSummaryDateOrg"
+ $ref: '#/components/schemas/UsageSummaryDateOrg'
type: array
product_analytics_sum:
description: Sum of all product analytics sessions over all hours in the current date for all organizations.
@@ -27173,7 +27173,7 @@ components:
format: int64
type: integer
logs_by_retention:
- $ref: "#/components/schemas/LogsByRetention"
+ $ref: '#/components/schemas/LogsByRetention'
metric_names_agg_sum:
description: Shows the sum of all custom metric names over all hours in the current month for all organizations.
format: int64
@@ -27637,7 +27637,7 @@ components:
usage:
description: An array of objects regarding hourly usage.
items:
- $ref: "#/components/schemas/UsageSummaryDate"
+ $ref: '#/components/schemas/UsageSummaryDate'
type: array
vsphere_host_top99p_sum:
description: Shows the 99th percentile of all vSphere hosts over all hours in the current month for all organizations.
@@ -27678,7 +27678,7 @@ components:
usage:
description: Get hourly usage for Synthetics API tests.
items:
- $ref: "#/components/schemas/UsageSyntheticsAPIHour"
+ $ref: '#/components/schemas/UsageSyntheticsAPIHour'
type: array
type: object
UsageSyntheticsBrowserHour:
@@ -27706,7 +27706,7 @@ components:
usage:
description: Get hourly usage for Synthetics Browser tests.
items:
- $ref: "#/components/schemas/UsageSyntheticsBrowserHour"
+ $ref: '#/components/schemas/UsageSyntheticsBrowserHour'
type: array
type: object
UsageSyntheticsHour:
@@ -27733,7 +27733,7 @@ components:
usage:
description: Array with the number of hourly Synthetics test run for a given organization.
items:
- $ref: "#/components/schemas/UsageSyntheticsHour"
+ $ref: '#/components/schemas/UsageSyntheticsHour'
type: array
type: object
UsageTimeseriesHour:
@@ -27768,7 +27768,7 @@ components:
usage:
description: An array of objects regarding hourly usage of timeseries.
items:
- $ref: "#/components/schemas/UsageTimeseriesHour"
+ $ref: '#/components/schemas/UsageTimeseriesHour'
type: array
type: object
UsageTopAvgMetricsHour:
@@ -27783,7 +27783,7 @@ components:
format: int64
type: integer
metric_category:
- $ref: "#/components/schemas/UsageMetricCategory"
+ $ref: '#/components/schemas/UsageMetricCategory'
metric_name:
description: Contains the custom metric name.
type: string
@@ -27800,7 +27800,7 @@ components:
format: date-time
type: string
pagination:
- $ref: "#/components/schemas/UsageTopAvgMetricsPagination"
+ $ref: '#/components/schemas/UsageTopAvgMetricsPagination'
type: object
UsageTopAvgMetricsPagination:
description: The metadata for the current pagination.
@@ -27823,18 +27823,18 @@ components:
description: Response containing the number of hourly recorded custom metrics for a given organization.
properties:
metadata:
- $ref: "#/components/schemas/UsageTopAvgMetricsMetadata"
+ $ref: '#/components/schemas/UsageTopAvgMetricsMetadata'
usage:
description: Number of hourly recorded custom metrics for a given organization.
items:
- $ref: "#/components/schemas/UsageTopAvgMetricsHour"
+ $ref: '#/components/schemas/UsageTopAvgMetricsHour'
type: array
type: object
User:
description: Create, edit, and disable users.
properties:
access_role:
- $ref: "#/components/schemas/AccessRole"
+ $ref: '#/components/schemas/AccessRole'
disabled:
description: The new disabled status of the user.
example: false
@@ -27874,16 +27874,16 @@ components:
description: Compute configuration for User Journey formula queries.
properties:
aggregation:
- $ref: "#/components/schemas/FormulaAndFunctionEventAggregation"
+ $ref: '#/components/schemas/FormulaAndFunctionEventAggregation'
interval:
description: Time bucket interval in milliseconds for time series queries.
example: 60000
format: double
type: number
metric:
- $ref: "#/components/schemas/UserJourneyFormulaComputeMetric"
+ $ref: '#/components/schemas/UserJourneyFormulaComputeMetric'
target:
- $ref: "#/components/schemas/UserJourneySearchTarget"
+ $ref: '#/components/schemas/UserJourneySearchTarget'
required:
- aggregation
type: object
@@ -27916,9 +27916,9 @@ components:
description: Whether to exclude events missing the group-by facet.
type: boolean
sort:
- $ref: "#/components/schemas/FormulaAndFunctionEventQueryGroupBySort"
+ $ref: '#/components/schemas/FormulaAndFunctionEventQueryGroupBySort'
target:
- $ref: "#/components/schemas/UserJourneySearchTarget"
+ $ref: '#/components/schemas/UserJourneySearchTarget'
required:
- facet
type: object
@@ -27947,12 +27947,12 @@ components:
example: "node_0 -> node_1"
type: string
filters:
- $ref: "#/components/schemas/UserJourneySearchFilters"
+ $ref: '#/components/schemas/UserJourneySearchFilters'
join_keys:
- $ref: "#/components/schemas/UserJourneyJoinKeys"
+ $ref: '#/components/schemas/UserJourneyJoinKeys'
node_objects:
additionalProperties:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
description: Node objects mapping.
type: object
step_aliases:
@@ -27968,7 +27968,7 @@ components:
description: Filters for user journey search.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
graph_filters:
description: Graph filters.
items:
@@ -27992,7 +27992,7 @@ components:
example: "gt"
type: string
target:
- $ref: "#/components/schemas/UserJourneySearchTarget"
+ $ref: '#/components/schemas/UserJourneySearchTarget'
value:
description: Filter value.
example: 1
@@ -28027,14 +28027,14 @@ components:
users:
description: Array of users.
items:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
type: object
UserResponse:
description: A Datadog User.
properties:
user:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: object
Version:
description: Version of the updated signal. If server side version is higher, update will be rejected.
@@ -28048,7 +28048,7 @@ components:
description: Whether the widgets on the shared dashboard should be displayed with high density.
type: boolean
theme:
- $ref: "#/components/schemas/ViewingPreferencesTheme"
+ $ref: '#/components/schemas/ViewingPreferencesTheme'
type: object
ViewingPreferencesTheme:
description: The theme of the shared dashboard view. "system" follows your system's default viewing theme.
@@ -28071,7 +28071,7 @@ components:
nullable: true
type: string
encode_as:
- $ref: "#/components/schemas/WebhooksIntegrationEncoding"
+ $ref: '#/components/schemas/WebhooksIntegrationEncoding'
name:
description: |-
The name of the webhook. It corresponds with ``.
@@ -28180,7 +28180,7 @@ components:
If given a JSON payload, these will be headers attached to your webhook.
type: string
encode_as:
- $ref: "#/components/schemas/WebhooksIntegrationEncoding"
+ $ref: '#/components/schemas/WebhooksIntegrationEncoding'
name:
description: |-
The name of the webhook. It corresponds with ``.
@@ -28211,13 +28211,13 @@ components:
- If `reflow_type` is `auto`, `layout` should not be set.
properties:
definition:
- $ref: "#/components/schemas/WidgetDefinition"
+ $ref: '#/components/schemas/WidgetDefinition'
id:
description: ID of the widget.
format: int64
type: integer
layout:
- $ref: "#/components/schemas/WidgetLayout"
+ $ref: '#/components/schemas/WidgetLayout'
required:
- definition
type: object
@@ -28314,7 +28314,7 @@ components:
description: Define a conditional format for the widget.
properties:
comparator:
- $ref: "#/components/schemas/WidgetComparator"
+ $ref: '#/components/schemas/WidgetComparator'
custom_bg_color:
description: Color palette to apply to the background, same values available as palette.
type: string
@@ -28331,7 +28331,7 @@ components:
description: Metric from the request to correlate this conditional format with.
type: string
palette:
- $ref: "#/components/schemas/WidgetPalette"
+ $ref: '#/components/schemas/WidgetPalette'
timeframe:
description: Defines the displayed timeframe.
type: string
@@ -28368,47 +28368,47 @@ components:
description: >-
[Definition of the widget](https://docs.datadoghq.com/dashboards/widgets/).
oneOf:
- - $ref: "#/components/schemas/AlertGraphWidgetDefinition"
- - $ref: "#/components/schemas/AlertValueWidgetDefinition"
- - $ref: "#/components/schemas/BarChartWidgetDefinition"
- - $ref: "#/components/schemas/ChangeWidgetDefinition"
- - $ref: "#/components/schemas/CheckStatusWidgetDefinition"
- - $ref: "#/components/schemas/CohortWidgetDefinition"
- - $ref: "#/components/schemas/DistributionWidgetDefinition"
- - $ref: "#/components/schemas/EventStreamWidgetDefinition"
- - $ref: "#/components/schemas/EventTimelineWidgetDefinition"
- - $ref: "#/components/schemas/FreeTextWidgetDefinition"
- - $ref: "#/components/schemas/FunnelWidgetDefinition"
- - $ref: "#/components/schemas/ProductAnalyticsFunnelWidgetDefinition"
- - $ref: "#/components/schemas/GeomapWidgetDefinition"
- - $ref: "#/components/schemas/GroupWidgetDefinition"
- - $ref: "#/components/schemas/HeatMapWidgetDefinition"
- - $ref: "#/components/schemas/HostMapWidgetDefinition"
- - $ref: "#/components/schemas/IFrameWidgetDefinition"
- - $ref: "#/components/schemas/ImageWidgetDefinition"
- - $ref: "#/components/schemas/ListStreamWidgetDefinition"
- - $ref: "#/components/schemas/LogStreamWidgetDefinition"
- - $ref: "#/components/schemas/MonitorSummaryWidgetDefinition"
- - $ref: "#/components/schemas/NoteWidgetDefinition"
- - $ref: "#/components/schemas/PowerpackWidgetDefinition"
- - $ref: "#/components/schemas/PointPlotWidgetDefinition"
- - $ref: "#/components/schemas/QueryValueWidgetDefinition"
- - $ref: "#/components/schemas/RetentionCurveWidgetDefinition"
- - $ref: "#/components/schemas/RunWorkflowWidgetDefinition"
- - $ref: "#/components/schemas/SLOListWidgetDefinition"
- - $ref: "#/components/schemas/SLOWidgetDefinition"
- - $ref: "#/components/schemas/ScatterPlotWidgetDefinition"
- - $ref: "#/components/schemas/SankeyWidgetDefinition"
- - $ref: "#/components/schemas/ServiceMapWidgetDefinition"
- - $ref: "#/components/schemas/ServiceSummaryWidgetDefinition"
- - $ref: "#/components/schemas/SplitGraphWidgetDefinition"
- - $ref: "#/components/schemas/SunburstWidgetDefinition"
- - $ref: "#/components/schemas/TableWidgetDefinition"
- - $ref: "#/components/schemas/TimeseriesWidgetDefinition"
- - $ref: "#/components/schemas/ToplistWidgetDefinition"
- - $ref: "#/components/schemas/TopologyMapWidgetDefinition"
- - $ref: "#/components/schemas/TreeMapWidgetDefinition"
- - $ref: "#/components/schemas/WildcardWidgetDefinition"
+ - $ref: '#/components/schemas/AlertGraphWidgetDefinition'
+ - $ref: '#/components/schemas/AlertValueWidgetDefinition'
+ - $ref: '#/components/schemas/BarChartWidgetDefinition'
+ - $ref: '#/components/schemas/ChangeWidgetDefinition'
+ - $ref: '#/components/schemas/CheckStatusWidgetDefinition'
+ - $ref: '#/components/schemas/CohortWidgetDefinition'
+ - $ref: '#/components/schemas/DistributionWidgetDefinition'
+ - $ref: '#/components/schemas/EventStreamWidgetDefinition'
+ - $ref: '#/components/schemas/EventTimelineWidgetDefinition'
+ - $ref: '#/components/schemas/FreeTextWidgetDefinition'
+ - $ref: '#/components/schemas/FunnelWidgetDefinition'
+ - $ref: '#/components/schemas/ProductAnalyticsFunnelWidgetDefinition'
+ - $ref: '#/components/schemas/GeomapWidgetDefinition'
+ - $ref: '#/components/schemas/GroupWidgetDefinition'
+ - $ref: '#/components/schemas/HeatMapWidgetDefinition'
+ - $ref: '#/components/schemas/HostMapWidgetDefinition'
+ - $ref: '#/components/schemas/IFrameWidgetDefinition'
+ - $ref: '#/components/schemas/ImageWidgetDefinition'
+ - $ref: '#/components/schemas/ListStreamWidgetDefinition'
+ - $ref: '#/components/schemas/LogStreamWidgetDefinition'
+ - $ref: '#/components/schemas/MonitorSummaryWidgetDefinition'
+ - $ref: '#/components/schemas/NoteWidgetDefinition'
+ - $ref: '#/components/schemas/PowerpackWidgetDefinition'
+ - $ref: '#/components/schemas/PointPlotWidgetDefinition'
+ - $ref: '#/components/schemas/QueryValueWidgetDefinition'
+ - $ref: '#/components/schemas/RetentionCurveWidgetDefinition'
+ - $ref: '#/components/schemas/RunWorkflowWidgetDefinition'
+ - $ref: '#/components/schemas/SLOListWidgetDefinition'
+ - $ref: '#/components/schemas/SLOWidgetDefinition'
+ - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
+ - $ref: '#/components/schemas/SankeyWidgetDefinition'
+ - $ref: '#/components/schemas/ServiceMapWidgetDefinition'
+ - $ref: '#/components/schemas/ServiceSummaryWidgetDefinition'
+ - $ref: '#/components/schemas/SplitGraphWidgetDefinition'
+ - $ref: '#/components/schemas/SunburstWidgetDefinition'
+ - $ref: '#/components/schemas/TableWidgetDefinition'
+ - $ref: '#/components/schemas/TimeseriesWidgetDefinition'
+ - $ref: '#/components/schemas/ToplistWidgetDefinition'
+ - $ref: '#/components/schemas/TopologyMapWidgetDefinition'
+ - $ref: '#/components/schemas/TreeMapWidgetDefinition'
+ - $ref: '#/components/schemas/WildcardWidgetDefinition'
WidgetDisplayType:
description: Type of display to use for the request.
enum:
@@ -28457,7 +28457,7 @@ components:
example: ""
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
required:
- column
- order
@@ -28469,24 +28469,24 @@ components:
description: Expression alias.
type: string
cell_display_mode:
- $ref: "#/components/schemas/TableWidgetCellDisplayMode"
+ $ref: '#/components/schemas/TableWidgetCellDisplayMode'
cell_display_mode_options:
- $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptions"
+ $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptions'
conditional_formats:
description: List of conditional formats.
items:
- $ref: "#/components/schemas/WidgetConditionalFormat"
+ $ref: '#/components/schemas/WidgetConditionalFormat'
type: array
formula:
description: String expression built from queries, formulas, and functions.
example: "func(a) + b"
type: string
limit:
- $ref: "#/components/schemas/WidgetFormulaLimit"
+ $ref: '#/components/schemas/WidgetFormulaLimit'
number_format:
- $ref: "#/components/schemas/WidgetNumberFormat"
+ $ref: '#/components/schemas/WidgetNumberFormat'
style:
- $ref: "#/components/schemas/WidgetFormulaStyle"
+ $ref: '#/components/schemas/WidgetFormulaStyle'
required:
- formula
type: object
@@ -28494,9 +28494,9 @@ components:
description: Cell display mode options for the widget formula. (only if `cell_display_mode` is set to `trend`).
properties:
trend_type:
- $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType"
+ $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsTrendType'
y_scale:
- $ref: "#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale"
+ $ref: '#/components/schemas/WidgetFormulaCellDisplayModeOptionsYScale'
type: object
WidgetFormulaCellDisplayModeOptionsTrendType:
description: Trend type for the cell display mode options.
@@ -28528,7 +28528,7 @@ components:
format: int64
type: integer
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
type: object
WidgetFormulaSort:
description: The formula to sort the widget by.
@@ -28540,9 +28540,9 @@ components:
minimum: 0
type: integer
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
type:
- $ref: "#/components/schemas/FormulaType"
+ $ref: '#/components/schemas/FormulaType'
required: ["type", "index", "order"]
type: object
WidgetFormulaStyle:
@@ -28566,9 +28566,9 @@ components:
example: "group_name"
type: string
order:
- $ref: "#/components/schemas/WidgetSort"
+ $ref: '#/components/schemas/WidgetSort'
type:
- $ref: "#/components/schemas/GroupType"
+ $ref: '#/components/schemas/GroupType'
required: ["type", "name", "order"]
type: object
WidgetGrouping:
@@ -28677,7 +28677,7 @@ components:
description: Whether to hide incomplete cost data in the widget.
type: boolean
live_span:
- $ref: "#/components/schemas/WidgetLiveSpan"
+ $ref: '#/components/schemas/WidgetLiveSpan'
type: object
WidgetLegendSize:
description: Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
@@ -28888,7 +28888,7 @@ components:
minimum: 0
type: integer
type:
- $ref: "#/components/schemas/WidgetNewFixedSpanType"
+ $ref: '#/components/schemas/WidgetNewFixedSpanType'
required:
- type
- from
@@ -28908,9 +28908,9 @@ components:
description: Whether to hide incomplete cost data in the widget.
type: boolean
type:
- $ref: "#/components/schemas/WidgetNewLiveSpanType"
+ $ref: '#/components/schemas/WidgetNewLiveSpanType'
unit:
- $ref: "#/components/schemas/WidgetLiveSpanUnit"
+ $ref: '#/components/schemas/WidgetLiveSpanUnit'
value:
description: Value of the time span.
example: 4
@@ -28942,9 +28942,9 @@ components:
description: Number format options for the widget.
properties:
unit:
- $ref: "#/components/schemas/NumberFormatUnit"
+ $ref: '#/components/schemas/NumberFormatUnit'
unit_scale:
- $ref: "#/components/schemas/NumberFormatUnitScale"
+ $ref: '#/components/schemas/NumberFormatUnitScale'
type: object
WidgetOrderBy:
description: What to order by.
@@ -29007,11 +29007,11 @@ components:
description: Define request widget style.
properties:
line_type:
- $ref: "#/components/schemas/WidgetLineType"
+ $ref: '#/components/schemas/WidgetLineType'
line_width:
- $ref: "#/components/schemas/WidgetLineWidth"
+ $ref: '#/components/schemas/WidgetLineWidth'
order_by:
- $ref: "#/components/schemas/WidgetStyleOrderBy"
+ $ref: '#/components/schemas/WidgetStyleOrderBy'
palette:
description: Color palette to apply to the widget.
type: string
@@ -29059,14 +29059,14 @@ components:
order_by:
description: The array of items to sort the widget by in order.
items:
- $ref: "#/components/schemas/WidgetSortOrderBy"
+ $ref: '#/components/schemas/WidgetSortOrderBy'
type: array
type: object
WidgetSortOrderBy:
description: "The item to sort the widget by."
oneOf:
- - $ref: "#/components/schemas/WidgetFormulaSort"
- - $ref: "#/components/schemas/WidgetGroupSort"
+ - $ref: '#/components/schemas/WidgetFormulaSort'
+ - $ref: '#/components/schemas/WidgetGroupSort'
WidgetStyle:
description: Widget style definition.
properties:
@@ -29124,9 +29124,9 @@ components:
WidgetTime:
description: Time setting for the widget.
oneOf:
- - $ref: "#/components/schemas/WidgetLegacyLiveSpan"
- - $ref: "#/components/schemas/WidgetNewLiveSpan"
- - $ref: "#/components/schemas/WidgetNewFixedSpan"
+ - $ref: '#/components/schemas/WidgetLegacyLiveSpan'
+ - $ref: '#/components/schemas/WidgetNewLiveSpan'
+ - $ref: '#/components/schemas/WidgetNewFixedSpan'
WidgetTimeWindows:
description: Define a time window.
enum:
@@ -29187,28 +29187,28 @@ components:
custom_links:
description: List of custom links.
items:
- $ref: "#/components/schemas/WidgetCustomLink"
+ $ref: '#/components/schemas/WidgetCustomLink'
type: array
requests:
description: List of data requests for the wildcard widget.
example: [{"formulas": ["formula": "query1"], "queries": [{"aggregator": "avg", "data_source": "metrics", "name": "query1", "query": "avg:system.cpu.user{*} by {env}"}], "response_format": "scalar"}]
items:
- $ref: "#/components/schemas/WildcardWidgetRequest"
+ $ref: '#/components/schemas/WildcardWidgetRequest'
type: array
specification:
- $ref: "#/components/schemas/WildcardWidgetSpecification"
+ $ref: '#/components/schemas/WildcardWidgetSpecification'
time:
- $ref: "#/components/schemas/WidgetTime"
+ $ref: '#/components/schemas/WidgetTime'
title:
description: Title of the widget.
type: string
title_align:
- $ref: "#/components/schemas/WidgetTextAlign"
+ $ref: '#/components/schemas/WidgetTextAlign'
title_size:
description: Size of the title.
type: string
type:
- $ref: "#/components/schemas/WildcardWidgetDefinitionType"
+ $ref: '#/components/schemas/WildcardWidgetDefinitionType'
required:
- type
- requests
@@ -29227,10 +29227,10 @@ components:
description: >-
Request object for the wildcard widget. Each variant represents a distinct data-fetching pattern: scalar formulas, timeseries formulas, list streams, and histograms.
oneOf:
- - $ref: "#/components/schemas/TreeMapWidgetRequest"
- - $ref: "#/components/schemas/TimeseriesWidgetRequest"
- - $ref: "#/components/schemas/ListStreamWidgetRequest"
- - $ref: "#/components/schemas/DistributionWidgetRequest"
+ - $ref: '#/components/schemas/TreeMapWidgetRequest'
+ - $ref: '#/components/schemas/TimeseriesWidgetRequest'
+ - $ref: '#/components/schemas/ListStreamWidgetRequest'
+ - $ref: '#/components/schemas/DistributionWidgetRequest'
WildcardWidgetSpecification:
description: >-
Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.
@@ -29240,7 +29240,7 @@ components:
example: {"$schema": "https://vega.github.io/schema/vega-lite/v5.json", "data": {"name": "table1"}, "description": "A simple bar chart", "encoding": {"x": {"field": "env", "sort": "-y", "type": "nominal"}, "y": {"field": "query1", "type": "quantitative"}}, "mark": "bar"}
type: object
type:
- $ref: "#/components/schemas/WildcardWidgetSpecificationType"
+ $ref: '#/components/schemas/WildcardWidgetSpecificationType'
required:
- type
- contents
@@ -29409,7 +29409,7 @@ paths:
- "1.2.3.4/32"
prefixes_ipv6: []
schema:
- $ref: "#/components/schemas/IPRanges"
+ $ref: '#/components/schemas/IPRanges'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29480,13 +29480,13 @@ paths:
key: abc123example456key789placeholder0
name: app_key
schema:
- $ref: "#/components/schemas/ApiKeyListResponse"
+ $ref: '#/components/schemas/ApiKeyListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29512,7 +29512,7 @@ paths:
value:
name: example key
schema:
- $ref: "#/components/schemas/ApiKey"
+ $ref: '#/components/schemas/ApiKey'
required: true
responses:
"200":
@@ -29527,19 +29527,19 @@ paths:
key: abc123example456key789placeholder0
name: app_key
schema:
- $ref: "#/components/schemas/ApiKeyResponse"
+ $ref: '#/components/schemas/ApiKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29579,25 +29579,25 @@ paths:
key: abc123example456key789placeholder0
name: app_key
schema:
- $ref: "#/components/schemas/ApiKeyResponse"
+ $ref: '#/components/schemas/ApiKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29635,19 +29635,19 @@ paths:
key: abc123example456key789placeholder0
name: app_key
schema:
- $ref: "#/components/schemas/ApiKeyResponse"
+ $ref: '#/components/schemas/ApiKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29680,7 +29680,7 @@ paths:
value:
name: example key
schema:
- $ref: "#/components/schemas/ApiKey"
+ $ref: '#/components/schemas/ApiKey'
required: true
responses:
"200":
@@ -29695,25 +29695,25 @@ paths:
key: abc123example456key789placeholder0
name: app_key
schema:
- $ref: "#/components/schemas/ApiKeyResponse"
+ $ref: '#/components/schemas/ApiKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29746,13 +29746,13 @@ paths:
name: app_key
owner: test@example.com
schema:
- $ref: "#/components/schemas/ApplicationKeyListResponse"
+ $ref: '#/components/schemas/ApplicationKeyListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29780,7 +29780,7 @@ paths:
value:
name: example key
schema:
- $ref: "#/components/schemas/ApplicationKey"
+ $ref: '#/components/schemas/ApplicationKey'
required: true
responses:
"200":
@@ -29794,25 +29794,25 @@ paths:
name: app_key
owner: test@example.com
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29852,19 +29852,19 @@ paths:
name: app_key
owner: test@example.com
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29903,19 +29903,19 @@ paths:
name: app_key
owner: test@example.com
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -29950,7 +29950,7 @@ paths:
value:
name: example key
schema:
- $ref: "#/components/schemas/ApplicationKey"
+ $ref: '#/components/schemas/ApplicationKey'
required: true
responses:
"200":
@@ -29964,31 +29964,31 @@ paths:
name: app_key
owner: test@example.com
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30024,7 +30024,7 @@ paths:
tags:
- "environment:test"
schema:
- $ref: "#/components/schemas/ServiceChecks"
+ $ref: '#/components/schemas/ServiceChecks'
description: Service Check request body.
required: true
responses:
@@ -30036,31 +30036,31 @@ paths:
value:
status: ok
schema:
- $ref: "#/components/schemas/IntakePayloadAccepted"
+ $ref: '#/components/schemas/IntakePayloadAccepted'
description: Payload accepted
"400":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"408":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Request timeout
"413":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Payload too large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30099,13 +30099,13 @@ paths:
name: sort_dir
required: false
schema:
- $ref: "#/components/schemas/UsageSortDirection"
+ $ref: '#/components/schemas/UsageSortDirection'
- description: "The field to sort by: `[computed_on, size, start_date, end_date]`."
in: query
name: sort
required: false
schema:
- $ref: "#/components/schemas/UsageSort"
+ $ref: '#/components/schemas/UsageSort'
responses:
"200":
content:
@@ -30127,19 +30127,19 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/UsageCustomReportsResponse"
+ $ref: '#/components/schemas/UsageCustomReportsResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
summary: Get the list of available daily custom reports
tags:
@@ -30186,25 +30186,25 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"404":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
summary: Get specified daily custom reports
tags:
@@ -30232,7 +30232,7 @@ paths:
json-request-body:
value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]}
schema:
- $ref: "#/components/schemas/DashboardBulkDeleteRequest"
+ $ref: '#/components/schemas/DashboardBulkDeleteRequest'
description: Delete dashboards request body.
required: true
responses:
@@ -30242,19 +30242,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Dashboards Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30327,13 +30327,13 @@ paths:
title: Example Dashboard
url: /dashboard/abc-123-def/example-dashboard
schema:
- $ref: "#/components/schemas/DashboardSummary"
+ $ref: '#/components/schemas/DashboardSummary'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30371,7 +30371,7 @@ paths:
json-request-body:
value: {"data": [{"id": "123-abc-456", "type": "dashboard"}, {"id": "789-def-101", "type": "dashboard"}]}
schema:
- $ref: "#/components/schemas/DashboardRestoreRequest"
+ $ref: '#/components/schemas/DashboardRestoreRequest'
description: Restore dashboards request body.
required: true
responses:
@@ -30381,19 +30381,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Dashboards Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30432,7 +30432,7 @@ paths:
title: CPU Usage
type: timeseries
schema:
- $ref: "#/components/schemas/Dashboard"
+ $ref: '#/components/schemas/Dashboard'
description: Create a dashboard request body.
required: true
responses:
@@ -30461,19 +30461,19 @@ paths:
type: timeseries
id: 123
schema:
- $ref: "#/components/schemas/Dashboard"
+ $ref: '#/components/schemas/Dashboard'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30515,13 +30515,13 @@ paths:
name: My Dashboard List
type: manual_dashboard_list
schema:
- $ref: "#/components/schemas/DashboardListListResponse"
+ $ref: '#/components/schemas/DashboardListListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30550,7 +30550,7 @@ paths:
value:
name: My Dashboard List
schema:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
description: Create a dashboard list request body.
required: true
responses:
@@ -30571,19 +30571,19 @@ paths:
name: My Dashboard List
type: manual_dashboard_list
schema:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30623,19 +30623,19 @@ paths:
value:
deleted_dashboard_list_id: 123
schema:
- $ref: "#/components/schemas/DashboardListDeleteResponse"
+ $ref: '#/components/schemas/DashboardListDeleteResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30682,19 +30682,19 @@ paths:
name: My Dashboard List
type: manual_dashboard_list
schema:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30731,7 +30731,7 @@ paths:
value:
name: My Dashboard List
schema:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
description: Update a dashboard list request body.
required: true
responses:
@@ -30752,25 +30752,25 @@ paths:
name: My Dashboard List
type: manual_dashboard_list
schema:
- $ref: "#/components/schemas/DashboardList"
+ $ref: '#/components/schemas/DashboardList'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30807,7 +30807,7 @@ paths:
json-request-body:
value: {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "share_type": "open"}
schema:
- $ref: "#/components/schemas/SharedDashboard"
+ $ref: '#/components/schemas/SharedDashboard'
description: Create a shared dashboard request body.
required: true
responses:
@@ -30830,25 +30830,25 @@ paths:
status: active
token: abc-123
schema:
- $ref: "#/components/schemas/SharedDashboard"
+ $ref: '#/components/schemas/SharedDashboard'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Dashboard Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30893,19 +30893,19 @@ paths:
value:
deleted_public_dashboard_token: abc-123
schema:
- $ref: "#/components/schemas/DeleteSharedDashboardResponse"
+ $ref: '#/components/schemas/DeleteSharedDashboardResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Shared Dashboard Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -30959,19 +30959,19 @@ paths:
status: active
token: abc-123
schema:
- $ref: "#/components/schemas/SharedDashboard"
+ $ref: '#/components/schemas/SharedDashboard'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Shared Dashboard Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31020,7 +31020,7 @@ paths:
json-request-body:
value: {"global_time": {"live_span": "1h"}, "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"}
schema:
- $ref: "#/components/schemas/SharedDashboardUpdateRequest"
+ $ref: '#/components/schemas/SharedDashboardUpdateRequest'
description: Update Dashboard request body.
required: true
responses:
@@ -31043,25 +31043,25 @@ paths:
status: active
token: abc-123
schema:
- $ref: "#/components/schemas/SharedDashboard"
+ $ref: '#/components/schemas/SharedDashboard'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31110,7 +31110,7 @@ paths:
json-request-body:
value: {"data": {"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}}
schema:
- $ref: "#/components/schemas/SharedDashboardInvites"
+ $ref: '#/components/schemas/SharedDashboardInvites'
description: Shared Dashboard Invitation deletion request body.
required: true
responses:
@@ -31120,13 +31120,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31188,19 +31188,19 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/SharedDashboardInvites"
+ $ref: '#/components/schemas/SharedDashboardInvites'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31241,7 +31241,7 @@ paths:
json-request-body:
value: {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
schema:
- $ref: "#/components/schemas/SharedDashboardInvites"
+ $ref: '#/components/schemas/SharedDashboardInvites'
description: Shared Dashboard Invitation request body.
required: true
responses:
@@ -31263,25 +31263,25 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/SharedDashboardInvites"
+ $ref: '#/components/schemas/SharedDashboardInvites'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31319,19 +31319,19 @@ paths:
value:
deleted_dashboard_id: abc-123
schema:
- $ref: "#/components/schemas/DashboardDeleteResponse"
+ $ref: '#/components/schemas/DashboardDeleteResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Dashboards Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31384,19 +31384,19 @@ paths:
type: timeseries
id: 123
schema:
- $ref: "#/components/schemas/Dashboard"
+ $ref: '#/components/schemas/Dashboard'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31439,7 +31439,7 @@ paths:
title: CPU Usage
type: timeseries
schema:
- $ref: "#/components/schemas/Dashboard"
+ $ref: '#/components/schemas/Dashboard'
description: Update Dashboard request body.
required: true
responses:
@@ -31468,25 +31468,25 @@ paths:
type: timeseries
id: 123
schema:
- $ref: "#/components/schemas/Dashboard"
+ $ref: '#/components/schemas/Dashboard'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31514,7 +31514,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/DistributionPointsContentEncoding"
+ $ref: '#/components/schemas/DistributionPointsContentEncoding'
requestBody:
content:
text/json:
@@ -31536,7 +31536,7 @@ paths:
x-variables:
NOW: "$(date +%s)"
schema:
- $ref: "#/components/schemas/DistributionPointsPayload"
+ $ref: '#/components/schemas/DistributionPointsPayload'
required: true
responses:
"202":
@@ -31547,31 +31547,31 @@ paths:
value:
status: ok
schema:
- $ref: "#/components/schemas/IntakePayloadAccepted"
+ $ref: '#/components/schemas/IntakePayloadAccepted'
description: Payload accepted
"400":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"408":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Request timeout
"413":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Payload too large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31618,14 +31618,14 @@ paths:
start: 1412792983
schema:
items:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
type: array
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31662,7 +31662,7 @@ paths:
start: 1412792983
timezone: America/New_York
schema:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
description: Schedule a downtime request body.
required: true
responses:
@@ -31681,19 +31681,19 @@ paths:
- env:staging
start: 1412792983
schema:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31725,7 +31725,7 @@ paths:
value:
scope: host:myserver
schema:
- $ref: "#/components/schemas/CancelDowntimesByScopeRequest"
+ $ref: '#/components/schemas/CancelDowntimesByScopeRequest'
description: Scope to cancel downtimes for.
required: true
responses:
@@ -31738,25 +31738,25 @@ paths:
cancelled_ids:
- 123
schema:
- $ref: "#/components/schemas/CanceledDowntimesIds"
+ $ref: '#/components/schemas/CanceledDowntimesIds'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtimes not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31796,13 +31796,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtime not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31849,19 +31849,19 @@ paths:
- env:staging
start: 1412792983
schema:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtime not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31908,7 +31908,7 @@ paths:
start: 1412792983
timezone: America/New_York
schema:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
description: Update a downtime request body.
required: true
responses:
@@ -31927,25 +31927,25 @@ paths:
- env:staging
start: 1412792983
schema:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtime not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -31996,7 +31996,7 @@ paths:
name: priority
required: false
schema:
- $ref: "#/components/schemas/EventPriority"
+ $ref: '#/components/schemas/EventPriority'
- description: A comma separated string of sources.
in: query
name: sources
@@ -32059,19 +32059,19 @@ paths:
url: "/event/event?id=123"
status: ok
schema:
- $ref: "#/components/schemas/EventListResponse"
+ $ref: '#/components/schemas/EventListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32105,7 +32105,7 @@ paths:
text: Oh boy!
title: Did you hear the news today?
schema:
- $ref: "#/components/schemas/EventCreateRequest"
+ $ref: '#/components/schemas/EventCreateRequest'
description: Event request object
required: true
responses:
@@ -32128,13 +32128,13 @@ paths:
url: "/event/event?id=123"
status: ok
schema:
- $ref: "#/components/schemas/EventCreateResponse"
+ $ref: '#/components/schemas/EventCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32182,19 +32182,19 @@ paths:
url: "/event/event?id=123"
status: ok
schema:
- $ref: "#/components/schemas/EventResponse"
+ $ref: '#/components/schemas/EventResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32228,13 +32228,13 @@ paths:
graph_title: Example Graph
html: ''
schema:
- $ref: "#/components/schemas/EmbeddableGraphs"
+ $ref: '#/components/schemas/EmbeddableGraphs'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32267,7 +32267,7 @@ paths:
timeframe: "1_hour"
title: "System Load Average"
schema:
- $ref: "#/components/schemas/EmbeddableGraphPayload"
+ $ref: '#/components/schemas/EmbeddableGraphPayload'
description: Embeddable Graph body
required: true
responses:
@@ -32281,19 +32281,19 @@ paths:
graph_title: Example Graph
html: ''
schema:
- $ref: "#/components/schemas/EmbeddableGraph"
+ $ref: '#/components/schemas/EmbeddableGraph'
description: Payload accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32329,19 +32329,19 @@ paths:
graph_title: Example Graph
html: ''
schema:
- $ref: "#/components/schemas/EmbeddableGraph"
+ $ref: '#/components/schemas/EmbeddableGraph'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32373,19 +32373,19 @@ paths:
value:
success: "Embed abc-123 successfully enabled."
schema:
- $ref: "#/components/schemas/EnableEmbeddableGraphResponseSchema"
+ $ref: '#/components/schemas/EnableEmbeddableGraphResponseSchema'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32418,19 +32418,19 @@ paths:
value:
success: "Embed abc-123 successfully enabled."
schema:
- $ref: "#/components/schemas/EnableEmbeddableGraphResponseSchema"
+ $ref: '#/components/schemas/EnableEmbeddableGraphResponseSchema'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32515,19 +32515,19 @@ paths:
metric_query: "avg:system.load.1{*}"
snapshot_url: https://app.datadoghq.com/s/f12345678/aaa-bbb-ccc
schema:
- $ref: "#/components/schemas/GraphSnapshot"
+ $ref: '#/components/schemas/GraphSnapshot'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32563,7 +32563,7 @@ paths:
message: Muting this host for a test!
override: false
schema:
- $ref: "#/components/schemas/HostMuteSettings"
+ $ref: '#/components/schemas/HostMuteSettings'
description: Mute a host request body.
required: true
responses:
@@ -32578,19 +32578,19 @@ paths:
hostname: test.host
message: Muting this host for a test!
schema:
- $ref: "#/components/schemas/HostMuteResponse"
+ $ref: '#/components/schemas/HostMuteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32620,19 +32620,19 @@ paths:
action: Unmuted
hostname: test.host
schema:
- $ref: "#/components/schemas/HostMuteResponse"
+ $ref: '#/components/schemas/HostMuteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32723,19 +32723,19 @@ paths:
total_matching: 1
total_returned: 1
schema:
- $ref: "#/components/schemas/HostListResponse"
+ $ref: '#/components/schemas/HostListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32776,19 +32776,19 @@ paths:
total_active: 65
total_up: 42
schema:
- $ref: "#/components/schemas/HostTotals"
+ $ref: '#/components/schemas/HostTotals'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32819,7 +32819,7 @@ paths:
account_id: "123456789012"
role_name: "DatadogAWSIntegrationRole"
schema:
- $ref: "#/components/schemas/AWSAccountDeleteRequest"
+ $ref: '#/components/schemas/AWSAccountDeleteRequest'
description: AWS request object
required: true
responses:
@@ -32836,19 +32836,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32906,19 +32906,19 @@ paths:
metrics_collection_enabled: false
role_name: "DatadogAWSIntegrationRole"
schema:
- $ref: "#/components/schemas/AWSAccountListResponse"
+ $ref: '#/components/schemas/AWSAccountListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -32960,7 +32960,7 @@ paths:
metrics_collection_enabled: false
role_name: "DatadogAWSIntegrationRole"
schema:
- $ref: "#/components/schemas/AWSAccount"
+ $ref: '#/components/schemas/AWSAccount'
description: AWS Request Object
required: true
responses:
@@ -32972,25 +32972,25 @@ paths:
value:
external_id: abc-123
schema:
- $ref: "#/components/schemas/AWSAccountCreateResponse"
+ $ref: '#/components/schemas/AWSAccountCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33052,7 +33052,7 @@ paths:
metrics_collection_enabled: false
role_name: "DatadogAWSIntegrationRole"
schema:
- $ref: "#/components/schemas/AWSAccount"
+ $ref: '#/components/schemas/AWSAccount'
description: AWS request object
required: true
responses:
@@ -33069,19 +33069,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33119,7 +33119,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33146,7 +33146,7 @@ paths:
event_generator_name: app-alerts-zyxw3210
region: us-east-1
schema:
- $ref: "#/components/schemas/AWSEventBridgeDeleteRequest"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteRequest'
description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account.
required: true
responses:
@@ -33158,19 +33158,19 @@ paths:
value:
status: empty
schema:
- $ref: "#/components/schemas/AWSEventBridgeDeleteResponse"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33204,19 +33204,19 @@ paths:
- "$KEY:$VALUE"
isInstalled: true
schema:
- $ref: "#/components/schemas/AWSEventBridgeListResponse"
+ $ref: '#/components/schemas/AWSEventBridgeListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33242,7 +33242,7 @@ paths:
event_generator_name: app-alerts
region: us-east-1
schema:
- $ref: "#/components/schemas/AWSEventBridgeCreateRequest"
+ $ref: '#/components/schemas/AWSEventBridgeCreateRequest'
description: Create an Amazon EventBridge source for an AWS account with a given name and region.
required: true
responses:
@@ -33257,19 +33257,19 @@ paths:
region: us-east-1
status: created
schema:
- $ref: "#/components/schemas/AWSEventBridgeCreateResponse"
+ $ref: '#/components/schemas/AWSEventBridgeCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33296,7 +33296,7 @@ paths:
account_id: "FAKEAC0FAKEAC2FAKEAC"
namespace: elb
schema:
- $ref: "#/components/schemas/AWSTagFilterDeleteRequest"
+ $ref: '#/components/schemas/AWSTagFilterDeleteRequest'
description: Delete a tag filtering entry for a given AWS account and `dd-aws` namespace.
required: true
responses:
@@ -33314,13 +33314,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33355,19 +33355,19 @@ paths:
- namespace: elb
tag_filter_str: "prod*"
schema:
- $ref: "#/components/schemas/AWSTagFilterListResponse"
+ $ref: '#/components/schemas/AWSTagFilterListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33393,7 +33393,7 @@ paths:
namespace: elb
tag_filter_str: "prod*"
schema:
- $ref: "#/components/schemas/AWSTagFilterCreateRequest"
+ $ref: '#/components/schemas/AWSTagFilterCreateRequest'
description: |-
Set an AWS tag filter using an `aws_account_identifier`, `namespace`, and filtering string.
Namespace options are `application_elb`, `elb`, `lambda`, `network_elb`, `rds`, `sqs`, and `custom`.
@@ -33413,13 +33413,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33446,7 +33446,7 @@ paths:
account_id: "123456789012"
role_name: "DatadogAWSIntegrationRole"
schema:
- $ref: "#/components/schemas/AWSAccount"
+ $ref: '#/components/schemas/AWSAccount'
description: |-
Your Datadog role delegation name.
For more information about your AWS account Role name,
@@ -33461,19 +33461,19 @@ paths:
value:
external_id: abc-123
schema:
- $ref: "#/components/schemas/AWSAccountCreateResponse"
+ $ref: '#/components/schemas/AWSAccountCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33501,7 +33501,7 @@ paths:
account_id: "1234567"
lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"
schema:
- $ref: "#/components/schemas/AWSAccountAndLambdaRequest"
+ $ref: '#/components/schemas/AWSAccountAndLambdaRequest'
description: Delete AWS Lambda ARN request body.
required: true
responses:
@@ -33518,13 +33518,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33562,20 +33562,20 @@ paths:
schema:
example: [{"account_id": "123456789101", "lambdas": [], "services": ["s3", "elb", "elbv2", "cloudfront", "redshift", "lambda"]}]
items:
- $ref: "#/components/schemas/AWSLogsListResponse"
+ $ref: '#/components/schemas/AWSLogsListResponse'
type: array
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33601,7 +33601,7 @@ paths:
account_id: "1234567"
lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"
schema:
- $ref: "#/components/schemas/AWSAccountAndLambdaRequest"
+ $ref: '#/components/schemas/AWSAccountAndLambdaRequest'
description: AWS Log Lambda Async request body.
required: true
responses:
@@ -33618,13 +33618,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33660,7 +33660,7 @@ paths:
account_id: "1234567"
lambda_arn: "arn:aws:lambda:us-east-1:1234567:function:LogsCollectionAPITest"
schema:
- $ref: "#/components/schemas/AWSAccountAndLambdaRequest"
+ $ref: '#/components/schemas/AWSAccountAndLambdaRequest'
description: Check AWS Log Lambda Async request body.
required: true
responses:
@@ -33673,19 +33673,19 @@ paths:
errors: []
status: created
schema:
- $ref: "#/components/schemas/AWSLogsAsyncResponse"
+ $ref: '#/components/schemas/AWSLogsAsyncResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33719,14 +33719,14 @@ paths:
schema:
example: [{"id": "s3", "label": "S3 Access Logs"}, {"id": "elb", "label": "Classic ELB Access Logs"}, {"id": "elbv2", "label": "Application ELB Access Logs"}, {"id": "cloudfront", "label": "CloudFront Access Logs"}, {"id": "redshift", "label": "Redshift Logs"}, {"id": "lambda", "label": "Lambda Cloudwatch Logs"}]
items:
- $ref: "#/components/schemas/AWSLogsListServicesResponse"
+ $ref: '#/components/schemas/AWSLogsListServicesResponse'
type: array
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33758,7 +33758,7 @@ paths:
- redshift
- lambda
schema:
- $ref: "#/components/schemas/AWSLogsServicesRequest"
+ $ref: '#/components/schemas/AWSLogsServicesRequest'
description: Enable AWS Log Services request body.
required: true
responses:
@@ -33775,13 +33775,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33824,7 +33824,7 @@ paths:
- redshift
- lambda
schema:
- $ref: "#/components/schemas/AWSLogsServicesRequest"
+ $ref: '#/components/schemas/AWSLogsServicesRequest'
description: Check AWS Logs Async Services request body.
required: true
responses:
@@ -33837,19 +33837,19 @@ paths:
errors: []
status: created
schema:
- $ref: "#/components/schemas/AWSLogsAsyncResponse"
+ $ref: '#/components/schemas/AWSLogsAsyncResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33877,7 +33877,7 @@ paths:
client_id: "testc7f6-1234-5678-9101-3fcbf464test"
tenant_name: "testc44-1234-5678-9101-cc00736ftest"
schema:
- $ref: "#/components/schemas/AzureAccount"
+ $ref: '#/components/schemas/AzureAccount'
description: Delete a given Datadog-Azure integration request body.
required: true
responses:
@@ -33895,13 +33895,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33930,19 +33930,19 @@ paths:
host_filters: "key:value,filter:example"
tenant_name: testc44-1234-5678-9101-cc00736ftest
schema:
- $ref: "#/components/schemas/AzureAccountListResponse"
+ $ref: '#/components/schemas/AzureAccountListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -33982,7 +33982,7 @@ paths:
resource_collection_enabled: true
tenant_name: "testc44-1234-5678-9101-cc00736ftest"
schema:
- $ref: "#/components/schemas/AzureAccount"
+ $ref: '#/components/schemas/AzureAccount'
description: Create a Datadog-Azure integration for your Datadog account request body.
required: true
responses:
@@ -34000,13 +34000,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34042,7 +34042,7 @@ paths:
resource_collection_enabled: true
tenant_name: "testc44-1234-5678-9101-cc00736ftest"
schema:
- $ref: "#/components/schemas/AzureAccount"
+ $ref: '#/components/schemas/AzureAccount'
description: Update a Datadog-Azure integration request body.
required: true
responses:
@@ -34060,13 +34060,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34094,7 +34094,7 @@ paths:
host_filters: "key:value,filter:example"
tenant_name: "testc44-1234-5678-9101-cc00736ftest"
schema:
- $ref: "#/components/schemas/AzureAccount"
+ $ref: '#/components/schemas/AzureAccount'
description: Update a Datadog-Azure integration's host filters request body.
required: true
responses:
@@ -34112,13 +34112,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34147,7 +34147,7 @@ paths:
client_id: "123456712345671234567"
project_id: "datadog-apitest"
schema:
- $ref: "#/components/schemas/GCPAccount"
+ $ref: '#/components/schemas/GCPAccount'
description: Delete a given Datadog-GCP integration.
required: true
responses:
@@ -34165,13 +34165,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34202,19 +34202,19 @@ paths:
project_id: datadog-apitest
type: service_account
schema:
- $ref: "#/components/schemas/GCPAccountListResponse"
+ $ref: '#/components/schemas/GCPAccountListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34251,7 +34251,7 @@ paths:
token_uri: "https://accounts.google.com/o/oauth2/token"
type: "service_account"
schema:
- $ref: "#/components/schemas/GCPAccount"
+ $ref: '#/components/schemas/GCPAccount'
description: Create a Datadog-GCP integration.
required: true
responses:
@@ -34269,13 +34269,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34309,7 +34309,7 @@ paths:
project_id: "datadog-apitest"
resource_collection_enabled: true
schema:
- $ref: "#/components/schemas/GCPAccount"
+ $ref: '#/components/schemas/GCPAccount'
description: Update a Datadog-GCP integration.
required: true
responses:
@@ -34327,13 +34327,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34359,7 +34359,7 @@ paths:
service_key: "your-pagerduty-service-key"
service_name: "my-pagerduty-service"
schema:
- $ref: "#/components/schemas/PagerDutyService"
+ $ref: '#/components/schemas/PagerDutyService'
description: Create a new service object request body.
required: true
responses:
@@ -34371,19 +34371,19 @@ paths:
value:
service_name: test-service
schema:
- $ref: "#/components/schemas/PagerDutyServiceName"
+ $ref: '#/components/schemas/PagerDutyServiceName'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34414,13 +34414,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34452,19 +34452,19 @@ paths:
value:
service_name: test-service
schema:
- $ref: "#/components/schemas/PagerDutyServiceName"
+ $ref: '#/components/schemas/PagerDutyServiceName'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34494,7 +34494,7 @@ paths:
value:
service_key: "updated-pagerduty-service-key"
schema:
- $ref: "#/components/schemas/PagerDutyServiceKey"
+ $ref: '#/components/schemas/PagerDutyServiceKey'
description: Update an existing service object request body.
required: true
responses:
@@ -34504,19 +34504,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34541,7 +34541,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34570,19 +34570,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34609,7 +34609,7 @@ paths:
- account: Main_Account
url: "https://hooks.slack.com/services/1/1/1"
schema:
- $ref: "#/components/schemas/SlackIntegration"
+ $ref: '#/components/schemas/SlackIntegration'
description: Create Datadog-Slack integration request body.
required: true
responses:
@@ -34619,13 +34619,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34655,7 +34655,7 @@ paths:
channel_name: "#channel_name_main_account"
transfer_all_user_comments: false
schema:
- $ref: "#/components/schemas/SlackChannels"
+ $ref: '#/components/schemas/SlackChannels'
description: Update an existing Datadog-Slack integration request body.
required: true
responses:
@@ -34665,13 +34665,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34701,25 +34701,25 @@ paths:
tags: true
name: "#test-channel"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannels"
+ $ref: '#/components/schemas/SlackIntegrationChannels'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34750,7 +34750,7 @@ paths:
tags: true
name: "#general"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
description: Payload describing Slack channel to be created
required: true
responses:
@@ -34768,25 +34768,25 @@ paths:
tags: true
name: "#test-channel"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34813,19 +34813,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34858,25 +34858,25 @@ paths:
tags: true
name: "#test-channel"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34908,7 +34908,7 @@ paths:
tags: true
name: "#general"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
description: Payload describing fields and values to be updated.
required: true
responses:
@@ -34926,25 +34926,25 @@ paths:
tags: true
name: "#test-channel"
schema:
- $ref: "#/components/schemas/SlackIntegrationChannel"
+ $ref: '#/components/schemas/SlackIntegrationChannel'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -34971,7 +34971,7 @@ paths:
name: CUSTOM_VARIABLE_NAME
value: CUSTOM_VARIABLE_VALUE
schema:
- $ref: "#/components/schemas/WebhooksIntegrationCustomVariable"
+ $ref: '#/components/schemas/WebhooksIntegrationCustomVariable'
description: Define a custom variable request body.
required: true
responses:
@@ -34984,19 +34984,19 @@ paths:
is_secret: true
name: CUSTOM_VARIABLE_NAME
schema:
- $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse"
+ $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35027,13 +35027,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35069,25 +35069,25 @@ paths:
is_secret: true
name: CUSTOM_VARIABLE_NAME
schema:
- $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse"
+ $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35119,7 +35119,7 @@ paths:
name: CUSTOM_VARIABLE_NAME
value: CUSTOM_VARIABLE_VALUE
schema:
- $ref: "#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest"
+ $ref: '#/components/schemas/WebhooksIntegrationCustomVariableUpdateRequest'
description: Update an existing custom variable request body.
required: true
responses:
@@ -35132,25 +35132,25 @@ paths:
is_secret: true
name: CUSTOM_VARIABLE_NAME
schema:
- $ref: "#/components/schemas/WebhooksIntegrationCustomVariableResponse"
+ $ref: '#/components/schemas/WebhooksIntegrationCustomVariableResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35177,7 +35177,7 @@ paths:
name: WEBHOOK_NAME
url: https://example.com/webhook
schema:
- $ref: "#/components/schemas/WebhooksIntegration"
+ $ref: '#/components/schemas/WebhooksIntegration'
description: Create a webhooks integration request body.
required: true
responses:
@@ -35191,19 +35191,19 @@ paths:
name: WEBHOOK_NAME
url: https://example.com/webhook
schema:
- $ref: "#/components/schemas/WebhooksIntegration"
+ $ref: '#/components/schemas/WebhooksIntegration'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35239,13 +35239,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35278,25 +35278,25 @@ paths:
name: WEBHOOK_NAME
url: https://example.com/webhook
schema:
- $ref: "#/components/schemas/WebhooksIntegration"
+ $ref: '#/components/schemas/WebhooksIntegration'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35328,7 +35328,7 @@ paths:
name: WEBHOOK_NAME
url: https://example.com/webhook
schema:
- $ref: "#/components/schemas/WebhooksIntegrationUpdateRequest"
+ $ref: '#/components/schemas/WebhooksIntegrationUpdateRequest'
description: Update an existing Datadog-Webhooks integration.
required: true
responses:
@@ -35342,25 +35342,25 @@ paths:
name: WEBHOOK_NAME
url: https://example.com/webhook
schema:
- $ref: "#/components/schemas/WebhooksIntegration"
+ $ref: '#/components/schemas/WebhooksIntegration'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35402,7 +35402,7 @@ paths:
from: "2020-02-02T02:02:02.202Z"
to: "2020-02-20T02:02:02.202Z"
schema:
- $ref: "#/components/schemas/LogsListRequest"
+ $ref: '#/components/schemas/LogsListRequest'
description: Logs filter
required: true
responses:
@@ -35424,19 +35424,19 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
status: done
schema:
- $ref: "#/components/schemas/LogsListResponse"
+ $ref: '#/components/schemas/LogsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35470,13 +35470,13 @@ paths:
- payments
- web
schema:
- $ref: "#/components/schemas/LogsIndexesOrder"
+ $ref: '#/components/schemas/LogsIndexesOrder'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35504,7 +35504,7 @@ paths:
- payments
- web
schema:
- $ref: "#/components/schemas/LogsIndexesOrder"
+ $ref: '#/components/schemas/LogsIndexesOrder'
description: Object containing the new ordered list of index names
required: true
responses:
@@ -35519,19 +35519,19 @@ paths:
- payments
- web
schema:
- $ref: "#/components/schemas/LogsIndexesOrder"
+ $ref: '#/components/schemas/LogsIndexesOrder'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35565,13 +35565,13 @@ paths:
name: main
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndexListResponse"
+ $ref: '#/components/schemas/LogsIndexListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35606,7 +35606,7 @@ paths:
name: main
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndex"
+ $ref: '#/components/schemas/LogsIndex'
description: Object containing the new index.
required: true
responses:
@@ -35623,25 +35623,25 @@ paths:
name: main
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndex"
+ $ref: '#/components/schemas/LogsIndex'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPILimitReachedResponse"
+ $ref: '#/components/schemas/LogsAPILimitReachedResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35674,13 +35674,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35717,19 +35717,19 @@ paths:
name: main
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndex"
+ $ref: '#/components/schemas/LogsIndex'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35775,7 +35775,7 @@ paths:
query: source:python
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndexUpdateRequest"
+ $ref: '#/components/schemas/LogsIndexUpdateRequest'
description: Object containing the new `LogsIndexUpdateRequest`.
required: true
responses:
@@ -35792,25 +35792,25 @@ paths:
name: main
num_retention_days: 15
schema:
- $ref: "#/components/schemas/LogsIndex"
+ $ref: '#/components/schemas/LogsIndex'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Invalid Parameter Error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Too Many Requests
summary: Update an index
tags:
@@ -35835,13 +35835,13 @@ paths:
- org_ids
- products
schema:
- $ref: "#/components/schemas/LogsPipelinesOrder"
+ $ref: '#/components/schemas/LogsPipelinesOrder'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35872,7 +35872,7 @@ paths:
- org_ids
- products
schema:
- $ref: "#/components/schemas/LogsPipelinesOrder"
+ $ref: '#/components/schemas/LogsPipelinesOrder'
description: Object containing the new ordered list of pipeline IDs.
required: true
responses:
@@ -35887,25 +35887,25 @@ paths:
- org_ids
- products
schema:
- $ref: "#/components/schemas/LogsPipelinesOrder"
+ $ref: '#/components/schemas/LogsPipelinesOrder'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35939,13 +35939,13 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipelineList"
+ $ref: '#/components/schemas/LogsPipelineList'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -35972,7 +35972,7 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
description: Definition of the new pipeline.
required: true
responses:
@@ -35990,19 +35990,19 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36035,13 +36035,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36080,19 +36080,19 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36130,7 +36130,7 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
description: New definition of the pipeline.
required: true
responses:
@@ -36148,19 +36148,19 @@ paths:
name: My Pipeline
processors: []
schema:
- $ref: "#/components/schemas/LogsPipeline"
+ $ref: '#/components/schemas/LogsPipeline'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/LogsAPIErrorResponse"
+ $ref: '#/components/schemas/LogsAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36214,19 +36214,19 @@ paths:
- system.cpu.idle
- system.load.1
schema:
- $ref: "#/components/schemas/MetricsListResponse"
+ $ref: '#/components/schemas/MetricsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36266,19 +36266,19 @@ paths:
type: count
unit: byte
schema:
- $ref: "#/components/schemas/MetricMetadata"
+ $ref: '#/components/schemas/MetricMetadata'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36317,7 +36317,7 @@ paths:
type: count
unit: byte
schema:
- $ref: "#/components/schemas/MetricMetadata"
+ $ref: '#/components/schemas/MetricMetadata'
description: New metadata.
required: true
responses:
@@ -36332,25 +36332,25 @@ paths:
type: count
unit: byte
schema:
- $ref: "#/components/schemas/MetricMetadata"
+ $ref: '#/components/schemas/MetricMetadata'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36454,20 +36454,20 @@ paths:
schema:
description: An array of monitor objects.
items:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
type: array
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36743,7 +36743,7 @@ paths:
- "frontend"
type: "query alert"
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: Create a monitor request body.
required: true
responses:
@@ -36765,19 +36765,19 @@ paths:
- frontend
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36824,25 +36824,25 @@ paths:
- 123
errors:
schema:
- $ref: "#/components/schemas/CheckCanDeleteMonitorResponse"
+ $ref: '#/components/schemas/CheckCanDeleteMonitorResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/CheckCanDeleteMonitorResponse"
+ $ref: '#/components/schemas/CheckCanDeleteMonitorResponse'
description: Deletion conflict error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -36932,19 +36932,19 @@ paths:
per_page: 30
total_count: 1
schema:
- $ref: "#/components/schemas/MonitorGroupSearchResponse"
+ $ref: '#/components/schemas/MonitorGroupSearchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37034,19 +37034,19 @@ paths:
status: No Data
type: query alert
schema:
- $ref: "#/components/schemas/MonitorSearchResponse"
+ $ref: '#/components/schemas/MonitorSearchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37087,7 +37087,7 @@ paths:
- "frontend"
type: "query alert"
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: Monitor request object
required: true
responses:
@@ -37105,13 +37105,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid JSON
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37158,31 +37158,31 @@ paths:
value:
deleted_monitor_id: 123
schema:
- $ref: "#/components/schemas/DeletedMonitor"
+ $ref: '#/components/schemas/DeletedMonitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Item not found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37244,25 +37244,25 @@ paths:
- "app:webserver"
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37309,7 +37309,7 @@ paths:
- "frontend"
type: "query alert"
schema:
- $ref: "#/components/schemas/MonitorUpdateRequest"
+ $ref: '#/components/schemas/MonitorUpdateRequest'
description: Edit a monitor request body.
required: true
responses:
@@ -37327,31 +37327,31 @@ paths:
- "app:webserver"
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37400,20 +37400,20 @@ paths:
start: 1412792983
schema:
items:
- $ref: "#/components/schemas/Downtime"
+ $ref: '#/components/schemas/Downtime'
type: array
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37479,25 +37479,25 @@ paths:
- env:prod
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37563,25 +37563,25 @@ paths:
- env:prod
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37632,7 +37632,7 @@ paths:
- "frontend"
type: "query alert"
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: Monitor request object
required: true
responses:
@@ -37650,13 +37650,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid JSON
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -37702,13 +37702,13 @@ paths:
name: sort_dir
required: false
schema:
- $ref: "#/components/schemas/UsageSortDirection"
+ $ref: '#/components/schemas/UsageSortDirection'
- description: "The field to sort by: `[computed_on, size, start_date, end_date]`."
in: query
name: sort
required: false
schema:
- $ref: "#/components/schemas/UsageSort"
+ $ref: '#/components/schemas/UsageSort'
responses:
"200":
content:
@@ -37730,19 +37730,19 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/UsageCustomReportsResponse"
+ $ref: '#/components/schemas/UsageCustomReportsResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
summary: Get the list of available monthly custom reports
tags:
@@ -37789,31 +37789,31 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/UsageSpecifiedCustomReportsResponse"
+ $ref: '#/components/schemas/UsageSpecifiedCustomReportsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"404":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
summary: Get specified monthly custom reports
tags:
@@ -37937,19 +37937,19 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/NotebooksResponse"
+ $ref: '#/components/schemas/NotebooksResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38008,7 +38008,7 @@ paths:
json-request-body:
value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "line", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "dog_classic"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}}
schema:
- $ref: "#/components/schemas/NotebookCreateRequest"
+ $ref: '#/components/schemas/NotebookCreateRequest'
description: The JSON description of the notebook you want to create.
required: true
responses:
@@ -38035,19 +38035,19 @@ paths:
id: 123456
type: notebooks
schema:
- $ref: "#/components/schemas/NotebookResponse"
+ $ref: '#/components/schemas/NotebookResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38079,19 +38079,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38139,25 +38139,25 @@ paths:
id: 123
type: notebooks
schema:
- $ref: "#/components/schemas/NotebookResponse"
+ $ref: '#/components/schemas/NotebookResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38221,7 +38221,7 @@ paths:
json-request-body:
value: {"data": {"attributes": {"cells": [{"attributes": {"definition": {"text": "## Some updated test markdown\n\nWith some example content.", "type": "markdown"}}, "type": "notebook_cells"}, {"attributes": {"definition": {"requests": [{"display_type": "bars", "q": "avg:system.load.1{*}", "style": {"line_type": "solid", "line_width": "normal", "palette": "warm"}}], "show_legend": true, "type": "timeseries", "yaxis": {"scale": "linear"}}, "graph_size": "m", "split_by": {"keys": [], "tags": []}, "time": null}, "id": "abcd1234", "type": "notebook_cells"}], "name": "Example Notebook", "time": {"live_span": "1h"}}, "type": "notebooks"}}
schema:
- $ref: "#/components/schemas/NotebookUpdateRequest"
+ $ref: '#/components/schemas/NotebookUpdateRequest'
description: Update notebook request body.
required: true
responses:
@@ -38248,31 +38248,31 @@ paths:
id: 123456
type: notebooks
schema:
- $ref: "#/components/schemas/NotebookResponse"
+ $ref: '#/components/schemas/NotebookResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38301,13 +38301,13 @@ paths:
name: Example Org
public_id: abc-123
schema:
- $ref: "#/components/schemas/OrganizationListResponse"
+ $ref: '#/components/schemas/OrganizationListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38344,7 +38344,7 @@ paths:
subscription:
type: pro
schema:
- $ref: "#/components/schemas/OrganizationCreateBody"
+ $ref: '#/components/schemas/OrganizationCreateBody'
description: Organization object that needs to be created
required: true
responses:
@@ -38363,19 +38363,19 @@ paths:
handle: test@example.com
name: Example Name
schema:
- $ref: "#/components/schemas/OrganizationCreateResponse"
+ $ref: '#/components/schemas/OrganizationCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38412,19 +38412,19 @@ paths:
name: Example Org
public_id: abc-123
schema:
- $ref: "#/components/schemas/OrganizationResponse"
+ $ref: '#/components/schemas/OrganizationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38460,7 +38460,7 @@ paths:
saml_strict_mode:
enabled: false
schema:
- $ref: "#/components/schemas/Organization"
+ $ref: '#/components/schemas/Organization'
required: true
responses:
"200":
@@ -38474,19 +38474,19 @@ paths:
name: Example Org
public_id: abc-123
schema:
- $ref: "#/components/schemas/OrganizationResponse"
+ $ref: '#/components/schemas/OrganizationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38516,19 +38516,19 @@ paths:
value:
message: "Child organization abc-123 downgraded successfully"
schema:
- $ref: "#/components/schemas/OrgDowngradedResponse"
+ $ref: '#/components/schemas/OrgDowngradedResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38562,7 +38562,7 @@ paths:
value:
idp_file: "@/path/to/idp_metadata.xml"
schema:
- $ref: "#/components/schemas/IdpFormData"
+ $ref: '#/components/schemas/IdpFormData'
required: true
responses:
"200":
@@ -38573,25 +38573,25 @@ paths:
value:
message: IdP metadata successfully uploaded for example org
schema:
- $ref: "#/components/schemas/IdpResponse"
+ $ref: '#/components/schemas/IdpResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"415":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unsupported Media Type
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38647,19 +38647,19 @@ paths:
scope: "*"
status: ok
schema:
- $ref: "#/components/schemas/MetricsQueryResponse"
+ $ref: '#/components/schemas/MetricsQueryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38703,19 +38703,19 @@ paths:
- system.cpu.idle
- system.load.1
schema:
- $ref: "#/components/schemas/MetricSearchResponse"
+ $ref: '#/components/schemas/MetricSearchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38748,7 +38748,7 @@ paths:
incident_id: 2066
version: 0
schema:
- $ref: "#/components/schemas/AddSignalToIncidentRequest"
+ $ref: '#/components/schemas/AddSignalToIncidentRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -38760,25 +38760,25 @@ paths:
value:
status: updated
schema:
- $ref: "#/components/schemas/SuccessfulSignalUpdateResponse"
+ $ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38807,7 +38807,7 @@ paths:
assignee: "773b045d-ccf8-4808-bd3b-955ef6a8c940"
version: 0
schema:
- $ref: "#/components/schemas/SignalAssigneeUpdateRequest"
+ $ref: '#/components/schemas/SignalAssigneeUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -38819,25 +38819,25 @@ paths:
value:
status: updated
schema:
- $ref: "#/components/schemas/SuccessfulSignalUpdateResponse"
+ $ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38867,7 +38867,7 @@ paths:
state: open
version: 0
schema:
- $ref: "#/components/schemas/SignalStateUpdateRequest"
+ $ref: '#/components/schemas/SignalStateUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -38879,25 +38879,25 @@ paths:
value:
status: updated
schema:
- $ref: "#/components/schemas/SuccessfulSignalUpdateResponse"
+ $ref: '#/components/schemas/SuccessfulSignalUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -38930,7 +38930,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/MetricContentEncoding"
+ $ref: '#/components/schemas/MetricContentEncoding'
requestBody:
content:
text/json:
@@ -38952,7 +38952,7 @@ paths:
x-variables:
NOW: $(date +%s)
schema:
- $ref: "#/components/schemas/MetricsPayload"
+ $ref: '#/components/schemas/MetricsPayload'
required: true
responses:
"202":
@@ -38963,31 +38963,31 @@ paths:
value:
status: ok
schema:
- $ref: "#/components/schemas/IntakePayloadAccepted"
+ $ref: '#/components/schemas/IntakePayloadAccepted'
description: Payload accepted
"400":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"408":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Request timeout
"413":
content:
text/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Payload too large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39049,19 +39049,19 @@ paths:
- service-b
- service-c
schema:
- $ref: "#/components/schemas/ServiceDependencies"
+ $ref: '#/components/schemas/ServiceDependencies'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39130,19 +39130,19 @@ paths:
- service-c
name: test-service
schema:
- $ref: "#/components/schemas/SingleServiceDependencies"
+ $ref: '#/components/schemas/SingleServiceDependencies'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39236,25 +39236,25 @@ paths:
type: metric
errors: []
schema:
- $ref: "#/components/schemas/SLOListResponse"
+ $ref: '#/components/schemas/SLOListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39300,7 +39300,7 @@ paths:
warning: 97
type: metric
schema:
- $ref: "#/components/schemas/ServiceLevelObjectiveRequest"
+ $ref: '#/components/schemas/ServiceLevelObjectiveRequest'
description: Service level objective request object.
required: true
responses:
@@ -39324,19 +39324,19 @@ paths:
type: metric
errors: []
schema:
- $ref: "#/components/schemas/SLOListResponse"
+ $ref: '#/components/schemas/SLOListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39376,7 +39376,7 @@ paths:
- "7d"
- "30d"
schema:
- $ref: "#/components/schemas/SLOBulkDelete"
+ $ref: '#/components/schemas/SLOBulkDelete'
description: Delete multiple service level objective objects request body.
required: true
responses:
@@ -39392,19 +39392,19 @@ paths:
- abc-123
errors: []
schema:
- $ref: "#/components/schemas/SLOBulkDeleteResponse"
+ $ref: '#/components/schemas/SLOBulkDeleteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39449,25 +39449,25 @@ paths:
- abc-123
errors: {}
schema:
- $ref: "#/components/schemas/CheckCanDeleteSLOResponse"
+ $ref: '#/components/schemas/CheckCanDeleteSLOResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/CheckCanDeleteSLOResponse"
+ $ref: '#/components/schemas/CheckCanDeleteSLOResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39524,13 +39524,13 @@ paths:
id: abc-123
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionListResponse"
+ $ref: '#/components/schemas/SLOCorrectionListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39583,7 +39583,7 @@ paths:
timezone: UTC
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionCreateRequest"
+ $ref: '#/components/schemas/SLOCorrectionCreateRequest'
description: Create an SLO Correction
required: true
responses:
@@ -39603,25 +39603,25 @@ paths:
id: abc-123
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionResponse"
+ $ref: '#/components/schemas/SLOCorrectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: SLO Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39658,13 +39658,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39700,19 +39700,19 @@ paths:
id: abc-123
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionResponse"
+ $ref: '#/components/schemas/SLOCorrectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39756,7 +39756,7 @@ paths:
timezone: UTC
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionUpdateRequest"
+ $ref: '#/components/schemas/SLOCorrectionUpdateRequest'
description: The edited SLO correction object.
required: true
responses:
@@ -39776,25 +39776,25 @@ paths:
id: abc-123
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionResponse"
+ $ref: '#/components/schemas/SLOCorrectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39858,19 +39858,19 @@ paths:
type: slo
type: service_level_objective_search_results
schema:
- $ref: "#/components/schemas/SearchSLOResponse"
+ $ref: '#/components/schemas/SearchSLOResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39919,25 +39919,25 @@ paths:
- abc-123
errors: {}
schema:
- $ref: "#/components/schemas/SLODeleteResponse"
+ $ref: '#/components/schemas/SLODeleteResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/SLODeleteResponse"
+ $ref: '#/components/schemas/SLODeleteResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -39991,19 +39991,19 @@ paths:
type: metric
errors: []
schema:
- $ref: "#/components/schemas/SLOResponse"
+ $ref: '#/components/schemas/SLOResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40052,7 +40052,7 @@ paths:
warning: 97
type: metric
schema:
- $ref: "#/components/schemas/ServiceLevelObjective"
+ $ref: '#/components/schemas/ServiceLevelObjective'
description: The edited service level objective request object.
required: true
responses:
@@ -40075,25 +40075,25 @@ paths:
type: metric
errors: []
schema:
- $ref: "#/components/schemas/SLOListResponse"
+ $ref: '#/components/schemas/SLOListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40140,25 +40140,25 @@ paths:
id: abc-123
type: correction
schema:
- $ref: "#/components/schemas/SLOCorrectionListResponse"
+ $ref: '#/components/schemas/SLOCorrectionListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40247,25 +40247,25 @@ paths:
type_id: 1
errors:
schema:
- $ref: "#/components/schemas/SLOHistoryResponse"
+ $ref: '#/components/schemas/SLOHistoryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40310,13 +40310,13 @@ paths:
test_type: api
status: passed
schema:
- $ref: "#/components/schemas/SyntheticsBatchDetails"
+ $ref: '#/components/schemas/SyntheticsBatchDetails'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Batch does not exist.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40350,7 +40350,7 @@ paths:
- id: "aws:eu-west-3"
name: "Paris (AWS)"
schema:
- $ref: "#/components/schemas/SyntheticsLocations"
+ $ref: '#/components/schemas/SyntheticsLocations'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40382,7 +40382,7 @@ paths:
tags:
- "team:front"
schema:
- $ref: "#/components/schemas/SyntheticsPrivateLocation"
+ $ref: '#/components/schemas/SyntheticsPrivateLocation'
description: Details of the private location to create.
required: true
responses:
@@ -40399,19 +40399,19 @@ paths:
tags:
- "team:front"
schema:
- $ref: "#/components/schemas/SyntheticsPrivateLocationCreationResponse"
+ $ref: '#/components/schemas/SyntheticsPrivateLocationCreationResponse'
description: OK
"402":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Quota reached for private locations
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Private locations are not activated for the user
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40447,7 +40447,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Private locations are not activated for the user
- Private location does not exist
@@ -40489,13 +40489,13 @@ paths:
tags:
- "team:front"
schema:
- $ref: "#/components/schemas/SyntheticsPrivateLocation"
+ $ref: '#/components/schemas/SyntheticsPrivateLocation'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic private locations are not activated for the user
- Private location does not exist
@@ -40535,7 +40535,7 @@ paths:
tags:
- "team:front"
schema:
- $ref: "#/components/schemas/SyntheticsPrivateLocation"
+ $ref: '#/components/schemas/SyntheticsPrivateLocation'
description: Details of the private location to be updated.
required: true
responses:
@@ -40551,13 +40551,13 @@ paths:
tags:
- "team:front"
schema:
- $ref: "#/components/schemas/SyntheticsPrivateLocation"
+ $ref: '#/components/schemas/SyntheticsPrivateLocation'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Private locations are not activated for the user
- Private location does not exist
@@ -40591,7 +40591,7 @@ paths:
- "aws:eu-west-3"
- "aws:us-east-1"
schema:
- $ref: "#/components/schemas/SyntheticsDefaultLocations"
+ $ref: '#/components/schemas/SyntheticsDefaultLocations'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40641,19 +40641,19 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsListTestsResponse"
+ $ref: '#/components/schemas/SyntheticsListTestsResponse'
description: OK - Returns the list of all Synthetic tests.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Synthetic Monitoring is not activated for the user.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40701,7 +40701,7 @@ paths:
status: live
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetails"
+ $ref: '#/components/schemas/SyntheticsTestDetails'
description: Details of the test to create.
required: true
responses:
@@ -40728,13 +40728,13 @@ paths:
status: live
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetails"
+ $ref: '#/components/schemas/SyntheticsTestDetails'
description: OK - Returns the created test details.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Creation failed
@@ -40742,13 +40742,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Test quota is reached
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -40915,7 +40915,7 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsAPITest"
+ $ref: '#/components/schemas/SyntheticsAPITest'
description: Details of the test to create.
required: true
responses:
@@ -40949,13 +40949,13 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsAPITest"
+ $ref: '#/components/schemas/SyntheticsAPITest'
description: OK - Returns the created test details.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Creation failed
@@ -40963,13 +40963,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Test quota is reached
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -41024,19 +41024,19 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsAPITest"
+ $ref: '#/components/schemas/SyntheticsAPITest'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41093,7 +41093,7 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsAPITest"
+ $ref: '#/components/schemas/SyntheticsAPITest'
description: New test details to be saved.
required: true
responses:
@@ -41120,13 +41120,13 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsAPITest"
+ $ref: '#/components/schemas/SyntheticsAPITest'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Updating sub-type is forbidden
@@ -41134,13 +41134,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41195,7 +41195,7 @@ paths:
- "env:production"
type: browser
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTest"
+ $ref: '#/components/schemas/SyntheticsBrowserTest'
description: Details of the test to create.
required: true
responses:
@@ -41224,13 +41224,13 @@ paths:
- "env:production"
type: browser
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTest"
+ $ref: '#/components/schemas/SyntheticsBrowserTest'
description: OK - Returns the created test details.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Creation failed
@@ -41238,13 +41238,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Test quota is reached
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -41301,19 +41301,19 @@ paths:
- "env:production"
type: browser
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTest"
+ $ref: '#/components/schemas/SyntheticsBrowserTest'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41372,7 +41372,7 @@ paths:
- "env:production"
type: browser
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTest"
+ $ref: '#/components/schemas/SyntheticsBrowserTest'
description: New test details to be saved.
required: true
responses:
@@ -41401,13 +41401,13 @@ paths:
- "env:production"
type: browser
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTest"
+ $ref: '#/components/schemas/SyntheticsBrowserTest'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Updating sub-type is forbidden
@@ -41415,13 +41415,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41492,19 +41492,19 @@ paths:
result_id: "abc-123"
status: 0
schema:
- $ref: "#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse"
+ $ref: '#/components/schemas/SyntheticsGetBrowserTestLatestResultsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41555,19 +41555,19 @@ paths:
result_id: "abc-123"
status: 0
schema:
- $ref: "#/components/schemas/SyntheticsBrowserTestResultFull"
+ $ref: '#/components/schemas/SyntheticsBrowserTestResultFull'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test or result is not owned by the user
@@ -41599,7 +41599,7 @@ paths:
public_ids:
- "abc-def-123"
schema:
- $ref: "#/components/schemas/SyntheticsDeleteTestsPayload"
+ $ref: '#/components/schemas/SyntheticsDeleteTestsPayload'
description: Public ID list of the Synthetic tests to be deleted.
required: true
responses:
@@ -41613,13 +41613,13 @@ paths:
- deleted_at: "2024-01-01T00:00:00+00:00"
public_id: "abc-def-123"
schema:
- $ref: "#/components/schemas/SyntheticsDeleteTestsResponse"
+ $ref: '#/components/schemas/SyntheticsDeleteTestsResponse'
description: OK.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Test cannot be deleted as it's used elsewhere (as a sub-test or in an uptime widget)
@@ -41628,13 +41628,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Tests to be deleted can't be found
- Synthetic is not activated for the user
@@ -41681,7 +41681,7 @@ paths:
- "env:production"
type: mobile
schema:
- $ref: "#/components/schemas/SyntheticsMobileTest"
+ $ref: '#/components/schemas/SyntheticsMobileTest'
description: Details of the test to create.
required: true
responses:
@@ -41709,13 +41709,13 @@ paths:
- "env:production"
type: mobile
schema:
- $ref: "#/components/schemas/SyntheticsMobileTest"
+ $ref: '#/components/schemas/SyntheticsMobileTest'
description: OK - Returns the created test details.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Creation failed
@@ -41723,13 +41723,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Test quota is reached
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -41785,19 +41785,19 @@ paths:
- "env:production"
type: mobile
schema:
- $ref: "#/components/schemas/SyntheticsMobileTest"
+ $ref: '#/components/schemas/SyntheticsMobileTest'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41849,7 +41849,7 @@ paths:
- "env:production"
type: mobile
schema:
- $ref: "#/components/schemas/SyntheticsMobileTest"
+ $ref: '#/components/schemas/SyntheticsMobileTest'
description: New test details to be saved.
required: true
responses:
@@ -41877,13 +41877,13 @@ paths:
- "env:production"
type: mobile
schema:
- $ref: "#/components/schemas/SyntheticsMobileTest"
+ $ref: '#/components/schemas/SyntheticsMobileTest'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Updating sub-type is forbidden
@@ -41891,13 +41891,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -41983,19 +41983,19 @@ paths:
- env:prod
type: api
schema:
- $ref: "#/components/schemas/SyntheticsListTestsResponse"
+ $ref: '#/components/schemas/SyntheticsListTestsResponse'
description: OK - Returns the list of Synthetic tests matching the search.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42025,7 +42025,7 @@ paths:
tests:
- public_id: aaa-aaa-aaa
schema:
- $ref: "#/components/schemas/SyntheticsTriggerBody"
+ $ref: '#/components/schemas/SyntheticsTriggerBody'
description: The identifiers of the tests to trigger.
required: true
responses:
@@ -42043,13 +42043,13 @@ paths:
triggered_check_ids:
- "abc-def-123"
schema:
- $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse"
+ $ref: '#/components/schemas/SyntheticsTriggerCITestsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42080,7 +42080,7 @@ paths:
tests:
- public_id: aaa-aaa-aaa
schema:
- $ref: "#/components/schemas/SyntheticsCITestBody"
+ $ref: '#/components/schemas/SyntheticsCITestBody'
description: Details of the test to trigger.
required: true
responses:
@@ -42098,13 +42098,13 @@ paths:
triggered_check_ids:
- "abc-def-123"
schema:
- $ref: "#/components/schemas/SyntheticsTriggerCITestsResponse"
+ $ref: '#/components/schemas/SyntheticsTriggerCITestsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: JSON format is wrong
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42137,7 +42137,7 @@ paths:
- "abc-def-123"
to_ts: 1726127888
schema:
- $ref: "#/components/schemas/SyntheticsFetchUptimesPayload"
+ $ref: '#/components/schemas/SyntheticsFetchUptimesPayload'
description: Public ID list of the Synthetic tests and timeframe.
required: true
responses:
@@ -42158,21 +42158,21 @@ paths:
to_ts: 1726127888
schema:
items:
- $ref: "#/components/schemas/SyntheticsTestUptime"
+ $ref: '#/components/schemas/SyntheticsTestUptime'
type: array
description: OK.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42219,19 +42219,19 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetailsWithoutSteps"
+ $ref: '#/components/schemas/SyntheticsTestDetailsWithoutSteps'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic is not activated for the user
- Test is not owned by the user
@@ -42273,7 +42273,7 @@ paths:
- op: remove
path: /config/assertions/0
schema:
- $ref: "#/components/schemas/SyntheticsPatchTestBody"
+ $ref: '#/components/schemas/SyntheticsPatchTestBody'
description: "[JSON Patch](https://jsonpatch.com/) compliant list of operations"
required: true
responses:
@@ -42294,13 +42294,13 @@ paths:
- "env:production"
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetails"
+ $ref: '#/components/schemas/SyntheticsTestDetails'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Updating sub-type is forbidden
@@ -42308,13 +42308,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -42369,7 +42369,7 @@ paths:
status: live
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetails"
+ $ref: '#/components/schemas/SyntheticsTestDetails'
description: New test details to be saved.
required: true
responses:
@@ -42396,13 +42396,13 @@ paths:
status: live
type: api
schema:
- $ref: "#/components/schemas/SyntheticsTestDetails"
+ $ref: '#/components/schemas/SyntheticsTestDetails'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- JSON format is wrong
- Updating sub-type is forbidden
@@ -42410,13 +42410,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic is not activated for the user
- Test is not owned by the user
@@ -42487,19 +42487,19 @@ paths:
result_id: "abc-123"
status: 0
schema:
- $ref: "#/components/schemas/SyntheticsGetAPITestLatestResultsResponse"
+ $ref: '#/components/schemas/SyntheticsGetAPITestLatestResultsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic is not activated for the user
- Test is not owned by the user
@@ -42548,19 +42548,19 @@ paths:
result_id: "abc-123"
status: 0
schema:
- $ref: "#/components/schemas/SyntheticsAPITestResultFull"
+ $ref: '#/components/schemas/SyntheticsAPITestResultFull'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test or result is not owned by the user
@@ -42598,7 +42598,7 @@ paths:
value:
new_status: live
schema:
- $ref: "#/components/schemas/SyntheticsUpdateTestPauseStatusPayload"
+ $ref: '#/components/schemas/SyntheticsUpdateTestPauseStatusPayload'
description: Status to set the given Synthetic test to.
required: true
responses:
@@ -42615,19 +42615,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: JSON format is wrong.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: |-
- Synthetic Monitoring is not activated for the user
- Test is not owned by the user
@@ -42668,13 +42668,13 @@ paths:
secure: false
value: "example-value"
schema:
- $ref: "#/components/schemas/SyntheticsListGlobalVariablesResponse"
+ $ref: '#/components/schemas/SyntheticsListGlobalVariablesResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42712,7 +42712,7 @@ paths:
secure: false
value: variable-value
schema:
- $ref: "#/components/schemas/SyntheticsGlobalVariableRequest"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableRequest'
description: Details of the global variable to create.
required: true
responses:
@@ -42732,25 +42732,25 @@ paths:
secure: false
value: "variable-value"
schema:
- $ref: "#/components/schemas/SyntheticsGlobalVariable"
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42786,19 +42786,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: JSON format is wrong
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42841,19 +42841,19 @@ paths:
secure: false
value: "variable-value"
schema:
- $ref: "#/components/schemas/SyntheticsGlobalVariable"
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42891,7 +42891,7 @@ paths:
secure: false
value: variable-value
schema:
- $ref: "#/components/schemas/SyntheticsGlobalVariableRequest"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableRequest'
description: Details of the global variable to update.
required: true
responses:
@@ -42911,19 +42911,19 @@ paths:
secure: false
value: "variable-value"
schema:
- $ref: "#/components/schemas/SyntheticsGlobalVariable"
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Invalid request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -42963,19 +42963,19 @@ paths:
environment:production:
- test.metric.host
schema:
- $ref: "#/components/schemas/TagToHosts"
+ $ref: '#/components/schemas/TagToHosts'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -43017,13 +43017,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -43058,19 +43058,19 @@ paths:
tags:
- "environment:production"
schema:
- $ref: "#/components/schemas/HostTags"
+ $ref: '#/components/schemas/HostTags'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -43108,7 +43108,7 @@ paths:
tags:
- "environment:production"
schema:
- $ref: "#/components/schemas/HostTags"
+ $ref: '#/components/schemas/HostTags'
description: Update host tags request body.
required: true
responses:
@@ -43122,19 +43122,19 @@ paths:
tags:
- "environment:production"
schema:
- $ref: "#/components/schemas/HostTags"
+ $ref: '#/components/schemas/HostTags'
description: Created
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -43172,7 +43172,7 @@ paths:
tags:
- "environment:production"
schema:
- $ref: "#/components/schemas/HostTags"
+ $ref: '#/components/schemas/HostTags'
description: Add tags to host
required: true
responses:
@@ -43186,19 +43186,19 @@ paths:
tags:
- "environment:production"
schema:
- $ref: "#/components/schemas/HostTags"
+ $ref: '#/components/schemas/HostTags'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -43244,25 +43244,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageAnalyzedLogsResponse"
+ $ref: '#/components/schemas/UsageAnalyzedLogsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43314,25 +43314,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageAuditLogsResponse"
+ $ref: '#/components/schemas/UsageAuditLogsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43383,25 +43383,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageLambdaResponse"
+ $ref: '#/components/schemas/UsageLambdaResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43454,25 +43454,25 @@ paths:
public_id: abc-123
start_date: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/UsageBillableSummaryResponse"
+ $ref: '#/components/schemas/UsageBillableSummaryResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43527,25 +43527,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageCIVisibilityResponse"
+ $ref: '#/components/schemas/UsageCIVisibilityResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43601,25 +43601,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageCloudSecurityPostureManagementResponse"
+ $ref: '#/components/schemas/UsageCloudSecurityPostureManagementResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43672,25 +43672,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageCWSResponse"
+ $ref: '#/components/schemas/UsageCWSResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43743,25 +43743,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageDBMResponse"
+ $ref: '#/components/schemas/UsageDBMResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43812,25 +43812,25 @@ paths:
public_id: abc-123
tasks_count: 5
schema:
- $ref: "#/components/schemas/UsageFargateResponse"
+ $ref: '#/components/schemas/UsageFargateResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43885,25 +43885,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageHostsResponse"
+ $ref: '#/components/schemas/UsageHostsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -43963,7 +43963,7 @@ paths:
name: usage_type
required: true
schema:
- $ref: "#/components/schemas/HourlyUsageAttributionUsageType"
+ $ref: '#/components/schemas/HourlyUsageAttributionUsageType'
- description: List following results with a next_record_id provided in the previous query.
in: query
name: next_record_id
@@ -44005,19 +44005,19 @@ paths:
updated_at: "2024-01-01T00:00:00+00:00"
usage_type: infra_host_usage
schema:
- $ref: "#/components/schemas/HourlyUsageAttributionResponse"
+ $ref: '#/components/schemas/HourlyUsageAttributionResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44069,25 +44069,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageIncidentManagementResponse"
+ $ref: '#/components/schemas/UsageIncidentManagementResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44138,25 +44138,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageIndexedSpansResponse"
+ $ref: '#/components/schemas/UsageIndexedSpansResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44208,25 +44208,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageIngestedSpansResponse"
+ $ref: '#/components/schemas/UsageIngestedSpansResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44278,25 +44278,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageIoTResponse"
+ $ref: '#/components/schemas/UsageIoTResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44348,25 +44348,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageLogsResponse"
+ $ref: '#/components/schemas/UsageLogsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44420,25 +44420,25 @@ paths:
rehydrated_indexed_events_count: 20
retention: "15"
schema:
- $ref: "#/components/schemas/UsageLogsByRetentionResponse"
+ $ref: '#/components/schemas/UsageLogsByRetentionResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44497,25 +44497,25 @@ paths:
public_id: abc-123
retention: 15
schema:
- $ref: "#/components/schemas/UsageLogsByIndexResponse"
+ $ref: '#/components/schemas/UsageLogsByIndexResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44576,13 +44576,13 @@ paths:
name: fields
required: true
schema:
- $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics"
+ $ref: '#/components/schemas/MonthlyUsageAttributionSupportedMetrics'
- description: "The direction to sort by: `[desc, asc]`."
in: query
name: sort_direction
required: false
schema:
- $ref: "#/components/schemas/UsageSortDirection"
+ $ref: '#/components/schemas/UsageSortDirection'
- description: |-
The field to sort by. Sort fields are in the format `_usage`.
Example: `infra_host_usage`
@@ -44592,7 +44592,7 @@ paths:
name: sort_name
required: false
schema:
- $ref: "#/components/schemas/MonthlyUsageAttributionSupportedMetrics"
+ $ref: '#/components/schemas/MonthlyUsageAttributionSupportedMetrics'
- description: |-
Comma separated list of tag keys used to group usage. If no value is provided the usage will not be broken down by tags.
@@ -44635,19 +44635,19 @@ paths:
infra_host_percentage: 100.0
infra_host_usage: 1.0
schema:
- $ref: "#/components/schemas/MonthlyUsageAttributionResponse"
+ $ref: '#/components/schemas/MonthlyUsageAttributionResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44699,25 +44699,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageNetworkFlowsResponse"
+ $ref: '#/components/schemas/UsageNetworkFlowsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44767,25 +44767,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageNetworkHostsResponse"
+ $ref: '#/components/schemas/UsageNetworkHostsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44837,25 +44837,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageOnlineArchiveResponse"
+ $ref: '#/components/schemas/UsageOnlineArchiveResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44908,25 +44908,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageProfilingResponse"
+ $ref: '#/components/schemas/UsageProfilingResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -44977,25 +44977,25 @@ paths:
public_id: abc-123
rum_units: 100
schema:
- $ref: "#/components/schemas/UsageRumUnitsResponse"
+ $ref: '#/components/schemas/UsageRumUnitsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45052,25 +45052,25 @@ paths:
replay_session_count: 10
session_count: 100
schema:
- $ref: "#/components/schemas/UsageRumSessionsResponse"
+ $ref: '#/components/schemas/UsageRumSessionsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45124,25 +45124,25 @@ paths:
public_id: abc-123
total_scanned_bytes: 2000000
schema:
- $ref: "#/components/schemas/UsageSDSResponse"
+ $ref: '#/components/schemas/UsageSDSResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45194,25 +45194,25 @@ paths:
public_id: abc-123
snmp_devices: 10
schema:
- $ref: "#/components/schemas/UsageSNMPResponse"
+ $ref: '#/components/schemas/UsageSNMPResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45288,25 +45288,25 @@ paths:
container_avg: 5
date: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/UsageSummaryResponse"
+ $ref: '#/components/schemas/UsageSummaryResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45356,25 +45356,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageSyntheticsResponse"
+ $ref: '#/components/schemas/UsageSyntheticsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45424,25 +45424,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageSyntheticsAPIResponse"
+ $ref: '#/components/schemas/UsageSyntheticsAPIResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45492,25 +45492,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageSyntheticsBrowserResponse"
+ $ref: '#/components/schemas/UsageSyntheticsBrowserResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45562,25 +45562,25 @@ paths:
org_name: example-handle
public_id: abc-123
schema:
- $ref: "#/components/schemas/UsageTimeseriesResponse"
+ $ref: '#/components/schemas/UsageTimeseriesResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45653,25 +45653,25 @@ paths:
metric_category: custom
metric_name: test-metric
schema:
- $ref: "#/components/schemas/UsageTopAvgMetricsResponse"
+ $ref: '#/components/schemas/UsageTopAvgMetricsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -45703,13 +45703,13 @@ paths:
handle: test@example.com
name: Example Name
schema:
- $ref: "#/components/schemas/UserListResponse"
+ $ref: '#/components/schemas/UserListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -45743,7 +45743,7 @@ paths:
handle: test@datadoghq.com
name: test user
schema:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
description: User object that needs to be created.
required: true
responses:
@@ -45759,25 +45759,25 @@ paths:
handle: test@example.com
name: Example Name
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: User created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -45815,25 +45815,25 @@ paths:
value:
message: "User user@example.com disabled"
schema:
- $ref: "#/components/schemas/UserDisableResponse"
+ $ref: '#/components/schemas/UserDisableResponse'
description: User disabled
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -45865,19 +45865,19 @@ paths:
handle: test@example.com
name: Example Name
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK for get user
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -45909,7 +45909,7 @@ paths:
email: test@datadoghq.com
name: test user
schema:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
description: Description of the update.
required: true
responses:
@@ -45925,25 +45925,25 @@ paths:
handle: test@example.com
name: Example Name
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: User updated
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -45965,13 +45965,13 @@ paths:
value:
valid: true
schema:
- $ref: "#/components/schemas/AuthenticationValidationResponse"
+ $ref: '#/components/schemas/AuthenticationValidationResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -46014,7 +46014,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/ContentEncoding"
+ $ref: '#/components/schemas/ContentEncoding'
- description: Log tags can be passed as query parameters with `text/plain` content type.
example: "env:prod,user:my-user"
in: query
@@ -46040,7 +46040,7 @@ paths:
- message: hello
- message: world
schema:
- $ref: "#/components/schemas/HTTPLog"
+ $ref: '#/components/schemas/HTTPLog'
application/json;simple:
examples:
default:
@@ -46059,7 +46059,7 @@ paths:
hostname: "fa1e1e739d95"
message: hello world
schema:
- $ref: "#/components/schemas/HTTPLogItem"
+ $ref: '#/components/schemas/HTTPLogItem'
application/logplex-1:
examples:
default:
@@ -46109,7 +46109,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogError"
+ $ref: '#/components/schemas/HTTPLogError'
description: unexpected error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -46194,19 +46194,19 @@ paths:
- env:prod
type: query alert
schema:
- $ref: "#/components/schemas/Monitor"
+ $ref: '#/components/schemas/Monitor'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -46231,7 +46231,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
diff --git a/hugo/data/api/v2/CodeExamples.json b/hugo/data/api/v2/CodeExamples.json
index 1d30d81310b..24cc55745c9 100644
--- a/hugo/data/api/v2/CodeExamples.json
+++ b/hugo/data/api/v2/CodeExamples.json
@@ -679,6 +679,16 @@
"group": "deployment_gates",
"suffix": "",
"description": "Create deployment rule returns \"OK\" response"
+ },
+ {
+ "group": "deployment_gates",
+ "suffix": "_2423265690",
+ "description": "Create monitor deployment rule with monitor IDs returns \"OK\" response"
+ },
+ {
+ "group": "deployment_gates",
+ "suffix": "_4286388136",
+ "description": "Create monitor deployment rule with query returns \"OK\" response"
}
],
"TriggerDeploymentGatesEvaluation": [
diff --git a/hugo/data/api/v2/full_spec.yaml b/hugo/data/api/v2/full_spec.yaml
index fc22c3eca0c..356e8d9efa7 100644
--- a/hugo/data/api/v2/full_spec.yaml
+++ b/hugo/data/api/v2/full_spec.yaml
@@ -82,7 +82,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/APIKeysSort"
+ $ref: '#/components/schemas/APIKeysSort'
AWSAccountConfigIDPathParameter:
description: |-
Unique Datadog ID of the AWS Account Integration Config. To get the config ID for an account, use the
@@ -206,7 +206,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/ApplicationKeysSort"
+ $ref: '#/components/schemas/ApplicationKeysSort'
ApplicationSecurityPolicyIDParam:
description: The ID of the policy.
example: recommended
@@ -317,7 +317,7 @@ components:
name: sort[field]
required: false
schema:
- $ref: "#/components/schemas/CaseSortableField"
+ $ref: '#/components/schemas/CaseSortableField'
CaseTypeIDPathParameter:
description: The UUID of the case type.
example: "f98a5a5b-e0ff-45d4-b2f5-afe6e74de505"
@@ -396,7 +396,7 @@ components:
name: commitmentType
required: false
schema:
- $ref: "#/components/schemas/CommitmentsCommitmentType"
+ $ref: '#/components/schemas/CommitmentsCommitmentType'
CommitmentsEnd:
description: End of the query time range in Unix milliseconds.
example: 1696118400000
@@ -428,7 +428,7 @@ components:
name: provider
required: true
schema:
- $ref: "#/components/schemas/CommitmentsProvider"
+ $ref: '#/components/schemas/CommitmentsProvider'
CommitmentsStart:
description: Start of the query time range in Unix milliseconds.
example: 1693526400000
@@ -605,7 +605,7 @@ components:
name: filter[relation][type]
required: false
schema:
- $ref: "#/components/schemas/RelationType"
+ $ref: '#/components/schemas/RelationType'
FilterRelationByFromRef:
description: Filter relations by the reference of the first entity in the relation.
example: service:shopping-cart
@@ -631,7 +631,7 @@ components:
name: filter[type]
required: false
schema:
- $ref: "#/components/schemas/RelationType"
+ $ref: '#/components/schemas/RelationType'
FromTimestamp:
description: The starting timestamp for the SLO status query in epoch seconds.
in: query
@@ -656,7 +656,7 @@ components:
required: false
schema:
items:
- $ref: "#/components/schemas/GetIssueIncludeQueryParameterItem"
+ $ref: '#/components/schemas/GetIssueIncludeQueryParameterItem'
type: array
GoogleChatHandleIdPathParameter:
description: Your organization handle ID.
@@ -761,7 +761,7 @@ components:
required: false
schema:
items:
- $ref: "#/components/schemas/IncidentImpactRelatedObject"
+ $ref: '#/components/schemas/IncidentImpactRelatedObject'
type: array
IncidentImportIncludeQueryParameter:
description: Specifies which related object types to include in the response when importing an incident.
@@ -771,7 +771,7 @@ components:
required: false
schema:
items:
- $ref: "#/components/schemas/IncidentImportRelatedObject"
+ $ref: '#/components/schemas/IncidentImportRelatedObject'
type: array
IncidentIncludeQueryParameter:
description: Specifies which types of related objects should be included in the response.
@@ -781,7 +781,7 @@ components:
required: false
schema:
items:
- $ref: "#/components/schemas/IncidentRelatedObject"
+ $ref: '#/components/schemas/IncidentRelatedObject'
type: array
IncidentIntegrationMetadataIDPathParameter:
description: The UUID of the incident integration metadata.
@@ -868,7 +868,7 @@ components:
name: "include"
required: false
schema:
- $ref: "#/components/schemas/IncidentRelatedObject"
+ $ref: '#/components/schemas/IncidentRelatedObject'
IncidentSearchQueryQueryParameter:
description: |-
Specifies which incidents should be returned. The query can contain any number of incident facets
@@ -887,7 +887,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/IncidentSearchSortOrder"
+ $ref: '#/components/schemas/IncidentSearchSortOrder'
IncidentTimestampOverrideIDPathParameter:
description: The UUID of the timestamp override.
in: path
@@ -941,7 +941,7 @@ components:
name: include
required: false
schema:
- $ref: "#/components/schemas/IncludeType"
+ $ref: '#/components/schemas/IncludeType'
InstanceId:
description: The ID of the workflow instance.
in: path
@@ -1027,7 +1027,7 @@ components:
name: integration
required: true
schema:
- $ref: "#/components/schemas/LLMObsIntegrationName"
+ $ref: '#/components/schemas/LLMObsIntegrationName'
LLMObsPatternsConfigIDPathParameter:
description: The ID of the patterns configuration.
example: "a7c8d9e0-1234-5678-9abc-def012345678"
@@ -1137,7 +1137,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/OrgGroupMembershipSortOption"
+ $ref: '#/components/schemas/OrgGroupMembershipSortOption'
MetricID:
description: The name of the log-based metric.
in: path
@@ -1455,7 +1455,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/OrgGroupSortOption"
+ $ref: '#/components/schemas/OrgGroupSortOption'
OverrideSort:
description: >-
Field to sort overrides by. Supported values: `id`, `org_uuid`, `-id`, `-org_uuid`. Defaults to `id`.
@@ -1463,7 +1463,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideSortOption"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideSortOption'
PageNumber:
description: Specific page number to return.
in: query
@@ -1528,7 +1528,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/PersonalAccessTokensSort"
+ $ref: '#/components/schemas/PersonalAccessTokensSort'
PolicySort:
description: >-
Field to sort policies by. Supported values: `id`, `name`, `-id`, `-name`. Defaults to `id`.
@@ -1536,7 +1536,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/OrgGroupPolicySortOption"
+ $ref: '#/components/schemas/OrgGroupPolicySortOption'
PostmortemTemplateFilterIncidentTypeParameter:
description: Filter postmortem templates by the associated incident type ID.
in: query
@@ -1628,7 +1628,7 @@ components:
name: sort
required: false
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsSort"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsSort'
RelationInclude:
description: Include relationship data.
explode: true
@@ -1636,7 +1636,7 @@ components:
name: include
required: false
schema:
- $ref: "#/components/schemas/RelationIncludeType"
+ $ref: '#/components/schemas/RelationIncludeType'
ReportID:
description: The ID of the report job.
in: path
@@ -1819,7 +1819,7 @@ components:
name: permanent_rf_id
required: true
schema:
- $ref: "#/components/schemas/RumPermanentRetentionFilterID"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterID'
RumRetentionFilterIDParameter:
description: Retention filter ID.
in: path
@@ -1845,7 +1845,7 @@ components:
name: scope_type
required: true
schema:
- $ref: "#/components/schemas/RumRetentionQuotaScopeType"
+ $ref: '#/components/schemas/RumRetentionQuotaScopeType'
SAMLConfigurationUUIDPathParameter:
description: The UUID of the SAML configuration.
in: path
@@ -1881,7 +1881,7 @@ components:
name: schema_version
required: false
schema:
- $ref: "#/components/schemas/ServiceDefinitionSchemaVersions"
+ $ref: '#/components/schemas/ServiceDefinitionSchemaVersions'
SearchIssuesIncludeQueryParameter:
description: Comma-separated list of relationship objects that should be included in the response. Possible values are `issue`, `issue.assignee`, `issue.case`, and `issue.team_owners`.
explode: false
@@ -1890,7 +1890,7 @@ components:
required: false
schema:
items:
- $ref: "#/components/schemas/SearchIssuesIncludeQueryParameterItem"
+ $ref: '#/components/schemas/SearchIssuesIncludeQueryParameterItem'
type: array
SecureEmbedTokenPathParameter:
description: The share token identifying the secure embed.
@@ -1965,7 +1965,7 @@ components:
name: resource_type
required: true
schema:
- $ref: "#/components/schemas/SecurityMonitoringTerraformResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformResourceType'
SensitiveDataScannerGroupID:
description: The ID of a group of rules.
in: path
@@ -2184,7 +2184,7 @@ components:
name: include
required: false
schema:
- $ref: "#/components/schemas/WebhooksAuthMethodProtocol"
+ $ref: '#/components/schemas/WebhooksAuthMethodProtocol'
WorkflowId:
description: The ID of the workflow.
in: path
@@ -2234,139 +2234,139 @@ components:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
ConcurrentModificationResponse:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Concurrent Modification
ConflictResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
FindingsBadRequestResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad Request: The server cannot process the request due to invalid syntax in the request."
FindingsForbiddenResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
FindingsNotFoundResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not Found: The requested finding cannot be found."
FindingsTooManyRequestsResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Too many requests: The rate limit set by the API has been exceeded."
ForbiddenResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
HTTPCDGatesBadRequestResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCDGatesBadRequestResponse"
+ $ref: '#/components/schemas/HTTPCDGatesBadRequestResponse'
description: Bad request.
HTTPCDGatesNotFoundResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCDGatesNotFoundResponse"
+ $ref: '#/components/schemas/HTTPCDGatesNotFoundResponse'
description: Deployment gate not found.
HTTPCDRulesNotFoundResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCDRulesNotFoundResponse"
+ $ref: '#/components/schemas/HTTPCDRulesNotFoundResponse'
description: Deployment rule not found.
NotAuthorizedResponse:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Authorized
NotFoundResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
NotificationRulesList:
content:
"application/json":
schema:
- $ref: "#/components/schemas/NotificationRulesListResponse"
+ $ref: '#/components/schemas/NotificationRulesListResponse'
description: The list of notification rules.
PreconditionFailedResponse:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Failed Precondition
RumExclusionFilterMethodNotAllowedResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Method Not Allowed
SpansBadRequestResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad Request."
SpansForbiddenResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied."
SpansTooManyRequestsResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Too many requests: The rate limit set by the API has been exceeded."
SpansUnprocessableEntityResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Unprocessable Entity."
TooManyRequestsResponse:
content:
"application/json":
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
UnauthorizedResponse:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
UnprocessableEntityResponse:
content:
"application/json":
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: The server cannot process the request because it contains invalid data.
schemas:
APIErrorResponse:
@@ -2404,9 +2404,9 @@ components:
description: Object used to create an API key.
properties:
attributes:
- $ref: "#/components/schemas/APIKeyCreateAttributes"
+ $ref: '#/components/schemas/APIKeyCreateAttributes'
type:
- $ref: "#/components/schemas/APIKeysType"
+ $ref: '#/components/schemas/APIKeysType'
required:
- attributes
- type
@@ -2415,7 +2415,7 @@ components:
description: Request used to create an API key.
properties:
data:
- $ref: "#/components/schemas/APIKeyCreateData"
+ $ref: '#/components/schemas/APIKeyCreateData'
required:
- data
type: object
@@ -2423,26 +2423,26 @@ components:
description: Resources related to the API key.
properties:
created_by:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
modified_by:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
type: object
APIKeyResponse:
description: Response for retrieving an API key.
properties:
data:
- $ref: "#/components/schemas/FullAPIKey"
+ $ref: '#/components/schemas/FullAPIKey'
included:
description: Array of objects related to the API key.
items:
- $ref: "#/components/schemas/APIKeyResponseIncludedItem"
+ $ref: '#/components/schemas/APIKeyResponseIncludedItem'
type: array
type: object
APIKeyResponseIncludedItem:
description: An object related to an API key.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/LeakedKey"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/LeakedKey'
APIKeyUpdateAttributes:
description: Attributes used to update an API Key.
properties:
@@ -2463,13 +2463,13 @@ components:
description: Object used to update an API key.
properties:
attributes:
- $ref: "#/components/schemas/APIKeyUpdateAttributes"
+ $ref: '#/components/schemas/APIKeyUpdateAttributes'
id:
description: ID of the API key.
example: "00112233-4455-6677-8899-aabbccddeeff"
type: string
type:
- $ref: "#/components/schemas/APIKeysType"
+ $ref: '#/components/schemas/APIKeysType'
required:
- attributes
- id
@@ -2479,7 +2479,7 @@ components:
description: Request used to update an API key.
properties:
data:
- $ref: "#/components/schemas/APIKeyUpdateData"
+ $ref: '#/components/schemas/APIKeyUpdateData'
required:
- data
type: object
@@ -2489,15 +2489,15 @@ components:
data:
description: Array of API keys.
items:
- $ref: "#/components/schemas/PartialAPIKey"
+ $ref: '#/components/schemas/PartialAPIKey'
type: array
included:
description: Array of objects related to the API key.
items:
- $ref: "#/components/schemas/APIKeyResponseIncludedItem"
+ $ref: '#/components/schemas/APIKeyResponseIncludedItem'
type: array
meta:
- $ref: "#/components/schemas/APIKeysResponseMeta"
+ $ref: '#/components/schemas/APIKeysResponseMeta'
type: object
APIKeysResponseMeta:
description: Additional information related to api keys response.
@@ -2507,7 +2507,7 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/APIKeysResponseMetaPage"
+ $ref: '#/components/schemas/APIKeysResponseMetaPage'
type: object
APIKeysResponseMetaPage:
description: Additional information related to the API keys response.
@@ -2552,15 +2552,15 @@ components:
description: "Trigger a workflow from an API request. The workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
APITriggerWrapper:
description: "Schema for an API-based trigger."
properties:
apiTrigger:
- $ref: "#/components/schemas/APITrigger"
+ $ref: '#/components/schemas/APITrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- apiTrigger
type: object
@@ -2589,7 +2589,7 @@ components:
format: int64
type: integer
error:
- $ref: "#/components/schemas/APMSpanErrorFlag"
+ $ref: '#/components/schemas/APMSpanErrorFlag'
meta:
additionalProperties:
type: string
@@ -2682,7 +2682,7 @@ components:
APMTraceSpans:
description: The list of spans that compose the trace.
items:
- $ref: "#/components/schemas/APMTraceSpan"
+ $ref: '#/components/schemas/APMTraceSpan'
type: array
AWSAccountConfigID:
description: |-
@@ -2696,7 +2696,7 @@ components:
description: AWS Account Create Request body.
properties:
data:
- $ref: "#/components/schemas/AWSAccountCreateRequestData"
+ $ref: '#/components/schemas/AWSAccountCreateRequestData'
required:
- data
type: object
@@ -2704,23 +2704,23 @@ components:
description: The AWS Account Integration Config to be created.
properties:
account_tags:
- $ref: "#/components/schemas/AWSAccountTags"
+ $ref: '#/components/schemas/AWSAccountTags'
auth_config:
- $ref: "#/components/schemas/AWSAuthConfig"
+ $ref: '#/components/schemas/AWSAuthConfig'
aws_account_id:
- $ref: "#/components/schemas/AWSAccountID"
+ $ref: '#/components/schemas/AWSAccountID'
aws_partition:
- $ref: "#/components/schemas/AWSAccountPartition"
+ $ref: '#/components/schemas/AWSAccountPartition'
aws_regions:
- $ref: "#/components/schemas/AWSRegions"
+ $ref: '#/components/schemas/AWSRegions'
logs_config:
- $ref: "#/components/schemas/AWSLogsConfig"
+ $ref: '#/components/schemas/AWSLogsConfig'
metrics_config:
- $ref: "#/components/schemas/AWSMetricsConfig"
+ $ref: '#/components/schemas/AWSMetricsConfig'
resources_config:
- $ref: "#/components/schemas/AWSResourcesConfig"
+ $ref: '#/components/schemas/AWSResourcesConfig'
traces_config:
- $ref: "#/components/schemas/AWSTracesConfig"
+ $ref: '#/components/schemas/AWSTracesConfig'
required:
- aws_account_id
- aws_partition
@@ -2730,9 +2730,9 @@ components:
description: AWS Account Create Request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSAccountCreateRequestAttributes"
+ $ref: '#/components/schemas/AWSAccountCreateRequestAttributes'
type:
- $ref: "#/components/schemas/AWSAccountType"
+ $ref: '#/components/schemas/AWSAccountType'
required:
- attributes
- type
@@ -2760,7 +2760,7 @@ components:
description: AWS Account response body.
properties:
data:
- $ref: "#/components/schemas/AWSAccountResponseData"
+ $ref: '#/components/schemas/AWSAccountResponseData'
required:
- data
type: object
@@ -2768,33 +2768,33 @@ components:
description: AWS Account response attributes.
properties:
account_tags:
- $ref: "#/components/schemas/AWSAccountTags"
+ $ref: '#/components/schemas/AWSAccountTags'
auth_config:
- $ref: "#/components/schemas/AWSAuthConfig"
+ $ref: '#/components/schemas/AWSAuthConfig'
aws_account_id:
- $ref: "#/components/schemas/AWSAccountID"
+ $ref: '#/components/schemas/AWSAccountID'
aws_partition:
- $ref: "#/components/schemas/AWSAccountPartition"
+ $ref: '#/components/schemas/AWSAccountPartition'
aws_regions:
- $ref: "#/components/schemas/AWSRegions"
+ $ref: '#/components/schemas/AWSRegions'
created_at:
description: Timestamp of when the account integration was created.
format: date-time
readOnly: true
type: string
logs_config:
- $ref: "#/components/schemas/AWSLogsConfig"
+ $ref: '#/components/schemas/AWSLogsConfig'
metrics_config:
- $ref: "#/components/schemas/AWSMetricsConfig"
+ $ref: '#/components/schemas/AWSMetricsConfig'
modified_at:
description: Timestamp of when the account integration was updated.
format: date-time
readOnly: true
type: string
resources_config:
- $ref: "#/components/schemas/AWSResourcesConfig"
+ $ref: '#/components/schemas/AWSResourcesConfig'
traces_config:
- $ref: "#/components/schemas/AWSTracesConfig"
+ $ref: '#/components/schemas/AWSTracesConfig'
required:
- aws_account_id
type: object
@@ -2802,11 +2802,11 @@ components:
description: AWS Account response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSAccountResponseAttributes"
+ $ref: '#/components/schemas/AWSAccountResponseAttributes'
id:
- $ref: "#/components/schemas/AWSAccountConfigID"
+ $ref: '#/components/schemas/AWSAccountConfigID'
type:
- $ref: "#/components/schemas/AWSAccountType"
+ $ref: '#/components/schemas/AWSAccountType'
required:
- id
- type
@@ -2832,7 +2832,7 @@ components:
description: AWS Account Update Request body.
properties:
data:
- $ref: "#/components/schemas/AWSAccountUpdateRequestData"
+ $ref: '#/components/schemas/AWSAccountUpdateRequestData'
required:
- data
type: object
@@ -2840,23 +2840,23 @@ components:
description: The AWS Account Integration Config to be updated.
properties:
account_tags:
- $ref: "#/components/schemas/AWSAccountTags"
+ $ref: '#/components/schemas/AWSAccountTags'
auth_config:
- $ref: "#/components/schemas/AWSAuthConfig"
+ $ref: '#/components/schemas/AWSAuthConfig'
aws_account_id:
- $ref: "#/components/schemas/AWSAccountID"
+ $ref: '#/components/schemas/AWSAccountID'
aws_partition:
- $ref: "#/components/schemas/AWSAccountPartition"
+ $ref: '#/components/schemas/AWSAccountPartition'
aws_regions:
- $ref: "#/components/schemas/AWSRegions"
+ $ref: '#/components/schemas/AWSRegions'
logs_config:
- $ref: "#/components/schemas/AWSLogsConfig"
+ $ref: '#/components/schemas/AWSLogsConfig'
metrics_config:
- $ref: "#/components/schemas/AWSMetricsConfig"
+ $ref: '#/components/schemas/AWSMetricsConfig'
resources_config:
- $ref: "#/components/schemas/AWSResourcesConfig"
+ $ref: '#/components/schemas/AWSResourcesConfig'
traces_config:
- $ref: "#/components/schemas/AWSTracesConfig"
+ $ref: '#/components/schemas/AWSTracesConfig'
required:
- aws_account_id
type: object
@@ -2864,11 +2864,11 @@ components:
description: AWS Account Update Request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/AWSAccountUpdateRequestAttributes'
id:
- $ref: "#/components/schemas/AWSAccountConfigID"
+ $ref: '#/components/schemas/AWSAccountConfigID'
type:
- $ref: "#/components/schemas/AWSAccountType"
+ $ref: '#/components/schemas/AWSAccountType'
required:
- attributes
- type
@@ -2879,7 +2879,7 @@ components:
data:
description: List of AWS Account Integration Configs.
items:
- $ref: "#/components/schemas/AWSAccountResponseData"
+ $ref: '#/components/schemas/AWSAccountResponseData'
type: array
required:
- data
@@ -2907,7 +2907,7 @@ components:
example: my-role
type: string
type:
- $ref: "#/components/schemas/AWSAssumeRoleType"
+ $ref: '#/components/schemas/AWSAssumeRoleType'
required:
- type
- account_id
@@ -2937,15 +2937,15 @@ components:
example: my-role
type: string
type:
- $ref: "#/components/schemas/AWSAssumeRoleType"
+ $ref: '#/components/schemas/AWSAssumeRoleType'
required:
- type
type: object
AWSAuthConfig:
description: AWS Authentication config.
oneOf:
- - $ref: "#/components/schemas/AWSAuthConfigKeys"
- - $ref: "#/components/schemas/AWSAuthConfigRole"
+ - $ref: '#/components/schemas/AWSAuthConfigKeys'
+ - $ref: '#/components/schemas/AWSAuthConfigRole'
AWSAuthConfigKeys:
description: AWS Authentication config to integrate your account using an access key pair.
properties:
@@ -2983,7 +2983,7 @@ components:
data_export_configs:
description: List of data export configurations for Cost and Usage Reports.
items:
- $ref: "#/components/schemas/DataExportConfig"
+ $ref: '#/components/schemas/DataExportConfig'
type: array
required:
- data_export_configs
@@ -2992,7 +2992,7 @@ components:
description: AWS CCM Config Create/Update Request body.
properties:
data:
- $ref: "#/components/schemas/AWSCcmConfigRequestData"
+ $ref: '#/components/schemas/AWSCcmConfigRequestData'
required:
- data
type: object
@@ -3000,7 +3000,7 @@ components:
description: AWS CCM Config attributes for Create/Update requests.
properties:
ccm_config:
- $ref: "#/components/schemas/AWSCcmConfig"
+ $ref: '#/components/schemas/AWSCcmConfig'
required:
- ccm_config
type: object
@@ -3008,9 +3008,9 @@ components:
description: AWS CCM Config Create/Update Request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSCcmConfigRequestAttributes"
+ $ref: '#/components/schemas/AWSCcmConfigRequestAttributes'
type:
- $ref: "#/components/schemas/AWSCcmConfigType"
+ $ref: '#/components/schemas/AWSCcmConfigType'
required:
- attributes
- type
@@ -3019,7 +3019,7 @@ components:
description: AWS CCM Config response body.
properties:
data:
- $ref: "#/components/schemas/AWSCcmConfigResponseData"
+ $ref: '#/components/schemas/AWSCcmConfigResponseData'
required:
- data
type: object
@@ -3029,18 +3029,18 @@ components:
data_export_configs:
description: List of data export configurations for Cost and Usage Reports.
items:
- $ref: "#/components/schemas/DataExportConfig"
+ $ref: '#/components/schemas/DataExportConfig'
type: array
type: object
AWSCcmConfigResponseData:
description: AWS CCM Config response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSCcmConfigResponseAttributes"
+ $ref: '#/components/schemas/AWSCcmConfigResponseAttributes'
id:
- $ref: "#/components/schemas/AWSAccountConfigID"
+ $ref: '#/components/schemas/AWSAccountConfigID'
type:
- $ref: "#/components/schemas/AWSCcmConfigType"
+ $ref: '#/components/schemas/AWSCcmConfigType'
required:
- type
type: object
@@ -3057,7 +3057,7 @@ components:
description: A single validation issue found while validating an AWS Cost and Usage Report (CUR) 2.0 configuration.
properties:
code:
- $ref: "#/components/schemas/AWSCcmConfigValidationIssueCode"
+ $ref: '#/components/schemas/AWSCcmConfigValidationIssueCode'
description:
description: Human-readable description of the validation issue.
example: 'no CUR 2.0 export named "cost-and-usage-report" found'
@@ -3109,13 +3109,13 @@ components:
AWSCcmConfigValidationIssues:
description: List of validation issues found for the Cost and Usage Report (CUR) 2.0 configuration. Empty when the configuration is valid.
items:
- $ref: "#/components/schemas/AWSCcmConfigValidationIssue"
+ $ref: '#/components/schemas/AWSCcmConfigValidationIssue'
type: array
AWSCcmConfigValidationRequest:
description: AWS CCM config validation request body.
properties:
data:
- $ref: "#/components/schemas/AWSCcmConfigValidationRequestData"
+ $ref: '#/components/schemas/AWSCcmConfigValidationRequestData'
required:
- data
type: object
@@ -3152,9 +3152,9 @@ components:
description: AWS CCM config validation request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSCcmConfigValidationRequestAttributes"
+ $ref: '#/components/schemas/AWSCcmConfigValidationRequestAttributes'
type:
- $ref: "#/components/schemas/AWSCcmConfigValidationType"
+ $ref: '#/components/schemas/AWSCcmConfigValidationType'
required:
- attributes
- type
@@ -3163,7 +3163,7 @@ components:
description: AWS CCM config validation response body.
properties:
data:
- $ref: "#/components/schemas/AWSCcmConfigValidationResponseData"
+ $ref: '#/components/schemas/AWSCcmConfigValidationResponseData'
required:
- data
type: object
@@ -3175,7 +3175,7 @@ components:
example: "123456789012"
type: string
issues:
- $ref: "#/components/schemas/AWSCcmConfigValidationIssues"
+ $ref: '#/components/schemas/AWSCcmConfigValidationIssues'
required:
- account_id
- issues
@@ -3184,13 +3184,13 @@ components:
description: AWS CCM config validation response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSCcmConfigValidationResponseAttributes"
+ $ref: '#/components/schemas/AWSCcmConfigValidationResponseAttributes'
id:
description: AWS CCM config validation resource identifier.
example: "ccm_config_validation"
type: string
type:
- $ref: "#/components/schemas/AWSCcmConfigValidationType"
+ $ref: '#/components/schemas/AWSCcmConfigValidationType'
required:
- attributes
- id
@@ -3244,9 +3244,9 @@ components:
description: Data for creating an AWS cloud authentication persona mapping
properties:
attributes:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateAttributes"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateAttributes'
type:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingType"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingType'
required:
- type
- attributes
@@ -3255,7 +3255,7 @@ components:
description: Request used to create an AWS cloud authentication persona mapping
properties:
data:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateData"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateData'
required:
- data
type: object
@@ -3263,13 +3263,13 @@ components:
description: Data for AWS cloud authentication persona mapping response
properties:
attributes:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingAttributesResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingAttributesResponse'
id:
description: Unique identifier for the persona mapping
example: "c5c758c6-18c2-4484-ae3f-46b84128404a"
type: string
type:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingType"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingType'
required:
- id
- type
@@ -3279,7 +3279,7 @@ components:
description: Response containing a single AWS cloud authentication persona mapping
properties:
data:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingDataResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingDataResponse'
required:
- data
type: object
@@ -3294,7 +3294,7 @@ components:
AWSCloudAuthPersonaMappingsData:
description: List of AWS cloud authentication persona mappings
items:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingDataResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingDataResponse'
type: array
AWSCloudAuthPersonaMappingsResponse:
description: Response containing a list of AWS cloud authentication persona mappings
@@ -3314,11 +3314,11 @@ components:
AWSCredentials:
description: The definition of `AWSCredentials` object.
oneOf:
- - $ref: "#/components/schemas/AWSAssumeRole"
+ - $ref: '#/components/schemas/AWSAssumeRole'
AWSCredentialsUpdate:
description: The definition of `AWSCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/AWSAssumeRoleUpdate"
+ - $ref: '#/components/schemas/AWSAssumeRoleUpdate'
AWSEventBridgeAccountConfiguration:
description: The EventBridge configuration for one AWS account.
properties:
@@ -3329,7 +3329,7 @@ components:
event_hubs:
description: Array of AWS event sources associated with this account.
items:
- $ref: "#/components/schemas/AWSEventBridgeSource"
+ $ref: '#/components/schemas/AWSEventBridgeSource'
type: array
tags:
description: |-
@@ -3345,7 +3345,7 @@ components:
description: Amazon EventBridge create request body.
properties:
data:
- $ref: "#/components/schemas/AWSEventBridgeCreateRequestData"
+ $ref: '#/components/schemas/AWSEventBridgeCreateRequestData'
required:
- data
type: object
@@ -3353,7 +3353,7 @@ components:
description: The EventBridge source to be created.
properties:
account_id:
- $ref: "#/components/schemas/AWSAccountID"
+ $ref: '#/components/schemas/AWSAccountID'
create_event_bus:
description: |-
Set to true if Datadog should create the event bus in addition to the event
@@ -3381,9 +3381,9 @@ components:
description: Amazon EventBridge create request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSEventBridgeCreateRequestAttributes"
+ $ref: '#/components/schemas/AWSEventBridgeCreateRequestAttributes'
type:
- $ref: "#/components/schemas/AWSEventBridgeType"
+ $ref: '#/components/schemas/AWSEventBridgeType'
required:
- attributes
- type
@@ -3392,7 +3392,7 @@ components:
description: Amazon EventBridge create response body.
properties:
data:
- $ref: "#/components/schemas/AWSEventBridgeCreateResponseData"
+ $ref: '#/components/schemas/AWSEventBridgeCreateResponseData'
required:
- data
type: object
@@ -3414,20 +3414,20 @@ components:
example: "us-east-1"
type: string
status:
- $ref: "#/components/schemas/AWSEventBridgeCreateStatus"
+ $ref: '#/components/schemas/AWSEventBridgeCreateStatus'
type: object
AWSEventBridgeCreateResponseData:
description: Amazon EventBridge create response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSEventBridgeCreateResponseAttributes"
+ $ref: '#/components/schemas/AWSEventBridgeCreateResponseAttributes'
id:
default: "create_event_bridge"
description: The ID of the Amazon EventBridge create response data.
example: "create_event_bridge"
type: string
type:
- $ref: "#/components/schemas/AWSEventBridgeType"
+ $ref: '#/components/schemas/AWSEventBridgeType'
required:
- attributes
- type
@@ -3442,7 +3442,7 @@ components:
description: Amazon EventBridge delete request body.
properties:
data:
- $ref: "#/components/schemas/AWSEventBridgeDeleteRequestData"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteRequestData'
required:
- data
type: object
@@ -3450,7 +3450,7 @@ components:
description: The EventBridge source to be deleted.
properties:
account_id:
- $ref: "#/components/schemas/AWSAccountID"
+ $ref: '#/components/schemas/AWSAccountID'
event_generator_name:
description: The event source name.
example: "app-alerts-zyxw3210"
@@ -3470,9 +3470,9 @@ components:
description: Amazon EventBridge delete request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSEventBridgeDeleteRequestAttributes"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteRequestAttributes'
type:
- $ref: "#/components/schemas/AWSEventBridgeType"
+ $ref: '#/components/schemas/AWSEventBridgeType'
required:
- attributes
- type
@@ -3481,7 +3481,7 @@ components:
description: Amazon EventBridge delete response body.
properties:
data:
- $ref: "#/components/schemas/AWSEventBridgeDeleteResponseData"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteResponseData'
required:
- data
type: object
@@ -3489,20 +3489,20 @@ components:
description: The EventBridge source delete response attributes.
properties:
status:
- $ref: "#/components/schemas/AWSEventBridgeDeleteStatus"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteStatus'
type: object
AWSEventBridgeDeleteResponseData:
description: Amazon EventBridge delete response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSEventBridgeDeleteResponseAttributes"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteResponseAttributes'
id:
default: "delete_event_bridge"
description: The ID of the Amazon EventBridge list response data.
example: "delete_event_bridge"
type: string
type:
- $ref: "#/components/schemas/AWSEventBridgeType"
+ $ref: '#/components/schemas/AWSEventBridgeType'
required:
- attributes
- type
@@ -3517,7 +3517,7 @@ components:
description: Amazon EventBridge list response body.
properties:
data:
- $ref: "#/components/schemas/AWSEventBridgeListResponseData"
+ $ref: '#/components/schemas/AWSEventBridgeListResponseData'
required:
- data
type: object
@@ -3527,7 +3527,7 @@ components:
accounts:
description: List of accounts with their event sources.
items:
- $ref: "#/components/schemas/AWSEventBridgeAccountConfiguration"
+ $ref: '#/components/schemas/AWSEventBridgeAccountConfiguration'
type: array
is_installed:
description: True if the EventBridge integration is enabled for your organization.
@@ -3537,14 +3537,14 @@ components:
description: Amazon EventBridge list response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSEventBridgeListResponseAttributes"
+ $ref: '#/components/schemas/AWSEventBridgeListResponseAttributes'
id:
default: "get_event_bridge"
description: The ID of the Amazon EventBridge list response data.
example: "get_event_bridge"
type: string
type:
- $ref: "#/components/schemas/AWSEventBridgeType"
+ $ref: '#/components/schemas/AWSEventBridgeType'
required:
- attributes
- id
@@ -3577,9 +3577,9 @@ components:
description: The definition of `AWSIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/AWSCredentials"
+ $ref: '#/components/schemas/AWSCredentials'
type:
- $ref: "#/components/schemas/AWSIntegrationType"
+ $ref: '#/components/schemas/AWSIntegrationType'
required:
- type
- credentials
@@ -3588,7 +3588,7 @@ components:
description: AWS Integration IAM Permissions response body.
properties:
data:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseData"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseData'
required:
- data
type: object
@@ -3615,14 +3615,14 @@ components:
description: AWS Integration IAM Permissions response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseAttributes"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseAttributes'
id:
default: "permissions"
description: The `AWSIntegrationIamPermissionsResponseData` `id`.
example: "permissions"
type: string
type:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponseDataType"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponseDataType'
type: object
AWSIntegrationIamPermissionsResponseDataType:
default: "permissions"
@@ -3645,9 +3645,9 @@ components:
description: The definition of `AWSIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/AWSCredentialsUpdate"
+ $ref: '#/components/schemas/AWSCredentialsUpdate'
type:
- $ref: "#/components/schemas/AWSIntegrationType"
+ $ref: '#/components/schemas/AWSIntegrationType'
required:
- type
type: object
@@ -3665,7 +3665,7 @@ components:
type: string
type: array
log_source_config:
- $ref: "#/components/schemas/AWSLambdaForwarderConfigLogSourceConfig"
+ $ref: '#/components/schemas/AWSLambdaForwarderConfigLogSourceConfig'
sources:
description: |-
List of service IDs set to enable automatic log collection.
@@ -3685,7 +3685,7 @@ components:
tag_filters:
description: List of AWS log source tag filters. Defaults to `[]`.
items:
- $ref: "#/components/schemas/AWSLogSourceTagFilter"
+ $ref: '#/components/schemas/AWSLogSourceTagFilter'
type: array
type: object
AWSLogSourceTagFilter:
@@ -3716,13 +3716,13 @@ components:
description: AWS Logs Collection config.
properties:
lambda_forwarder:
- $ref: "#/components/schemas/AWSLambdaForwarderConfig"
+ $ref: '#/components/schemas/AWSLambdaForwarderConfig'
type: object
AWSLogsServicesResponse:
description: AWS Logs Services response body
properties:
data:
- $ref: "#/components/schemas/AWSLogsServicesResponseData"
+ $ref: '#/components/schemas/AWSLogsServicesResponseData'
required:
- data
type: object
@@ -3745,14 +3745,14 @@ components:
description: AWS Logs Services response body
properties:
attributes:
- $ref: "#/components/schemas/AWSLogsServicesResponseAttributes"
+ $ref: '#/components/schemas/AWSLogsServicesResponseAttributes'
id:
default: "logs_services"
description: The `AWSLogsServicesResponseData` `id`.
example: "logs_services"
type: string
type:
- $ref: "#/components/schemas/AWSLogsServicesResponseDataType"
+ $ref: '#/components/schemas/AWSLogsServicesResponseDataType'
required:
- id
- type
@@ -3807,7 +3807,7 @@ components:
dd_names:
description: The Datadog metric names produced from this CloudWatch metric.
items:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewDDName"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewDDName'
type: array
required:
- cw_name
@@ -3819,14 +3819,14 @@ components:
filters:
description: The metric name filter patterns evaluated for this namespace and how many metrics they matched.
items:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewFilterMatch"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewFilterMatch'
type: array
metrics:
description: |-
The CloudWatch metrics collected for this namespace and whether each resulting
Datadog metric is filtered.
items:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewMetric"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewMetric'
type: array
namespace:
description: The AWS CloudWatch namespace.
@@ -3841,7 +3841,7 @@ components:
description: AWS metric name filter preview request body.
properties:
data:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewRequestData"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewRequestData'
required:
- data
type: object
@@ -3851,7 +3851,7 @@ components:
metric_name_filters:
description: The metric name filters to preview.
items:
- $ref: "#/components/schemas/AWSMetricNameFilters"
+ $ref: '#/components/schemas/AWSMetricNameFilters'
type: array
required:
- metric_name_filters
@@ -3860,9 +3860,9 @@ components:
description: AWS metric name filter preview request data.
properties:
attributes:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewRequestAttributes"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewRequestAttributes'
type:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewType"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewType'
required:
- type
- attributes
@@ -3871,7 +3871,7 @@ components:
description: AWS metric name filter preview response body.
properties:
data:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewResponseData"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewResponseData'
required:
- data
type: object
@@ -3881,7 +3881,7 @@ components:
namespaces:
description: The list of namespaces affected by the previewed metric name filters.
items:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewNamespace"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewNamespace'
type: array
required:
- namespaces
@@ -3890,11 +3890,11 @@ components:
description: AWS metric name filter preview response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewResponseAttributes"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewResponseAttributes'
id:
- $ref: "#/components/schemas/AWSAccountConfigID"
+ $ref: '#/components/schemas/AWSAccountConfigID'
type:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewType"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewType'
required:
- id
- type
@@ -3914,8 +3914,8 @@ components:
AWS CloudWatch metric name filter for a single namespace.
Exactly one of `include_only` or `exclude_only` must be set.
oneOf:
- - $ref: "#/components/schemas/AWSMetricNameFiltersIncludeOnly"
- - $ref: "#/components/schemas/AWSMetricNameFiltersExcludeOnly"
+ - $ref: '#/components/schemas/AWSMetricNameFiltersIncludeOnly'
+ - $ref: '#/components/schemas/AWSMetricNameFiltersExcludeOnly'
AWSMetricNameFiltersExcludeOnly:
description: Exclude metric names matching one of these patterns for a single namespace.
properties:
@@ -3980,21 +3980,21 @@ components:
AWS CloudWatch metric name filters. Each filter applies to a single namespace.
Exactly one of `include_only` or `exclude_only` must be set on each filter.
items:
- $ref: "#/components/schemas/AWSMetricNameFilters"
+ $ref: '#/components/schemas/AWSMetricNameFilters'
type: array
namespace_filters:
- $ref: "#/components/schemas/AWSNamespaceFilters"
+ $ref: '#/components/schemas/AWSNamespaceFilters'
tag_filters:
description: AWS Metrics collection tag filters list. Defaults to `[]`.
items:
- $ref: "#/components/schemas/AWSNamespaceTagFilter"
+ $ref: '#/components/schemas/AWSNamespaceTagFilter'
type: array
type: object
AWSNamespaceFilters:
description: AWS Metrics namespace filters. Defaults to `exclude_only`.
oneOf:
- - $ref: "#/components/schemas/AWSNamespaceFiltersExcludeOnly"
- - $ref: "#/components/schemas/AWSNamespaceFiltersIncludeOnly"
+ - $ref: '#/components/schemas/AWSNamespaceFiltersExcludeOnly'
+ - $ref: '#/components/schemas/AWSNamespaceFiltersIncludeOnly'
AWSNamespaceFiltersExcludeOnly:
description: |-
Exclude only these namespaces from metrics collection.
@@ -4062,7 +4062,7 @@ components:
description: AWS Namespaces response body.
properties:
data:
- $ref: "#/components/schemas/AWSNamespacesResponseData"
+ $ref: '#/components/schemas/AWSNamespacesResponseData'
required:
- data
type: object
@@ -4085,14 +4085,14 @@ components:
description: AWS Namespaces response data.
properties:
attributes:
- $ref: "#/components/schemas/AWSNamespacesResponseAttributes"
+ $ref: '#/components/schemas/AWSNamespacesResponseAttributes'
id:
default: "namespaces"
description: The `AWSNamespacesResponseData` `id`.
example: "namespaces"
type: string
type:
- $ref: "#/components/schemas/AWSNamespacesResponseDataType"
+ $ref: '#/components/schemas/AWSNamespacesResponseDataType'
required:
- id
- type
@@ -4110,7 +4110,7 @@ components:
description: AWS External ID response body.
properties:
data:
- $ref: "#/components/schemas/AWSNewExternalIDResponseData"
+ $ref: '#/components/schemas/AWSNewExternalIDResponseData'
required:
- data
type: object
@@ -4128,14 +4128,14 @@ components:
description: AWS External ID response body.
properties:
attributes:
- $ref: "#/components/schemas/AWSNewExternalIDResponseAttributes"
+ $ref: '#/components/schemas/AWSNewExternalIDResponseAttributes'
id:
default: "external_id"
description: The `AWSNewExternalIDResponseData` `id`.
example: "external_id"
type: string
type:
- $ref: "#/components/schemas/AWSNewExternalIDResponseDataType"
+ $ref: '#/components/schemas/AWSNewExternalIDResponseDataType'
required:
- id
- type
@@ -4152,8 +4152,8 @@ components:
AWSRegions:
description: AWS Regions to collect data from. Defaults to `include_all`.
oneOf:
- - $ref: "#/components/schemas/AWSRegionsIncludeAll"
- - $ref: "#/components/schemas/AWSRegionsIncludeOnly"
+ - $ref: '#/components/schemas/AWSRegionsIncludeAll'
+ - $ref: '#/components/schemas/AWSRegionsIncludeOnly'
AWSRegionsIncludeAll:
description: Include all regions. Defaults to `true`.
properties:
@@ -4200,26 +4200,26 @@ components:
description: AWS Traces Collection config.
properties:
xray_services:
- $ref: "#/components/schemas/XRayServicesList"
+ $ref: '#/components/schemas/XRayServicesList'
type: object
AccessTokenListItem:
description: An access token entry returned by the personal access tokens list endpoint. May represent either a personal or a service access token.
properties:
attributes:
- $ref: "#/components/schemas/PersonalAccessTokenAttributes"
+ $ref: '#/components/schemas/PersonalAccessTokenAttributes'
id:
description: ID of the access token.
type: string
relationships:
- $ref: "#/components/schemas/AccessTokenListItemRelationships"
+ $ref: '#/components/schemas/AccessTokenListItemRelationships'
type:
- $ref: "#/components/schemas/AccessTokensType"
+ $ref: '#/components/schemas/AccessTokensType'
type: object
AccessTokenListItemRelationships:
description: Resources related to the access token entry in the mixed list response.
properties:
owned_by:
- $ref: "#/components/schemas/RelationshipToAccessTokenOwner"
+ $ref: '#/components/schemas/RelationshipToAccessTokenOwner'
type: object
AccessTokenOwnerType:
description: Owner resource type. Either a user or a service account.
@@ -4268,13 +4268,13 @@ components:
description: The account filters for a cloud account.
properties:
attributes:
- $ref: "#/components/schemas/AccountFiltersAttributes"
+ $ref: '#/components/schemas/AccountFiltersAttributes'
id:
description: The ID of the cloud account.
example: "123456789123"
type: string
type:
- $ref: "#/components/schemas/AccountFiltersType"
+ $ref: '#/components/schemas/AccountFiltersType'
required:
- attributes
- type
@@ -4283,7 +4283,7 @@ components:
description: Attributes for the account filters of a cloud account.
properties:
account_filters:
- $ref: "#/components/schemas/AccountFilteringConfig"
+ $ref: '#/components/schemas/AccountFilteringConfig'
account_id:
description: The cloud account ID.
example: "123456789123"
@@ -4297,9 +4297,9 @@ components:
description: Account filters patch data.
properties:
attributes:
- $ref: "#/components/schemas/AccountFiltersPatchRequestAttributes"
+ $ref: '#/components/schemas/AccountFiltersPatchRequestAttributes'
type:
- $ref: "#/components/schemas/AccountFiltersPatchRequestType"
+ $ref: '#/components/schemas/AccountFiltersPatchRequestType'
required:
- attributes
- type
@@ -4308,7 +4308,7 @@ components:
description: Account filters patch request.
properties:
data:
- $ref: "#/components/schemas/AccountFiltersPatchData"
+ $ref: '#/components/schemas/AccountFiltersPatchData'
required:
- data
type: object
@@ -4316,7 +4316,7 @@ components:
description: Attributes for an account filters patch request.
properties:
account_filters:
- $ref: "#/components/schemas/AccountFilteringConfig"
+ $ref: '#/components/schemas/AccountFilteringConfig'
required:
- account_filters
type: object
@@ -4333,7 +4333,7 @@ components:
description: Response containing the account filters for a cloud account.
properties:
data:
- $ref: "#/components/schemas/AccountFilters"
+ $ref: '#/components/schemas/AccountFilters'
type: object
AccountFiltersType:
default: account_filters
@@ -4348,7 +4348,7 @@ components:
description: The definition of `ActionConnectionAttributes` object.
properties:
integration:
- $ref: "#/components/schemas/ActionConnectionIntegration"
+ $ref: '#/components/schemas/ActionConnectionIntegration'
name:
description: Name of the connection
example: My AWS Connection
@@ -4373,7 +4373,7 @@ components:
description: The definition of `ActionConnectionAttributesUpdate` object.
properties:
integration:
- $ref: "#/components/schemas/ActionConnectionIntegrationUpdate"
+ $ref: '#/components/schemas/ActionConnectionIntegrationUpdate'
name:
description: Name of the connection
example: My AWS Connection
@@ -4395,13 +4395,13 @@ components:
description: Data related to the connection.
properties:
attributes:
- $ref: "#/components/schemas/ActionConnectionAttributes"
+ $ref: '#/components/schemas/ActionConnectionAttributes'
id:
description: The connection identifier
readOnly: true
type: string
type:
- $ref: "#/components/schemas/ActionConnectionDataType"
+ $ref: '#/components/schemas/ActionConnectionDataType'
required:
- type
- attributes
@@ -4418,9 +4418,9 @@ components:
description: Data related to the connection update.
properties:
attributes:
- $ref: "#/components/schemas/ActionConnectionAttributesUpdate"
+ $ref: '#/components/schemas/ActionConnectionAttributesUpdate'
type:
- $ref: "#/components/schemas/ActionConnectionDataType"
+ $ref: '#/components/schemas/ActionConnectionDataType'
required:
- type
- attributes
@@ -4428,64 +4428,64 @@ components:
ActionConnectionIntegration:
description: The definition of `ActionConnectionIntegration` object.
oneOf:
- - $ref: "#/components/schemas/AWSIntegration"
- - $ref: "#/components/schemas/AnthropicIntegration"
- - $ref: "#/components/schemas/AsanaIntegration"
- - $ref: "#/components/schemas/AzureIntegration"
- - $ref: "#/components/schemas/CircleCIIntegration"
- - $ref: "#/components/schemas/ClickupIntegration"
- - $ref: "#/components/schemas/CloudflareIntegration"
- - $ref: "#/components/schemas/ConfigCatIntegration"
- - $ref: "#/components/schemas/DatadogIntegration"
- - $ref: "#/components/schemas/FastlyIntegration"
- - $ref: "#/components/schemas/FreshserviceIntegration"
- - $ref: "#/components/schemas/GCPIntegration"
- - $ref: "#/components/schemas/GeminiIntegration"
- - $ref: "#/components/schemas/GitlabIntegration"
- - $ref: "#/components/schemas/GreyNoiseIntegration"
- - $ref: "#/components/schemas/HTTPIntegration"
- - $ref: "#/components/schemas/LaunchDarklyIntegration"
- - $ref: "#/components/schemas/NotionIntegration"
- - $ref: "#/components/schemas/OktaIntegration"
- - $ref: "#/components/schemas/OpenAIIntegration"
- - $ref: "#/components/schemas/ServiceNowIntegration"
- - $ref: "#/components/schemas/SplitIntegration"
- - $ref: "#/components/schemas/StatsigIntegration"
- - $ref: "#/components/schemas/VirusTotalIntegration"
+ - $ref: '#/components/schemas/AWSIntegration'
+ - $ref: '#/components/schemas/AnthropicIntegration'
+ - $ref: '#/components/schemas/AsanaIntegration'
+ - $ref: '#/components/schemas/AzureIntegration'
+ - $ref: '#/components/schemas/CircleCIIntegration'
+ - $ref: '#/components/schemas/ClickupIntegration'
+ - $ref: '#/components/schemas/CloudflareIntegration'
+ - $ref: '#/components/schemas/ConfigCatIntegration'
+ - $ref: '#/components/schemas/DatadogIntegration'
+ - $ref: '#/components/schemas/FastlyIntegration'
+ - $ref: '#/components/schemas/FreshserviceIntegration'
+ - $ref: '#/components/schemas/GCPIntegration'
+ - $ref: '#/components/schemas/GeminiIntegration'
+ - $ref: '#/components/schemas/GitlabIntegration'
+ - $ref: '#/components/schemas/GreyNoiseIntegration'
+ - $ref: '#/components/schemas/HTTPIntegration'
+ - $ref: '#/components/schemas/LaunchDarklyIntegration'
+ - $ref: '#/components/schemas/NotionIntegration'
+ - $ref: '#/components/schemas/OktaIntegration'
+ - $ref: '#/components/schemas/OpenAIIntegration'
+ - $ref: '#/components/schemas/ServiceNowIntegration'
+ - $ref: '#/components/schemas/SplitIntegration'
+ - $ref: '#/components/schemas/StatsigIntegration'
+ - $ref: '#/components/schemas/VirusTotalIntegration'
ActionConnectionIntegrationUpdate:
description: The definition of `ActionConnectionIntegrationUpdate` object.
oneOf:
- - $ref: "#/components/schemas/AWSIntegrationUpdate"
- - $ref: "#/components/schemas/AnthropicIntegrationUpdate"
- - $ref: "#/components/schemas/AsanaIntegrationUpdate"
- - $ref: "#/components/schemas/AzureIntegrationUpdate"
- - $ref: "#/components/schemas/CircleCIIntegrationUpdate"
- - $ref: "#/components/schemas/ClickupIntegrationUpdate"
- - $ref: "#/components/schemas/CloudflareIntegrationUpdate"
- - $ref: "#/components/schemas/ConfigCatIntegrationUpdate"
- - $ref: "#/components/schemas/DatadogIntegrationUpdate"
- - $ref: "#/components/schemas/FastlyIntegrationUpdate"
- - $ref: "#/components/schemas/FreshserviceIntegrationUpdate"
- - $ref: "#/components/schemas/GCPIntegrationUpdate"
- - $ref: "#/components/schemas/GeminiIntegrationUpdate"
- - $ref: "#/components/schemas/GitlabIntegrationUpdate"
- - $ref: "#/components/schemas/GreyNoiseIntegrationUpdate"
- - $ref: "#/components/schemas/HTTPIntegrationUpdate"
- - $ref: "#/components/schemas/LaunchDarklyIntegrationUpdate"
- - $ref: "#/components/schemas/NotionIntegrationUpdate"
- - $ref: "#/components/schemas/OktaIntegrationUpdate"
- - $ref: "#/components/schemas/OpenAIIntegrationUpdate"
- - $ref: "#/components/schemas/ServiceNowIntegrationUpdate"
- - $ref: "#/components/schemas/SplitIntegrationUpdate"
- - $ref: "#/components/schemas/StatsigIntegrationUpdate"
- - $ref: "#/components/schemas/VirusTotalIntegrationUpdate"
+ - $ref: '#/components/schemas/AWSIntegrationUpdate'
+ - $ref: '#/components/schemas/AnthropicIntegrationUpdate'
+ - $ref: '#/components/schemas/AsanaIntegrationUpdate'
+ - $ref: '#/components/schemas/AzureIntegrationUpdate'
+ - $ref: '#/components/schemas/CircleCIIntegrationUpdate'
+ - $ref: '#/components/schemas/ClickupIntegrationUpdate'
+ - $ref: '#/components/schemas/CloudflareIntegrationUpdate'
+ - $ref: '#/components/schemas/ConfigCatIntegrationUpdate'
+ - $ref: '#/components/schemas/DatadogIntegrationUpdate'
+ - $ref: '#/components/schemas/FastlyIntegrationUpdate'
+ - $ref: '#/components/schemas/FreshserviceIntegrationUpdate'
+ - $ref: '#/components/schemas/GCPIntegrationUpdate'
+ - $ref: '#/components/schemas/GeminiIntegrationUpdate'
+ - $ref: '#/components/schemas/GitlabIntegrationUpdate'
+ - $ref: '#/components/schemas/GreyNoiseIntegrationUpdate'
+ - $ref: '#/components/schemas/HTTPIntegrationUpdate'
+ - $ref: '#/components/schemas/LaunchDarklyIntegrationUpdate'
+ - $ref: '#/components/schemas/NotionIntegrationUpdate'
+ - $ref: '#/components/schemas/OktaIntegrationUpdate'
+ - $ref: '#/components/schemas/OpenAIIntegrationUpdate'
+ - $ref: '#/components/schemas/ServiceNowIntegrationUpdate'
+ - $ref: '#/components/schemas/SplitIntegrationUpdate'
+ - $ref: '#/components/schemas/StatsigIntegrationUpdate'
+ - $ref: '#/components/schemas/VirusTotalIntegrationUpdate'
ActionQuery:
description: An action query. This query type is used to trigger an action, such as sending a HTTP request.
properties:
events:
description: Events to listen for downstream of the action query.
items:
- $ref: "#/components/schemas/AppBuilderEvent"
+ $ref: '#/components/schemas/AppBuilderEvent'
type: array
id:
description: The ID of the action query.
@@ -4497,9 +4497,9 @@ components:
example: "fetchPendingOrders"
type: string
properties:
- $ref: "#/components/schemas/ActionQueryProperties"
+ $ref: '#/components/schemas/ActionQueryProperties'
type:
- $ref: "#/components/schemas/ActionQueryType"
+ $ref: '#/components/schemas/ActionQueryType'
required:
- id
- name
@@ -4525,7 +4525,7 @@ components:
description: The mocked outputs of the action query. This is useful for testing the app without actually running the action.
oneOf:
- type: string
- - $ref: "#/components/schemas/ActionQueryMockedOutputsObject"
+ - $ref: '#/components/schemas/ActionQueryMockedOutputsObject'
ActionQueryMockedOutputsEnabled:
description: Whether to enable the mocked outputs for testing.
example: false
@@ -4538,7 +4538,7 @@ components:
description: The mocked outputs of the action query.
properties:
enabled:
- $ref: "#/components/schemas/ActionQueryMockedOutputsEnabled"
+ $ref: '#/components/schemas/ActionQueryMockedOutputsEnabled'
outputs:
description: The mocked outputs of the action query, serialized as JSON.
example: '{"status": "success"}'
@@ -4567,25 +4567,25 @@ components:
description: The properties of the action query.
properties:
condition:
- $ref: "#/components/schemas/ActionQueryCondition"
+ $ref: '#/components/schemas/ActionQueryCondition'
debounceInMs:
- $ref: "#/components/schemas/ActionQueryDebounceInMs"
+ $ref: '#/components/schemas/ActionQueryDebounceInMs'
mockedOutputs:
- $ref: "#/components/schemas/ActionQueryMockedOutputs"
+ $ref: '#/components/schemas/ActionQueryMockedOutputs'
onlyTriggerManually:
- $ref: "#/components/schemas/ActionQueryOnlyTriggerManually"
+ $ref: '#/components/schemas/ActionQueryOnlyTriggerManually'
outputs:
description: The post-query transformation function, which is a JavaScript function that changes the query's `.outputs` property after the query's execution.
example: "${((outputs) => {return outputs.body.data})(self.rawOutputs)}"
type: string
pollingIntervalInMs:
- $ref: "#/components/schemas/ActionQueryPollingIntervalInMs"
+ $ref: '#/components/schemas/ActionQueryPollingIntervalInMs'
requiresConfirmation:
- $ref: "#/components/schemas/ActionQueryRequiresConfirmation"
+ $ref: '#/components/schemas/ActionQueryRequiresConfirmation'
showToastOnError:
- $ref: "#/components/schemas/ActionQueryShowToastOnError"
+ $ref: '#/components/schemas/ActionQueryShowToastOnError'
spec:
- $ref: "#/components/schemas/ActionQuerySpec"
+ $ref: '#/components/schemas/ActionQuerySpec'
required:
- spec
type: object
@@ -4608,7 +4608,7 @@ components:
example: ""
oneOf:
- type: string
- - $ref: "#/components/schemas/ActionQuerySpecObject"
+ - $ref: '#/components/schemas/ActionQuerySpecObject'
ActionQuerySpecConnectionGroup:
description: The connection group to use for an action query.
properties:
@@ -4632,12 +4632,12 @@ components:
description: The inputs to the action query. These are the values that are passed to the action when it is triggered.
oneOf:
- type: string
- - $ref: "#/components/schemas/ActionQuerySpecInput"
+ - $ref: '#/components/schemas/ActionQuerySpecInput'
ActionQuerySpecObject:
description: The action query spec object.
properties:
connectionGroup:
- $ref: "#/components/schemas/ActionQuerySpecConnectionGroup"
+ $ref: '#/components/schemas/ActionQuerySpecConnectionGroup'
connectionId:
description: The ID of the custom connection to use for this action query.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
@@ -4647,7 +4647,7 @@ components:
example: "com.datadoghq.http.request"
type: string
inputs:
- $ref: "#/components/schemas/ActionQuerySpecInputs"
+ $ref: '#/components/schemas/ActionQuerySpecInputs'
required:
- fqn
type: object
@@ -4679,18 +4679,18 @@ components:
description: Active billing dimensions data.
properties:
attributes:
- $ref: "#/components/schemas/ActiveBillingDimensionsAttributes"
+ $ref: '#/components/schemas/ActiveBillingDimensionsAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/ActiveBillingDimensionsType"
+ $ref: '#/components/schemas/ActiveBillingDimensionsType'
type: object
ActiveBillingDimensionsResponse:
description: Active billing dimensions response.
properties:
data:
- $ref: "#/components/schemas/ActiveBillingDimensionsBody"
+ $ref: '#/components/schemas/ActiveBillingDimensionsBody'
type: object
ActiveBillingDimensionsType:
default: billing_dimensions
@@ -4704,7 +4704,7 @@ components:
description: Request to add a member team to super team's hierarchy
properties:
data:
- $ref: "#/components/schemas/MemberTeam"
+ $ref: '#/components/schemas/MemberTeam'
required:
- data
type: object
@@ -4731,15 +4731,15 @@ components:
description: "Trigger a workflow from an agent via the MCP execute tool. Workflow can be executed from Bits Chat, Bits Agent Builder, Claude Code, Codex, Cursor, and any other coding agent using the Datadog MCP."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
AgentTriggerWrapper:
description: "Schema for an agent-based trigger."
properties:
agentTrigger:
- $ref: "#/components/schemas/AgentTrigger"
+ $ref: '#/components/schemas/AgentTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- agentTrigger
type: object
@@ -4867,11 +4867,11 @@ components:
example: resolve-promise
type: string
stats_per_view:
- $ref: "#/components/schemas/LongTaskStatsPerView"
+ $ref: '#/components/schemas/LongTaskStatsPerView'
top_invokers:
description: Top invokers within this invoker type, sorted by impact score descending.
items:
- $ref: "#/components/schemas/TopLongTaskInvoker"
+ $ref: '#/components/schemas/TopLongTaskInvoker'
type: array
view_occurrences:
description: Number of sampled views where this invoker type had any long tasks.
@@ -4889,7 +4889,7 @@ components:
description: Request body for the aggregated long tasks endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedLongTasksRequestData"
+ $ref: '#/components/schemas/AggregatedLongTasksRequestData'
required:
- data
type: object
@@ -4901,7 +4901,7 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
filter:
description: RUM query string to filter events (for example, @session.type:user @geo.country:US).
example: "@session.type:user"
@@ -4938,9 +4938,9 @@ components:
description: Data envelope for an aggregated long tasks request.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedLongTasksRequestAttributes"
+ $ref: '#/components/schemas/AggregatedLongTasksRequestAttributes'
type:
- $ref: "#/components/schemas/AggregatedLongTasksRequestType"
+ $ref: '#/components/schemas/AggregatedLongTasksRequestType'
required:
- type
- attributes
@@ -4957,7 +4957,7 @@ components:
description: Response body for the aggregated long tasks endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedLongTasksResponseData"
+ $ref: '#/components/schemas/AggregatedLongTasksResponseData'
required:
- data
type: object
@@ -4969,7 +4969,7 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
from:
description: Start of the analyzed time range as a Unix timestamp in seconds.
example: 1762437564
@@ -4978,7 +4978,7 @@ components:
long_tasks_by_invoker_type:
description: Long task statistics grouped by invoker type, sorted by impact score descending.
items:
- $ref: "#/components/schemas/AggregatedLongTasksByInvokerType"
+ $ref: '#/components/schemas/AggregatedLongTasksByInvokerType'
type: array
sampled_view_ids:
description: List of RUM view IDs sampled for this aggregation, capped at 50.
@@ -5015,13 +5015,13 @@ components:
description: Data envelope for an aggregated long tasks response.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedLongTasksResponseAttributes"
+ $ref: '#/components/schemas/AggregatedLongTasksResponseAttributes'
id:
description: Hash-based unique identifier for this aggregation.
example: 2f0b3455
type: string
type:
- $ref: "#/components/schemas/AggregatedLongTasksRequestType"
+ $ref: '#/components/schemas/AggregatedLongTasksRequestType'
required:
- id
- type
@@ -5183,7 +5183,7 @@ components:
example: /api/gallery
type: string
timing_breakdown:
- $ref: "#/components/schemas/AggregatedResourceTimingBreakdown"
+ $ref: '#/components/schemas/AggregatedResourceTimingBreakdown'
total_requests:
description: Total number of requests for this resource across all sampled views.
example: 27
@@ -5260,7 +5260,7 @@ components:
description: Request body for the aggregated signals and problems endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedSignalsProblemsRequestData"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsRequestData'
required:
- data
type: object
@@ -5272,7 +5272,7 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
detection_types:
description: List of detection types to include in the response. When omitted, all types are returned.
example:
@@ -5317,9 +5317,9 @@ components:
description: Data envelope for an aggregated signals and problems request.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedSignalsProblemsRequestAttributes"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsRequestAttributes'
type:
- $ref: "#/components/schemas/AggregatedSignalsProblemsRequestType"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsRequestType'
required:
- type
- attributes
@@ -5336,7 +5336,7 @@ components:
description: Response body for the aggregated signals and problems endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedSignalsProblemsResponseData"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsResponseData'
required:
- data
type: object
@@ -5348,16 +5348,16 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
from:
description: Start of the analyzed time range as a Unix timestamp in seconds.
example: 1710000000
format: int64
type: integer
problem_detections:
- $ref: "#/components/schemas/SignalsProblemsDetections"
+ $ref: '#/components/schemas/SignalsProblemsDetections'
sample_metadata:
- $ref: "#/components/schemas/SignalsProblemsSampleMetadata"
+ $ref: '#/components/schemas/SignalsProblemsSampleMetadata'
to:
description: End of the analyzed time range as a Unix timestamp in seconds.
example: 1710003600
@@ -5379,13 +5379,13 @@ components:
description: Data envelope for an aggregated signals and problems response.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedSignalsProblemsResponseAttributes"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsResponseAttributes'
id:
description: Hash-based unique identifier for this aggregation.
example: 2f0b3455
type: string
type:
- $ref: "#/components/schemas/AggregatedSignalsProblemsRequestType"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsRequestType'
required:
- id
- type
@@ -5569,7 +5569,7 @@ components:
format: double
type: number
metric:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteriaMetric"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteriaMetric'
min:
description: Minimum threshold in seconds (inclusive).
example: 2.5
@@ -5596,7 +5596,7 @@ components:
description: Request body for the aggregated waterfall endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedWaterfallRequestData"
+ $ref: '#/components/schemas/AggregatedWaterfallRequestData'
required:
- data
type: object
@@ -5608,7 +5608,7 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
filter:
description: RUM query string to filter events (for example, @session.type:user @geo.country:US).
example: "@session.type:user"
@@ -5649,9 +5649,9 @@ components:
description: Data envelope for an aggregated waterfall request.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedWaterfallRequestAttributes"
+ $ref: '#/components/schemas/AggregatedWaterfallRequestAttributes'
type:
- $ref: "#/components/schemas/AggregatedWaterfallRequestType"
+ $ref: '#/components/schemas/AggregatedWaterfallRequestType'
required:
- type
- attributes
@@ -5668,7 +5668,7 @@ components:
description: Response body for the aggregated waterfall endpoint.
properties:
data:
- $ref: "#/components/schemas/AggregatedWaterfallResponseData"
+ $ref: '#/components/schemas/AggregatedWaterfallResponseData'
required:
- data
type: object
@@ -5680,7 +5680,7 @@ components:
example: ccbc53b1-74f2-496b-bdd7-9a8fa7b7376b
type: string
criteria:
- $ref: "#/components/schemas/AggregatedWaterfallPerformanceCriteria"
+ $ref: '#/components/schemas/AggregatedWaterfallPerformanceCriteria'
from:
description: Start of the analyzed time range as a Unix timestamp in seconds.
example: 1762437564
@@ -5689,7 +5689,7 @@ components:
resources:
description: Network resources in chronological waterfall order.
items:
- $ref: "#/components/schemas/AggregatedResource"
+ $ref: '#/components/schemas/AggregatedResource'
type: array
sampled_view_ids:
description: List of RUM view IDs sampled for this aggregation, capped at 50.
@@ -5733,13 +5733,13 @@ components:
description: Data envelope for an aggregated waterfall response.
properties:
attributes:
- $ref: "#/components/schemas/AggregatedWaterfallResponseAttributes"
+ $ref: '#/components/schemas/AggregatedWaterfallResponseAttributes'
id:
description: Hash-based unique identifier for this aggregation.
example: 2f0b3455
type: string
type:
- $ref: "#/components/schemas/AggregatedWaterfallRequestType"
+ $ref: '#/components/schemas/AggregatedWaterfallRequestType'
required:
- id
- type
@@ -5782,7 +5782,7 @@ components:
description: Request body for creating an AI custom rule.
properties:
data:
- $ref: "#/components/schemas/AiCustomRuleRequestData"
+ $ref: '#/components/schemas/AiCustomRuleRequestData'
type: object
AiCustomRuleRequestAttributes:
description: Attributes for creating an AI custom rule.
@@ -5796,19 +5796,19 @@ components:
description: Request data for creating an AI custom rule.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRuleRequestAttributes"
+ $ref: '#/components/schemas/AiCustomRuleRequestAttributes'
id:
description: The rule identifier, which must match the name.
example: my-ai-rule
type: string
type:
- $ref: "#/components/schemas/AiCustomRuleDataType"
+ $ref: '#/components/schemas/AiCustomRuleDataType'
type: object
AiCustomRuleResponse:
description: Response containing a single AI custom rule.
properties:
data:
- $ref: "#/components/schemas/AiCustomRuleResponseData"
+ $ref: '#/components/schemas/AiCustomRuleResponseData'
required:
- data
type: object
@@ -5816,13 +5816,13 @@ components:
description: Response data for an AI custom rule.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRuleItem"
+ $ref: '#/components/schemas/AiCustomRuleItem'
id:
description: The rule identifier.
example: my-ai-rule
type: string
type:
- $ref: "#/components/schemas/AiCustomRuleDataType"
+ $ref: '#/components/schemas/AiCustomRuleDataType'
required:
- id
- type
@@ -5848,13 +5848,13 @@ components:
description: Request body for creating an AI custom rule revision.
properties:
data:
- $ref: "#/components/schemas/AiCustomRuleRevisionRequestData"
+ $ref: '#/components/schemas/AiCustomRuleRevisionRequestData'
type: object
AiCustomRuleRevisionRequestAttributes:
description: Attributes for creating an AI custom rule revision.
properties:
category:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory'
content:
description: Base64-encoded AI model content for this revision.
example: Content
@@ -5875,7 +5875,7 @@ components:
type: string
type: array
execution_mode:
- $ref: "#/components/schemas/AiCustomRuleRevisionExecutionMode"
+ $ref: '#/components/schemas/AiCustomRuleRevisionExecutionMode'
globs:
description: File glob patterns this rule applies to.
example:
@@ -5892,7 +5892,7 @@ components:
example: false
type: boolean
severity:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity'
short_description:
description: Base64-encoded short description.
example: Ruleset short description
@@ -5918,19 +5918,19 @@ components:
description: Request data for creating an AI custom rule revision.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRuleRevisionRequestAttributes"
+ $ref: '#/components/schemas/AiCustomRuleRevisionRequestAttributes'
id:
description: The revision identifier.
example: revision-abc-123
type: string
type:
- $ref: "#/components/schemas/AiCustomRuleRevisionDataType"
+ $ref: '#/components/schemas/AiCustomRuleRevisionDataType'
type: object
AiCustomRuleRevisionResponse:
description: Response containing a single AI custom rule revision.
properties:
data:
- $ref: "#/components/schemas/AiCustomRuleRevisionResponseData"
+ $ref: '#/components/schemas/AiCustomRuleRevisionResponseData'
required:
- data
type: object
@@ -5938,7 +5938,7 @@ components:
description: Response attributes of an AI custom rule revision.
properties:
category:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory'
checksum:
description: Checksum of the revision content.
example: abc123def456
@@ -5972,7 +5972,7 @@ components:
type: string
type: array
execution_mode:
- $ref: "#/components/schemas/AiCustomRuleRevisionExecutionMode"
+ $ref: '#/components/schemas/AiCustomRuleRevisionExecutionMode'
globs:
description: File glob patterns this rule applies to.
example:
@@ -5993,7 +5993,7 @@ components:
example: false
type: boolean
severity:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity'
short_description:
description: Base64-encoded short description.
example: Ruleset short description
@@ -6025,13 +6025,13 @@ components:
description: Response data for an AI custom rule revision.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRuleRevisionResponseAttributes"
+ $ref: '#/components/schemas/AiCustomRuleRevisionResponseAttributes'
id:
description: The revision identifier.
example: revision-abc-123
type: string
type:
- $ref: "#/components/schemas/AiCustomRuleRevisionDataType"
+ $ref: '#/components/schemas/AiCustomRuleRevisionDataType'
required:
- id
- type
@@ -6043,7 +6043,7 @@ components:
data:
description: The list of AI custom rule revisions.
items:
- $ref: "#/components/schemas/AiCustomRuleRevisionResponseData"
+ $ref: '#/components/schemas/AiCustomRuleRevisionResponseData'
type: array
required:
- data
@@ -6059,7 +6059,7 @@ components:
description: Request body for creating an AI custom ruleset.
properties:
data:
- $ref: "#/components/schemas/AiCustomRulesetRequestData"
+ $ref: '#/components/schemas/AiCustomRulesetRequestData'
type: object
AiCustomRulesetRequestAttributes:
description: Attributes for creating an AI custom ruleset.
@@ -6085,19 +6085,19 @@ components:
description: Request data for creating an AI custom ruleset.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRulesetRequestAttributes"
+ $ref: '#/components/schemas/AiCustomRulesetRequestAttributes'
id:
description: The ruleset identifier, which must match the name.
example: my-ai-ruleset
type: string
type:
- $ref: "#/components/schemas/AiCustomRulesetDataType"
+ $ref: '#/components/schemas/AiCustomRulesetDataType'
type: object
AiCustomRulesetResponse:
description: Response containing a single AI custom ruleset.
properties:
data:
- $ref: "#/components/schemas/AiCustomRulesetResponseData"
+ $ref: '#/components/schemas/AiCustomRulesetResponseData'
required:
- data
type: object
@@ -6124,7 +6124,7 @@ components:
rules:
description: The rules contained in the ruleset.
items:
- $ref: "#/components/schemas/AiCustomRuleItem"
+ $ref: '#/components/schemas/AiCustomRuleItem'
nullable: true
type: array
short_description:
@@ -6143,13 +6143,13 @@ components:
description: Response data for an AI custom ruleset.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRulesetResponseAttributes"
+ $ref: '#/components/schemas/AiCustomRulesetResponseAttributes'
id:
description: The ruleset identifier.
example: my-ai-ruleset
type: string
type:
- $ref: "#/components/schemas/AiCustomRulesetDataType"
+ $ref: '#/components/schemas/AiCustomRulesetDataType'
required:
- id
- type
@@ -6175,19 +6175,19 @@ components:
description: Request data for updating an AI custom ruleset.
properties:
attributes:
- $ref: "#/components/schemas/AiCustomRulesetUpdateAttributes"
+ $ref: '#/components/schemas/AiCustomRulesetUpdateAttributes'
id:
description: The ruleset identifier.
example: my-ai-ruleset
type: string
type:
- $ref: "#/components/schemas/AiCustomRulesetDataType"
+ $ref: '#/components/schemas/AiCustomRulesetDataType'
type: object
AiCustomRulesetUpdateRequest:
description: Request body for updating an AI custom ruleset.
properties:
data:
- $ref: "#/components/schemas/AiCustomRulesetUpdateData"
+ $ref: '#/components/schemas/AiCustomRulesetUpdateData'
type: object
AiCustomRulesetsResponse:
description: Response containing a list of AI custom rulesets.
@@ -6195,7 +6195,7 @@ components:
data:
description: The list of AI custom rulesets.
items:
- $ref: "#/components/schemas/AiCustomRulesetResponseData"
+ $ref: '#/components/schemas/AiCustomRulesetResponseData'
type: array
required:
- data
@@ -6211,7 +6211,7 @@ components:
description: Request body for creating an AI memory violation result.
properties:
data:
- $ref: "#/components/schemas/AiMemoryViolationResultRequestData"
+ $ref: '#/components/schemas/AiMemoryViolationResultRequestData'
type: object
AiMemoryViolationResultRequestAttributes:
description: Attributes for creating an AI memory violation result.
@@ -6242,7 +6242,7 @@ components:
example: abc123def456789012345678901234567890abcd
type: string
type:
- $ref: "#/components/schemas/AiMemoryViolationType"
+ $ref: '#/components/schemas/AiMemoryViolationType'
required:
- rule
- repository_id
@@ -6256,13 +6256,13 @@ components:
description: Request data for creating an AI memory violation result.
properties:
attributes:
- $ref: "#/components/schemas/AiMemoryViolationResultRequestAttributes"
+ $ref: '#/components/schemas/AiMemoryViolationResultRequestAttributes'
id:
description: The violation result identifier.
example: violation-abc
type: string
type:
- $ref: "#/components/schemas/AiMemoryViolationResultDataType"
+ $ref: '#/components/schemas/AiMemoryViolationResultDataType'
type: object
AiMemoryViolationResultResponseAttributes:
description: Response attributes of an AI memory violation result.
@@ -6302,7 +6302,7 @@ components:
example: abc123def456789012345678901234567890abcd
type: string
type:
- $ref: "#/components/schemas/AiMemoryViolationType"
+ $ref: '#/components/schemas/AiMemoryViolationType'
required:
- rule
- repository_id
@@ -6318,13 +6318,13 @@ components:
description: Response data for an AI memory violation result.
properties:
attributes:
- $ref: "#/components/schemas/AiMemoryViolationResultResponseAttributes"
+ $ref: '#/components/schemas/AiMemoryViolationResultResponseAttributes'
id:
description: The numeric identifier of the violation result.
example: "42"
type: string
type:
- $ref: "#/components/schemas/AiMemoryViolationResultDataType"
+ $ref: '#/components/schemas/AiMemoryViolationResultDataType'
required:
- id
- type
@@ -6336,7 +6336,7 @@ components:
data:
description: The list of AI memory violation results.
items:
- $ref: "#/components/schemas/AiMemoryViolationResultResponseData"
+ $ref: '#/components/schemas/AiMemoryViolationResultResponseData'
type: array
required:
- data
@@ -6360,7 +6360,7 @@ components:
description: Response attributes of an AI prompt.
properties:
category:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory'
checksum:
description: Checksum of the prompt content.
example: abc123
@@ -6384,7 +6384,7 @@ components:
type: string
type: array
execution_mode:
- $ref: "#/components/schemas/AiCustomRuleRevisionExecutionMode"
+ $ref: '#/components/schemas/AiCustomRuleRevisionExecutionMode'
file_search_keywords:
description: Keywords used to search for relevant files.
example:
@@ -6408,7 +6408,7 @@ components:
example: false
type: boolean
language:
- $ref: "#/components/schemas/Language"
+ $ref: '#/components/schemas/Language'
result_keywords_exclude:
description: Keywords to exclude from results.
example: []
@@ -6420,7 +6420,7 @@ components:
example: "1"
type: string
severity:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity'
short_description:
description: Base64-encoded short description.
example: Ruleset short description
@@ -6445,13 +6445,13 @@ components:
description: Response data for an AI prompt.
properties:
attributes:
- $ref: "#/components/schemas/AiPromptResponseAttributes"
+ $ref: '#/components/schemas/AiPromptResponseAttributes'
id:
description: The prompt identifier.
example: my-ai-ruleset/my-ai-rule
type: string
type:
- $ref: "#/components/schemas/AiPromptDataType"
+ $ref: '#/components/schemas/AiPromptDataType'
required:
- id
- type
@@ -6463,7 +6463,7 @@ components:
data:
description: The list of AI prompts.
items:
- $ref: "#/components/schemas/AiPromptResponseData"
+ $ref: '#/components/schemas/AiPromptResponseData'
type: array
required:
- data
@@ -6472,35 +6472,35 @@ components:
description: Alert event attributes.
properties:
aggregation_key:
- $ref: "#/components/schemas/V2EventAggregationKey"
+ $ref: '#/components/schemas/V2EventAggregationKey'
custom:
description: JSON object of custom attributes.
example: {}
type: object
evt:
- $ref: "#/components/schemas/EventSystemAttributes"
+ $ref: '#/components/schemas/EventSystemAttributes'
links:
description: The links related to the event.
example: [{"category": "runbook", "title": "Runbook Link", "url": "https://app.datadoghq.com/runbook"}]
items:
- $ref: "#/components/schemas/AlertEventAttributesLinksItem"
+ $ref: '#/components/schemas/AlertEventAttributesLinksItem'
type: array
priority:
- $ref: "#/components/schemas/AlertEventAttributesPriority"
+ $ref: '#/components/schemas/AlertEventAttributesPriority'
service:
- $ref: "#/components/schemas/V2EventService"
+ $ref: '#/components/schemas/V2EventService'
status:
- $ref: "#/components/schemas/AlertEventAttributesStatus"
+ $ref: '#/components/schemas/AlertEventAttributesStatus'
timestamp:
- $ref: "#/components/schemas/V2EventTimestamp"
+ $ref: '#/components/schemas/V2EventTimestamp'
title:
- $ref: "#/components/schemas/V2EventTitle"
+ $ref: '#/components/schemas/V2EventTitle'
type: object
AlertEventAttributesLinksItem:
description: A link.
properties:
category:
- $ref: "#/components/schemas/AlertEventAttributesLinksItemCategory"
+ $ref: '#/components/schemas/AlertEventAttributesLinksItemCategory'
title:
description: |-
The display text of the link.
@@ -6556,13 +6556,13 @@ components:
Alert event attributes.
properties:
custom:
- $ref: "#/components/schemas/AlertEventCustomAttributesCustom"
+ $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
links:
- $ref: "#/components/schemas/AlertEventCustomAttributesLinks"
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
priority:
- $ref: "#/components/schemas/AlertEventCustomAttributesPriority"
+ $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
status:
- $ref: "#/components/schemas/AlertEventCustomAttributesStatus"
+ $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
required:
- status
type: object
@@ -6576,7 +6576,7 @@ components:
description: |-
The links related to the event. Maximum of 20 links allowed.
items:
- $ref: "#/components/schemas/AlertEventCustomAttributesLinksItems"
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
maxItems: 20
minItems: 1
type: array
@@ -6586,7 +6586,7 @@ components:
A link.
properties:
category:
- $ref: "#/components/schemas/AlertEventCustomAttributesLinksItemsCategory"
+ $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
title:
description: |-
The display text of the link. Limited to 300 characters.
@@ -6674,11 +6674,11 @@ components:
nullable: true
type: string
exposure_schedule:
- $ref: "#/components/schemas/AllocationExposureSchedule"
+ $ref: '#/components/schemas/AllocationExposureSchedule'
guardrail_metrics:
description: Guardrail metrics associated with this targeting rule allocation.
items:
- $ref: "#/components/schemas/GuardrailMetric"
+ $ref: '#/components/schemas/GuardrailMetric'
type: array
id:
description: The unique identifier of the targeting rule allocation.
@@ -6701,10 +6701,10 @@ components:
targeting_rules:
description: Conditions associated with this targeting rule allocation.
items:
- $ref: "#/components/schemas/TargetingRule"
+ $ref: '#/components/schemas/TargetingRule'
type: array
type:
- $ref: "#/components/schemas/AllocationType"
+ $ref: '#/components/schemas/AllocationType'
updated_at:
description: The timestamp when the targeting rule allocation was last updated.
example: "2024-01-01T12:00:00Z"
@@ -6713,7 +6713,7 @@ components:
variant_weights:
description: Weighted variant assignments for this targeting rule allocation.
items:
- $ref: "#/components/schemas/VariantWeight"
+ $ref: '#/components/schemas/VariantWeight'
type: array
required:
- name
@@ -6731,9 +6731,9 @@ components:
description: Data wrapper for allocation request payloads.
properties:
attributes:
- $ref: "#/components/schemas/UpsertAllocationRequest"
+ $ref: '#/components/schemas/UpsertAllocationRequest'
type:
- $ref: "#/components/schemas/AllocationDataType"
+ $ref: '#/components/schemas/AllocationDataType'
required:
- type
- attributes
@@ -6742,14 +6742,14 @@ components:
description: Data wrapper for targeting rule allocation responses.
properties:
attributes:
- $ref: "#/components/schemas/Allocation"
+ $ref: '#/components/schemas/Allocation'
id:
description: The unique identifier of the targeting rule allocation.
example: "550e8400-e29b-41d4-a716-446655440020"
format: uuid
type: string
type:
- $ref: "#/components/schemas/AllocationDataType"
+ $ref: '#/components/schemas/AllocationDataType'
required:
- id
- type
@@ -6901,7 +6901,7 @@ components:
guardrail_triggers:
description: Guardrail trigger records for this schedule.
items:
- $ref: "#/components/schemas/AllocationExposureGuardrailTrigger"
+ $ref: '#/components/schemas/AllocationExposureGuardrailTrigger'
type: array
id:
description: The unique identifier of the progressive rollout.
@@ -6909,11 +6909,11 @@ components:
format: uuid
type: string
rollout_options:
- $ref: "#/components/schemas/RolloutOptions"
+ $ref: '#/components/schemas/RolloutOptions'
rollout_steps:
description: Ordered progression steps for exposure.
items:
- $ref: "#/components/schemas/AllocationExposureRolloutStep"
+ $ref: '#/components/schemas/AllocationExposureRolloutStep'
type: array
updated_at:
description: The timestamp when the schedule was last updated.
@@ -6932,14 +6932,14 @@ components:
description: Data wrapper for progressive rollout schedule responses.
properties:
attributes:
- $ref: "#/components/schemas/AllocationExposureSchedule"
+ $ref: '#/components/schemas/AllocationExposureSchedule'
id:
description: The unique identifier of the progressive rollout.
example: "550e8400-e29b-41d4-a716-446655440010"
format: uuid
type: string
type:
- $ref: "#/components/schemas/AllocationExposureScheduleDataType"
+ $ref: '#/components/schemas/AllocationExposureScheduleDataType'
required:
- id
- type
@@ -6957,7 +6957,7 @@ components:
description: Response containing a progressive rollout schedule.
properties:
data:
- $ref: "#/components/schemas/AllocationExposureScheduleData"
+ $ref: '#/components/schemas/AllocationExposureScheduleData'
required:
- data
type: object
@@ -6965,7 +6965,7 @@ components:
description: Response containing a single targeting rule (allocation).
properties:
data:
- $ref: "#/components/schemas/AllocationDataResponse"
+ $ref: '#/components/schemas/AllocationDataResponse'
required:
- data
type: object
@@ -6988,13 +6988,13 @@ components:
nullable: true
type: string
edit_type:
- $ref: "#/components/schemas/AnalysisEditType"
+ $ref: '#/components/schemas/AnalysisEditType'
end:
$ref: "#/components/schemas/AnalysisPosition"
description: The end position of the edit, or null for pure insertions.
nullable: true
start:
- $ref: "#/components/schemas/AnalysisPosition"
+ $ref: '#/components/schemas/AnalysisPosition'
required:
- start
- end
@@ -7024,7 +7024,7 @@ components:
edits:
description: The list of edit operations that constitute the fix.
items:
- $ref: "#/components/schemas/AnalysisEdit"
+ $ref: '#/components/schemas/AnalysisEdit'
type: array
required:
- description
@@ -7051,7 +7051,7 @@ components:
description: The request payload for running static analysis on source code.
properties:
data:
- $ref: "#/components/schemas/AnalysisRequestData"
+ $ref: '#/components/schemas/AnalysisRequestData'
required:
- data
type: object
@@ -7059,12 +7059,12 @@ components:
description: The primary data object in the analysis request.
properties:
attributes:
- $ref: "#/components/schemas/AnalysisRequestDataAttributes"
+ $ref: '#/components/schemas/AnalysisRequestDataAttributes'
id:
description: An optional identifier for the analysis request resource.
type: string
type:
- $ref: "#/components/schemas/AnalysisRequestDataType"
+ $ref: '#/components/schemas/AnalysisRequestDataType'
required:
- type
- attributes
@@ -7091,7 +7091,7 @@ components:
rules:
description: The list of static analysis rules to apply during analysis.
items:
- $ref: "#/components/schemas/AnalysisRequestRule"
+ $ref: '#/components/schemas/AnalysisRequestRule'
type: array
required:
- code
@@ -7166,7 +7166,7 @@ components:
description: The response payload from running static analysis on source code.
properties:
data:
- $ref: "#/components/schemas/AnalysisResponseData"
+ $ref: '#/components/schemas/AnalysisResponseData'
required:
- data
type: object
@@ -7174,13 +7174,13 @@ components:
description: The primary data object in the analysis response.
properties:
attributes:
- $ref: "#/components/schemas/AnalysisResponseDataAttributes"
+ $ref: '#/components/schemas/AnalysisResponseDataAttributes'
id:
description: The unique identifier of the analysis response resource.
example: abc-123
type: string
type:
- $ref: "#/components/schemas/AnalysisResponseDataType"
+ $ref: '#/components/schemas/AnalysisResponseDataType'
required:
- id
- type
@@ -7198,7 +7198,7 @@ components:
rule_responses:
description: The list of results for each static analysis rule applied during analysis.
items:
- $ref: "#/components/schemas/AnalysisRuleResponse"
+ $ref: '#/components/schemas/AnalysisRuleResponse'
type: array
required:
- rule_responses
@@ -7243,7 +7243,7 @@ components:
violations:
description: The list of violations found by this rule.
items:
- $ref: "#/components/schemas/AnalysisViolation"
+ $ref: '#/components/schemas/AnalysisViolation'
type: array
required:
- errors
@@ -7261,11 +7261,11 @@ components:
example: BEST_PRACTICES
type: string
end:
- $ref: "#/components/schemas/AnalysisPosition"
+ $ref: '#/components/schemas/AnalysisPosition'
fixes:
description: The list of suggested fixes for this violation.
items:
- $ref: "#/components/schemas/AnalysisFix"
+ $ref: '#/components/schemas/AnalysisFix'
type: array
message:
description: A human-readable description of the violation.
@@ -7276,7 +7276,7 @@ components:
example: WARNING
type: string
start:
- $ref: "#/components/schemas/AnalysisPosition"
+ $ref: '#/components/schemas/AnalysisPosition'
required:
- category
- severity
@@ -7289,14 +7289,14 @@ components:
description: A text annotation displayed on the workflow canvas.
properties:
display:
- $ref: "#/components/schemas/AnnotationDisplay"
+ $ref: '#/components/schemas/AnnotationDisplay'
id:
description: The unique identifier of this annotation within the workflow.
example: ""
minLength: 1
type: string
markdownTextAnnotation:
- $ref: "#/components/schemas/AnnotationMarkdownTextAnnotation"
+ $ref: '#/components/schemas/AnnotationMarkdownTextAnnotation'
required:
- id
- display
@@ -7310,7 +7310,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
color:
- $ref: "#/components/schemas/AnnotationColor"
+ $ref: '#/components/schemas/AnnotationColor'
created_at:
description: Creation time of the annotation in milliseconds since the Unix epoch.
example: 1704067200000
@@ -7343,7 +7343,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/AnnotationKind"
+ $ref: '#/components/schemas/AnnotationKind'
widget_ids:
description: IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
example:
@@ -7385,7 +7385,7 @@ components:
description: Attributes for creating or updating an annotation.
properties:
color:
- $ref: "#/components/schemas/AnnotationColor"
+ $ref: '#/components/schemas/AnnotationColor'
description:
description: User-defined text attached to the annotation.
example: "Deployed v2.3.1 to production."
@@ -7408,7 +7408,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/AnnotationKind"
+ $ref: '#/components/schemas/AnnotationKind'
widget_ids:
description: IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
example:
@@ -7428,7 +7428,7 @@ components:
description: Request body for creating an annotation.
properties:
data:
- $ref: "#/components/schemas/AnnotationRequestData"
+ $ref: '#/components/schemas/AnnotationRequestData'
required:
- data
type: object
@@ -7436,14 +7436,14 @@ components:
description: A single annotation resource.
properties:
attributes:
- $ref: "#/components/schemas/AnnotationAttributes"
+ $ref: '#/components/schemas/AnnotationAttributes'
id:
description: Unique identifier of the annotation.
example: "00000000-0000-0000-0000-000000000000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/AnnotationType"
+ $ref: '#/components/schemas/AnnotationType'
required:
- id
- type
@@ -7453,7 +7453,7 @@ components:
description: The annotation's position and size on the workflow canvas.
properties:
bounds:
- $ref: "#/components/schemas/AnnotationDisplayBounds"
+ $ref: '#/components/schemas/AnnotationDisplayBounds'
type: object
AnnotationDisplayBounds:
description: Canvas coordinates and dimensions for an annotation on the workflow canvas.
@@ -7483,7 +7483,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
color:
- $ref: "#/components/schemas/AnnotationColor"
+ $ref: '#/components/schemas/AnnotationColor'
created_at:
description: Creation time of the annotation in milliseconds since the Unix epoch.
example: 1704067200000
@@ -7521,7 +7521,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/AnnotationKind"
+ $ref: '#/components/schemas/AnnotationKind'
widget_ids:
description: IDs of widgets the annotation is associated with. When empty or omitted, the annotation applies to the whole page.
example:
@@ -7566,9 +7566,9 @@ components:
description: Data for creating an annotation.
properties:
attributes:
- $ref: "#/components/schemas/AnnotationCreateAttributes"
+ $ref: '#/components/schemas/AnnotationCreateAttributes'
type:
- $ref: "#/components/schemas/AnnotationType"
+ $ref: '#/components/schemas/AnnotationType'
required:
- type
- attributes
@@ -7577,7 +7577,7 @@ components:
description: Response containing a single annotation.
properties:
data:
- $ref: "#/components/schemas/AnnotationData"
+ $ref: '#/components/schemas/AnnotationData'
required:
- data
type: object
@@ -7593,18 +7593,18 @@ components:
description: Request body for updating an annotation.
properties:
data:
- $ref: "#/components/schemas/AnnotationRequestData"
+ $ref: '#/components/schemas/AnnotationRequestData'
required:
- data
type: object
AnnotationsData:
description: List of annotation resources.
items:
- $ref: "#/components/schemas/AnnotationData"
+ $ref: '#/components/schemas/AnnotationData'
type: array
AnnotationsInPageMap:
additionalProperties:
- $ref: "#/components/schemas/AnnotationInPage"
+ $ref: '#/components/schemas/AnnotationInPage'
description: Map of annotation UUID to annotation object, keyed by annotation ID.
example:
"00000000-0000-0000-0000-000000000000":
@@ -7625,7 +7625,7 @@ components:
description: Response containing a list of annotations.
properties:
data:
- $ref: "#/components/schemas/AnnotationsData"
+ $ref: '#/components/schemas/AnnotationsData'
required:
- data
type: object
@@ -7648,7 +7648,7 @@ components:
description: Request body for anonymizing users.
properties:
data:
- $ref: "#/components/schemas/AnonymizeUsersRequestData"
+ $ref: '#/components/schemas/AnonymizeUsersRequestData'
required:
- data
type: object
@@ -7670,13 +7670,13 @@ components:
description: Object to anonymize a list of users.
properties:
attributes:
- $ref: "#/components/schemas/AnonymizeUsersRequestAttributes"
+ $ref: '#/components/schemas/AnonymizeUsersRequestAttributes'
id:
description: Unique identifier for the request. Not used server-side.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/AnonymizeUsersRequestType"
+ $ref: '#/components/schemas/AnonymizeUsersRequestType'
required:
- type
- attributes
@@ -7694,7 +7694,7 @@ components:
description: Response containing the result of an anonymize users request.
properties:
data:
- $ref: "#/components/schemas/AnonymizeUsersResponseData"
+ $ref: '#/components/schemas/AnonymizeUsersResponseData'
type: object
AnonymizeUsersResponseAttributes:
description: Attributes of an anonymize users response.
@@ -7702,7 +7702,7 @@ components:
anonymize_errors:
description: List of errors encountered during anonymization, one entry per failed user.
items:
- $ref: "#/components/schemas/AnonymizeUserError"
+ $ref: '#/components/schemas/AnonymizeUserError'
type: array
anonymized_user_ids:
description: List of user IDs (UUIDs) that were successfully anonymized.
@@ -7720,13 +7720,13 @@ components:
description: Response data for anonymizing users.
properties:
attributes:
- $ref: "#/components/schemas/AnonymizeUsersResponseAttributes"
+ $ref: '#/components/schemas/AnonymizeUsersResponseAttributes'
id:
description: Unique identifier of the response.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/AnonymizeUsersResponseType"
+ $ref: '#/components/schemas/AnonymizeUsersResponseType'
type: object
AnonymizeUsersResponseType:
default: anonymize_users_response
@@ -7745,7 +7745,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/AnthropicAPIKeyType"
+ $ref: '#/components/schemas/AnthropicAPIKeyType'
required:
- type
- api_token
@@ -7765,25 +7765,25 @@ components:
description: The `AnthropicAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/AnthropicAPIKeyType"
+ $ref: '#/components/schemas/AnthropicAPIKeyType'
required:
- type
type: object
AnthropicCredentials:
description: The definition of the `AnthropicCredentials` object.
oneOf:
- - $ref: "#/components/schemas/AnthropicAPIKey"
+ - $ref: '#/components/schemas/AnthropicAPIKey'
AnthropicCredentialsUpdate:
description: The definition of the `AnthropicCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/AnthropicAPIKeyUpdate"
+ - $ref: '#/components/schemas/AnthropicAPIKeyUpdate'
AnthropicIntegration:
description: The definition of the `AnthropicIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/AnthropicCredentials"
+ $ref: '#/components/schemas/AnthropicCredentials'
type:
- $ref: "#/components/schemas/AnthropicIntegrationType"
+ $ref: '#/components/schemas/AnthropicIntegrationType'
required:
- type
- credentials
@@ -7800,9 +7800,9 @@ components:
description: The definition of the `AnthropicIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/AnthropicCredentialsUpdate"
+ $ref: '#/components/schemas/AnthropicCredentialsUpdate'
type:
- $ref: "#/components/schemas/AnthropicIntegrationType"
+ $ref: '#/components/schemas/AnthropicIntegrationType'
required:
- type
type: object
@@ -7810,16 +7810,16 @@ components:
description: Represents any valid JSON value.
nullable: true
oneOf:
- - $ref: "#/components/schemas/AnyValueString"
- - $ref: "#/components/schemas/AnyValueNumber"
- - $ref: "#/components/schemas/AnyValueObject"
- - $ref: "#/components/schemas/AnyValueArray"
- - $ref: "#/components/schemas/AnyValueBoolean"
+ - $ref: '#/components/schemas/AnyValueString'
+ - $ref: '#/components/schemas/AnyValueNumber'
+ - $ref: '#/components/schemas/AnyValueObject'
+ - $ref: '#/components/schemas/AnyValueArray'
+ - $ref: '#/components/schemas/AnyValueBoolean'
type: object
AnyValueArray:
description: An array of arbitrary values.
items:
- $ref: "#/components/schemas/AnyValueItem"
+ $ref: '#/components/schemas/AnyValueItem'
type: array
AnyValueBoolean:
description: A scalar boolean value.
@@ -7827,10 +7827,10 @@ components:
AnyValueItem:
description: A single item in an array of arbitrary values, which can be a string, number, object, or boolean.
oneOf:
- - $ref: "#/components/schemas/AnyValueString"
- - $ref: "#/components/schemas/AnyValueNumber"
- - $ref: "#/components/schemas/AnyValueObject"
- - $ref: "#/components/schemas/AnyValueBoolean"
+ - $ref: '#/components/schemas/AnyValueString'
+ - $ref: '#/components/schemas/AnyValueNumber'
+ - $ref: '#/components/schemas/AnyValueObject'
+ - $ref: '#/components/schemas/AnyValueBoolean'
AnyValueNumber:
description: A scalar numeric value.
format: double
@@ -7881,9 +7881,9 @@ components:
A query for APM dependency statistics between services, such as call latency and error rates.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ApmDependencyStatsDataSource"
+ $ref: '#/components/schemas/ApmDependencyStatsDataSource'
env:
description: The environment to query.
example: prod
@@ -7917,7 +7917,7 @@ components:
example: web-store
type: string
stat:
- $ref: "#/components/schemas/ApmDependencyStatName"
+ $ref: '#/components/schemas/ApmDependencyStatName'
required:
- data_source
- name
@@ -7941,9 +7941,9 @@ components:
A query for APM trace metrics such as hits, errors, and latency percentiles, aggregated across services.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ApmMetricsDataSource"
+ $ref: '#/components/schemas/ApmMetricsDataSource'
group_by:
description: Optional fields to group the query results by.
items:
@@ -7987,9 +7987,9 @@ components:
example: web-store
type: string
span_kind:
- $ref: "#/components/schemas/ApmMetricsSpanKind"
+ $ref: '#/components/schemas/ApmMetricsSpanKind'
stat:
- $ref: "#/components/schemas/ApmMetricsStat"
+ $ref: '#/components/schemas/ApmMetricsStat'
required:
- data_source
- name
@@ -8093,9 +8093,9 @@ components:
A query for APM resource statistics such as latency, error rate, and hit count, grouped by resource name.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ApmResourceStatsDataSource"
+ $ref: '#/components/schemas/ApmResourceStatsDataSource'
env:
description: The environment to query.
example: prod
@@ -8132,7 +8132,7 @@ components:
example: web-store
type: string
stat:
- $ref: "#/components/schemas/ApmResourceStatName"
+ $ref: '#/components/schemas/ApmResourceStatName'
required:
- data_source
- name
@@ -8153,9 +8153,9 @@ components:
description: An event on a UI component that triggers a response or action in an app.
properties:
name:
- $ref: "#/components/schemas/AppBuilderEventName"
+ $ref: '#/components/schemas/AppBuilderEventName'
type:
- $ref: "#/components/schemas/AppBuilderEventType"
+ $ref: '#/components/schemas/AppBuilderEventType'
type: object
AppBuilderEventName:
description: "The triggering action for the event."
@@ -8211,7 +8211,7 @@ components:
data:
description: An array of tags.
items:
- $ref: "#/components/schemas/TagData"
+ $ref: '#/components/schemas/TagData'
type: array
type: object
AppDefinitionType:
@@ -8250,7 +8250,7 @@ components:
readOnly: true
type: string
type:
- $ref: "#/components/schemas/AppKeyRegistrationDataType"
+ $ref: '#/components/schemas/AppKeyRegistrationDataType'
required:
- type
type: object
@@ -8326,10 +8326,10 @@ components:
connections:
description: Array of custom connections used by the app.
items:
- $ref: "#/components/schemas/CustomConnection"
+ $ref: '#/components/schemas/CustomConnection'
type: array
deployment:
- $ref: "#/components/schemas/DeploymentRelationship"
+ $ref: '#/components/schemas/DeploymentRelationship'
type: object
AppSelfServiceType:
default: selfService
@@ -8356,7 +8356,7 @@ components:
description: "Trigger a workflow from an App."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- appTrigger
type: object
@@ -8364,14 +8364,14 @@ components:
description: A version of an app.
properties:
attributes:
- $ref: "#/components/schemas/AppVersionAttributes"
+ $ref: '#/components/schemas/AppVersionAttributes'
id:
description: The ID of the app version.
example: 9e20cbaf-68da-45a6-9ccf-54193ac29fa5
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppVersionType"
+ $ref: '#/components/schemas/AppVersionType'
type: object
AppVersionAttributes:
description: Attributes describing an app version.
@@ -8456,9 +8456,9 @@ components:
description: Object used to create an application key.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationKeyCreateAttributes"
+ $ref: '#/components/schemas/ApplicationKeyCreateAttributes'
type:
- $ref: "#/components/schemas/ApplicationKeysType"
+ $ref: '#/components/schemas/ApplicationKeysType'
required:
- attributes
- type
@@ -8467,7 +8467,7 @@ components:
description: Request used to create an application key.
properties:
data:
- $ref: "#/components/schemas/ApplicationKeyCreateData"
+ $ref: '#/components/schemas/ApplicationKeyCreateData'
required:
- data
type: object
@@ -8475,25 +8475,25 @@ components:
description: Resources related to the application key.
properties:
owned_by:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
ApplicationKeyResponse:
description: Response for retrieving an application key.
properties:
data:
- $ref: "#/components/schemas/FullApplicationKey"
+ $ref: '#/components/schemas/FullApplicationKey'
included:
description: Array of objects related to the application key.
items:
- $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem"
+ $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
type: array
type: object
ApplicationKeyResponseIncludedItem:
description: An object related to an application key.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/Role"
- - $ref: "#/components/schemas/LeakedKey"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/Role'
+ - $ref: '#/components/schemas/LeakedKey'
ApplicationKeyResponseMeta:
description: Additional information related to the application key response.
properties:
@@ -8502,7 +8502,7 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/ApplicationKeyResponseMetaPage"
+ $ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
type: object
ApplicationKeyResponseMetaPage:
description: Additional information related to the application key response.
@@ -8532,13 +8532,13 @@ components:
description: Object used to update an application key.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationKeyUpdateAttributes"
+ $ref: '#/components/schemas/ApplicationKeyUpdateAttributes'
id:
description: ID of the application key.
example: "00112233-4455-6677-8899-aabbccddeeff"
type: string
type:
- $ref: "#/components/schemas/ApplicationKeysType"
+ $ref: '#/components/schemas/ApplicationKeysType'
required:
- attributes
- id
@@ -8548,7 +8548,7 @@ components:
description: Request used to update an application key.
properties:
data:
- $ref: "#/components/schemas/ApplicationKeyUpdateData"
+ $ref: '#/components/schemas/ApplicationKeyUpdateData'
required:
- data
type: object
@@ -8605,18 +8605,18 @@ components:
rules:
description: Rule overrides applied by the policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRuleOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRuleOverride'
type: array
rulesets:
deprecated: true
description: "Deprecated: Ruleset overrides. Use `protectionPresets` instead."
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRulesetOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRulesetOverride'
type: array
scope:
description: The scope of the WAF policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyScope"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyScope'
type: array
version:
default: 0
@@ -8658,18 +8658,18 @@ components:
rules:
description: Rule overrides applied by the policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRuleOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRuleOverride'
type: array
rulesets:
deprecated: true
description: "Deprecated: Ruleset overrides. Use `protectionPresets` instead."
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRulesetOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRulesetOverride'
type: array
scope:
description: The scope of the WAF policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyScope"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyScope'
type: array
version:
default: 0
@@ -8686,9 +8686,9 @@ components:
description: Object for a single WAF policy.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityPolicyCreateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyCreateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityPolicyType"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyType'
required:
- attributes
- type
@@ -8697,7 +8697,7 @@ components:
description: Request object that includes the policy to create.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityPolicyCreateData"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyCreateData'
required:
- data
type: object
@@ -8705,16 +8705,16 @@ components:
description: Object for a single WAF policy.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityPolicyAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyAttributes'
id:
description: "The ID of the policy."
example: "2857c47d-1e3a-4300-8b2f-dc24089c084b"
readOnly: true
type: string
meta:
- $ref: "#/components/schemas/ApplicationSecurityPolicyMetadata"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyMetadata'
type:
- $ref: "#/components/schemas/ApplicationSecurityPolicyType"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyType'
type: object
ApplicationSecurityPolicyListResponse:
description: Response object that includes a list of WAF policies.
@@ -8722,7 +8722,7 @@ components:
data:
description: The WAF policy data.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyData"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyData'
type: array
type: object
ApplicationSecurityPolicyMetadata:
@@ -8760,7 +8760,7 @@ components:
description: Response object that includes a single WAF policy.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityPolicyData"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyData'
type: object
ApplicationSecurityPolicyRuleOverride:
description: Override WAF rule parameters for services in a policy.
@@ -8859,18 +8859,18 @@ components:
rules:
description: Rule overrides applied by the policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRuleOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRuleOverride'
type: array
rulesets:
deprecated: true
description: "Deprecated: Ruleset overrides. Use `protectionPresets` instead."
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyRulesetOverride"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyRulesetOverride'
type: array
scope:
description: The scope of the WAF policy.
items:
- $ref: "#/components/schemas/ApplicationSecurityPolicyScope"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyScope'
type: array
version:
default: 0
@@ -8891,9 +8891,9 @@ components:
description: Object for a single WAF policy.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityPolicyUpdateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyUpdateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityPolicyType"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyType'
required:
- attributes
- type
@@ -8902,7 +8902,7 @@ components:
description: Request object that includes the policy to update.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityPolicyUpdateData"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyUpdateData'
required:
- data
type: object
@@ -9157,13 +9157,13 @@ components:
description: A JSON:API resource describing a service and its Application Security details.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityServiceAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityServiceAttributes'
id:
description: The unique identifier of the service, formatted as `_`.
example: web-store_prod
type: string
type:
- $ref: "#/components/schemas/ApplicationSecurityServiceType"
+ $ref: '#/components/schemas/ApplicationSecurityServiceType'
required:
- id
- type
@@ -9195,10 +9195,10 @@ components:
data:
description: The list of services matching the requested name.
items:
- $ref: "#/components/schemas/ApplicationSecurityServiceResource"
+ $ref: '#/components/schemas/ApplicationSecurityServiceResource'
type: array
meta:
- $ref: "#/components/schemas/ApplicationSecurityServicesMetadata"
+ $ref: '#/components/schemas/ApplicationSecurityServicesMetadata'
required:
- data
- meta
@@ -9207,9 +9207,9 @@ components:
description: The definition of `ApplicationSecurityWafCustomRuleAction` object.
properties:
action:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleActionAction"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionAction'
parameters:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleActionParameters'
type: object
ApplicationSecurityWafCustomRuleActionAction:
default: block_request
@@ -9240,7 +9240,7 @@ components:
description: "A WAF custom rule."
properties:
action:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
blocking:
description: Indicates whether the WAF custom rule will block the request.
example: false
@@ -9250,14 +9250,14 @@ components:
Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF
rule to trigger.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
type: array
enabled:
description: Indicates whether the WAF custom rule is enabled.
example: false
type: boolean
metadata:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleMetadata"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleMetadata'
name:
description: The name of the WAF custom rule.
example: "Block request from bad useragent"
@@ -9269,10 +9269,10 @@ components:
scope:
description: The scope of the WAF custom rule.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
type: array
tags:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
required:
- enabled
- blocking
@@ -9284,9 +9284,9 @@ components:
description: One condition of the WAF Custom Rule.
properties:
operator:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOperator'
parameters:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionParameters'
required:
- operator
- parameters
@@ -9295,7 +9295,7 @@ components:
description: Input from the request on which the condition should apply.
properties:
address:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInputAddress'
key_path:
description: Specific path for the input.
items:
@@ -9439,7 +9439,7 @@ components:
inputs:
description: List of inputs on which at least one should match with the given operator.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionInput'
type: array
list:
description: |-
@@ -9450,13 +9450,13 @@ components:
type: string
type: array
options:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionOptions'
regex:
description: "Regex to use with the condition. Only used with match_regex and !match_regex operator."
example: "path.*"
type: string
type:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleConditionParametersType"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleConditionParametersType'
value:
description: |-
Store the captured value in the specified tag name. Only used with the capture_data operator.
@@ -9485,7 +9485,7 @@ components:
description: "Create a new WAF custom rule."
properties:
action:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
blocking:
description: Indicates whether the WAF custom rule will block the request.
example: false
@@ -9495,7 +9495,7 @@ components:
Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF
rule to trigger
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
type: array
enabled:
description: Indicates whether the WAF custom rule is enabled.
@@ -9512,10 +9512,10 @@ components:
scope:
description: The scope of the WAF custom rule.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
type: array
tags:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
required:
- enabled
- blocking
@@ -9527,9 +9527,9 @@ components:
description: Object for a single WAF custom rule.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
required:
- attributes
- type
@@ -9538,7 +9538,7 @@ components:
description: Request object that includes the custom rule to create.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateData"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateData'
required:
- data
type: object
@@ -9546,14 +9546,14 @@ components:
description: Object for a single WAF custom rule.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAttributes'
id:
description: "The ID of the custom rule."
example: "2857c47d-1e3a-4300-8b2f-dc24089c084b"
readOnly: true
type: string
type:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
type: object
ApplicationSecurityWafCustomRuleListResponse:
description: Response object that includes a list of WAF custom rules.
@@ -9561,7 +9561,7 @@ components:
data:
description: The WAF custom rule data.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleData"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData'
type: array
type: object
ApplicationSecurityWafCustomRuleMetadata:
@@ -9599,7 +9599,7 @@ components:
description: Response object that includes a single WAF custom rule.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleData"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleData'
type: object
ApplicationSecurityWafCustomRuleScope:
description: The scope of the WAF custom rule.
@@ -9625,7 +9625,7 @@ components:
maxProperties: 32
properties:
category:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTagsCategory'
type:
description: The type of the WAF rule, associated with the category will form the security activity.
example: "users.login.success"
@@ -9659,7 +9659,7 @@ components:
description: "Update a WAF custom rule."
properties:
action:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleAction"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleAction'
blocking:
description: Indicates whether the WAF custom rule will block the request.
example: false
@@ -9669,7 +9669,7 @@ components:
Conditions for which the WAF Custom Rule will triggers, all conditions needs to match in order for the WAF
rule to trigger.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCondition"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCondition'
type: array
enabled:
description: Indicates whether the WAF custom rule is enabled.
@@ -9686,10 +9686,10 @@ components:
scope:
description: The scope of the WAF custom rule.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleScope'
type: array
tags:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleTags"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleTags'
required:
- enabled
- blocking
@@ -9701,9 +9701,9 @@ components:
description: Object for a single WAF Custom Rule.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleType"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleType'
required:
- attributes
- type
@@ -9712,7 +9712,7 @@ components:
description: Request object that includes the Custom Rule to update.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateData"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateData'
required:
- data
type: object
@@ -9738,9 +9738,9 @@ components:
type: string
type: array
metadata:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterMetadata'
on_match:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
parameters:
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
items:
@@ -9755,12 +9755,12 @@ components:
rules_target:
description: The WAF rules targeted by the exclusion filter.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
type: array
scope:
description: The services where the exclusion filter is deployed.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
type: array
search_query:
description: Generated event search query for traces matching the exclusion filter.
@@ -9786,7 +9786,7 @@ components:
type: string
type: array
on_match:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
parameters:
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
items:
@@ -9801,12 +9801,12 @@ components:
rules_target:
description: The WAF rules targeted by the exclusion filter.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
type: array
scope:
description: The services where the exclusion filter is deployed.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
type: array
required:
- description
@@ -9816,9 +9816,9 @@ components:
description: Object for creating a single WAF exclusion filter.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
required:
- attributes
- type
@@ -9827,7 +9827,7 @@ components:
description: Request object for creating a single WAF exclusion filter.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateData"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateData'
required:
- data
type: object
@@ -9872,17 +9872,17 @@ components:
description: A JSON:API resource for an WAF exclusion filter.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterAttributes'
id:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterID"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterID'
type:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
type: object
ApplicationSecurityWafExclusionFilterResponse:
description: Response object for a single WAF exclusion filter.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResource"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource'
type: object
ApplicationSecurityWafExclusionFilterRulesTarget:
description: Target WAF rules based either on an identifier or tags.
@@ -9892,7 +9892,7 @@ components:
example: dog-913-009
type: string
tags:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTargetTags'
type: object
ApplicationSecurityWafExclusionFilterRulesTargetTags:
additionalProperties:
@@ -9947,7 +9947,7 @@ components:
type: string
type: array
on_match:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterOnMatch'
parameters:
description: A list of parameters matched by the exclusion filter in the HTTP query string and HTTP request body. Nested parameters can be matched by joining fields with a dot character.
items:
@@ -9962,12 +9962,12 @@ components:
rules_target:
description: The WAF rules targeted by the exclusion filter.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterRulesTarget'
type: array
scope:
description: The services where the exclusion filter is deployed.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterScope"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterScope'
type: array
required:
- description
@@ -9977,9 +9977,9 @@ components:
description: Object for updating a single WAF exclusion filter.
properties:
attributes:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateAttributes"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateAttributes'
type:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterType"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterType'
required:
- attributes
- type
@@ -9988,7 +9988,7 @@ components:
description: Request object for updating a single WAF exclusion filter.
properties:
data:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateData"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateData'
required:
- data
type: object
@@ -9998,7 +9998,7 @@ components:
data:
description: A list of WAF exclusion filters.
items:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResource"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResource'
type: array
type: object
AppsSortField:
@@ -10066,18 +10066,18 @@ components:
type: upsert_arbitrary_rule
properties:
data:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestData"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestData'
type: object
ArbitraryCostUpsertRequestData:
description: The definition of `ArbitraryCostUpsertRequestData` object.
properties:
attributes:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributes"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributes'
id:
description: The `ArbitraryCostUpsertRequestData` `id`.
type: string
type:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataType"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataType'
required:
- type
type: object
@@ -10087,7 +10087,7 @@ components:
costs_to_allocate:
description: The `attributes` `costs_to_allocate`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesCostsToAllocateItems'
type: array
enabled:
description: The `attributes` `enabled`.
@@ -10112,7 +10112,7 @@ components:
example: ""
type: string
strategy:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategy"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategy'
type:
description: The `attributes` `type`.
example: ""
@@ -10155,12 +10155,12 @@ components:
allocated_by:
description: The `strategy` `allocated_by`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItems'
type: array
allocated_by_filters:
description: The `strategy` `allocated_by_filters`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByFiltersItems'
type: array
allocated_by_tag_keys:
description: The `strategy` `allocated_by_tag_keys`.
@@ -10171,7 +10171,7 @@ components:
based_on_costs:
description: The `strategy` `based_on_costs`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyBasedOnCostsItems'
type: array
based_on_timeseries:
additionalProperties: {}
@@ -10180,7 +10180,7 @@ components:
evaluate_grouped_by_filters:
description: The `strategy` `evaluate_grouped_by_filters`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyEvaluateGroupedByFiltersItems'
type: array
evaluate_grouped_by_tag_keys:
description: The `strategy` `evaluate_grouped_by_tag_keys`.
@@ -10229,7 +10229,7 @@ components:
allocated_tags:
description: The `items` `allocated_tags`.
items:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequestDataAttributesStrategyAllocatedByItemsAllocatedTagsItems'
type: array
percentage:
description: The `items` `percentage`. The numeric value format should be a 32bit float value.
@@ -10362,7 +10362,7 @@ components:
type: arbitrary_rule
properties:
data:
- $ref: "#/components/schemas/ArbitraryRuleResponseData"
+ $ref: '#/components/schemas/ArbitraryRuleResponseData'
type: object
ArbitraryRuleResponseArray:
description: The definition of `ArbitraryRuleResponseArray` object.
@@ -10490,10 +10490,10 @@ components:
data:
description: The `ArbitraryRuleResponseArray` `data`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseData"
+ $ref: '#/components/schemas/ArbitraryRuleResponseData'
type: array
meta:
- $ref: "#/components/schemas/ArbitraryRuleResponseArrayMeta"
+ $ref: '#/components/schemas/ArbitraryRuleResponseArrayMeta'
required:
- data
type: object
@@ -10509,12 +10509,12 @@ components:
description: The definition of `ArbitraryRuleResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributes"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributes'
id:
description: The `ArbitraryRuleResponseData` `id`.
type: string
type:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataType"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataType'
required:
- type
type: object
@@ -10524,7 +10524,7 @@ components:
costs_to_allocate:
description: The `attributes` `costs_to_allocate`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesCostsToAllocateItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesCostsToAllocateItems'
type: array
created:
description: The `attributes` `created`.
@@ -10564,7 +10564,7 @@ components:
example: ""
type: string
strategy:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategy"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategy'
type:
description: The `attributes` `type`.
example: ""
@@ -10624,12 +10624,12 @@ components:
allocated_by:
description: The `strategy` `allocated_by`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItems'
type: array
allocated_by_filters:
description: The `strategy` `allocated_by_filters`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByFiltersItems'
type: array
allocated_by_tag_keys:
description: The `strategy` `allocated_by_tag_keys`.
@@ -10640,7 +10640,7 @@ components:
based_on_costs:
description: The `strategy` `based_on_costs`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyBasedOnCostsItems'
type: array
based_on_timeseries:
additionalProperties: {}
@@ -10649,7 +10649,7 @@ components:
evaluate_grouped_by_filters:
description: The `strategy` `evaluate_grouped_by_filters`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyEvaluateGroupedByFiltersItems'
type: array
evaluate_grouped_by_tag_keys:
description: The `strategy` `evaluate_grouped_by_tag_keys`.
@@ -10698,7 +10698,7 @@ components:
allocated_tags:
description: The `items` `allocated_tags`.
items:
- $ref: "#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems"
+ $ref: '#/components/schemas/ArbitraryRuleResponseDataAttributesStrategyAllocatedByItemsAllocatedTagsItems'
type: array
percentage:
description: The `items` `percentage`. The numeric value format should be a 32bit float value.
@@ -10799,7 +10799,7 @@ components:
data:
description: Processing status for a custom allocation rule.
items:
- $ref: "#/components/schemas/ArbitraryRuleStatusResponseData"
+ $ref: '#/components/schemas/ArbitraryRuleStatusResponseData'
type: array
required:
- data
@@ -10808,13 +10808,13 @@ components:
description: Processing status for a custom allocation rule.
properties:
attributes:
- $ref: "#/components/schemas/ArbitraryRuleStatusResponseDataAttributes"
+ $ref: '#/components/schemas/ArbitraryRuleStatusResponseDataAttributes'
id:
description: The unique identifier of the custom allocation rule.
example: "123"
type: string
type:
- $ref: "#/components/schemas/ArbitraryRuleStatusResponseDataType"
+ $ref: '#/components/schemas/ArbitraryRuleStatusResponseDataType'
required:
- id
- type
@@ -10862,7 +10862,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/AsanaAccessTokenType"
+ $ref: '#/components/schemas/AsanaAccessTokenType'
required:
- type
- access_token
@@ -10882,25 +10882,25 @@ components:
description: The `AsanaAccessTokenUpdate` `access_token`.
type: string
type:
- $ref: "#/components/schemas/AsanaAccessTokenType"
+ $ref: '#/components/schemas/AsanaAccessTokenType'
required:
- type
type: object
AsanaCredentials:
description: The definition of the `AsanaCredentials` object.
oneOf:
- - $ref: "#/components/schemas/AsanaAccessToken"
+ - $ref: '#/components/schemas/AsanaAccessToken'
AsanaCredentialsUpdate:
description: The definition of the `AsanaCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/AsanaAccessTokenUpdate"
+ - $ref: '#/components/schemas/AsanaAccessTokenUpdate'
AsanaIntegration:
description: The definition of the `AsanaIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/AsanaCredentials"
+ $ref: '#/components/schemas/AsanaCredentials'
type:
- $ref: "#/components/schemas/AsanaIntegrationType"
+ $ref: '#/components/schemas/AsanaIntegrationType'
required:
- type
- credentials
@@ -10917,9 +10917,9 @@ components:
description: The definition of the `AsanaIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/AsanaCredentialsUpdate"
+ $ref: '#/components/schemas/AsanaCredentialsUpdate'
type:
- $ref: "#/components/schemas/AsanaIntegrationType"
+ $ref: '#/components/schemas/AsanaIntegrationType'
required:
- type
type: object
@@ -10927,13 +10927,13 @@ components:
description: A single vulnerable asset
properties:
attributes:
- $ref: "#/components/schemas/AssetAttributes"
+ $ref: '#/components/schemas/AssetAttributes'
id:
description: The unique ID for this asset.
example: Repository|github.com/DataDog/datadog-agent.git
type: string
type:
- $ref: "#/components/schemas/AssetEntityType"
+ $ref: '#/components/schemas/AssetEntityType'
required:
- id
- type
@@ -10960,9 +10960,9 @@ components:
example: github.com/DataDog/datadog-agent.git
type: string
operating_system:
- $ref: "#/components/schemas/AssetOperatingSystem"
+ $ref: '#/components/schemas/AssetOperatingSystem'
risks:
- $ref: "#/components/schemas/AssetRisks"
+ $ref: '#/components/schemas/AssetRisks'
teams:
description: List of teams that own the asset.
example:
@@ -10973,9 +10973,9 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/AssetType"
+ $ref: '#/components/schemas/AssetType'
version:
- $ref: "#/components/schemas/AssetVersion"
+ $ref: '#/components/schemas/AssetVersion'
required:
- name
- type
@@ -11123,7 +11123,7 @@ components:
description: The ID of the assign seats user response.
type: string
type:
- $ref: "#/components/schemas/SeatAssignmentsDataType"
+ $ref: '#/components/schemas/SeatAssignmentsDataType'
type: object
AssignSeatsUserResponseDataAttributes:
description: Attributes of the assign seats response, including the list of users assigned and the product code.
@@ -11151,7 +11151,7 @@ components:
description: Request to assign or unassign security findings.
properties:
data:
- $ref: "#/components/schemas/AssigneeRequestData"
+ $ref: '#/components/schemas/AssigneeRequestData'
required:
- data
type: object
@@ -11159,15 +11159,15 @@ components:
description: Data of the assignee request.
properties:
attributes:
- $ref: "#/components/schemas/AssigneeRequestDataAttributes"
+ $ref: '#/components/schemas/AssigneeRequestDataAttributes'
id:
description: Unique identifier of the assignee request.
example: "00000000-0000-0000-0000-000000000001"
type: string
relationships:
- $ref: "#/components/schemas/AssigneeRequestDataRelationships"
+ $ref: '#/components/schemas/AssigneeRequestDataRelationships'
type:
- $ref: "#/components/schemas/AssigneeDataType"
+ $ref: '#/components/schemas/AssigneeDataType'
required:
- relationships
- type
@@ -11193,9 +11193,9 @@ components:
description: Response for the assign or unassign request.
properties:
data:
- $ref: "#/components/schemas/AssigneeResponseData"
+ $ref: '#/components/schemas/AssigneeResponseData'
meta:
- $ref: "#/components/schemas/AssigneeResponseMeta"
+ $ref: '#/components/schemas/AssigneeResponseMeta'
required:
- data
type: object
@@ -11203,13 +11203,13 @@ components:
description: Data of the assignee response.
properties:
attributes:
- $ref: "#/components/schemas/AssigneeResponseDataAttributes"
+ $ref: '#/components/schemas/AssigneeResponseDataAttributes'
id:
description: Unique identifier of the assignee request.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/AssigneeDataType"
+ $ref: '#/components/schemas/AssigneeDataType'
required:
- id
- type
@@ -11229,12 +11229,12 @@ components:
failures:
description: Findings that could not be assigned or unassigned.
items:
- $ref: "#/components/schemas/AssignmentResult"
+ $ref: '#/components/schemas/AssignmentResult'
type: array
warnings:
description: Findings for which the assignment succeeded but a non-critical error occurred during processing.
items:
- $ref: "#/components/schemas/AssignmentResult"
+ $ref: '#/components/schemas/AssignmentResult'
type: array
type: object
AssignmentResult:
@@ -11268,7 +11268,7 @@ components:
description: Request for attaching security findings to a case.
properties:
data:
- $ref: "#/components/schemas/AttachCaseRequestData"
+ $ref: '#/components/schemas/AttachCaseRequestData'
type: object
AttachCaseRequestData:
description: Data of the case to attach security findings to.
@@ -11278,9 +11278,9 @@ components:
example: "c1234567-89ab-cdef-0123-456789abcdef"
type: string
relationships:
- $ref: "#/components/schemas/AttachCaseRequestDataRelationships"
+ $ref: '#/components/schemas/AttachCaseRequestDataRelationships'
type:
- $ref: "#/components/schemas/CaseDataType"
+ $ref: '#/components/schemas/CaseDataType'
required:
- type
- id
@@ -11298,17 +11298,17 @@ components:
description: Request for attaching security findings to a Jira issue.
properties:
data:
- $ref: "#/components/schemas/AttachJiraIssueRequestData"
+ $ref: '#/components/schemas/AttachJiraIssueRequestData'
type: object
AttachJiraIssueRequestData:
description: Data of the Jira issue to attach security findings to.
properties:
attributes:
- $ref: "#/components/schemas/AttachJiraIssueRequestDataAttributes"
+ $ref: '#/components/schemas/AttachJiraIssueRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/AttachJiraIssueRequestDataRelationships"
+ $ref: '#/components/schemas/AttachJiraIssueRequestDataRelationships'
type:
- $ref: "#/components/schemas/JiraIssuesDataType"
+ $ref: '#/components/schemas/JiraIssuesDataType'
required:
- type
type: object
@@ -11339,7 +11339,7 @@ components:
description: Request for attaching security findings to a Linear issue.
properties:
data:
- $ref: "#/components/schemas/AttachLinearIssueRequestData"
+ $ref: '#/components/schemas/AttachLinearIssueRequestData'
required:
- data
type: object
@@ -11347,11 +11347,11 @@ components:
description: Data of the Linear issue to attach security findings to.
properties:
attributes:
- $ref: "#/components/schemas/AttachLinearIssueRequestDataAttributes"
+ $ref: '#/components/schemas/AttachLinearIssueRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/AttachLinearIssueRequestDataRelationships"
+ $ref: '#/components/schemas/AttachLinearIssueRequestDataRelationships'
type:
- $ref: "#/components/schemas/LinearIssuesDataType"
+ $ref: '#/components/schemas/LinearIssuesDataType'
required:
- attributes
- relationships
@@ -11384,7 +11384,7 @@ components:
description: Request for attaching security findings to a ServiceNow ticket.
properties:
data:
- $ref: "#/components/schemas/AttachServiceNowTicketRequestData"
+ $ref: '#/components/schemas/AttachServiceNowTicketRequestData'
required:
- data
type: object
@@ -11392,11 +11392,11 @@ components:
description: Data of the ServiceNow ticket to attach security findings to.
properties:
attributes:
- $ref: "#/components/schemas/AttachServiceNowTicketRequestDataAttributes"
+ $ref: '#/components/schemas/AttachServiceNowTicketRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/AttachServiceNowTicketRequestDataRelationships"
+ $ref: '#/components/schemas/AttachServiceNowTicketRequestDataRelationships'
type:
- $ref: "#/components/schemas/ServiceNowTicketsDataType"
+ $ref: '#/components/schemas/ServiceNowTicketsDataType'
required:
- attributes
- relationships
@@ -11429,11 +11429,11 @@ components:
description: An attachment response containing the attachment data and related objects.
properties:
data:
- $ref: "#/components/schemas/AttachmentData"
+ $ref: '#/components/schemas/AttachmentData'
included:
description: A list of related objects included in the response.
items:
- $ref: "#/components/schemas/AttachmentIncluded"
+ $ref: '#/components/schemas/AttachmentIncluded'
type: array
type: object
AttachmentArray:
@@ -11442,12 +11442,12 @@ components:
data:
description: An array of attachment data objects.
items:
- $ref: "#/components/schemas/AttachmentData"
+ $ref: '#/components/schemas/AttachmentData'
type: array
included:
description: A list of related objects included in the response.
items:
- $ref: "#/components/schemas/AttachmentIncluded"
+ $ref: '#/components/schemas/AttachmentIncluded'
type: array
required:
- data
@@ -11456,15 +11456,15 @@ components:
description: Attachment data from a response.
properties:
attributes:
- $ref: "#/components/schemas/AttachmentDataAttributes"
+ $ref: '#/components/schemas/AttachmentDataAttributes'
id:
description: The unique identifier of the attachment.
example: "00000000-abcd-0002-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/AttachmentDataRelationships"
+ $ref: '#/components/schemas/AttachmentDataRelationships'
type:
- $ref: "#/components/schemas/IncidentAttachmentType"
+ $ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
- attributes
@@ -11475,9 +11475,9 @@ components:
description: The attachment's attributes.
properties:
attachment:
- $ref: "#/components/schemas/AttachmentDataAttributesAttachment"
+ $ref: '#/components/schemas/AttachmentDataAttributesAttachment'
attachment_type:
- $ref: "#/components/schemas/AttachmentDataAttributesAttachmentType"
+ $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
modified:
description: Timestamp when the attachment was last modified.
example: "2025-01-01T01:01:01.000000001Z"
@@ -11508,25 +11508,25 @@ components:
description: The attachment's resource relationships.
properties:
incident:
- $ref: "#/components/schemas/RelationshipToIncident"
+ $ref: '#/components/schemas/RelationshipToIncident'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
AttachmentIncluded:
description: Objects related to an attachment.
oneOf:
- - $ref: "#/components/schemas/IncidentUserData"
+ - $ref: '#/components/schemas/IncidentUserData'
AuditLogsEvent:
description: Object description of an Audit Logs event after it is processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/AuditLogsEventAttributes"
+ $ref: '#/components/schemas/AuditLogsEventAttributes'
id:
description: Unique ID of the event.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/AuditLogsEventType"
+ $ref: '#/components/schemas/AuditLogsEventType'
type: object
AuditLogsEventAttributes:
description: JSON object containing all event attributes and their associated values.
@@ -11574,12 +11574,12 @@ components:
data:
description: Array of events matching the request.
items:
- $ref: "#/components/schemas/AuditLogsEvent"
+ $ref: '#/components/schemas/AuditLogsEvent'
type: array
links:
- $ref: "#/components/schemas/AuditLogsResponseLinks"
+ $ref: '#/components/schemas/AuditLogsResponseLinks'
meta:
- $ref: "#/components/schemas/AuditLogsResponseMetadata"
+ $ref: '#/components/schemas/AuditLogsResponseMetadata'
type: object
AuditLogsQueryFilter:
description: Search and filter query settings.
@@ -11651,19 +11651,19 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/AuditLogsResponsePage"
+ $ref: '#/components/schemas/AuditLogsResponsePage'
request_id:
description: The identifier of the request.
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/AuditLogsResponseStatus"
+ $ref: '#/components/schemas/AuditLogsResponseStatus'
warnings:
description: |-
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
items:
- $ref: "#/components/schemas/AuditLogsWarning"
+ $ref: '#/components/schemas/AuditLogsWarning'
type: array
type: object
AuditLogsResponsePage:
@@ -11685,13 +11685,13 @@ components:
description: The request for a Audit Logs events list.
properties:
filter:
- $ref: "#/components/schemas/AuditLogsQueryFilter"
+ $ref: '#/components/schemas/AuditLogsQueryFilter'
options:
- $ref: "#/components/schemas/AuditLogsQueryOptions"
+ $ref: '#/components/schemas/AuditLogsQueryOptions'
page:
- $ref: "#/components/schemas/AuditLogsQueryPageOptions"
+ $ref: '#/components/schemas/AuditLogsQueryPageOptions'
sort:
- $ref: "#/components/schemas/AuditLogsSort"
+ $ref: '#/components/schemas/AuditLogsSort'
type: object
AuditLogsSort:
description: Sort parameters when querying events.
@@ -11722,15 +11722,15 @@ components:
description: The AuthN Mapping object returned by API.
properties:
attributes:
- $ref: "#/components/schemas/AuthNMappingAttributes"
+ $ref: '#/components/schemas/AuthNMappingAttributes'
id:
description: ID of the AuthN Mapping.
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
relationships:
- $ref: "#/components/schemas/AuthNMappingRelationships"
+ $ref: '#/components/schemas/AuthNMappingRelationships'
type:
- $ref: "#/components/schemas/AuthNMappingsType"
+ $ref: '#/components/schemas/AuthNMappingsType'
required:
- id
- type
@@ -11777,38 +11777,38 @@ components:
description: Data for creating an AuthN Mapping.
properties:
attributes:
- $ref: "#/components/schemas/AuthNMappingCreateAttributes"
+ $ref: '#/components/schemas/AuthNMappingCreateAttributes'
relationships:
- $ref: "#/components/schemas/AuthNMappingCreateRelationships"
+ $ref: '#/components/schemas/AuthNMappingCreateRelationships'
type:
- $ref: "#/components/schemas/AuthNMappingsType"
+ $ref: '#/components/schemas/AuthNMappingsType'
required:
- type
type: object
AuthNMappingCreateRelationships:
description: Relationship of AuthN Mapping create object to a Role or Team.
oneOf:
- - $ref: "#/components/schemas/AuthNMappingRelationshipToRole"
- - $ref: "#/components/schemas/AuthNMappingRelationshipToTeam"
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
AuthNMappingCreateRequest:
description: Request for creating an AuthN Mapping.
properties:
data:
- $ref: "#/components/schemas/AuthNMappingCreateData"
+ $ref: '#/components/schemas/AuthNMappingCreateData'
required:
- data
type: object
AuthNMappingIncluded:
description: Included data in the AuthN Mapping response.
oneOf:
- - $ref: "#/components/schemas/SAMLAssertionAttribute"
- - $ref: "#/components/schemas/Role"
- - $ref: "#/components/schemas/AuthNMappingTeam"
+ - $ref: '#/components/schemas/SAMLAssertionAttribute'
+ - $ref: '#/components/schemas/Role'
+ - $ref: '#/components/schemas/AuthNMappingTeam'
AuthNMappingRelationshipToRole:
description: Relationship of AuthN Mapping to a Role.
properties:
role:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
required:
- role
type: object
@@ -11816,7 +11816,7 @@ components:
description: Relationship of AuthN Mapping to a Team.
properties:
team:
- $ref: "#/components/schemas/RelationshipToTeam"
+ $ref: '#/components/schemas/RelationshipToTeam'
required:
- team
type: object
@@ -11824,11 +11824,11 @@ components:
description: All relationships associated with AuthN Mapping.
properties:
role:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
saml_assertion_attribute:
- $ref: "#/components/schemas/RelationshipToSAMLAssertionAttribute"
+ $ref: '#/components/schemas/RelationshipToSAMLAssertionAttribute'
team:
- $ref: "#/components/schemas/RelationshipToTeam"
+ $ref: '#/components/schemas/RelationshipToTeam'
type: object
AuthNMappingResourceType:
description: The type of resource being mapped to.
@@ -11843,24 +11843,24 @@ components:
description: AuthN Mapping response from the API.
properties:
data:
- $ref: "#/components/schemas/AuthNMapping"
+ $ref: '#/components/schemas/AuthNMapping'
included:
description: Included data in the AuthN Mapping response.
items:
- $ref: "#/components/schemas/AuthNMappingIncluded"
+ $ref: '#/components/schemas/AuthNMappingIncluded'
type: array
type: object
AuthNMappingTeam:
description: Team.
properties:
attributes:
- $ref: "#/components/schemas/AuthNMappingTeamAttributes"
+ $ref: '#/components/schemas/AuthNMappingTeamAttributes'
id:
description: The ID of the Team.
example: "f9bb8444-af7f-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
type: object
AuthNMappingTeamAttributes:
description: Team attributes.
@@ -11919,15 +11919,15 @@ components:
description: Data for updating an AuthN Mapping.
properties:
attributes:
- $ref: "#/components/schemas/AuthNMappingUpdateAttributes"
+ $ref: '#/components/schemas/AuthNMappingUpdateAttributes'
id:
description: ID of the AuthN Mapping.
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
relationships:
- $ref: "#/components/schemas/AuthNMappingUpdateRelationships"
+ $ref: '#/components/schemas/AuthNMappingUpdateRelationships'
type:
- $ref: "#/components/schemas/AuthNMappingsType"
+ $ref: '#/components/schemas/AuthNMappingsType'
required:
- id
- type
@@ -11935,13 +11935,13 @@ components:
AuthNMappingUpdateRelationships:
description: Relationship of AuthN Mapping update object to a Role or Team.
oneOf:
- - $ref: "#/components/schemas/AuthNMappingRelationshipToRole"
- - $ref: "#/components/schemas/AuthNMappingRelationshipToTeam"
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToRole'
+ - $ref: '#/components/schemas/AuthNMappingRelationshipToTeam'
AuthNMappingUpdateRequest:
description: Request to update an AuthN Mapping.
properties:
data:
- $ref: "#/components/schemas/AuthNMappingUpdateData"
+ $ref: '#/components/schemas/AuthNMappingUpdateData'
required:
- data
type: object
@@ -11951,15 +11951,15 @@ components:
data:
description: Array of returned AuthN Mappings.
items:
- $ref: "#/components/schemas/AuthNMapping"
+ $ref: '#/components/schemas/AuthNMapping'
type: array
included:
description: Included data in the AuthN Mapping response.
items:
- $ref: "#/components/schemas/AuthNMappingIncluded"
+ $ref: '#/components/schemas/AuthNMappingIncluded'
type: array
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
type: object
AuthNMappingsSort:
description: Sorting options for AuthN Mappings.
@@ -12021,15 +12021,15 @@ components:
description: An automation rule that executes an action (such as running a Datadog workflow or assigning an AI agent) when a specified case event occurs within a project.
properties:
attributes:
- $ref: "#/components/schemas/AutomationRuleAttributes"
+ $ref: '#/components/schemas/AutomationRuleAttributes'
id:
description: Automation rule identifier.
example: "e6773723-fe58-49ff-9975-dff00f14e28d"
type: string
relationships:
- $ref: "#/components/schemas/AutomationRuleRelationships"
+ $ref: '#/components/schemas/AutomationRuleRelationships'
type:
- $ref: "#/components/schemas/CaseAutomationRuleResourceType"
+ $ref: '#/components/schemas/CaseAutomationRuleResourceType'
required:
- id
- type
@@ -12039,9 +12039,9 @@ components:
description: Defines what happens when the rule triggers. Combines an action type with action-specific configuration data.
properties:
data:
- $ref: "#/components/schemas/AutomationRuleActionData"
+ $ref: '#/components/schemas/AutomationRuleActionData'
type:
- $ref: "#/components/schemas/AutomationRuleActionType"
+ $ref: '#/components/schemas/AutomationRuleActionType'
required:
- type
- data
@@ -12084,7 +12084,7 @@ components:
description: Core attributes of an automation rule, including its name, trigger condition, action to execute, and current state.
properties:
action:
- $ref: "#/components/schemas/AutomationRuleAction"
+ $ref: '#/components/schemas/AutomationRuleAction'
created_at:
description: Timestamp when the automation rule was created.
example: "2024-01-01T00:00:00.000Z"
@@ -12101,9 +12101,9 @@ components:
example: "Auto-assign workflow"
type: string
state:
- $ref: "#/components/schemas/CaseAutomationRuleState"
+ $ref: '#/components/schemas/CaseAutomationRuleState'
trigger:
- $ref: "#/components/schemas/AutomationRuleTrigger"
+ $ref: '#/components/schemas/AutomationRuleTrigger'
required:
- name
- trigger
@@ -12115,9 +12115,9 @@ components:
description: Data object for creating an automation rule.
properties:
attributes:
- $ref: "#/components/schemas/AutomationRuleCreateAttributes"
+ $ref: '#/components/schemas/AutomationRuleCreateAttributes'
type:
- $ref: "#/components/schemas/CaseAutomationRuleResourceType"
+ $ref: '#/components/schemas/CaseAutomationRuleResourceType'
required:
- type
- attributes
@@ -12126,15 +12126,15 @@ components:
description: Attributes required to create an automation rule.
properties:
action:
- $ref: "#/components/schemas/AutomationRuleAction"
+ $ref: '#/components/schemas/AutomationRuleAction'
name:
description: Name of the automation rule.
example: "Auto-assign workflow"
type: string
state:
- $ref: "#/components/schemas/CaseAutomationRuleState"
+ $ref: '#/components/schemas/CaseAutomationRuleState'
trigger:
- $ref: "#/components/schemas/AutomationRuleTrigger"
+ $ref: '#/components/schemas/AutomationRuleTrigger'
required:
- name
- trigger
@@ -12144,7 +12144,7 @@ components:
description: Request payload for creating an automation rule.
properties:
data:
- $ref: "#/components/schemas/AutomationRuleCreate"
+ $ref: '#/components/schemas/AutomationRuleCreate'
required:
- data
type: object
@@ -12160,7 +12160,7 @@ components:
example: "Jane Doe"
type: string
type:
- $ref: "#/components/schemas/AutomationRuleActorType"
+ $ref: '#/components/schemas/AutomationRuleActorType'
required:
- type
- id
@@ -12178,7 +12178,7 @@ components:
example: "Jane Doe"
type: string
type:
- $ref: "#/components/schemas/AutomationRuleActorType"
+ $ref: '#/components/schemas/AutomationRuleActorType'
required:
- type
- id
@@ -12188,15 +12188,15 @@ components:
description: Related resources for the automation rule, including the users who created and last modified it.
properties:
created_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
modified_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
type: object
AutomationRuleResponse:
description: Response containing a single automation rule.
properties:
data:
- $ref: "#/components/schemas/AutomationRule"
+ $ref: '#/components/schemas/AutomationRule'
required:
- data
type: object
@@ -12204,7 +12204,7 @@ components:
description: Defines the scope of findings to which the automation rule applies.
properties:
finding_types:
- $ref: "#/components/schemas/SecurityFindingTypes"
+ $ref: '#/components/schemas/SecurityFindingTypes'
query:
description: A search query to further filter the findings matched by this rule. The `@workflow.*` namespace and `@status` fields are not permitted. For a reference of available fields, see the [Security Findings schema documentation](https://docs.datadoghq.com/security/guide/findings-schema/).
example: "env:prod team:platform"
@@ -12217,9 +12217,9 @@ components:
description: Defines when the rule activates. Combines a trigger type (the case event to listen for) with optional trigger data (conditions that narrow when the trigger fires).
properties:
data:
- $ref: "#/components/schemas/AutomationRuleTriggerData"
+ $ref: '#/components/schemas/AutomationRuleTriggerData'
type:
- $ref: "#/components/schemas/AutomationRuleTriggerType"
+ $ref: '#/components/schemas/AutomationRuleTriggerType'
required:
- type
type: object
@@ -12264,9 +12264,9 @@ components:
description: Data object for updating an automation rule.
properties:
attributes:
- $ref: "#/components/schemas/AutomationRuleCreateAttributes"
+ $ref: '#/components/schemas/AutomationRuleCreateAttributes'
type:
- $ref: "#/components/schemas/CaseAutomationRuleResourceType"
+ $ref: '#/components/schemas/CaseAutomationRuleResourceType'
required:
- type
type: object
@@ -12274,7 +12274,7 @@ components:
description: Request payload for updating an automation rule.
properties:
data:
- $ref: "#/components/schemas/AutomationRuleUpdate"
+ $ref: '#/components/schemas/AutomationRuleUpdate'
required:
- data
type: object
@@ -12284,7 +12284,7 @@ components:
data:
description: List of automation rules.
items:
- $ref: "#/components/schemas/AutomationRule"
+ $ref: '#/components/schemas/AutomationRule'
type: array
required:
- data
@@ -12297,12 +12297,12 @@ components:
description: AWS CUR config.
properties:
attributes:
- $ref: "#/components/schemas/AwsCURConfigAttributes"
+ $ref: '#/components/schemas/AwsCURConfigAttributes'
id:
description: The ID of the AWS CUR config.
type: string
type:
- $ref: "#/components/schemas/AwsCURConfigType"
+ $ref: '#/components/schemas/AwsCURConfigType'
required:
- attributes
- type
@@ -12311,7 +12311,7 @@ components:
description: Attributes for An AWS CUR config.
properties:
account_filters:
- $ref: "#/components/schemas/AccountFilteringConfig"
+ $ref: '#/components/schemas/AccountFilteringConfig'
account_id:
description: The AWS account ID.
example: "123456789123"
@@ -12373,9 +12373,9 @@ components:
description: AWS CUR config Patch data.
properties:
attributes:
- $ref: "#/components/schemas/AwsCURConfigPatchRequestAttributes"
+ $ref: '#/components/schemas/AwsCURConfigPatchRequestAttributes'
type:
- $ref: "#/components/schemas/AwsCURConfigPatchRequestType"
+ $ref: '#/components/schemas/AwsCURConfigPatchRequestType'
required:
- attributes
- type
@@ -12384,7 +12384,7 @@ components:
description: AWS CUR config Patch Request.
properties:
data:
- $ref: "#/components/schemas/AwsCURConfigPatchData"
+ $ref: '#/components/schemas/AwsCURConfigPatchData'
required:
- data
type: object
@@ -12392,7 +12392,7 @@ components:
description: Attributes for AWS CUR config Patch Request.
properties:
account_filters:
- $ref: "#/components/schemas/AccountFilteringConfig"
+ $ref: '#/components/schemas/AccountFilteringConfig'
is_enabled:
description: Whether or not the Cloud Cost Management account is enabled.
example: true
@@ -12411,9 +12411,9 @@ components:
description: AWS CUR config Post data.
properties:
attributes:
- $ref: "#/components/schemas/AwsCURConfigPostRequestAttributes"
+ $ref: '#/components/schemas/AwsCURConfigPostRequestAttributes'
type:
- $ref: "#/components/schemas/AwsCURConfigPostRequestType"
+ $ref: '#/components/schemas/AwsCURConfigPostRequestType'
required:
- type
type: object
@@ -12421,7 +12421,7 @@ components:
description: AWS CUR config Post Request.
properties:
data:
- $ref: "#/components/schemas/AwsCURConfigPostData"
+ $ref: '#/components/schemas/AwsCURConfigPostData'
required:
- data
type: object
@@ -12429,7 +12429,7 @@ components:
description: Attributes for AWS CUR config Post Request.
properties:
account_filters:
- $ref: "#/components/schemas/AccountFilteringConfig"
+ $ref: '#/components/schemas/AccountFilteringConfig'
account_id:
description: The AWS account ID.
example: "123456789123"
@@ -12485,7 +12485,7 @@ components:
data:
description: An AWS CUR config.
items:
- $ref: "#/components/schemas/AwsCURConfig"
+ $ref: '#/components/schemas/AwsCURConfig'
type: array
required:
- data
@@ -12515,18 +12515,18 @@ components:
type: aws_cur_config
properties:
data:
- $ref: "#/components/schemas/AwsCurConfigResponseData"
+ $ref: '#/components/schemas/AwsCurConfigResponseData'
type: object
AwsCurConfigResponseData:
description: The definition of `AwsCurConfigResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/AwsCurConfigResponseDataAttributes"
+ $ref: '#/components/schemas/AwsCurConfigResponseDataAttributes'
id:
description: The `AwsCurConfigResponseData` `id`.
type: string
type:
- $ref: "#/components/schemas/AwsCurConfigResponseDataType"
+ $ref: '#/components/schemas/AwsCurConfigResponseDataType'
required:
- type
type: object
@@ -12534,7 +12534,7 @@ components:
description: The definition of `AwsCurConfigResponseDataAttributes` object.
properties:
account_filters:
- $ref: "#/components/schemas/AwsCurConfigResponseDataAttributesAccountFilters"
+ $ref: '#/components/schemas/AwsCurConfigResponseDataAttributesAccountFilters'
account_id:
description: The `attributes` `account_id`.
type: string
@@ -12642,9 +12642,9 @@ components:
description: Object for a single AWS on demand task.
properties:
attributes:
- $ref: "#/components/schemas/AwsOnDemandCreateAttributes"
+ $ref: '#/components/schemas/AwsOnDemandCreateAttributes'
type:
- $ref: "#/components/schemas/AwsOnDemandType"
+ $ref: '#/components/schemas/AwsOnDemandType'
required:
- type
- attributes
@@ -12653,7 +12653,7 @@ components:
description: Request object that includes the on demand task to submit.
properties:
data:
- $ref: "#/components/schemas/AwsOnDemandCreateData"
+ $ref: '#/components/schemas/AwsOnDemandCreateData'
required:
- data
type: object
@@ -12661,13 +12661,13 @@ components:
description: Single AWS on demand task.
properties:
attributes:
- $ref: "#/components/schemas/AwsOnDemandAttributes"
+ $ref: '#/components/schemas/AwsOnDemandAttributes'
id:
description: The UUID of the task.
example: "6d09294c-9ad9-42fd-a759-a0c1599b4828"
type: string
type:
- $ref: "#/components/schemas/AwsOnDemandType"
+ $ref: '#/components/schemas/AwsOnDemandType'
type: object
AwsOnDemandListResponse:
description: Response object that includes a list of AWS on demand tasks.
@@ -12675,14 +12675,14 @@ components:
data:
description: A list of on demand tasks.
items:
- $ref: "#/components/schemas/AwsOnDemandData"
+ $ref: '#/components/schemas/AwsOnDemandData'
type: array
type: object
AwsOnDemandResponse:
description: Response object that includes an AWS on demand task.
properties:
data:
- $ref: "#/components/schemas/AwsOnDemandData"
+ $ref: '#/components/schemas/AwsOnDemandData'
type: object
AwsOnDemandType:
default: aws_resource
@@ -12750,11 +12750,11 @@ components:
description: Object for the scan options of a single AWS account.
properties:
attributes:
- $ref: "#/components/schemas/AwsScanOptionsCreateAttributes"
+ $ref: '#/components/schemas/AwsScanOptionsCreateAttributes'
id:
- $ref: "#/components/schemas/AwsAccountId"
+ $ref: '#/components/schemas/AwsAccountId'
type:
- $ref: "#/components/schemas/AwsScanOptionsType"
+ $ref: '#/components/schemas/AwsScanOptionsType'
required:
- id
- type
@@ -12764,7 +12764,7 @@ components:
description: Request object that includes the scan options to create.
properties:
data:
- $ref: "#/components/schemas/AwsScanOptionsCreateData"
+ $ref: '#/components/schemas/AwsScanOptionsCreateData'
required:
- data
type: object
@@ -12772,13 +12772,13 @@ components:
description: Single AWS Scan Options entry.
properties:
attributes:
- $ref: "#/components/schemas/AwsScanOptionsAttributes"
+ $ref: '#/components/schemas/AwsScanOptionsAttributes'
id:
description: The ID of the AWS account.
example: "184366314700"
type: string
type:
- $ref: "#/components/schemas/AwsScanOptionsType"
+ $ref: '#/components/schemas/AwsScanOptionsType'
type: object
AwsScanOptionsListResponse:
description: Response object that includes a list of AWS scan options.
@@ -12786,14 +12786,14 @@ components:
data:
description: A list of AWS scan options.
items:
- $ref: "#/components/schemas/AwsScanOptionsData"
+ $ref: '#/components/schemas/AwsScanOptionsData'
type: array
type: object
AwsScanOptionsResponse:
description: Response object that includes the scan options of an AWS account.
properties:
data:
- $ref: "#/components/schemas/AwsScanOptionsData"
+ $ref: '#/components/schemas/AwsScanOptionsData'
type: object
AwsScanOptionsType:
default: aws_scan_options
@@ -12831,11 +12831,11 @@ components:
description: Object for the scan options of a single AWS account.
properties:
attributes:
- $ref: "#/components/schemas/AwsScanOptionsUpdateAttributes"
+ $ref: '#/components/schemas/AwsScanOptionsUpdateAttributes'
id:
- $ref: "#/components/schemas/AwsAccountId"
+ $ref: '#/components/schemas/AwsAccountId'
type:
- $ref: "#/components/schemas/AwsScanOptionsType"
+ $ref: '#/components/schemas/AwsScanOptionsType'
required:
- id
- type
@@ -12845,25 +12845,25 @@ components:
description: Request object that includes the scan options to update.
properties:
data:
- $ref: "#/components/schemas/AwsScanOptionsUpdateData"
+ $ref: '#/components/schemas/AwsScanOptionsUpdateData'
required:
- data
type: object
AzureCredentials:
description: The definition of the `AzureCredentials` object.
oneOf:
- - $ref: "#/components/schemas/AzureTenant"
+ - $ref: '#/components/schemas/AzureTenant'
AzureCredentialsUpdate:
description: The definition of the `AzureCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/AzureTenantUpdate"
+ - $ref: '#/components/schemas/AzureTenantUpdate'
AzureIntegration:
description: The definition of the `AzureIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/AzureCredentials"
+ $ref: '#/components/schemas/AzureCredentials'
type:
- $ref: "#/components/schemas/AzureIntegrationType"
+ $ref: '#/components/schemas/AzureIntegrationType'
required:
- type
- credentials
@@ -12880,9 +12880,9 @@ components:
description: The definition of the `AzureIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/AzureCredentialsUpdate"
+ $ref: '#/components/schemas/AzureCredentialsUpdate'
type:
- $ref: "#/components/schemas/AzureIntegrationType"
+ $ref: '#/components/schemas/AzureIntegrationType'
required:
- type
type: object
@@ -12899,7 +12899,7 @@ components:
type: azure_scan_options
properties:
data:
- $ref: "#/components/schemas/AzureScanOptionsData"
+ $ref: '#/components/schemas/AzureScanOptionsData'
type: object
AzureScanOptionsArray:
description: Response object containing a list of Azure scan options.
@@ -12916,7 +12916,7 @@ components:
data:
description: A list of Azure scan options.
items:
- $ref: "#/components/schemas/AzureScanOptionsData"
+ $ref: '#/components/schemas/AzureScanOptionsData'
type: array
required:
- data
@@ -12925,13 +12925,13 @@ components:
description: Single Azure scan options entry.
properties:
attributes:
- $ref: "#/components/schemas/AzureScanOptionsDataAttributes"
+ $ref: '#/components/schemas/AzureScanOptionsDataAttributes'
id:
description: The Azure subscription ID.
example: ""
type: string
type:
- $ref: "#/components/schemas/AzureScanOptionsDataType"
+ $ref: '#/components/schemas/AzureScanOptionsDataType'
required:
- type
- id
@@ -12969,19 +12969,19 @@ components:
type: azure_scan_options
properties:
data:
- $ref: "#/components/schemas/AzureScanOptionsInputUpdateData"
+ $ref: '#/components/schemas/AzureScanOptionsInputUpdateData'
type: object
AzureScanOptionsInputUpdateData:
description: Data object for updating the scan options of a single Azure subscription.
properties:
attributes:
- $ref: "#/components/schemas/AzureScanOptionsInputUpdateDataAttributes"
+ $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataAttributes'
id:
description: The Azure subscription ID.
example: "12345678-90ab-cdef-1234-567890abcdef"
type: string
type:
- $ref: "#/components/schemas/AzureScanOptionsInputUpdateDataType"
+ $ref: '#/components/schemas/AzureScanOptionsInputUpdateDataType'
required:
- type
- id
@@ -13022,9 +13022,9 @@ components:
example: "logs/"
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompression'
connection_string_key:
description: Name of the environment variable or secret that holds the Azure Storage connection string.
example: AZURE_STORAGE_CONNECTION_STRING
@@ -13045,7 +13045,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/AzureStorageDestinationType"
+ $ref: '#/components/schemas/AzureStorageDestinationType'
required:
- id
- type
@@ -13081,7 +13081,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/AzureTenantType"
+ $ref: '#/components/schemas/AzureTenantType'
required:
- type
- tenant_id
@@ -13112,7 +13112,7 @@ components:
description: The Tenant ID, also known as the Directory ID in Azure, is a unique identifier that represents an Azure AD instance. Your Tenant ID (Directory ID) is listed in your Active Directory overview page under the 'Tenant information' section.
type: string
type:
- $ref: "#/components/schemas/AzureTenantType"
+ $ref: '#/components/schemas/AzureTenantType'
required:
- type
type: object
@@ -13198,12 +13198,12 @@ components:
description: Azure config pair.
properties:
attributes:
- $ref: "#/components/schemas/AzureUCConfigPairAttributes"
+ $ref: '#/components/schemas/AzureUCConfigPairAttributes'
id:
description: The ID of Cloud Cost Management account.
type: string
type:
- $ref: "#/components/schemas/AzureUCConfigPairType"
+ $ref: '#/components/schemas/AzureUCConfigPairType'
required:
- attributes
- type
@@ -13214,7 +13214,7 @@ components:
configs:
description: An Azure config.
items:
- $ref: "#/components/schemas/AzureUCConfig"
+ $ref: '#/components/schemas/AzureUCConfig'
type: array
id:
description: The ID of the Azure config pair.
@@ -13235,15 +13235,15 @@ components:
description: Response of Azure config pair.
properties:
data:
- $ref: "#/components/schemas/AzureUCConfigPair"
+ $ref: '#/components/schemas/AzureUCConfigPair'
type: object
AzureUCConfigPatchData:
description: Azure config Patch data.
properties:
attributes:
- $ref: "#/components/schemas/AzureUCConfigPatchRequestAttributes"
+ $ref: '#/components/schemas/AzureUCConfigPatchRequestAttributes'
type:
- $ref: "#/components/schemas/AzureUCConfigPatchRequestType"
+ $ref: '#/components/schemas/AzureUCConfigPatchRequestType'
required:
- type
type: object
@@ -13251,7 +13251,7 @@ components:
description: Azure config Patch Request.
properties:
data:
- $ref: "#/components/schemas/AzureUCConfigPatchData"
+ $ref: '#/components/schemas/AzureUCConfigPatchData'
required:
- data
type: object
@@ -13278,9 +13278,9 @@ components:
description: Azure config Post data.
properties:
attributes:
- $ref: "#/components/schemas/AzureUCConfigPostRequestAttributes"
+ $ref: '#/components/schemas/AzureUCConfigPostRequestAttributes'
type:
- $ref: "#/components/schemas/AzureUCConfigPostRequestType"
+ $ref: '#/components/schemas/AzureUCConfigPostRequestType'
required:
- type
type: object
@@ -13288,7 +13288,7 @@ components:
description: Azure config Post Request.
properties:
data:
- $ref: "#/components/schemas/AzureUCConfigPostData"
+ $ref: '#/components/schemas/AzureUCConfigPostData'
required:
- data
type: object
@@ -13300,9 +13300,9 @@ components:
example: "1234abcd-1234-abcd-1234-1234abcd1234"
type: string
actual_bill_config:
- $ref: "#/components/schemas/BillConfig"
+ $ref: '#/components/schemas/BillConfig'
amortized_bill_config:
- $ref: "#/components/schemas/BillConfig"
+ $ref: '#/components/schemas/BillConfig'
client_id:
description: The client ID of the Azure account.
example: "1234abcd-1234-abcd-1234-1234abcd1234"
@@ -13333,7 +13333,7 @@ components:
data:
description: An Azure config pair.
items:
- $ref: "#/components/schemas/AzureUCConfigPair"
+ $ref: '#/components/schemas/AzureUCConfigPair'
type: array
required:
- data
@@ -13344,7 +13344,7 @@ components:
data:
description: List of row resources to delete from the reference table.
items:
- $ref: "#/components/schemas/TableRowResourceIdentifier"
+ $ref: '#/components/schemas/TableRowResourceIdentifier'
maxItems: 200
type: array
required:
@@ -13363,15 +13363,15 @@ components:
description: Request object for querying multiple rows from a reference table by their identifiers.
properties:
data:
- $ref: "#/components/schemas/BatchRowsQueryRequestData"
+ $ref: '#/components/schemas/BatchRowsQueryRequestData'
type: object
BatchRowsQueryRequestData:
description: Data object for a batch rows query request.
properties:
attributes:
- $ref: "#/components/schemas/BatchRowsQueryRequestDataAttributes"
+ $ref: '#/components/schemas/BatchRowsQueryRequestDataAttributes'
type:
- $ref: "#/components/schemas/BatchRowsQueryDataType"
+ $ref: '#/components/schemas/BatchRowsQueryDataType'
required:
- type
type: object
@@ -13421,11 +13421,11 @@ components:
type: row
properties:
data:
- $ref: "#/components/schemas/BatchRowsQueryResponseData"
+ $ref: '#/components/schemas/BatchRowsQueryResponseData'
included:
description: Full row resources matching the query, included alongside the relationship references in `data`.
items:
- $ref: "#/components/schemas/TableRowResourceData"
+ $ref: '#/components/schemas/TableRowResourceData'
type: array
type: object
BatchRowsQueryResponseData:
@@ -13435,9 +13435,9 @@ components:
description: Unique identifier of the batch query.
type: string
relationships:
- $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationships"
+ $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationships'
type:
- $ref: "#/components/schemas/BatchRowsQueryDataType"
+ $ref: '#/components/schemas/BatchRowsQueryDataType'
required:
- type
type: object
@@ -13445,14 +13445,14 @@ components:
description: Relationships of the batch rows query response data.
properties:
rows:
- $ref: "#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows"
+ $ref: '#/components/schemas/BatchRowsQueryResponseDataRelationshipsRows'
type: object
BatchRowsQueryResponseDataRelationshipsRows:
description: Relationship data containing the list of matching rows.
properties:
data:
items:
- $ref: "#/components/schemas/TableRowResourceIdentifier"
+ $ref: '#/components/schemas/TableRowResourceIdentifier'
type: array
type: object
BatchUpsertRowsRequestArray:
@@ -13461,7 +13461,7 @@ components:
data:
description: List of row resources to create or update in the reference table.
items:
- $ref: "#/components/schemas/BatchUpsertRowsRequestData"
+ $ref: '#/components/schemas/BatchUpsertRowsRequestData'
maxItems: 200
type: array
required:
@@ -13471,13 +13471,13 @@ components:
description: Row resource containing a single row identifier and its column values.
properties:
attributes:
- $ref: "#/components/schemas/BatchUpsertRowsRequestDataAttributes"
+ $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributes'
id:
description: The primary key value that uniquely identifies the row to create or update.
example: "primary_key_value"
type: string
type:
- $ref: "#/components/schemas/TableRowResourceDataType"
+ $ref: '#/components/schemas/TableRowResourceDataType'
required:
- type
- id
@@ -13489,7 +13489,7 @@ components:
properties:
values:
additionalProperties:
- $ref: "#/components/schemas/BatchUpsertRowsRequestDataAttributesValue"
+ $ref: '#/components/schemas/BatchUpsertRowsRequestDataAttributesValue'
description: >-
Key-value pairs representing row data, where keys are schema field names and values match the corresponding column types.
type: object
@@ -13533,18 +13533,18 @@ components:
BillingDimensionsMappingBody:
description: Billing dimensions mapping data.
items:
- $ref: "#/components/schemas/BillingDimensionsMappingBodyItem"
+ $ref: '#/components/schemas/BillingDimensionsMappingBodyItem'
type: array
BillingDimensionsMappingBodyItem:
description: The mapping data for each billing dimension.
properties:
attributes:
- $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributes"
+ $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributes'
id:
description: ID of the billing dimension.
type: string
type:
- $ref: "#/components/schemas/ActiveBillingDimensionsType"
+ $ref: '#/components/schemas/ActiveBillingDimensionsType'
type: object
BillingDimensionsMappingBodyItemAttributes:
description: Mapping of billing dimensions to endpoint keys.
@@ -13552,7 +13552,7 @@ components:
endpoints:
description: "List of supported endpoints with their keys mapped to the billing_dimension."
items:
- $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems"
+ $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItems'
type: array
in_app_label:
description: "Label used for the billing dimension in the Plan & Usage charts."
@@ -13581,7 +13581,7 @@ components:
type: string
type: array
status:
- $ref: "#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus"
+ $ref: '#/components/schemas/BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus'
type: object
BillingDimensionsMappingBodyItemAttributesEndpointsItemsStatus:
description: Denotes whether mapping keys were available for this endpoint.
@@ -13596,7 +13596,7 @@ components:
description: Billing dimensions mapping response.
properties:
data:
- $ref: "#/components/schemas/BillingDimensionsMappingBody"
+ $ref: '#/components/schemas/BillingDimensionsMappingBody'
type: object
BlueprintAttributes:
description: The attributes of a blueprint resource.
@@ -13607,7 +13607,7 @@ components:
format: date-time
type: string
definition:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
description:
description: A description of what the blueprint does.
example: ""
@@ -13619,7 +13619,7 @@ components:
embedded_native_actions:
description: Embedded native actions.
items:
- $ref: "#/components/schemas/BlueprintNativeAction"
+ $ref: '#/components/schemas/BlueprintNativeAction'
type: array
embedded_workflow_blueprints:
additionalProperties: {}
@@ -13668,14 +13668,14 @@ components:
description: A blueprint resource.
properties:
attributes:
- $ref: "#/components/schemas/BlueprintAttributes"
+ $ref: '#/components/schemas/BlueprintAttributes'
id:
description: The ID of the blueprint.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/BlueprintDataType"
+ $ref: '#/components/schemas/BlueprintDataType'
required:
- id
- type
@@ -13736,14 +13736,14 @@ components:
description: A blueprint metadata resource.
properties:
attributes:
- $ref: "#/components/schemas/BlueprintMetadataAttributes"
+ $ref: '#/components/schemas/BlueprintMetadataAttributes'
id:
description: The ID of the blueprint.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/BlueprintDataType"
+ $ref: '#/components/schemas/BlueprintDataType'
required:
- id
- type
@@ -13757,7 +13757,7 @@ components:
description: Request object for getting code coverage summary for a branch.
properties:
data:
- $ref: "#/components/schemas/BranchCoverageSummaryRequestData"
+ $ref: '#/components/schemas/BranchCoverageSummaryRequestData'
required:
- data
type: object
@@ -13787,9 +13787,9 @@ components:
description: Data object for branch summary request.
properties:
attributes:
- $ref: "#/components/schemas/BranchCoverageSummaryRequestAttributes"
+ $ref: '#/components/schemas/BranchCoverageSummaryRequestAttributes'
type:
- $ref: "#/components/schemas/BranchCoverageSummaryRequestType"
+ $ref: '#/components/schemas/BranchCoverageSummaryRequestType'
required:
- type
- attributes
@@ -13806,7 +13806,7 @@ components:
description: A budget.
properties:
attributes:
- $ref: "#/components/schemas/BudgetAttributes"
+ $ref: '#/components/schemas/BudgetAttributes'
id:
description: The id of the budget.
type: string
@@ -13838,7 +13838,7 @@ components:
data:
description: The `BudgetArray` `data`.
items:
- $ref: "#/components/schemas/Budget"
+ $ref: '#/components/schemas/Budget'
type: array
required:
- data
@@ -13877,7 +13877,7 @@ components:
entries:
description: The list of monthly budget entries.
items:
- $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems"
+ $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems'
type: array
metrics_query:
description: The cost query used to track against the budget.
@@ -13989,18 +13989,18 @@ components:
type: budget
properties:
data:
- $ref: "#/components/schemas/BudgetValidationRequestData"
+ $ref: '#/components/schemas/BudgetValidationRequestData'
type: object
BudgetValidationRequestData:
description: The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate.
properties:
attributes:
- $ref: "#/components/schemas/BudgetWithEntriesDataAttributes"
+ $ref: '#/components/schemas/BudgetWithEntriesDataAttributes'
id:
description: The unique identifier of the budget to validate.
type: string
type:
- $ref: "#/components/schemas/BudgetWithEntriesDataType"
+ $ref: '#/components/schemas/BudgetWithEntriesDataType'
required:
- type
type: object
@@ -14015,18 +14015,18 @@ components:
type: budget_validation
properties:
data:
- $ref: "#/components/schemas/BudgetValidationResponseData"
+ $ref: '#/components/schemas/BudgetValidationResponseData'
type: object
BudgetValidationResponseData:
description: The data object for a budget validation response, containing the resource type, ID, and validation attributes.
properties:
attributes:
- $ref: "#/components/schemas/BudgetValidationResponseDataAttributes"
+ $ref: '#/components/schemas/BudgetValidationResponseDataAttributes'
id:
description: The unique identifier of the budget being validated.
type: string
type:
- $ref: "#/components/schemas/BudgetValidationResponseDataType"
+ $ref: '#/components/schemas/BudgetValidationResponseDataType'
required:
- type
type: object
@@ -14056,13 +14056,13 @@ components:
description: The definition of the `BudgetWithEntries` object.
properties:
data:
- $ref: "#/components/schemas/BudgetWithEntriesData"
+ $ref: '#/components/schemas/BudgetWithEntriesData'
type: object
BudgetWithEntriesData:
description: A budget and all its entries.
properties:
attributes:
- $ref: "#/components/schemas/BudgetAttributes"
+ $ref: '#/components/schemas/BudgetAttributes'
id:
description: The `BudgetWithEntriesData` `id`.
example: 00000000-0a0a-0a0a-aaa0-00000000000a
@@ -14089,7 +14089,7 @@ components:
entries:
description: The list of monthly budget entries.
items:
- $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems"
+ $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems'
type: array
metrics_query:
description: The cost query used to track spending against the budget.
@@ -14134,7 +14134,7 @@ components:
tag_filters:
description: The list of tag filters that scope this budget entry to specific resources.
items:
- $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems"
+ $ref: '#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems'
type: array
type: object
BudgetWithEntriesDataAttributesEntriesItemsCosts:
@@ -14190,18 +14190,18 @@ components:
description: Request to delete items from a datastore.
properties:
data:
- $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData"
+ $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData'
type: object
BulkDeleteAppsDatastoreItemsRequestData:
description: Data wrapper containing the data needed to delete items from a datastore.
properties:
attributes:
- $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes"
+ $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes'
id:
description: ID for the datastore of the items to delete.
type: string
type:
- $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType"
+ $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType'
required:
- type
type: object
@@ -14229,15 +14229,15 @@ components:
description: Request to insert multiple items into a datastore in a single operation.
properties:
data:
- $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequestData"
+ $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequestData'
type: object
BulkPutAppsDatastoreItemsRequestData:
description: Data wrapper containing the items to insert and their configuration for the bulk insert operation.
properties:
attributes:
- $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequestDataAttributes"
+ $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequestDataAttributes'
type:
- $ref: "#/components/schemas/DatastoreItemsDataType"
+ $ref: '#/components/schemas/DatastoreItemsDataType'
required:
- type
type: object
@@ -14245,18 +14245,18 @@ components:
description: Configuration for bulk inserting multiple items into a datastore.
properties:
conflict_mode:
- $ref: "#/components/schemas/DatastoreItemConflictMode"
+ $ref: '#/components/schemas/DatastoreItemConflictMode'
values:
- $ref: "#/components/schemas/DatastoreItemValues"
+ $ref: '#/components/schemas/DatastoreItemValues'
required:
- values
type: object
CIAppAggregateBucketValue:
description: A bucket value, can either be a timeseries or a single value.
oneOf:
- - $ref: "#/components/schemas/CIAppAggregateBucketValueSingleString"
- - $ref: "#/components/schemas/CIAppAggregateBucketValueSingleNumber"
- - $ref: "#/components/schemas/CIAppAggregateBucketValueTimeseries"
+ - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleString'
+ - $ref: '#/components/schemas/CIAppAggregateBucketValueSingleNumber'
+ - $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseries'
CIAppAggregateBucketValueSingleNumber:
description: A single number value.
format: double
@@ -14267,7 +14267,7 @@ components:
CIAppAggregateBucketValueTimeseries:
description: A timeseries array.
items:
- $ref: "#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint"
+ $ref: '#/components/schemas/CIAppAggregateBucketValueTimeseriesPoint'
type: array
x-generate-alias-as-model: true
CIAppAggregateBucketValueTimeseriesPoint:
@@ -14290,15 +14290,15 @@ components:
example: {"aggregation": "count", "order": "asc"}
properties:
aggregation:
- $ref: "#/components/schemas/CIAppAggregationFunction"
+ $ref: '#/components/schemas/CIAppAggregationFunction'
metric:
description: The metric to sort by (only used for `type=measure`).
example: "@duration"
type: string
order:
- $ref: "#/components/schemas/CIAppSortOrder"
+ $ref: '#/components/schemas/CIAppSortOrder'
type:
- $ref: "#/components/schemas/CIAppAggregateSortType"
+ $ref: '#/components/schemas/CIAppAggregateSortType'
type: object
CIAppAggregateSortType:
default: "alphabetical"
@@ -14317,7 +14317,7 @@ components:
nullable: true
properties:
domain:
- $ref: "#/components/schemas/CIAppCIErrorDomain"
+ $ref: '#/components/schemas/CIAppCIErrorDomain'
message:
description: Error message.
maxLength: 5000
@@ -14342,7 +14342,7 @@ components:
description: A compute rule to compute metrics or timeseries.
properties:
aggregation:
- $ref: "#/components/schemas/CIAppAggregationFunction"
+ $ref: '#/components/schemas/CIAppAggregationFunction'
interval:
description: |-
The time buckets' size (only used for type=timeseries)
@@ -14354,7 +14354,7 @@ components:
example: "@duration"
type: string
type:
- $ref: "#/components/schemas/CIAppComputeType"
+ $ref: '#/components/schemas/CIAppComputeType'
required:
- aggregation
type: object
@@ -14366,14 +14366,14 @@ components:
x-enum-varnames: ["TIMESERIES", "TOTAL"]
CIAppComputes:
additionalProperties:
- $ref: "#/components/schemas/CIAppAggregateBucketValue"
+ $ref: '#/components/schemas/CIAppAggregateBucketValue'
description: A map of the metric name to value for regular compute, or a list of values for a timeseries.
type: object
CIAppCreatePipelineEventRequest:
description: Request object.
properties:
data:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataSingleOrArray"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataSingleOrArray'
type: object
CIAppCreatePipelineEventRequestAttributes:
description: Attributes of the pipeline event to create.
@@ -14385,7 +14385,7 @@ components:
description: The name of the CI provider. By default, this is "custom".
type: string
resource:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributesResource'
service:
description: If the CI provider is SaaS, use this to differentiate between instances.
type: string
@@ -14396,28 +14396,28 @@ components:
description: Details of the CI pipeline event.
example: "Details TBD"
oneOf:
- - $ref: "#/components/schemas/CIAppPipelineEventPipeline"
- - $ref: "#/components/schemas/CIAppPipelineEventStage"
- - $ref: "#/components/schemas/CIAppPipelineEventJob"
- - $ref: "#/components/schemas/CIAppPipelineEventStep"
+ - $ref: '#/components/schemas/CIAppPipelineEventPipeline'
+ - $ref: '#/components/schemas/CIAppPipelineEventStage'
+ - $ref: '#/components/schemas/CIAppPipelineEventJob'
+ - $ref: '#/components/schemas/CIAppPipelineEventStep'
CIAppCreatePipelineEventRequestData:
description: Data of the pipeline event to create.
properties:
attributes:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequestAttributes"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequestAttributes'
type:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataType"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataType'
type: object
CIAppCreatePipelineEventRequestDataArray:
description: Array of pipeline events to create in batch.
items:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequestData"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData'
type: array
CIAppCreatePipelineEventRequestDataSingleOrArray:
description: Data of the pipeline events to create.
oneOf:
- - $ref: "#/components/schemas/CIAppCreatePipelineEventRequestData"
- - $ref: "#/components/schemas/CIAppCreatePipelineEventRequestDataArray"
+ - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestData'
+ - $ref: '#/components/schemas/CIAppCreatePipelineEventRequestDataArray'
CIAppCreatePipelineEventRequestDataType:
default: cipipeline_resource_request
description: Type of the event.
@@ -14434,9 +14434,9 @@ components:
example: {"customAttribute": 123, "duration": 2345}
type: object
tags:
- $ref: "#/components/schemas/TagsEventAttribute"
+ $ref: '#/components/schemas/TagsEventAttribute'
test_level:
- $ref: "#/components/schemas/CIAppTestLevel"
+ $ref: '#/components/schemas/CIAppTestLevel'
type: object
CIAppGitHubAccountAttributes:
description: Attributes describing a GitHub account's CI Visibility opt-in status.
@@ -14461,14 +14461,14 @@ components:
repositories:
description: The repositories belonging to this account, with their individual opt-in status.
items:
- $ref: "#/components/schemas/CIAppGitHubAccountRepository"
+ $ref: '#/components/schemas/CIAppGitHubAccountRepository'
type: array
type: object
CIAppGitHubAccountData:
description: Data object for a GitHub account.
properties:
attributes:
- $ref: "#/components/schemas/CIAppGitHubAccountAttributes"
+ $ref: '#/components/schemas/CIAppGitHubAccountAttributes'
id:
description: |-
The account's unique identifier, in the form `/`
@@ -14476,7 +14476,7 @@ components:
example: github.com/datadog
type: string
type:
- $ref: "#/components/schemas/CIAppGitHubAccountType"
+ $ref: '#/components/schemas/CIAppGitHubAccountType'
required:
- id
- type
@@ -14498,7 +14498,7 @@ components:
description: Response object containing a single GitHub account's CI Visibility opt-in status.
properties:
data:
- $ref: "#/components/schemas/CIAppGitHubAccountData"
+ $ref: '#/components/schemas/CIAppGitHubAccountData'
required:
- data
type: object
@@ -14516,7 +14516,7 @@ components:
description: Request object for updating a GitHub account's CI Visibility opt-in status.
properties:
data:
- $ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestData"
+ $ref: '#/components/schemas/CIAppGitHubAccountUpdateRequestData'
required:
- data
type: object
@@ -14541,7 +14541,7 @@ components:
example: github.com
type: string
repository:
- $ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestRepository"
+ $ref: '#/components/schemas/CIAppGitHubAccountUpdateRequestRepository'
required:
- account
type: object
@@ -14549,9 +14549,9 @@ components:
description: Data object for updating a GitHub account's CI Visibility opt-in status.
properties:
attributes:
- $ref: "#/components/schemas/CIAppGitHubAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/CIAppGitHubAccountUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/CIAppGitHubAccountType"
+ $ref: '#/components/schemas/CIAppGitHubAccountType'
required:
- type
- attributes
@@ -14577,7 +14577,7 @@ components:
properties:
data:
items:
- $ref: "#/components/schemas/CIAppGitHubAccountData"
+ $ref: '#/components/schemas/CIAppGitHubAccountData'
type: array
required:
- data
@@ -14682,8 +14682,8 @@ components:
CIAppGroupByMissing:
description: The value to use for logs that don't have the facet used to group-by.
oneOf:
- - $ref: "#/components/schemas/CIAppGroupByMissingString"
- - $ref: "#/components/schemas/CIAppGroupByMissingNumber"
+ - $ref: '#/components/schemas/CIAppGroupByMissingString'
+ - $ref: '#/components/schemas/CIAppGroupByMissingNumber'
CIAppGroupByMissingNumber:
description: The missing value to use if there is a number valued facet.
format: double
@@ -14696,9 +14696,9 @@ components:
description: |-
A resulting object to put the given computes in over all the matching records.
oneOf:
- - $ref: "#/components/schemas/CIAppGroupByTotalBoolean"
- - $ref: "#/components/schemas/CIAppGroupByTotalString"
- - $ref: "#/components/schemas/CIAppGroupByTotalNumber"
+ - $ref: '#/components/schemas/CIAppGroupByTotalBoolean'
+ - $ref: '#/components/schemas/CIAppGroupByTotalString'
+ - $ref: '#/components/schemas/CIAppGroupByTotalNumber'
CIAppGroupByTotalBoolean:
description: If set to true, creates an additional bucket labeled "$facet_total".
type: boolean
@@ -14738,13 +14738,13 @@ components:
description: Object description of a pipeline event after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/CIAppPipelineEventAttributes"
+ $ref: '#/components/schemas/CIAppPipelineEventAttributes'
id:
description: Unique ID of the event.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/CIAppPipelineEventTypeName"
+ $ref: '#/components/schemas/CIAppPipelineEventTypeName'
type: object
CIAppPipelineEventAttributes:
description: JSON object containing all event attributes and their associated values.
@@ -14755,9 +14755,9 @@ components:
example: {"customAttribute": 123, "duration": 2345}
type: object
ci_level:
- $ref: "#/components/schemas/CIAppPipelineLevel"
+ $ref: '#/components/schemas/CIAppPipelineLevel'
tags:
- $ref: "#/components/schemas/TagsEventAttribute"
+ $ref: '#/components/schemas/TagsEventAttribute'
type: object
CIAppPipelineEventFinishedJob:
description: Details of a finished CI job.
@@ -14776,25 +14776,25 @@ components:
format: date-time
type: string
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
id:
description: The UUID for the job. It has to be unique within each pipeline execution.
example: c865bad4-de82-44b8-ade7-2c987528eb54
type: string
level:
- $ref: "#/components/schemas/CIAppPipelineEventJobLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventJobLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: The name for the job.
example: test
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
pipeline_name:
description: The parent pipeline name.
example: Build
@@ -14826,9 +14826,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventJobStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventJobStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
url:
description: The URL to look at the job in the CI provider UI.
example: https://ci-platform.com/job/your-job-name/build/123
@@ -14853,9 +14853,9 @@ components:
format: date-time
type: string
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
is_manual:
description: Whether or not the pipeline was triggered manually by the user.
example: false
@@ -14867,19 +14867,19 @@ components:
nullable: true
type: boolean
level:
- $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: Name of the pipeline. All pipeline runs for the builds should have the same name.
example: Deploy to AWS
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
parent_pipeline:
- $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
+ $ref: '#/components/schemas/CIAppPipelineEventParentPipeline'
partial_retry:
description: |-
Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
@@ -14893,7 +14893,7 @@ components:
example: "#023"
type: string
previous_attempt:
- $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
+ $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline'
queue_time:
description: The queue time in milliseconds, if applicable.
example: 1004
@@ -14907,9 +14907,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventPipelineStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventPipelineStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
unique_id:
description: |-
UUID of the pipeline run. The ID has to be unique across retries and pipelines,
@@ -14942,25 +14942,25 @@ components:
nullable: true
type: array
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
id:
description: The UUID for the job. It must match the ID of the corresponding finished job.
example: c865bad4-de82-44b8-ade7-2c987528eb54
type: string
level:
- $ref: "#/components/schemas/CIAppPipelineEventJobLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventJobLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: The name for the job.
example: test
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
pipeline_name:
description: The parent pipeline name.
example: Build
@@ -14992,9 +14992,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventJobInProgressStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventJobInProgressStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
url:
description: The URL to look at the job in the CI provider UI.
example: https://ci-platform.com/job/your-job-name/build/123
@@ -15013,9 +15013,9 @@ components:
description: Details of a running pipeline.
properties:
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
is_manual:
description: Whether or not the pipeline was triggered manually by the user.
example: false
@@ -15027,19 +15027,19 @@ components:
nullable: true
type: boolean
level:
- $ref: "#/components/schemas/CIAppPipelineEventPipelineLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventPipelineLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: Name of the pipeline. All pipeline runs for the builds should have the same name.
example: Deploy to AWS
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
parent_pipeline:
- $ref: "#/components/schemas/CIAppPipelineEventParentPipeline"
+ $ref: '#/components/schemas/CIAppPipelineEventParentPipeline'
partial_retry:
description: |-
Whether or not the pipeline was a partial retry of a previous attempt. A partial retry is one
@@ -15053,7 +15053,7 @@ components:
example: "#023"
type: string
previous_attempt:
- $ref: "#/components/schemas/CIAppPipelineEventPreviousPipeline"
+ $ref: '#/components/schemas/CIAppPipelineEventPreviousPipeline'
queue_time:
description: The queue time in milliseconds, if applicable.
example: 1004
@@ -15067,9 +15067,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventPipelineInProgressStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventPipelineInProgressStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
unique_id:
description: |-
UUID of the pipeline run. The ID has to be the same as the finished pipeline.
@@ -15091,8 +15091,8 @@ components:
CIAppPipelineEventJob:
description: Details of a CI job.
oneOf:
- - $ref: "#/components/schemas/CIAppPipelineEventFinishedJob"
- - $ref: "#/components/schemas/CIAppPipelineEventInProgressJob"
+ - $ref: '#/components/schemas/CIAppPipelineEventFinishedJob'
+ - $ref: '#/components/schemas/CIAppPipelineEventInProgressJob'
CIAppPipelineEventJobInProgressStatus:
description: The in-progress status of the job.
enum: ["running"]
@@ -15148,8 +15148,8 @@ components:
CIAppPipelineEventPipeline:
description: Details of the top level pipeline, build, or workflow of your CI.
oneOf:
- - $ref: "#/components/schemas/CIAppPipelineEventFinishedPipeline"
- - $ref: "#/components/schemas/CIAppPipelineEventInProgressPipeline"
+ - $ref: '#/components/schemas/CIAppPipelineEventFinishedPipeline'
+ - $ref: '#/components/schemas/CIAppPipelineEventInProgressPipeline'
CIAppPipelineEventPipelineInProgressStatus:
description: The in progress status of the pipeline.
enum: ["running"]
@@ -15201,25 +15201,25 @@ components:
format: date-time
type: string
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
id:
description: UUID for the stage. It has to be unique at least in the pipeline scope.
example: 562bdbbb-7cab-48c8-851c-b24ca14628bf
type: string
level:
- $ref: "#/components/schemas/CIAppPipelineEventStageLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventStageLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: The name for the stage.
example: build
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
pipeline_name:
description: The parent pipeline name.
example: Build
@@ -15241,9 +15241,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventStageStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventStageStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
required:
- level
- id
@@ -15276,9 +15276,9 @@ components:
format: date-time
type: string
error:
- $ref: "#/components/schemas/CIAppCIError"
+ $ref: '#/components/schemas/CIAppCIError'
git:
- $ref: "#/components/schemas/CIAppGitInfo"
+ $ref: '#/components/schemas/CIAppGitInfo'
id:
description: UUID for the step. It has to be unique within each pipeline execution.
example: c2d517a8-4f3a-4b41-b4ae-69df0c864c79
@@ -15292,17 +15292,17 @@ components:
nullable: true
type: string
level:
- $ref: "#/components/schemas/CIAppPipelineEventStepLevel"
+ $ref: '#/components/schemas/CIAppPipelineEventStepLevel'
metrics:
- $ref: "#/components/schemas/CIAppPipelineEventMetrics"
+ $ref: '#/components/schemas/CIAppPipelineEventMetrics'
name:
description: The name for the step.
example: test-server
type: string
node:
- $ref: "#/components/schemas/CIAppHostInfo"
+ $ref: '#/components/schemas/CIAppHostInfo'
parameters:
- $ref: "#/components/schemas/CIAppPipelineEventParameters"
+ $ref: '#/components/schemas/CIAppPipelineEventParameters'
pipeline_name:
description: The parent pipeline name.
example: Build
@@ -15325,9 +15325,9 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CIAppPipelineEventStepStatus"
+ $ref: '#/components/schemas/CIAppPipelineEventStepStatus'
tags:
- $ref: "#/components/schemas/CIAppPipelineEventTags"
+ $ref: '#/components/schemas/CIAppPipelineEventTags'
url:
description: The URL to look at the step in the CI provider UI.
nullable: true
@@ -15375,13 +15375,13 @@ components:
description: The request for a pipelines search.
properties:
filter:
- $ref: "#/components/schemas/CIAppPipelinesQueryFilter"
+ $ref: '#/components/schemas/CIAppPipelinesQueryFilter'
options:
- $ref: "#/components/schemas/CIAppQueryOptions"
+ $ref: '#/components/schemas/CIAppQueryOptions'
page:
- $ref: "#/components/schemas/CIAppQueryPageOptions"
+ $ref: '#/components/schemas/CIAppQueryPageOptions'
sort:
- $ref: "#/components/schemas/CIAppSort"
+ $ref: '#/components/schemas/CIAppSort'
type: object
CIAppPipelineEventsResponse:
description: Response object with all pipeline events matching the request and pagination information.
@@ -15389,12 +15389,12 @@ components:
data:
description: Array of events matching the request.
items:
- $ref: "#/components/schemas/CIAppPipelineEvent"
+ $ref: '#/components/schemas/CIAppPipelineEvent'
type: array
links:
- $ref: "#/components/schemas/CIAppResponseLinks"
+ $ref: '#/components/schemas/CIAppResponseLinks'
meta:
- $ref: "#/components/schemas/CIAppResponseMetadataWithPagination"
+ $ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
type: object
CIAppPipelineLevel:
description: Pipeline execution level.
@@ -15408,17 +15408,17 @@ components:
compute:
description: The list of metrics or timeseries to compute for the retrieved buckets.
items:
- $ref: "#/components/schemas/CIAppCompute"
+ $ref: '#/components/schemas/CIAppCompute'
type: array
filter:
- $ref: "#/components/schemas/CIAppPipelinesQueryFilter"
+ $ref: '#/components/schemas/CIAppPipelinesQueryFilter'
group_by:
description: The rules for the group-by.
items:
- $ref: "#/components/schemas/CIAppPipelinesGroupBy"
+ $ref: '#/components/schemas/CIAppPipelinesGroupBy'
type: array
options:
- $ref: "#/components/schemas/CIAppQueryOptions"
+ $ref: '#/components/schemas/CIAppQueryOptions'
type: object
CIAppPipelinesAggregationBucketsResponse:
description: The query results.
@@ -15426,18 +15426,18 @@ components:
buckets:
description: The list of matching buckets, one item per bucket.
items:
- $ref: "#/components/schemas/CIAppPipelinesBucketResponse"
+ $ref: '#/components/schemas/CIAppPipelinesBucketResponse'
type: array
type: object
CIAppPipelinesAnalyticsAggregateResponse:
description: The response object for the pipeline events aggregate API endpoint.
properties:
data:
- $ref: "#/components/schemas/CIAppPipelinesAggregationBucketsResponse"
+ $ref: '#/components/schemas/CIAppPipelinesAggregationBucketsResponse'
links:
- $ref: "#/components/schemas/CIAppResponseLinks"
+ $ref: '#/components/schemas/CIAppResponseLinks'
meta:
- $ref: "#/components/schemas/CIAppResponseMetadata"
+ $ref: '#/components/schemas/CIAppResponseMetadata'
type: object
CIAppPipelinesBucketResponse:
description: Bucket values.
@@ -15449,7 +15449,7 @@ components:
example: {"@ci.provider.name": "gitlab", "@ci.status": "success"}
type: object
computes:
- $ref: "#/components/schemas/CIAppComputes"
+ $ref: '#/components/schemas/CIAppComputes'
type: object
CIAppPipelinesGroupBy:
description: A group-by rule.
@@ -15459,18 +15459,18 @@ components:
example: "@ci.status"
type: string
histogram:
- $ref: "#/components/schemas/CIAppGroupByHistogram"
+ $ref: '#/components/schemas/CIAppGroupByHistogram'
limit:
default: 10
description: The maximum buckets to return for this group-by.
format: int64
type: integer
missing:
- $ref: "#/components/schemas/CIAppGroupByMissing"
+ $ref: '#/components/schemas/CIAppGroupByMissing'
sort:
- $ref: "#/components/schemas/CIAppAggregateSort"
+ $ref: '#/components/schemas/CIAppAggregateSort'
total:
- $ref: "#/components/schemas/CIAppGroupByTotal"
+ $ref: '#/components/schemas/CIAppGroupByTotal'
required:
- facet
type: object
@@ -15548,13 +15548,13 @@ components:
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/CIAppResponseStatus"
+ $ref: '#/components/schemas/CIAppResponseStatus'
warnings:
description: |-
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
items:
- $ref: "#/components/schemas/CIAppWarning"
+ $ref: '#/components/schemas/CIAppWarning'
type: array
type: object
CIAppResponseMetadataWithPagination:
@@ -15566,19 +15566,19 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/CIAppResponsePage"
+ $ref: '#/components/schemas/CIAppResponsePage'
request_id:
description: The identifier of the request.
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/CIAppResponseStatus"
+ $ref: '#/components/schemas/CIAppResponseStatus'
warnings:
description: |-
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
items:
- $ref: "#/components/schemas/CIAppWarning"
+ $ref: '#/components/schemas/CIAppWarning'
type: array
type: object
CIAppResponsePage:
@@ -15619,13 +15619,13 @@ components:
description: Object description of test event after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/CIAppEventAttributes"
+ $ref: '#/components/schemas/CIAppEventAttributes'
id:
description: Unique ID of the event.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/CIAppTestEventTypeName"
+ $ref: '#/components/schemas/CIAppTestEventTypeName'
type: object
CIAppTestEventTypeName:
description: Type of the event.
@@ -15637,13 +15637,13 @@ components:
description: The request for a tests search.
properties:
filter:
- $ref: "#/components/schemas/CIAppTestsQueryFilter"
+ $ref: '#/components/schemas/CIAppTestsQueryFilter'
options:
- $ref: "#/components/schemas/CIAppQueryOptions"
+ $ref: '#/components/schemas/CIAppQueryOptions'
page:
- $ref: "#/components/schemas/CIAppQueryPageOptions"
+ $ref: '#/components/schemas/CIAppQueryPageOptions'
sort:
- $ref: "#/components/schemas/CIAppSort"
+ $ref: '#/components/schemas/CIAppSort'
type: object
CIAppTestEventsResponse:
description: Response object with all test events matching the request and pagination information.
@@ -15651,12 +15651,12 @@ components:
data:
description: Array of events matching the request.
items:
- $ref: "#/components/schemas/CIAppTestEvent"
+ $ref: '#/components/schemas/CIAppTestEvent'
type: array
links:
- $ref: "#/components/schemas/CIAppResponseLinks"
+ $ref: '#/components/schemas/CIAppResponseLinks'
meta:
- $ref: "#/components/schemas/CIAppResponseMetadataWithPagination"
+ $ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
type: object
CIAppTestLevel:
description: Test run level.
@@ -15670,17 +15670,17 @@ components:
compute:
description: The list of metrics or timeseries to compute for the retrieved buckets.
items:
- $ref: "#/components/schemas/CIAppCompute"
+ $ref: '#/components/schemas/CIAppCompute'
type: array
filter:
- $ref: "#/components/schemas/CIAppTestsQueryFilter"
+ $ref: '#/components/schemas/CIAppTestsQueryFilter'
group_by:
description: The rules for the group-by.
items:
- $ref: "#/components/schemas/CIAppTestsGroupBy"
+ $ref: '#/components/schemas/CIAppTestsGroupBy'
type: array
options:
- $ref: "#/components/schemas/CIAppQueryOptions"
+ $ref: '#/components/schemas/CIAppQueryOptions'
type: object
CIAppTestsAggregationBucketsResponse:
description: The query results.
@@ -15688,18 +15688,18 @@ components:
buckets:
description: The list of matching buckets, one item per bucket.
items:
- $ref: "#/components/schemas/CIAppTestsBucketResponse"
+ $ref: '#/components/schemas/CIAppTestsBucketResponse'
type: array
type: object
CIAppTestsAnalyticsAggregateResponse:
description: The response object for the test events aggregate API endpoint.
properties:
data:
- $ref: "#/components/schemas/CIAppTestsAggregationBucketsResponse"
+ $ref: '#/components/schemas/CIAppTestsAggregationBucketsResponse'
links:
- $ref: "#/components/schemas/CIAppResponseLinks"
+ $ref: '#/components/schemas/CIAppResponseLinks'
meta:
- $ref: "#/components/schemas/CIAppResponseMetadataWithPagination"
+ $ref: '#/components/schemas/CIAppResponseMetadataWithPagination'
type: object
CIAppTestsBucketResponse:
description: Bucket values.
@@ -15711,7 +15711,7 @@ components:
example: {"@test.service": "web-ui-tests", "@test.status": "skip"}
type: object
computes:
- $ref: "#/components/schemas/CIAppComputes"
+ $ref: '#/components/schemas/CIAppComputes'
type: object
CIAppTestsGroupBy:
description: A group-by rule.
@@ -15721,18 +15721,18 @@ components:
example: "@test.service"
type: string
histogram:
- $ref: "#/components/schemas/CIAppGroupByHistogram"
+ $ref: '#/components/schemas/CIAppGroupByHistogram'
limit:
default: 10
description: The maximum buckets to return for this group-by.
format: int64
type: integer
missing:
- $ref: "#/components/schemas/CIAppGroupByMissing"
+ $ref: '#/components/schemas/CIAppGroupByMissing'
sort:
- $ref: "#/components/schemas/CIAppAggregateSort"
+ $ref: '#/components/schemas/CIAppAggregateSort'
total:
- $ref: "#/components/schemas/CIAppGroupByTotal"
+ $ref: '#/components/schemas/CIAppGroupByTotal'
required:
- facet
type: object
@@ -15807,7 +15807,7 @@ components:
format: double
type: number
severity:
- $ref: "#/components/schemas/VulnerabilitySeverity"
+ $ref: '#/components/schemas/VulnerabilitySeverity'
vector:
description: Vulnerability CVSS vector.
example: "CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H"
@@ -15836,7 +15836,7 @@ components:
description: Response containing campaign data.
properties:
data:
- $ref: "#/components/schemas/CampaignResponseData"
+ $ref: '#/components/schemas/CampaignResponseData'
required:
- data
type: object
@@ -15904,13 +15904,13 @@ components:
description: Campaign data.
properties:
attributes:
- $ref: "#/components/schemas/CampaignResponseAttributes"
+ $ref: '#/components/schemas/CampaignResponseAttributes'
id:
description: The unique ID of the campaign.
example: c10ODp0VCrrIpXmz
type: string
type:
- $ref: "#/components/schemas/CampaignType"
+ $ref: '#/components/schemas/CampaignType'
required:
- id
- type
@@ -15940,23 +15940,23 @@ components:
description: The response from the cancel data deletion request endpoint.
properties:
data:
- $ref: "#/components/schemas/DataDeletionResponseItem"
+ $ref: '#/components/schemas/DataDeletionResponseItem'
meta:
- $ref: "#/components/schemas/DataDeletionResponseMeta"
+ $ref: '#/components/schemas/DataDeletionResponseMeta'
type: object
Case:
description: A case
properties:
attributes:
- $ref: "#/components/schemas/CaseAttributes"
+ $ref: '#/components/schemas/CaseAttributes'
id:
description: Case's identifier
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
relationships:
- $ref: "#/components/schemas/CaseRelationships"
+ $ref: '#/components/schemas/CaseRelationships'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- id
- type
@@ -16019,7 +16019,7 @@ components:
description: Request payload for aggregating case counts with grouping. Use this to get faceted breakdowns of cases (for example, count of cases grouped by priority and status).
properties:
data:
- $ref: "#/components/schemas/CaseAggregateRequestData"
+ $ref: '#/components/schemas/CaseAggregateRequestData'
required:
- data
type: object
@@ -16027,7 +16027,7 @@ components:
description: Attributes for the aggregation request, including the search query and grouping configuration.
properties:
group_by:
- $ref: "#/components/schemas/CaseAggregateGroupBy"
+ $ref: '#/components/schemas/CaseAggregateGroupBy'
query_filter:
description: "A search query to filter which cases are included in the aggregation. Uses the same syntax as the Case Management search bar."
example: "service:case-api"
@@ -16040,9 +16040,9 @@ components:
description: Data object wrapping the aggregation query type and attributes.
properties:
attributes:
- $ref: "#/components/schemas/CaseAggregateRequestAttributes"
+ $ref: '#/components/schemas/CaseAggregateRequestAttributes'
type:
- $ref: "#/components/schemas/CaseAggregateResourceType"
+ $ref: '#/components/schemas/CaseAggregateResourceType'
required:
- attributes
- type
@@ -16059,7 +16059,7 @@ components:
description: Response containing aggregated case counts grouped by the requested fields.
properties:
data:
- $ref: "#/components/schemas/CaseAggregateResponseData"
+ $ref: '#/components/schemas/CaseAggregateResponseData'
required:
- data
type: object
@@ -16069,7 +16069,7 @@ components:
groups:
description: Aggregated groups.
items:
- $ref: "#/components/schemas/CaseAggregateGroup"
+ $ref: '#/components/schemas/CaseAggregateGroup'
type: array
total:
description: Total count of aggregated cases.
@@ -16084,7 +16084,7 @@ components:
description: Data object containing the aggregation results, including total count and per-group breakdowns.
properties:
attributes:
- $ref: "#/components/schemas/CaseAggregateResponseAttributes"
+ $ref: '#/components/schemas/CaseAggregateResponseAttributes'
id:
description: Aggregate response identifier.
example: "agg-result-001"
@@ -16102,9 +16102,9 @@ components:
description: Case assign
properties:
attributes:
- $ref: "#/components/schemas/CaseAssignAttributes"
+ $ref: '#/components/schemas/CaseAssignAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -16123,7 +16123,7 @@ components:
description: Case assign request
properties:
data:
- $ref: "#/components/schemas/CaseAssign"
+ $ref: '#/components/schemas/CaseAssign'
required:
- data
type: object
@@ -16137,7 +16137,7 @@ components:
readOnly: true
type: string
attributes:
- $ref: "#/components/schemas/CaseObjectAttributes"
+ $ref: '#/components/schemas/CaseObjectAttributes'
closed_at:
description: Timestamp of when the case was closed
format: date-time
@@ -16151,14 +16151,14 @@ components:
type: string
custom_attributes:
additionalProperties:
- $ref: "#/components/schemas/CustomAttributeValue"
+ $ref: '#/components/schemas/CustomAttributeValue'
description: Case custom attributes
type: object
description:
description: Description
type: string
jira_issue:
- $ref: "#/components/schemas/JiraIssue"
+ $ref: '#/components/schemas/JiraIssue'
key:
description: Key
example: "CASEM-4523"
@@ -16170,21 +16170,21 @@ components:
readOnly: true
type: string
priority:
- $ref: "#/components/schemas/CasePriority"
+ $ref: '#/components/schemas/CasePriority'
service_now_ticket:
- $ref: "#/components/schemas/ServiceNowTicket"
+ $ref: '#/components/schemas/ServiceNowTicket'
status:
- $ref: "#/components/schemas/CaseStatus"
+ $ref: '#/components/schemas/CaseStatus'
status_group:
- $ref: "#/components/schemas/CaseStatusGroup"
+ $ref: '#/components/schemas/CaseStatusGroup'
status_name:
- $ref: "#/components/schemas/CaseStatusName"
+ $ref: '#/components/schemas/CaseStatusName'
title:
description: Title
example: "Memory leak investigation on API"
type: string
type:
- $ref: "#/components/schemas/CaseType"
+ $ref: '#/components/schemas/CaseType'
type_id:
description: Case type UUID
example: "3b010bde-09ce-4449-b745-71dd5f861963"
@@ -16247,7 +16247,7 @@ components:
description: Request payload for applying a single action (such as changing priority, status, or assignment) to multiple cases at once.
properties:
data:
- $ref: "#/components/schemas/CaseBulkUpdateRequestData"
+ $ref: '#/components/schemas/CaseBulkUpdateRequestData'
required:
- data
type: object
@@ -16270,7 +16270,7 @@ components:
priority: "P1"
type: object
type:
- $ref: "#/components/schemas/CaseBulkActionType"
+ $ref: '#/components/schemas/CaseBulkActionType'
required:
- case_ids
- type
@@ -16279,9 +16279,9 @@ components:
description: Data object wrapping the bulk update type and attributes.
properties:
attributes:
- $ref: "#/components/schemas/CaseBulkUpdateRequestAttributes"
+ $ref: '#/components/schemas/CaseBulkUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/CaseBulkResourceType"
+ $ref: '#/components/schemas/CaseBulkResourceType'
required:
- attributes
- type
@@ -16290,9 +16290,9 @@ components:
description: Case comment
properties:
attributes:
- $ref: "#/components/schemas/CaseCommentAttributes"
+ $ref: '#/components/schemas/CaseCommentAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -16311,7 +16311,7 @@ components:
description: Case comment request
properties:
data:
- $ref: "#/components/schemas/CaseComment"
+ $ref: '#/components/schemas/CaseComment'
required:
- data
type: object
@@ -16325,7 +16325,7 @@ components:
group_values:
description: Values within this group.
items:
- $ref: "#/components/schemas/CaseCountGroupValue"
+ $ref: '#/components/schemas/CaseCountGroupValue'
type: array
required:
- group
@@ -16351,7 +16351,7 @@ components:
description: Response containing the total number of cases matching a query, optionally grouped by specified fields.
properties:
data:
- $ref: "#/components/schemas/CaseCountResponseData"
+ $ref: '#/components/schemas/CaseCountResponseData'
required:
- data
type: object
@@ -16361,7 +16361,7 @@ components:
groups:
description: List of facet groups, one per field specified in `group_bys`.
items:
- $ref: "#/components/schemas/CaseCountGroup"
+ $ref: '#/components/schemas/CaseCountGroup'
type: array
required:
- groups
@@ -16370,7 +16370,7 @@ components:
description: Data object containing the count results, including per-field group breakdowns.
properties:
attributes:
- $ref: "#/components/schemas/CaseCountResponseAttributes"
+ $ref: '#/components/schemas/CaseCountResponseAttributes'
id:
description: Count response identifier.
example: "count-result-001"
@@ -16388,11 +16388,11 @@ components:
description: Case creation data
properties:
attributes:
- $ref: "#/components/schemas/CaseCreateAttributes"
+ $ref: '#/components/schemas/CaseCreateAttributes'
relationships:
- $ref: "#/components/schemas/CaseCreateRelationships"
+ $ref: '#/components/schemas/CaseCreateRelationships'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -16402,16 +16402,16 @@ components:
properties:
custom_attributes:
additionalProperties:
- $ref: "#/components/schemas/CustomAttributeValue"
+ $ref: '#/components/schemas/CustomAttributeValue'
description: Case custom attributes
type: object
description:
description: Description
type: string
priority:
- $ref: "#/components/schemas/CasePriority"
+ $ref: '#/components/schemas/CasePriority'
status_name:
- $ref: "#/components/schemas/CaseStatusName"
+ $ref: '#/components/schemas/CaseStatusName'
title:
description: Title
example: "Security breach investigation"
@@ -16428,9 +16428,9 @@ components:
description: Relationships formed with the case on creation
properties:
assignee:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
project:
- $ref: "#/components/schemas/ProjectRelationship"
+ $ref: '#/components/schemas/ProjectRelationship'
required:
- project
type: object
@@ -16438,7 +16438,7 @@ components:
description: Case create request
properties:
data:
- $ref: "#/components/schemas/CaseCreate"
+ $ref: '#/components/schemas/CaseCreate'
required:
- data
type: object
@@ -16455,7 +16455,7 @@ components:
description: Case empty request data
properties:
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- type
type: object
@@ -16463,7 +16463,7 @@ components:
description: Case empty request
properties:
data:
- $ref: "#/components/schemas/CaseEmpty"
+ $ref: '#/components/schemas/CaseEmpty'
required:
- data
type: object
@@ -16479,7 +16479,7 @@ components:
example: "12345"
type: string
type:
- $ref: "#/components/schemas/CaseInsightType"
+ $ref: '#/components/schemas/CaseInsightType'
required:
- type
- ref
@@ -16529,7 +16529,7 @@ components:
insights:
description: Array of insights to add to or remove from a case.
items:
- $ref: "#/components/schemas/CaseInsight"
+ $ref: '#/components/schemas/CaseInsight'
maxItems: 100
minItems: 1
type: array
@@ -16540,9 +16540,9 @@ components:
description: Data object containing the insights to add or remove.
properties:
attributes:
- $ref: "#/components/schemas/CaseInsightsAttributes"
+ $ref: '#/components/schemas/CaseInsightsAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- type
- attributes
@@ -16567,7 +16567,7 @@ components:
description: Request payload for adding or removing case insights.
properties:
data:
- $ref: "#/components/schemas/CaseInsightsData"
+ $ref: '#/components/schemas/CaseInsightsData'
required:
- data
type: object
@@ -16575,13 +16575,13 @@ components:
description: "A directional link representing a relationship between two entities. At least one entity must be a case."
properties:
attributes:
- $ref: "#/components/schemas/CaseLinkAttributes"
+ $ref: '#/components/schemas/CaseLinkAttributes'
id:
description: "The case link identifier."
example: "804cd682-55f6-4541-ab00-b608b282ea7d"
type: string
type:
- $ref: "#/components/schemas/CaseLinkResourceType"
+ $ref: '#/components/schemas/CaseLinkResourceType'
required:
- id
- type
@@ -16621,9 +16621,9 @@ components:
description: "Data object for creating a case link."
properties:
attributes:
- $ref: "#/components/schemas/CaseLinkAttributes"
+ $ref: '#/components/schemas/CaseLinkAttributes'
type:
- $ref: "#/components/schemas/CaseLinkResourceType"
+ $ref: '#/components/schemas/CaseLinkResourceType'
required:
- type
- attributes
@@ -16632,7 +16632,7 @@ components:
description: "Request payload for creating a link between two entities."
properties:
data:
- $ref: "#/components/schemas/CaseLinkCreate"
+ $ref: '#/components/schemas/CaseLinkCreate'
required:
- data
type: object
@@ -16648,7 +16648,7 @@ components:
description: "Response containing a single case link."
properties:
data:
- $ref: "#/components/schemas/CaseLink"
+ $ref: '#/components/schemas/CaseLink'
required:
- data
type: object
@@ -16658,7 +16658,7 @@ components:
data:
description: "A list of case links."
items:
- $ref: "#/components/schemas/CaseLink"
+ $ref: '#/components/schemas/CaseLink'
type: array
required:
- data
@@ -16667,7 +16667,7 @@ components:
description: Case management project.
properties:
data:
- $ref: "#/components/schemas/CaseManagementProjectData"
+ $ref: '#/components/schemas/CaseManagementProjectData'
required:
- data
type: object
@@ -16679,7 +16679,7 @@ components:
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/CaseManagementProjectDataType"
+ $ref: '#/components/schemas/CaseManagementProjectDataType'
required:
- type
- id
@@ -16697,13 +16697,13 @@ components:
description: A notification rule for case management
properties:
attributes:
- $ref: "#/components/schemas/CaseNotificationRuleAttributes"
+ $ref: '#/components/schemas/CaseNotificationRuleAttributes'
id:
description: The notification rule's identifier
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/CaseNotificationRuleResourceType"
+ $ref: '#/components/schemas/CaseNotificationRuleResourceType'
required:
- id
- type
@@ -16721,21 +16721,21 @@ components:
recipients:
description: List of notification recipients
items:
- $ref: "#/components/schemas/CaseNotificationRuleRecipient"
+ $ref: '#/components/schemas/CaseNotificationRuleRecipient'
type: array
triggers:
description: List of triggers for this notification rule
items:
- $ref: "#/components/schemas/CaseNotificationRuleTrigger"
+ $ref: '#/components/schemas/CaseNotificationRuleTrigger'
type: array
type: object
CaseNotificationRuleCreate:
description: Notification rule create
properties:
attributes:
- $ref: "#/components/schemas/CaseNotificationRuleCreateAttributes"
+ $ref: '#/components/schemas/CaseNotificationRuleCreateAttributes'
type:
- $ref: "#/components/schemas/CaseNotificationRuleResourceType"
+ $ref: '#/components/schemas/CaseNotificationRuleResourceType'
required:
- attributes
- type
@@ -16753,12 +16753,12 @@ components:
recipients:
description: List of notification recipients
items:
- $ref: "#/components/schemas/CaseNotificationRuleRecipient"
+ $ref: '#/components/schemas/CaseNotificationRuleRecipient'
type: array
triggers:
description: List of triggers for this notification rule
items:
- $ref: "#/components/schemas/CaseNotificationRuleTrigger"
+ $ref: '#/components/schemas/CaseNotificationRuleTrigger'
type: array
required:
- recipients
@@ -16768,7 +16768,7 @@ components:
description: Notification rule create request
properties:
data:
- $ref: "#/components/schemas/CaseNotificationRuleCreate"
+ $ref: '#/components/schemas/CaseNotificationRuleCreate'
required:
- data
type: object
@@ -16776,7 +16776,7 @@ components:
description: Notification rule recipient
properties:
data:
- $ref: "#/components/schemas/CaseNotificationRuleRecipientData"
+ $ref: '#/components/schemas/CaseNotificationRuleRecipientData'
type:
description: Type of recipient (SLACK_CHANNEL, EMAIL, HTTP, PAGERDUTY_SERVICE, MS_TEAMS_CHANNEL)
example: EMAIL
@@ -16838,13 +16838,13 @@ components:
description: Notification rule response
properties:
data:
- $ref: "#/components/schemas/CaseNotificationRule"
+ $ref: '#/components/schemas/CaseNotificationRule'
type: object
CaseNotificationRuleTrigger:
description: Notification rule trigger
properties:
data:
- $ref: "#/components/schemas/CaseNotificationRuleTriggerData"
+ $ref: '#/components/schemas/CaseNotificationRuleTriggerData'
type:
description: Type of trigger (CASE_CREATED, STATUS_TRANSITIONED, ATTRIBUTE_VALUE_CHANGED, EVENT_CORRELATION_SIGNAL_CORRELATED)
example: CASE_CREATED
@@ -16876,9 +16876,9 @@ components:
description: Notification rule update
properties:
attributes:
- $ref: "#/components/schemas/CaseNotificationRuleAttributes"
+ $ref: '#/components/schemas/CaseNotificationRuleAttributes'
type:
- $ref: "#/components/schemas/CaseNotificationRuleResourceType"
+ $ref: '#/components/schemas/CaseNotificationRuleResourceType'
required:
- type
type: object
@@ -16886,7 +16886,7 @@ components:
description: Notification rule update request
properties:
data:
- $ref: "#/components/schemas/CaseNotificationRuleUpdate"
+ $ref: '#/components/schemas/CaseNotificationRuleUpdate'
required:
- data
type: object
@@ -16896,7 +16896,7 @@ components:
data:
description: Notification rules data
items:
- $ref: "#/components/schemas/CaseNotificationRule"
+ $ref: '#/components/schemas/CaseNotificationRule'
type: array
type: object
CaseObjectAttributes:
@@ -16930,13 +16930,13 @@ components:
description: Resources related to a case
properties:
assignee:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
created_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
modified_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
project:
- $ref: "#/components/schemas/ProjectRelationship"
+ $ref: '#/components/schemas/ProjectRelationship'
type: object
CaseResourceType:
default: case
@@ -16951,7 +16951,7 @@ components:
description: Case response
properties:
data:
- $ref: "#/components/schemas/Case"
+ $ref: '#/components/schemas/Case'
type: object
CaseSortableField:
description: Case field that can be sorted on
@@ -16998,15 +16998,15 @@ components:
description: "Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
CaseTriggerWrapper:
description: "Schema for a Case-based trigger."
properties:
caseTrigger:
- $ref: "#/components/schemas/CaseTrigger"
+ $ref: '#/components/schemas/CaseTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- caseTrigger
type: object
@@ -17023,9 +17023,9 @@ components:
description: Data object for creating a case type.
properties:
attributes:
- $ref: "#/components/schemas/CaseTypeResourceAttributes"
+ $ref: '#/components/schemas/CaseTypeResourceAttributes'
type:
- $ref: "#/components/schemas/CaseTypeResourceType"
+ $ref: '#/components/schemas/CaseTypeResourceType'
required:
- attributes
- type
@@ -17034,7 +17034,7 @@ components:
description: Request payload for creating a case type.
properties:
data:
- $ref: "#/components/schemas/CaseTypeCreate"
+ $ref: '#/components/schemas/CaseTypeCreate'
required:
- data
type: object
@@ -17042,13 +17042,13 @@ components:
description: A case type that defines a classification category for cases. Each case type can have its own custom attributes, statuses, and automation rules.
properties:
attributes:
- $ref: "#/components/schemas/CaseTypeResourceAttributes"
+ $ref: '#/components/schemas/CaseTypeResourceAttributes'
id:
description: Case type's identifier
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/CaseTypeResourceType"
+ $ref: '#/components/schemas/CaseTypeResourceType'
type: object
CaseTypeResourceAttributes:
description: "Attributes of a case type, which define a classification category for cases. Organizations use case types to model different workflows (for example, Security Incident, Bug Report, Change Request)."
@@ -17087,15 +17087,15 @@ components:
description: Response containing a single case type.
properties:
data:
- $ref: "#/components/schemas/CaseTypeResource"
+ $ref: '#/components/schemas/CaseTypeResource'
type: object
CaseTypeUpdate:
description: Data object for updating a case type.
properties:
attributes:
- $ref: "#/components/schemas/CaseTypeResourceAttributes"
+ $ref: '#/components/schemas/CaseTypeResourceAttributes'
type:
- $ref: "#/components/schemas/CaseTypeResourceType"
+ $ref: '#/components/schemas/CaseTypeResourceType'
required:
- type
type: object
@@ -17103,7 +17103,7 @@ components:
description: Request payload for updating a case type.
properties:
data:
- $ref: "#/components/schemas/CaseTypeUpdate"
+ $ref: '#/components/schemas/CaseTypeUpdate'
required:
- data
type: object
@@ -17113,16 +17113,16 @@ components:
data:
description: List of case types
items:
- $ref: "#/components/schemas/CaseTypeResource"
+ $ref: '#/components/schemas/CaseTypeResource'
type: array
type: object
CaseUpdateAttributes:
description: Case update attributes
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateAttributesAttributes"
+ $ref: '#/components/schemas/CaseUpdateAttributesAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17131,7 +17131,7 @@ components:
description: Case update attributes attributes
properties:
attributes:
- $ref: "#/components/schemas/CaseObjectAttributes"
+ $ref: '#/components/schemas/CaseObjectAttributes'
required:
- attributes
type: object
@@ -17139,7 +17139,7 @@ components:
description: Case update attributes request
properties:
data:
- $ref: "#/components/schemas/CaseUpdateAttributes"
+ $ref: '#/components/schemas/CaseUpdateAttributes'
required:
- data
type: object
@@ -17147,9 +17147,9 @@ components:
description: Data object for updating a case comment.
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateCommentAttributes"
+ $ref: '#/components/schemas/CaseUpdateCommentAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- type
- attributes
@@ -17168,7 +17168,7 @@ components:
description: Request payload for updating a comment on a case timeline.
properties:
data:
- $ref: "#/components/schemas/CaseUpdateComment"
+ $ref: '#/components/schemas/CaseUpdateComment'
required:
- data
type: object
@@ -17176,9 +17176,9 @@ components:
description: Case update custom attribute
properties:
attributes:
- $ref: "#/components/schemas/CustomAttributeValue"
+ $ref: '#/components/schemas/CustomAttributeValue'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17187,7 +17187,7 @@ components:
description: Case update custom attribute request
properties:
data:
- $ref: "#/components/schemas/CaseUpdateCustomAttribute"
+ $ref: '#/components/schemas/CaseUpdateCustomAttribute'
required:
- data
type: object
@@ -17195,9 +17195,9 @@ components:
description: Case update description
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateDescriptionAttributes"
+ $ref: '#/components/schemas/CaseUpdateDescriptionAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17216,7 +17216,7 @@ components:
description: Case update description request
properties:
data:
- $ref: "#/components/schemas/CaseUpdateDescription"
+ $ref: '#/components/schemas/CaseUpdateDescription'
required:
- data
type: object
@@ -17224,9 +17224,9 @@ components:
description: Data object for updating a case's due date.
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateDueDateAttributes"
+ $ref: '#/components/schemas/CaseUpdateDueDateAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17245,7 +17245,7 @@ components:
description: Request payload for updating a case's due date.
properties:
data:
- $ref: "#/components/schemas/CaseUpdateDueDate"
+ $ref: '#/components/schemas/CaseUpdateDueDate'
required:
- data
type: object
@@ -17253,9 +17253,9 @@ components:
description: Case priority status
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdatePriorityAttributes"
+ $ref: '#/components/schemas/CaseUpdatePriorityAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17264,7 +17264,7 @@ components:
description: Case update priority attributes
properties:
priority:
- $ref: "#/components/schemas/CasePriority"
+ $ref: '#/components/schemas/CasePriority'
required:
- priority
type: object
@@ -17272,7 +17272,7 @@ components:
description: Case update priority request
properties:
data:
- $ref: "#/components/schemas/CaseUpdatePriority"
+ $ref: '#/components/schemas/CaseUpdatePriority'
required:
- data
type: object
@@ -17280,9 +17280,9 @@ components:
description: Data object for updating a case's resolved reason.
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateResolvedReasonAttributes"
+ $ref: '#/components/schemas/CaseUpdateResolvedReasonAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17301,7 +17301,7 @@ components:
description: Request payload for updating the resolution reason on a closed security case.
properties:
data:
- $ref: "#/components/schemas/CaseUpdateResolvedReason"
+ $ref: '#/components/schemas/CaseUpdateResolvedReason'
required:
- data
type: object
@@ -17309,9 +17309,9 @@ components:
description: Case update status
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateStatusAttributes"
+ $ref: '#/components/schemas/CaseUpdateStatusAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17323,13 +17323,13 @@ components:
$ref: "#/components/schemas/CaseStatus"
deprecated: true
status_name:
- $ref: "#/components/schemas/CaseStatusName"
+ $ref: '#/components/schemas/CaseStatusName'
type: object
CaseUpdateStatusRequest:
description: Case update status request
properties:
data:
- $ref: "#/components/schemas/CaseUpdateStatus"
+ $ref: '#/components/schemas/CaseUpdateStatus'
required:
- data
type: object
@@ -17337,9 +17337,9 @@ components:
description: Case update title
properties:
attributes:
- $ref: "#/components/schemas/CaseUpdateTitleAttributes"
+ $ref: '#/components/schemas/CaseUpdateTitleAttributes'
type:
- $ref: "#/components/schemas/CaseResourceType"
+ $ref: '#/components/schemas/CaseResourceType'
required:
- attributes
- type
@@ -17358,7 +17358,7 @@ components:
description: Case update title request
properties:
data:
- $ref: "#/components/schemas/CaseUpdateTitle"
+ $ref: '#/components/schemas/CaseUpdateTitle'
required:
- data
type: object
@@ -17366,15 +17366,15 @@ components:
description: A saved case view that provides a filtered, reusable list of cases matching a specific query. Views act as persistent dashboards for monitoring case subsets.
properties:
attributes:
- $ref: "#/components/schemas/CaseViewAttributes"
+ $ref: '#/components/schemas/CaseViewAttributes'
id:
description: The view's identifier.
example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: string
relationships:
- $ref: "#/components/schemas/CaseViewRelationships"
+ $ref: '#/components/schemas/CaseViewRelationships'
type:
- $ref: "#/components/schemas/CaseViewResourceType"
+ $ref: '#/components/schemas/CaseViewResourceType'
required:
- id
- type
@@ -17414,9 +17414,9 @@ components:
description: Data object for creating a case view.
properties:
attributes:
- $ref: "#/components/schemas/CaseViewCreateAttributes"
+ $ref: '#/components/schemas/CaseViewCreateAttributes'
type:
- $ref: "#/components/schemas/CaseViewResourceType"
+ $ref: '#/components/schemas/CaseViewResourceType'
required:
- type
- attributes
@@ -17448,7 +17448,7 @@ components:
description: Request payload for creating a case view.
properties:
data:
- $ref: "#/components/schemas/CaseViewCreate"
+ $ref: '#/components/schemas/CaseViewCreate'
required:
- data
type: object
@@ -17456,11 +17456,11 @@ components:
description: Related resources for the case view, including the creator, last modifier, and associated project.
properties:
created_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
modified_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
project:
- $ref: "#/components/schemas/ProjectRelationship"
+ $ref: '#/components/schemas/ProjectRelationship'
type: object
CaseViewResourceType:
default: view
@@ -17475,7 +17475,7 @@ components:
description: Response containing a single case view.
properties:
data:
- $ref: "#/components/schemas/CaseView"
+ $ref: '#/components/schemas/CaseView'
required:
- data
type: object
@@ -17483,9 +17483,9 @@ components:
description: Data object for updating a case view.
properties:
attributes:
- $ref: "#/components/schemas/CaseViewUpdateAttributes"
+ $ref: '#/components/schemas/CaseViewUpdateAttributes'
type:
- $ref: "#/components/schemas/CaseViewResourceType"
+ $ref: '#/components/schemas/CaseViewResourceType'
required:
- type
type: object
@@ -17506,7 +17506,7 @@ components:
description: Request payload for updating a case view.
properties:
data:
- $ref: "#/components/schemas/CaseViewUpdate"
+ $ref: '#/components/schemas/CaseViewUpdate'
required:
- data
type: object
@@ -17516,7 +17516,7 @@ components:
data:
description: A list of case views.
items:
- $ref: "#/components/schemas/CaseView"
+ $ref: '#/components/schemas/CaseView'
type: array
required:
- data
@@ -17529,9 +17529,9 @@ components:
example: "8146583c-0b5f-11ec-abf8-da7ad0900001"
type: string
relationships:
- $ref: "#/components/schemas/CaseWatcherRelationships"
+ $ref: '#/components/schemas/CaseWatcherRelationships'
type:
- $ref: "#/components/schemas/CaseWatcherResourceType"
+ $ref: '#/components/schemas/CaseWatcherResourceType'
required:
- id
- type
@@ -17541,7 +17541,7 @@ components:
description: Relationships for a case watcher, linking to the underlying user resource.
properties:
user:
- $ref: "#/components/schemas/CaseWatcherUserRelationship"
+ $ref: '#/components/schemas/CaseWatcherUserRelationship'
required:
- user
type: object
@@ -17558,7 +17558,7 @@ components:
description: The user relationship for a case watcher.
properties:
data:
- $ref: "#/components/schemas/UserRelationshipData"
+ $ref: '#/components/schemas/UserRelationshipData'
required:
- data
type: object
@@ -17568,7 +17568,7 @@ components:
data:
description: List of case watchers.
items:
- $ref: "#/components/schemas/CaseWatcher"
+ $ref: '#/components/schemas/CaseWatcher'
type: array
required:
- data
@@ -17579,16 +17579,16 @@ components:
data:
description: Cases response data
items:
- $ref: "#/components/schemas/Case"
+ $ref: '#/components/schemas/Case'
type: array
meta:
- $ref: "#/components/schemas/CasesResponseMeta"
+ $ref: '#/components/schemas/CasesResponseMeta'
type: object
CasesResponseMeta:
description: Cases response metadata
properties:
page:
- $ref: "#/components/schemas/CasesResponseMetaPagination"
+ $ref: '#/components/schemas/CasesResponseMetaPagination'
type: object
CasesResponseMetaPagination:
description: Pagination metadata
@@ -17610,9 +17610,9 @@ components:
description: Change event attributes.
properties:
aggregation_key:
- $ref: "#/components/schemas/V2EventAggregationKey"
+ $ref: '#/components/schemas/V2EventAggregationKey'
author:
- $ref: "#/components/schemas/ChangeEventAttributesAuthor"
+ $ref: '#/components/schemas/ChangeEventAttributesAuthor'
change_metadata:
description: JSON object of change metadata.
example:
@@ -17623,14 +17623,14 @@ components:
user_name: "datadog_username"
type: object
changed_resource:
- $ref: "#/components/schemas/ChangeEventAttributesChangedResource"
+ $ref: '#/components/schemas/ChangeEventAttributesChangedResource'
evt:
- $ref: "#/components/schemas/EventSystemAttributes"
+ $ref: '#/components/schemas/EventSystemAttributes'
impacted_resources:
description: A list of resources impacted by this change.
example: [{"name": "service-name", "type": "service"}]
items:
- $ref: "#/components/schemas/ChangeEventAttributesImpactedResourcesItem"
+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItem'
type: array
new_value:
description: The new state of the changed resource.
@@ -17649,11 +17649,11 @@ components:
datacenter: "devcycle.us1.prod"
type: object
service:
- $ref: "#/components/schemas/V2EventService"
+ $ref: '#/components/schemas/V2EventService'
timestamp:
- $ref: "#/components/schemas/V2EventTimestamp"
+ $ref: '#/components/schemas/V2EventTimestamp'
title:
- $ref: "#/components/schemas/V2EventTitle"
+ $ref: '#/components/schemas/V2EventTitle'
type: object
ChangeEventAttributesAuthor:
description: The entity that made the change.
@@ -17663,7 +17663,7 @@ components:
example: "example@datadog.com"
type: string
type:
- $ref: "#/components/schemas/ChangeEventAttributesAuthorType"
+ $ref: '#/components/schemas/ChangeEventAttributesAuthorType'
type: object
ChangeEventAttributesAuthorType:
description: The type of the author.
@@ -17686,7 +17686,7 @@ components:
description: The name of the changed resource.
type: string
type:
- $ref: "#/components/schemas/ChangeEventAttributesChangedResourceType"
+ $ref: '#/components/schemas/ChangeEventAttributesChangedResourceType'
type: object
ChangeEventAttributesChangedResourceType:
description: The type of the changed resource.
@@ -17705,7 +17705,7 @@ components:
description: The name of the impacted resource.
type: string
type:
- $ref: "#/components/schemas/ChangeEventAttributesImpactedResourcesItemType"
+ $ref: '#/components/schemas/ChangeEventAttributesImpactedResourcesItemType'
type: object
ChangeEventAttributesImpactedResourcesItemType:
description: The type of the impacted resource.
@@ -17720,7 +17720,7 @@ components:
Change event attributes.
properties:
author:
- $ref: "#/components/schemas/ChangeEventCustomAttributesAuthor"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
change_metadata:
additionalProperties: {}
description: |-
@@ -17734,7 +17734,7 @@ components:
resource_link: "datadog.com/feature/fallback_payments_test"
type: object
changed_resource:
- $ref: "#/components/schemas/ChangeEventCustomAttributesChangedResource"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource'
impacted_resources:
description: |-
A list of resources impacted by this change. It is recommended to provide an impacted resource to display
@@ -17743,7 +17743,7 @@ components:
- name: payments_api
type: service
items:
- $ref: "#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
maxItems: 100
type: array
new_value:
@@ -17781,7 +17781,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/ChangeEventCustomAttributesAuthorType"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
required:
- name
- type
@@ -17813,7 +17813,7 @@ components:
pattern: ".*\\S.*"
type: string
type:
- $ref: "#/components/schemas/ChangeEventCustomAttributesChangedResourceType"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
required:
- type
- name
@@ -17840,7 +17840,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType"
+ $ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
required:
- type
- name
@@ -17860,7 +17860,7 @@ components:
description: "Trigger a workflow from a Change Event."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- changeEventTrigger
type: object
@@ -17883,9 +17883,9 @@ components:
description: Data object to create a change request branch.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestBranchCreateAttributes"
+ $ref: '#/components/schemas/ChangeRequestBranchCreateAttributes'
type:
- $ref: "#/components/schemas/ChangeRequestBranchResourceType"
+ $ref: '#/components/schemas/ChangeRequestBranchResourceType'
required:
- type
- attributes
@@ -17894,7 +17894,7 @@ components:
description: Request object to create a branch for a change request.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestBranchCreateData"
+ $ref: '#/components/schemas/ChangeRequestBranchCreateData'
required:
- data
type: object
@@ -17934,9 +17934,9 @@ components:
example: "1. Deploy to staging 2. Run tests 3. Deploy to production"
type: string
change_request_risk:
- $ref: "#/components/schemas/ChangeRequestRiskLevel"
+ $ref: '#/components/schemas/ChangeRequestRiskLevel'
change_request_type:
- $ref: "#/components/schemas/ChangeRequestChangeType"
+ $ref: '#/components/schemas/ChangeRequestChangeType'
description:
description: The description of the change request.
example: "Deploying new payment service v2.1"
@@ -17974,9 +17974,9 @@ components:
description: Data object to create a change request.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestCreateAttributes"
+ $ref: '#/components/schemas/ChangeRequestCreateAttributes'
type:
- $ref: "#/components/schemas/ChangeRequestResourceType"
+ $ref: '#/components/schemas/ChangeRequestResourceType'
required:
- type
- attributes
@@ -17985,7 +17985,7 @@ components:
description: Request object to create a change request.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestCreateData"
+ $ref: '#/components/schemas/ChangeRequestCreateData'
required:
- data
type: object
@@ -17993,7 +17993,7 @@ components:
description: Attributes for creating a change request decision.
properties:
change_request_status:
- $ref: "#/components/schemas/ChangeRequestDecisionStatusType"
+ $ref: '#/components/schemas/ChangeRequestDecisionStatusType'
request_reason:
description: The reason for requesting the decision.
example: "Please review and approve this change"
@@ -18003,15 +18003,15 @@ components:
description: An included change request decision for a create or update operation.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestDecisionCreateAttributes"
+ $ref: '#/components/schemas/ChangeRequestDecisionCreateAttributes'
id:
description: The decision identifier.
example: "decision-id-0"
type: string
relationships:
- $ref: "#/components/schemas/ChangeRequestDecisionCreateRelationships"
+ $ref: '#/components/schemas/ChangeRequestDecisionCreateRelationships'
type:
- $ref: "#/components/schemas/ChangeRequestDecisionResourceType"
+ $ref: '#/components/schemas/ChangeRequestDecisionResourceType'
required:
- type
- id
@@ -18020,7 +18020,7 @@ components:
description: Relationships for creating a change request decision.
properties:
requested_user:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
type: object
ChangeRequestDecisionRelationshipData:
description: Change request decision relationship data.
@@ -18030,7 +18030,7 @@ components:
example: "decision-id-0"
type: string
type:
- $ref: "#/components/schemas/ChangeRequestDecisionResourceType"
+ $ref: '#/components/schemas/ChangeRequestDecisionResourceType'
required:
- id
- type
@@ -18039,11 +18039,11 @@ components:
description: Relationships of a change request decision.
properties:
modified_by:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
requested_by_user:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
requested_user:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
required:
- requested_user
- requested_by_user
@@ -18061,7 +18061,7 @@ components:
description: Attributes of a change request decision in a response.
properties:
change_request_status:
- $ref: "#/components/schemas/ChangeRequestDecisionStatusType"
+ $ref: '#/components/schemas/ChangeRequestDecisionStatusType'
decided_at:
description: Timestamp of when the decision was made.
example: "2024-01-02T00:00:00Z"
@@ -18109,11 +18109,11 @@ components:
description: Data object to update a change request decision.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestDecisionUpdateDataAttributes"
+ $ref: '#/components/schemas/ChangeRequestDecisionUpdateDataAttributes'
relationships:
- $ref: "#/components/schemas/ChangeRequestDecisionUpdateDataRelationships"
+ $ref: '#/components/schemas/ChangeRequestDecisionUpdateDataRelationships'
type:
- $ref: "#/components/schemas/ChangeRequestResourceType"
+ $ref: '#/components/schemas/ChangeRequestResourceType'
required:
- type
type: object
@@ -18129,7 +18129,7 @@ components:
description: Relationships for updating a change request decision.
properties:
change_request_decisions:
- $ref: "#/components/schemas/ChangeRequestDecisionsRelationship"
+ $ref: '#/components/schemas/ChangeRequestDecisionsRelationship'
required:
- change_request_decisions
type: object
@@ -18137,9 +18137,9 @@ components:
description: Request object to update a change request decision.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestDecisionUpdateData"
+ $ref: '#/components/schemas/ChangeRequestDecisionUpdateData'
included:
- $ref: "#/components/schemas/ChangeRequestUpdateIncluded"
+ $ref: '#/components/schemas/ChangeRequestUpdateIncluded'
required:
- data
type: object
@@ -18149,7 +18149,7 @@ components:
data:
description: Array of decision relationship data.
items:
- $ref: "#/components/schemas/ChangeRequestDecisionRelationshipData"
+ $ref: '#/components/schemas/ChangeRequestDecisionRelationshipData'
type: array
required:
- data
@@ -18157,21 +18157,21 @@ components:
ChangeRequestIncluded:
description: Included resources related to the change request.
items:
- $ref: "#/components/schemas/ChangeRequestIncludedItem"
+ $ref: '#/components/schemas/ChangeRequestIncludedItem'
type: array
ChangeRequestIncludedDecision:
description: An included change request decision resource.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestDecisionResponseAttributes"
+ $ref: '#/components/schemas/ChangeRequestDecisionResponseAttributes'
id:
description: The decision UUID.
example: "decision-id-0"
type: string
relationships:
- $ref: "#/components/schemas/ChangeRequestDecisionRelationships"
+ $ref: '#/components/schemas/ChangeRequestDecisionRelationships'
type:
- $ref: "#/components/schemas/ChangeRequestDecisionResourceType"
+ $ref: '#/components/schemas/ChangeRequestDecisionResourceType'
required:
- type
- id
@@ -18180,13 +18180,13 @@ components:
ChangeRequestIncludedItem:
description: An included resource item in the change request response.
oneOf:
- - $ref: "#/components/schemas/ChangeRequestIncludedUser"
- - $ref: "#/components/schemas/ChangeRequestIncludedDecision"
+ - $ref: '#/components/schemas/ChangeRequestIncludedUser'
+ - $ref: '#/components/schemas/ChangeRequestIncludedDecision'
ChangeRequestIncludedUser:
description: An included user resource.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestIncludedUserAttributes"
+ $ref: '#/components/schemas/ChangeRequestIncludedUserAttributes'
id:
description: The user UUID.
example: "00000000-0000-0000-0000-000000000000"
@@ -18232,11 +18232,11 @@ components:
description: Relationships of a change request.
properties:
change_request_decisions:
- $ref: "#/components/schemas/ChangeRequestDecisionsRelationship"
+ $ref: '#/components/schemas/ChangeRequestDecisionsRelationship'
created_by:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
modified_by:
- $ref: "#/components/schemas/ChangeRequestUserRelationship"
+ $ref: '#/components/schemas/ChangeRequestUserRelationship'
required:
- created_by
- modified_by
@@ -18254,9 +18254,9 @@ components:
description: Response object for a change request.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestResponseData"
+ $ref: '#/components/schemas/ChangeRequestResponseData'
included:
- $ref: "#/components/schemas/ChangeRequestIncluded"
+ $ref: '#/components/schemas/ChangeRequestIncluded'
required:
- data
type: object
@@ -18270,7 +18270,7 @@ components:
readOnly: true
type: string
attributes:
- $ref: "#/components/schemas/ChangeRequestObjectAttributes"
+ $ref: '#/components/schemas/ChangeRequestObjectAttributes'
change_request_linked_incident_uuid:
description: The UUID of the linked incident.
example: ""
@@ -18284,9 +18284,9 @@ components:
example: ""
type: string
change_request_risk:
- $ref: "#/components/schemas/ChangeRequestRiskLevel"
+ $ref: '#/components/schemas/ChangeRequestRiskLevel'
change_request_type:
- $ref: "#/components/schemas/ChangeRequestChangeType"
+ $ref: '#/components/schemas/ChangeRequestChangeType'
closed_at:
description: Timestamp of when the change request was closed.
format: date-time
@@ -18375,15 +18375,15 @@ components:
description: Data object for a change request response.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestResponseAttributes"
+ $ref: '#/components/schemas/ChangeRequestResponseAttributes'
id:
description: The identifier of the change request.
example: "CHM-1234"
type: string
relationships:
- $ref: "#/components/schemas/ChangeRequestRelationships"
+ $ref: '#/components/schemas/ChangeRequestRelationships'
type:
- $ref: "#/components/schemas/ChangeRequestResourceType"
+ $ref: '#/components/schemas/ChangeRequestResourceType'
required:
- id
- type
@@ -18411,9 +18411,9 @@ components:
example: "Updated deployment plan"
type: string
change_request_risk:
- $ref: "#/components/schemas/ChangeRequestRiskLevel"
+ $ref: '#/components/schemas/ChangeRequestRiskLevel'
change_request_type:
- $ref: "#/components/schemas/ChangeRequestChangeType"
+ $ref: '#/components/schemas/ChangeRequestChangeType'
end_date:
description: The planned end date of the change request.
example: "2024-01-02T15:00:00Z"
@@ -18433,32 +18433,32 @@ components:
description: Data object to update a change request.
properties:
attributes:
- $ref: "#/components/schemas/ChangeRequestUpdateAttributes"
+ $ref: '#/components/schemas/ChangeRequestUpdateAttributes'
relationships:
- $ref: "#/components/schemas/ChangeRequestUpdateRelationships"
+ $ref: '#/components/schemas/ChangeRequestUpdateRelationships'
type:
- $ref: "#/components/schemas/ChangeRequestResourceType"
+ $ref: '#/components/schemas/ChangeRequestResourceType'
required:
- type
type: object
ChangeRequestUpdateIncluded:
description: Included resources for the change request update.
items:
- $ref: "#/components/schemas/ChangeRequestDecisionCreateItem"
+ $ref: '#/components/schemas/ChangeRequestDecisionCreateItem'
type: array
ChangeRequestUpdateRelationships:
description: Relationships for updating a change request.
properties:
change_request_decisions:
- $ref: "#/components/schemas/ChangeRequestDecisionsRelationship"
+ $ref: '#/components/schemas/ChangeRequestDecisionsRelationship'
type: object
ChangeRequestUpdateRequest:
description: Request object to update a change request.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestUpdateData"
+ $ref: '#/components/schemas/ChangeRequestUpdateData'
included:
- $ref: "#/components/schemas/ChangeRequestUpdateIncluded"
+ $ref: '#/components/schemas/ChangeRequestUpdateIncluded'
required:
- data
type: object
@@ -18466,7 +18466,7 @@ components:
description: Relationship to a user.
properties:
data:
- $ref: "#/components/schemas/ChangeRequestUserRelationshipData"
+ $ref: '#/components/schemas/ChangeRequestUserRelationshipData'
required:
- data
type: object
@@ -18510,7 +18510,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/CircleCIAPIKeyType"
+ $ref: '#/components/schemas/CircleCIAPIKeyType'
required:
- type
- api_token
@@ -18530,25 +18530,25 @@ components:
description: The `CircleCIAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/CircleCIAPIKeyType"
+ $ref: '#/components/schemas/CircleCIAPIKeyType'
required:
- type
type: object
CircleCICredentials:
description: The definition of the `CircleCICredentials` object.
oneOf:
- - $ref: "#/components/schemas/CircleCIAPIKey"
+ - $ref: '#/components/schemas/CircleCIAPIKey'
CircleCICredentialsUpdate:
description: The definition of the `CircleCICredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/CircleCIAPIKeyUpdate"
+ - $ref: '#/components/schemas/CircleCIAPIKeyUpdate'
CircleCIIntegration:
description: The definition of the `CircleCIIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/CircleCICredentials"
+ $ref: '#/components/schemas/CircleCICredentials'
type:
- $ref: "#/components/schemas/CircleCIIntegrationType"
+ $ref: '#/components/schemas/CircleCIIntegrationType'
required:
- type
- credentials
@@ -18565,9 +18565,9 @@ components:
description: The definition of the `CircleCIIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/CircleCICredentialsUpdate"
+ $ref: '#/components/schemas/CircleCICredentialsUpdate'
type:
- $ref: "#/components/schemas/CircleCIIntegrationType"
+ $ref: '#/components/schemas/CircleCIIntegrationType'
required:
- type
type: object
@@ -18579,7 +18579,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/ClickupAPIKeyType"
+ $ref: '#/components/schemas/ClickupAPIKeyType'
required:
- type
- api_token
@@ -18599,25 +18599,25 @@ components:
description: The `ClickupAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/ClickupAPIKeyType"
+ $ref: '#/components/schemas/ClickupAPIKeyType'
required:
- type
type: object
ClickupCredentials:
description: The definition of the `ClickupCredentials` object.
oneOf:
- - $ref: "#/components/schemas/ClickupAPIKey"
+ - $ref: '#/components/schemas/ClickupAPIKey'
ClickupCredentialsUpdate:
description: The definition of the `ClickupCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/ClickupAPIKeyUpdate"
+ - $ref: '#/components/schemas/ClickupAPIKeyUpdate'
ClickupIntegration:
description: The definition of the `ClickupIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/ClickupCredentials"
+ $ref: '#/components/schemas/ClickupCredentials'
type:
- $ref: "#/components/schemas/ClickupIntegrationType"
+ $ref: '#/components/schemas/ClickupIntegrationType'
required:
- type
- credentials
@@ -18634,9 +18634,9 @@ components:
description: The definition of the `ClickupIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/ClickupCredentialsUpdate"
+ $ref: '#/components/schemas/ClickupCredentialsUpdate'
type:
- $ref: "#/components/schemas/ClickupIntegrationType"
+ $ref: '#/components/schemas/ClickupIntegrationType'
required:
- type
type: object
@@ -18644,9 +18644,9 @@ components:
description: The data for cloning a form.
properties:
attributes:
- $ref: "#/components/schemas/CloneFormDataAttributes"
+ $ref: '#/components/schemas/CloneFormDataAttributes'
type:
- $ref: "#/components/schemas/FormType"
+ $ref: '#/components/schemas/FormType'
required:
- type
type: object
@@ -18662,7 +18662,7 @@ components:
description: A request to clone a form.
properties:
data:
- $ref: "#/components/schemas/CloneFormData"
+ $ref: '#/components/schemas/CloneFormData'
required:
- data
type: object
@@ -18686,7 +18686,7 @@ components:
description: "Whether the rule is a complex one.\nMust be set to true if `regoRule.resourceTypes` contains more than one item. Defaults to false."
type: boolean
regoRule:
- $ref: "#/components/schemas/CloudConfigurationRegoRule"
+ $ref: '#/components/schemas/CloudConfigurationRegoRule'
resourceType:
description: "Main resource type to be checked by the rule. It should be specified again in `regoRule.resourceTypes`."
example: aws_acm
@@ -18722,7 +18722,7 @@ components:
type: string
type: array
status:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
required:
- status
type: object
@@ -18758,14 +18758,14 @@ components:
cases:
description: "Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item."
items:
- $ref: "#/components/schemas/CloudConfigurationRuleCaseCreate"
+ $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate'
type: array
complianceSignalOptions:
- $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
filters:
description: Additional queries to filter matched events before they are processed.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
isEnabled:
description: Whether the rule is enabled.
@@ -18780,7 +18780,7 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/CloudConfigurationRuleOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleOptions'
tags:
description: Tags for generated findings and signals.
example:
@@ -18791,7 +18791,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/CloudConfigurationRuleType"
+ $ref: '#/components/schemas/CloudConfigurationRuleType'
required:
- name
- isEnabled
@@ -18804,7 +18804,7 @@ components:
description: Options on cloud configuration rules.
properties:
complianceRuleOptions:
- $ref: "#/components/schemas/CloudConfigurationComplianceRuleOptions"
+ $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions'
required:
- complianceRuleOptions
type: object
@@ -18814,10 +18814,10 @@ components:
cases:
description: "Description of generated findings and signals (severity and channels to be notified in case of a signal). Must contain exactly one item."
items:
- $ref: "#/components/schemas/CloudConfigurationRuleCaseCreate"
+ $ref: '#/components/schemas/CloudConfigurationRuleCaseCreate'
type: array
complianceSignalOptions:
- $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
customMessage:
description: Custom/Overridden message for generated signals (used in case of Default rule update).
type: string
@@ -18827,7 +18827,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
isEnabled:
description: Whether the rule is enabled.
@@ -18842,7 +18842,7 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/CloudConfigurationRuleOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleOptions'
tags:
description: Tags for generated findings and signals.
example:
@@ -18853,7 +18853,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/CloudConfigurationRuleType"
+ $ref: '#/components/schemas/CloudConfigurationRuleType'
required:
- name
- isEnabled
@@ -18946,7 +18946,7 @@ components:
example: 22222222-2222-2222-2222-222222222222
type: string
cloud_provider:
- $ref: "#/components/schemas/CloudInventoryCloudProviderId"
+ $ref: '#/components/schemas/CloudInventoryCloudProviderId'
error:
description: Human-readable error detail when sync is unhealthy.
example: ""
@@ -19062,7 +19062,7 @@ components:
description: Storage Management configuration returned after a create or update. Additional read-only fields appear on list and get responses.
properties:
data:
- $ref: "#/components/schemas/CloudInventorySyncConfigResponseData"
+ $ref: '#/components/schemas/CloudInventorySyncConfigResponseData'
required:
- data
type: object
@@ -19070,13 +19070,13 @@ components:
description: Storage Management configuration data.
properties:
attributes:
- $ref: "#/components/schemas/CloudInventorySyncConfigAttributes"
+ $ref: '#/components/schemas/CloudInventorySyncConfigAttributes'
id:
description: Unique identifier for this Storage Management configuration.
example: abc123
type: string
type:
- $ref: "#/components/schemas/CloudInventorySyncConfigResourceType"
+ $ref: '#/components/schemas/CloudInventorySyncConfigResourceType'
required:
- id
- type
@@ -19088,7 +19088,7 @@ components:
data:
description: "A list of Agent policy objects"
items:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData'
type: array
type: object
CloudWorkloadSecurityAgentPolicyAttributes:
@@ -19177,9 +19177,9 @@ components:
format: int64
type: integer
updater:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdaterAttributes'
versions:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyVersions"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyVersions'
type: object
CloudWorkloadSecurityAgentPolicyCreateAttributes:
description: "Create a new Cloud Workload Security Agent policy"
@@ -19218,9 +19218,9 @@ components:
description: "Object for a single Agent rule"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateAttributes'
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
required:
- attributes
- type
@@ -19229,7 +19229,7 @@ components:
description: "Request object that includes the Agent policy to create"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateData'
required:
- data
type: object
@@ -19237,13 +19237,13 @@ components:
description: "Object for a single Agent policy"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyAttributes'
id:
description: "The ID of the Agent policy"
example: "6517fcc1-cec7-4394-a655-8d6e9d085255"
type: string
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
type: object
CloudWorkloadSecurityAgentPolicyID:
description: "The ID of the Agent policy"
@@ -19253,7 +19253,7 @@ components:
description: "Response object that includes an Agent policy"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyData'
type: object
CloudWorkloadSecurityAgentPolicyType:
default: policy
@@ -19298,11 +19298,11 @@ components:
description: "Object for a single Agent policy"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateAttributes'
id:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyID"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyID'
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyType'
required:
- attributes
- type
@@ -19311,7 +19311,7 @@ components:
description: "Request object that includes the Agent policy with the attributes to update"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateData'
required:
- data
type: object
@@ -19343,7 +19343,7 @@ components:
CloudWorkloadSecurityAgentPolicyVersions:
description: "The versions of the policy"
items:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyVersion"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyVersion'
type: array
CloudWorkloadSecurityAgentRuleAction:
description: "The action the rule can perform if triggered"
@@ -19356,13 +19356,13 @@ components:
description: "SECL expression used to target the container to apply the action on"
type: string
hash:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionHash"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionHash'
kill:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleKill"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleKill'
metadata:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionMetadata'
set:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSet'
type: object
CloudWorkloadSecurityAgentRuleActionHash:
description: "Hash file specified by the field attribute"
@@ -19417,7 +19417,7 @@ components:
format: int64
type: integer
value:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActionSetValue'
type: object
CloudWorkloadSecurityAgentRuleActionSetValue:
description: "The value of the set action"
@@ -19430,14 +19430,14 @@ components:
CloudWorkloadSecurityAgentRuleActions:
description: "The array of actions the rule can perform if triggered"
items:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleAction"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAction'
nullable: true
type: array
CloudWorkloadSecurityAgentRuleAttributes:
description: "A Cloud Workload Security Agent rule returned by the API"
properties:
actions:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
agentConstraint:
description: "The version of the Agent"
type: string
@@ -19465,7 +19465,7 @@ components:
format: int64
type: integer
creator:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreatorAttributes'
defaultRule:
description: "Whether the rule is included by default"
example: false
@@ -19538,7 +19538,7 @@ components:
format: int64
type: integer
updater:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdaterAttributes'
version:
description: "The version of the Agent rule"
example: 23
@@ -19549,7 +19549,7 @@ components:
description: "Create a new Cloud Workload Security Agent rule."
properties:
actions:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
agent_version:
description: "Constrain the rule to specific versions of the Datadog Agent."
type: string
@@ -19615,9 +19615,9 @@ components:
description: "Object for a single Agent rule"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateAttributes'
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
required:
- attributes
- type
@@ -19626,7 +19626,7 @@ components:
description: "Request object that includes the Agent rule to create"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateData'
required:
- data
type: object
@@ -19647,13 +19647,13 @@ components:
description: "Object for a single Agent rule"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleAttributes'
id:
description: "The ID of the Agent rule"
example: "3dd-0uc-h1s"
type: string
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
type: object
CloudWorkloadSecurityAgentRuleID:
description: "The ID of the Agent rule"
@@ -19670,7 +19670,7 @@ components:
description: "Response object that includes an Agent rule"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
type: object
CloudWorkloadSecurityAgentRuleType:
default: agent_rule
@@ -19684,7 +19684,7 @@ components:
description: "Update an existing Cloud Workload Security Agent rule"
properties:
actions:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleActions"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleActions'
agent_version:
description: "Constrain the rule to specific versions of the Datadog Agent"
type: string
@@ -19737,11 +19737,11 @@ components:
description: "Object for a single Agent rule"
properties:
attributes:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateAttributes'
id:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleID"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleID'
type:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleType"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleType'
required:
- attributes
- type
@@ -19750,7 +19750,7 @@ components:
description: "Request object that includes the Agent rule with the attributes to update"
properties:
data:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateData'
required:
- data
type: object
@@ -19773,7 +19773,7 @@ components:
data:
description: "A list of Agent rules objects"
items:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleData"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleData'
type: array
type: object
CloudflareAPIToken:
@@ -19784,7 +19784,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/CloudflareAPITokenType"
+ $ref: '#/components/schemas/CloudflareAPITokenType'
required:
- type
- api_token
@@ -19804,7 +19804,7 @@ components:
description: The `CloudflareAPITokenUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/CloudflareAPITokenType"
+ $ref: '#/components/schemas/CloudflareAPITokenType'
required:
- type
type: object
@@ -19812,7 +19812,7 @@ components:
description: Payload schema when adding a Cloudflare account.
properties:
data:
- $ref: "#/components/schemas/CloudflareAccountCreateRequestData"
+ $ref: '#/components/schemas/CloudflareAccountCreateRequestData'
required:
- data
type: object
@@ -19853,9 +19853,9 @@ components:
description: Data object for creating a Cloudflare account.
properties:
attributes:
- $ref: "#/components/schemas/CloudflareAccountCreateRequestAttributes"
+ $ref: '#/components/schemas/CloudflareAccountCreateRequestAttributes'
type:
- $ref: "#/components/schemas/CloudflareAccountType"
+ $ref: '#/components/schemas/CloudflareAccountType'
required:
- attributes
- type
@@ -19864,7 +19864,7 @@ components:
description: The expected response schema when getting a Cloudflare account.
properties:
data:
- $ref: "#/components/schemas/CloudflareAccountResponseData"
+ $ref: '#/components/schemas/CloudflareAccountResponseData'
type: object
CloudflareAccountResponseAttributes:
description: Attributes object of a Cloudflare account.
@@ -19898,13 +19898,13 @@ components:
description: Data object of a Cloudflare account.
properties:
attributes:
- $ref: "#/components/schemas/CloudflareAccountResponseAttributes"
+ $ref: '#/components/schemas/CloudflareAccountResponseAttributes'
id:
description: The ID of the Cloudflare account, a hash of the account name.
example: "c1a8e059bfd1e911cf10b626340c9a54"
type: string
type:
- $ref: "#/components/schemas/CloudflareAccountType"
+ $ref: '#/components/schemas/CloudflareAccountType'
required:
- attributes
- id
@@ -19923,7 +19923,7 @@ components:
description: Payload schema when updating a Cloudflare account.
properties:
data:
- $ref: "#/components/schemas/CloudflareAccountUpdateRequestData"
+ $ref: '#/components/schemas/CloudflareAccountUpdateRequestData'
required:
- data
type: object
@@ -19962,9 +19962,9 @@ components:
description: Data object for updating a Cloudflare account.
properties:
attributes:
- $ref: "#/components/schemas/CloudflareAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/CloudflareAccountUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/CloudflareAccountType"
+ $ref: '#/components/schemas/CloudflareAccountType'
type: object
CloudflareAccountsResponse:
description: The expected response schema when getting Cloudflare accounts.
@@ -19972,19 +19972,19 @@ components:
data:
description: The JSON:API data schema.
items:
- $ref: "#/components/schemas/CloudflareAccountResponseData"
+ $ref: '#/components/schemas/CloudflareAccountResponseData'
type: array
type: object
CloudflareCredentials:
description: The definition of the `CloudflareCredentials` object.
oneOf:
- - $ref: "#/components/schemas/CloudflareAPIToken"
- - $ref: "#/components/schemas/CloudflareGlobalAPIToken"
+ - $ref: '#/components/schemas/CloudflareAPIToken'
+ - $ref: '#/components/schemas/CloudflareGlobalAPIToken'
CloudflareCredentialsUpdate:
description: The definition of the `CloudflareCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/CloudflareAPITokenUpdate"
- - $ref: "#/components/schemas/CloudflareGlobalAPITokenUpdate"
+ - $ref: '#/components/schemas/CloudflareAPITokenUpdate'
+ - $ref: '#/components/schemas/CloudflareGlobalAPITokenUpdate'
CloudflareGlobalAPIToken:
description: The definition of the `CloudflareGlobalAPIToken` object.
properties:
@@ -19997,7 +19997,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/CloudflareGlobalAPITokenType"
+ $ref: '#/components/schemas/CloudflareGlobalAPITokenType'
required:
- type
- auth_email
@@ -20021,7 +20021,7 @@ components:
description: The `CloudflareGlobalAPITokenUpdate` `global_api_key`.
type: string
type:
- $ref: "#/components/schemas/CloudflareGlobalAPITokenType"
+ $ref: '#/components/schemas/CloudflareGlobalAPITokenType'
required:
- type
type: object
@@ -20029,9 +20029,9 @@ components:
description: The definition of the `CloudflareIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/CloudflareCredentials"
+ $ref: '#/components/schemas/CloudflareCredentials'
type:
- $ref: "#/components/schemas/CloudflareIntegrationType"
+ $ref: '#/components/schemas/CloudflareIntegrationType'
required:
- type
- credentials
@@ -20048,9 +20048,9 @@ components:
description: The definition of the `CloudflareIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/CloudflareCredentialsUpdate"
+ $ref: '#/components/schemas/CloudflareCredentialsUpdate'
type:
- $ref: "#/components/schemas/CloudflareIntegrationType"
+ $ref: '#/components/schemas/CloudflareIntegrationType'
required:
- type
type: object
@@ -20076,7 +20076,7 @@ components:
description: Request object for getting code coverage summary for a commit.
properties:
data:
- $ref: "#/components/schemas/CommitCoverageSummaryRequestData"
+ $ref: '#/components/schemas/CommitCoverageSummaryRequestData'
required:
- data
type: object
@@ -20106,9 +20106,9 @@ components:
description: Data object for commit summary request.
properties:
attributes:
- $ref: "#/components/schemas/CommitCoverageSummaryRequestAttributes"
+ $ref: '#/components/schemas/CommitCoverageSummaryRequestAttributes'
type:
- $ref: "#/components/schemas/CommitCoverageSummaryRequestType"
+ $ref: '#/components/schemas/CommitCoverageSummaryRequestType'
required:
- type
- attributes
@@ -20421,7 +20421,7 @@ components:
example: "2023-01-01T00:00:00Z"
type: string
status:
- $ref: "#/components/schemas/CommitmentsAzureVMRIStatus"
+ $ref: '#/components/schemas/CommitmentsAzureVMRIStatus'
term_length:
description: The term length in years.
example: 1
@@ -20466,7 +20466,7 @@ components:
description: Response containing scalar coverage metrics for cloud commitment programs.
properties:
columns:
- $ref: "#/components/schemas/CommitmentsScalarColumns"
+ $ref: '#/components/schemas/CommitmentsScalarColumns'
required:
- columns
type: object
@@ -20474,9 +20474,9 @@ components:
description: Response containing timeseries coverage metrics for cloud commitment programs.
properties:
cost:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
hours:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
required:
- cost
- hours
@@ -20484,12 +20484,12 @@ components:
CommitmentsListItem:
description: A commitment item, which varies based on the provider, product, and commitment type.
oneOf:
- - $ref: "#/components/schemas/CommitmentsAwsEC2RICommitment"
- - $ref: "#/components/schemas/CommitmentsAwsRDSRICommitment"
- - $ref: "#/components/schemas/CommitmentsAwsElasticacheRICommitment"
- - $ref: "#/components/schemas/CommitmentsAwsSPCommitment"
- - $ref: "#/components/schemas/CommitmentsAzureVMRICommitment"
- - $ref: "#/components/schemas/CommitmentsAzureComputeSPCommitment"
+ - $ref: '#/components/schemas/CommitmentsAwsEC2RICommitment'
+ - $ref: '#/components/schemas/CommitmentsAwsRDSRICommitment'
+ - $ref: '#/components/schemas/CommitmentsAwsElasticacheRICommitment'
+ - $ref: '#/components/schemas/CommitmentsAwsSPCommitment'
+ - $ref: '#/components/schemas/CommitmentsAzureVMRICommitment'
+ - $ref: '#/components/schemas/CommitmentsAzureComputeSPCommitment'
CommitmentsListItems:
description: Array of commitment items.
example:
@@ -20500,21 +20500,21 @@ components:
purchase_option: All Upfront
region: us-east-1
items:
- $ref: "#/components/schemas/CommitmentsListItem"
+ $ref: '#/components/schemas/CommitmentsListItem'
type: array
CommitmentsListMeta:
description: Metadata for a commitments list response.
properties:
committed_spend_unit:
- $ref: "#/components/schemas/CommitmentsUnit"
+ $ref: '#/components/schemas/CommitmentsUnit'
type: object
CommitmentsListResponse:
description: Response containing a list of cloud commitment details.
properties:
commitments:
- $ref: "#/components/schemas/CommitmentsListItems"
+ $ref: '#/components/schemas/CommitmentsListItems'
meta:
- $ref: "#/components/schemas/CommitmentsListMeta"
+ $ref: '#/components/schemas/CommitmentsListMeta'
required:
- commitments
type: object
@@ -20532,11 +20532,11 @@ components:
description: Response containing scalar on-demand hot-spots data for cloud commitment programs.
properties:
columns:
- $ref: "#/components/schemas/CommitmentsScalarColumns"
+ $ref: '#/components/schemas/CommitmentsScalarColumns'
meta:
- $ref: "#/components/schemas/CommitmentsOnDemandHotspotsScalarMeta"
+ $ref: '#/components/schemas/CommitmentsOnDemandHotspotsScalarMeta'
total:
- $ref: "#/components/schemas/CommitmentsScalarColumns"
+ $ref: '#/components/schemas/CommitmentsScalarColumns'
required:
- columns
- total
@@ -20555,7 +20555,7 @@ components:
description: Response containing scalar savings metrics for cloud commitment programs.
properties:
columns:
- $ref: "#/components/schemas/CommitmentsScalarColumns"
+ $ref: '#/components/schemas/CommitmentsScalarColumns'
required:
- columns
type: object
@@ -20563,13 +20563,13 @@ components:
description: Response containing timeseries savings metrics for cloud commitment programs.
properties:
actual_cost:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
effective_savings_rate:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
on_demand_equivalent_cost:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
realized_savings:
- $ref: "#/components/schemas/CommitmentsTimeseriesMetric"
+ $ref: '#/components/schemas/CommitmentsTimeseriesMetric'
required:
- actual_cost
- effective_savings_rate
@@ -20580,15 +20580,15 @@ components:
description: A column in a scalar response. When type is "group", values contains arrays of strings. When type is "number", values contains numeric values.
properties:
meta:
- $ref: "#/components/schemas/CommitmentsScalarColumnMeta"
+ $ref: '#/components/schemas/CommitmentsScalarColumnMeta'
name:
description: The column name.
example: utilization
type: string
type:
- $ref: "#/components/schemas/CommitmentsScalarColumnType"
+ $ref: '#/components/schemas/CommitmentsScalarColumnType'
values:
- $ref: "#/components/schemas/CommitmentsScalarColumnValueItems"
+ $ref: '#/components/schemas/CommitmentsScalarColumnValueItems'
required:
- name
- type
@@ -20598,7 +20598,7 @@ components:
description: Metadata for a scalar column, including unit information.
properties:
unit:
- $ref: "#/components/schemas/CommitmentsUnit"
+ $ref: '#/components/schemas/CommitmentsUnit'
required:
- unit
type: object
@@ -20623,24 +20623,24 @@ components:
CommitmentsScalarColumns:
description: Array of scalar columns in the response.
items:
- $ref: "#/components/schemas/CommitmentsScalarColumn"
+ $ref: '#/components/schemas/CommitmentsScalarColumn'
type: array
CommitmentsTimeseriesMetric:
description: A timeseries metric containing timestamps, series values, and optional unit metadata.
properties:
series:
- $ref: "#/components/schemas/CommitmentsTimeseriesSeries"
+ $ref: '#/components/schemas/CommitmentsTimeseriesSeries'
times:
- $ref: "#/components/schemas/CommitmentsTimestamps"
+ $ref: '#/components/schemas/CommitmentsTimestamps'
unit:
- $ref: "#/components/schemas/CommitmentsUnit"
+ $ref: '#/components/schemas/CommitmentsUnit'
required:
- series
- times
type: object
CommitmentsTimeseriesSeries:
additionalProperties:
- $ref: "#/components/schemas/CommitmentsTimeseriesValues"
+ $ref: '#/components/schemas/CommitmentsTimeseriesValues'
description: Timeseries data as a map of series names to their corresponding value arrays.
type: object
CommitmentsTimeseriesValues:
@@ -20700,7 +20700,7 @@ components:
CommitmentsUtilizationScalarProductBreakdown:
description: Array of per-product utilization breakdown entries.
items:
- $ref: "#/components/schemas/CommitmentsUtilizationScalarProductBreakdownEntry"
+ $ref: '#/components/schemas/CommitmentsUtilizationScalarProductBreakdownEntry'
type: array
CommitmentsUtilizationScalarProductBreakdownEntry:
description: Per-product utilization data in a scalar utilization response.
@@ -20722,9 +20722,9 @@ components:
description: Response containing scalar utilization metrics for cloud commitment programs.
properties:
columns:
- $ref: "#/components/schemas/CommitmentsScalarColumns"
+ $ref: '#/components/schemas/CommitmentsScalarColumns'
product_breakdown:
- $ref: "#/components/schemas/CommitmentsUtilizationScalarProductBreakdown"
+ $ref: '#/components/schemas/CommitmentsUtilizationScalarProductBreakdown'
required:
- columns
type: object
@@ -20732,11 +20732,11 @@ components:
description: Response containing timeseries utilization metrics for cloud commitment programs.
properties:
series:
- $ref: "#/components/schemas/CommitmentsTimeseriesSeries"
+ $ref: '#/components/schemas/CommitmentsTimeseriesSeries'
times:
- $ref: "#/components/schemas/CommitmentsTimestamps"
+ $ref: '#/components/schemas/CommitmentsTimestamps'
unit:
- $ref: "#/components/schemas/CommitmentsUnit"
+ $ref: '#/components/schemas/CommitmentsUnit'
required:
- series
- times
@@ -20750,7 +20750,7 @@ components:
operand2:
description: The `CompletionCondition` `operand2`.
operator:
- $ref: "#/components/schemas/CompletionConditionOperator"
+ $ref: '#/components/schemas/CompletionConditionOperator'
required:
- operand1
- operator
@@ -20790,9 +20790,9 @@ components:
description: Used to create conditions before running subsequent actions.
properties:
completionCondition:
- $ref: "#/components/schemas/CompletionCondition"
+ $ref: '#/components/schemas/CompletionCondition'
retryStrategy:
- $ref: "#/components/schemas/RetryStrategy"
+ $ref: '#/components/schemas/RetryStrategy'
required:
- completionCondition
- retryStrategy
@@ -20803,7 +20803,7 @@ components:
events:
description: Events to listen for on the UI component.
items:
- $ref: "#/components/schemas/AppBuilderEvent"
+ $ref: '#/components/schemas/AppBuilderEvent'
type: array
id:
description: The ID of the UI component. This property is deprecated; use `name` to identify individual components instead.
@@ -20814,9 +20814,9 @@ components:
example: ""
type: string
properties:
- $ref: "#/components/schemas/ComponentProperties"
+ $ref: '#/components/schemas/ComponentProperties'
type:
- $ref: "#/components/schemas/ComponentType"
+ $ref: '#/components/schemas/ComponentType'
required:
- name
- type
@@ -20828,7 +20828,7 @@ components:
events:
description: Events to listen for on the grid component.
items:
- $ref: "#/components/schemas/AppBuilderEvent"
+ $ref: '#/components/schemas/AppBuilderEvent'
type: array
id:
description: The ID of the grid component. This property is deprecated; use `name` to identify individual components instead.
@@ -20838,9 +20838,9 @@ components:
example: ""
type: string
properties:
- $ref: "#/components/schemas/ComponentGridProperties"
+ $ref: '#/components/schemas/ComponentGridProperties'
type:
- $ref: "#/components/schemas/ComponentGridType"
+ $ref: '#/components/schemas/ComponentGridType'
required:
- name
- type
@@ -20856,10 +20856,10 @@ components:
children:
description: The child components of the grid.
items:
- $ref: "#/components/schemas/Component"
+ $ref: '#/components/schemas/Component'
type: array
isVisible:
- $ref: "#/components/schemas/ComponentGridPropertiesIsVisible"
+ $ref: '#/components/schemas/ComponentGridPropertiesIsVisible'
type: object
ComponentGridPropertiesIsVisible:
description: Whether the grid component and its children are visible. If a string, it must be a valid JavaScript expression that evaluates to a boolean.
@@ -20883,10 +20883,10 @@ components:
children:
description: The child components of the UI component.
items:
- $ref: "#/components/schemas/Component"
+ $ref: '#/components/schemas/Component'
type: array
isVisible:
- $ref: "#/components/schemas/ComponentPropertiesIsVisible"
+ $ref: '#/components/schemas/ComponentPropertiesIsVisible'
type: object
ComponentPropertiesIsVisible:
description: Whether the UI component is visible. If this is a string, it must be a valid JavaScript expression that evaluates to a boolean.
@@ -20899,7 +20899,7 @@ components:
description: Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs.
properties:
estimation:
- $ref: "#/components/schemas/Estimation"
+ $ref: '#/components/schemas/Estimation'
required: [estimation]
type: object
ComponentType:
@@ -20970,7 +20970,7 @@ components:
format: uuid
type: string
operator:
- $ref: "#/components/schemas/ConditionOperator"
+ $ref: '#/components/schemas/ConditionOperator'
saved_filter_id:
description: The ID of the saved filter referenced by this condition, or null for inline conditions.
example: "550e8400-e29b-41d4-a716-446655440090"
@@ -21031,7 +21031,7 @@ components:
example: "user_tier"
type: string
operator:
- $ref: "#/components/schemas/ConditionOperator"
+ $ref: '#/components/schemas/ConditionOperator'
saved_filter_id:
description: |-
The ID of a saved filter to reference as this condition. Mutually exclusive
@@ -21051,18 +21051,18 @@ components:
ConfigCatCredentials:
description: The definition of the `ConfigCatCredentials` object.
oneOf:
- - $ref: "#/components/schemas/ConfigCatSDKKey"
+ - $ref: '#/components/schemas/ConfigCatSDKKey'
ConfigCatCredentialsUpdate:
description: The definition of the `ConfigCatCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/ConfigCatSDKKeyUpdate"
+ - $ref: '#/components/schemas/ConfigCatSDKKeyUpdate'
ConfigCatIntegration:
description: The definition of the `ConfigCatIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/ConfigCatCredentials"
+ $ref: '#/components/schemas/ConfigCatCredentials'
type:
- $ref: "#/components/schemas/ConfigCatIntegrationType"
+ $ref: '#/components/schemas/ConfigCatIntegrationType'
required:
- type
- credentials
@@ -21079,9 +21079,9 @@ components:
description: The definition of the `ConfigCatIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/ConfigCatCredentialsUpdate"
+ $ref: '#/components/schemas/ConfigCatCredentialsUpdate'
type:
- $ref: "#/components/schemas/ConfigCatIntegrationType"
+ $ref: '#/components/schemas/ConfigCatIntegrationType'
required:
- type
type: object
@@ -21101,7 +21101,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/ConfigCatSDKKeyType"
+ $ref: '#/components/schemas/ConfigCatSDKKeyType'
required:
- type
- sdk_key
@@ -21129,7 +21129,7 @@ components:
description: The `ConfigCatSDKKeyUpdate` `sdk_key`.
type: string
type:
- $ref: "#/components/schemas/ConfigCatSDKKeyType"
+ $ref: '#/components/schemas/ConfigCatSDKKeyType'
required:
- type
type: object
@@ -21137,15 +21137,15 @@ components:
description: "Full resource representation of a configured schedule target with position (previous, current, or next)."
properties:
attributes:
- $ref: "#/components/schemas/ConfiguredScheduleTargetAttributes"
+ $ref: '#/components/schemas/ConfiguredScheduleTargetAttributes'
id:
description: "Specifies the unique identifier of the configured schedule target."
example: "00000000-aba1-0000-0000-000000000000_previous"
type: string
relationships:
- $ref: "#/components/schemas/ConfiguredScheduleTargetRelationships"
+ $ref: '#/components/schemas/ConfiguredScheduleTargetRelationships'
type:
- $ref: "#/components/schemas/ConfiguredScheduleTargetType"
+ $ref: '#/components/schemas/ConfiguredScheduleTargetType'
required:
- type
- id
@@ -21160,7 +21160,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000_previous"
type: string
type:
- $ref: "#/components/schemas/ConfiguredScheduleTargetType"
+ $ref: '#/components/schemas/ConfiguredScheduleTargetType'
required:
- type
- id
@@ -21171,7 +21171,7 @@ components:
position: previous
properties:
position:
- $ref: "#/components/schemas/ScheduleTargetPosition"
+ $ref: '#/components/schemas/ScheduleTargetPosition'
required:
- position
type: object
@@ -21179,7 +21179,7 @@ components:
description: "Represents the relationships of a configured schedule target."
properties:
schedule:
- $ref: "#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule"
+ $ref: '#/components/schemas/ConfiguredScheduleTargetRelationshipsSchedule'
required:
- schedule
type: object
@@ -21187,7 +21187,7 @@ components:
description: "Holds the schedule reference for a configured schedule target."
properties:
data:
- $ref: "#/components/schemas/ScheduleTarget"
+ $ref: '#/components/schemas/ScheduleTarget'
required:
- data
type: object
@@ -21224,7 +21224,7 @@ components:
description: Payload schema when adding a Confluent account.
properties:
data:
- $ref: "#/components/schemas/ConfluentAccountCreateRequestData"
+ $ref: '#/components/schemas/ConfluentAccountCreateRequestData'
required:
- data
type: object
@@ -21242,7 +21242,7 @@ components:
resources:
description: A list of Confluent resources associated with the Confluent account.
items:
- $ref: "#/components/schemas/ConfluentAccountResourceAttributes"
+ $ref: '#/components/schemas/ConfluentAccountResourceAttributes'
type: array
tags:
description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.
@@ -21261,9 +21261,9 @@ components:
description: The data body for adding a Confluent account.
properties:
attributes:
- $ref: "#/components/schemas/ConfluentAccountCreateRequestAttributes"
+ $ref: '#/components/schemas/ConfluentAccountCreateRequestAttributes'
type:
- $ref: "#/components/schemas/ConfluentAccountType"
+ $ref: '#/components/schemas/ConfluentAccountType'
required:
- attributes
- type
@@ -21300,7 +21300,7 @@ components:
description: The expected response schema when getting a Confluent account.
properties:
data:
- $ref: "#/components/schemas/ConfluentAccountResponseData"
+ $ref: '#/components/schemas/ConfluentAccountResponseData'
type: object
ConfluentAccountResponseAttributes:
description: The attributes of a Confluent account.
@@ -21312,7 +21312,7 @@ components:
resources:
description: A list of Confluent resources associated with the Confluent account.
items:
- $ref: "#/components/schemas/ConfluentResourceResponseAttributes"
+ $ref: '#/components/schemas/ConfluentResourceResponseAttributes'
type: array
tags:
description: A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.
@@ -21330,13 +21330,13 @@ components:
description: An API key and API secret pair that represents a Confluent account.
properties:
attributes:
- $ref: "#/components/schemas/ConfluentAccountResponseAttributes"
+ $ref: '#/components/schemas/ConfluentAccountResponseAttributes'
id:
description: A randomly generated ID associated with a Confluent account.
example: "account_id_abc123"
type: string
type:
- $ref: "#/components/schemas/ConfluentAccountType"
+ $ref: '#/components/schemas/ConfluentAccountType'
required:
- attributes
- id
@@ -21355,7 +21355,7 @@ components:
description: The JSON:API request for updating a Confluent account.
properties:
data:
- $ref: "#/components/schemas/ConfluentAccountUpdateRequestData"
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequestData'
required:
- data
type: object
@@ -21387,9 +21387,9 @@ components:
description: Data object for updating a Confluent account.
properties:
attributes:
- $ref: "#/components/schemas/ConfluentAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/ConfluentAccountType"
+ $ref: '#/components/schemas/ConfluentAccountType'
required:
- attributes
- type
@@ -21400,14 +21400,14 @@ components:
data:
description: The Confluent account.
items:
- $ref: "#/components/schemas/ConfluentAccountResponseData"
+ $ref: '#/components/schemas/ConfluentAccountResponseData'
type: array
type: object
ConfluentResourceRequest:
description: The JSON:API request for updating a Confluent resource.
properties:
data:
- $ref: "#/components/schemas/ConfluentResourceRequestData"
+ $ref: '#/components/schemas/ConfluentResourceRequestData'
required:
- data
type: object
@@ -21439,13 +21439,13 @@ components:
description: JSON:API request for updating a Confluent resource.
properties:
attributes:
- $ref: "#/components/schemas/ConfluentResourceRequestAttributes"
+ $ref: '#/components/schemas/ConfluentResourceRequestAttributes'
id:
description: The ID associated with a Confluent resource.
example: "resource-id-123"
type: string
type:
- $ref: "#/components/schemas/ConfluentResourceType"
+ $ref: '#/components/schemas/ConfluentResourceType'
required:
- attributes
- type
@@ -21455,7 +21455,7 @@ components:
description: Response schema when interacting with a Confluent resource.
properties:
data:
- $ref: "#/components/schemas/ConfluentResourceResponseData"
+ $ref: '#/components/schemas/ConfluentResourceResponseData'
type: object
ConfluentResourceResponseAttributes:
description: Model representation of a Confluent Cloud resource.
@@ -21489,13 +21489,13 @@ components:
description: Confluent Cloud resource data.
properties:
attributes:
- $ref: "#/components/schemas/ConfluentResourceResponseAttributes"
+ $ref: '#/components/schemas/ConfluentResourceResponseAttributes'
id:
description: The ID associated with the Confluent resource.
example: "resource_id_abc123"
type: string
type:
- $ref: "#/components/schemas/ConfluentResourceType"
+ $ref: '#/components/schemas/ConfluentResourceType'
required:
- attributes
- type
@@ -21516,14 +21516,14 @@ components:
data:
description: The JSON:API data attribute.
items:
- $ref: "#/components/schemas/ConfluentResourceResponseData"
+ $ref: '#/components/schemas/ConfluentResourceResponseData'
type: array
type: object
ConnectedTeamRef:
description: Reference to a team from an external system.
properties:
data:
- $ref: "#/components/schemas/ConnectedTeamRefData"
+ $ref: '#/components/schemas/ConnectedTeamRefData'
type: object
ConnectedTeamRefData:
description: Reference to connected external team.
@@ -21533,7 +21533,7 @@ components:
example: "@GitHubOrg/team-handle"
type: string
type:
- $ref: "#/components/schemas/ConnectedTeamRefDataType"
+ $ref: '#/components/schemas/ConnectedTeamRefDataType'
required:
- id
- type
@@ -21568,15 +21568,15 @@ components:
connectionGroups:
description: The `ConnectionEnv` `connectionGroups`.
items:
- $ref: "#/components/schemas/ConnectionGroup"
+ $ref: '#/components/schemas/ConnectionGroup'
type: array
connections:
description: The `ConnectionEnv` `connections`.
items:
- $ref: "#/components/schemas/Connection"
+ $ref: '#/components/schemas/Connection'
type: array
env:
- $ref: "#/components/schemas/ConnectionEnvEnv"
+ $ref: '#/components/schemas/ConnectionEnvEnv'
required:
- env
type: object
@@ -21654,18 +21654,18 @@ components:
description: Connections response metadata.
properties:
page:
- $ref: "#/components/schemas/ConnectionsPagePagination"
+ $ref: '#/components/schemas/ConnectionsPagePagination'
type: object
Container:
description: Container object.
properties:
attributes:
- $ref: "#/components/schemas/ContainerAttributes"
+ $ref: '#/components/schemas/ContainerAttributes'
id:
description: Container ID.
type: string
type:
- $ref: "#/components/schemas/ContainerType"
+ $ref: '#/components/schemas/ContainerType'
type: object
ContainerAttributes:
description: Attributes for a container.
@@ -21722,14 +21722,14 @@ components:
description: Container group object.
properties:
attributes:
- $ref: "#/components/schemas/ContainerGroupAttributes"
+ $ref: '#/components/schemas/ContainerGroupAttributes'
id:
description: Container Group ID.
type: string
relationships:
- $ref: "#/components/schemas/ContainerGroupRelationships"
+ $ref: '#/components/schemas/ContainerGroupRelationships'
type:
- $ref: "#/components/schemas/ContainerGroupType"
+ $ref: '#/components/schemas/ContainerGroupType'
type: object
ContainerGroupAttributes:
description: Attributes for a container group.
@@ -21746,7 +21746,7 @@ components:
description: Relationships to containers inside a container group.
properties:
containers:
- $ref: "#/components/schemas/ContainerGroupRelationshipsLink"
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLink'
type: object
ContainerGroupRelationshipsData:
description: Links data.
@@ -21758,9 +21758,9 @@ components:
description: Relationships to Containers inside a Container Group.
properties:
data:
- $ref: "#/components/schemas/ContainerGroupRelationshipsData"
+ $ref: '#/components/schemas/ContainerGroupRelationshipsData'
links:
- $ref: "#/components/schemas/ContainerGroupRelationshipsLinks"
+ $ref: '#/components/schemas/ContainerGroupRelationshipsLinks'
type: object
ContainerGroupRelationshipsLinks:
description: Links attributes.
@@ -21782,12 +21782,12 @@ components:
description: Container Image object.
properties:
attributes:
- $ref: "#/components/schemas/ContainerImageAttributes"
+ $ref: '#/components/schemas/ContainerImageAttributes'
id:
description: Container Image ID.
type: string
type:
- $ref: "#/components/schemas/ContainerImageType"
+ $ref: '#/components/schemas/ContainerImageType'
type: object
ContainerImageAttributes:
description: Attributes for a Container Image.
@@ -21801,7 +21801,7 @@ components:
List of platform-specific images associated with the image record.
The list contains more than 1 entry for multi-architecture images.
items:
- $ref: "#/components/schemas/ContainerImageFlavor"
+ $ref: '#/components/schemas/ContainerImageFlavor'
type: array
image_tags:
description: List of image tags associated with the Container Image.
@@ -21877,7 +21877,7 @@ components:
type: string
type: array
vulnerability_count:
- $ref: "#/components/schemas/ContainerImageVulnerabilities"
+ $ref: '#/components/schemas/ContainerImageVulnerabilities'
type: object
ContainerImageFlavor:
description: Container Image breakdown by supported platform.
@@ -21903,14 +21903,14 @@ components:
description: Container Image Group object.
properties:
attributes:
- $ref: "#/components/schemas/ContainerImageGroupAttributes"
+ $ref: '#/components/schemas/ContainerImageGroupAttributes'
id:
description: Container Image Group ID.
type: string
relationships:
- $ref: "#/components/schemas/ContainerImageGroupRelationships"
+ $ref: '#/components/schemas/ContainerImageGroupRelationships'
type:
- $ref: "#/components/schemas/ContainerImageGroupType"
+ $ref: '#/components/schemas/ContainerImageGroupType'
type: object
ContainerImageGroupAttributes:
description: Attributes for a Container Image Group.
@@ -21930,15 +21930,15 @@ components:
description: Relationships to Container Images inside a Container Image Group.
properties:
data:
- $ref: "#/components/schemas/ContainerImageGroupRelationshipsData"
+ $ref: '#/components/schemas/ContainerImageGroupRelationshipsData'
links:
- $ref: "#/components/schemas/ContainerImageGroupRelationshipsLinks"
+ $ref: '#/components/schemas/ContainerImageGroupRelationshipsLinks'
type: object
ContainerImageGroupRelationships:
description: Relationships inside a Container Image Group.
properties:
container_images:
- $ref: "#/components/schemas/ContainerImageGroupImagesRelationshipsLink"
+ $ref: '#/components/schemas/ContainerImageGroupImagesRelationshipsLink'
type: object
ContainerImageGroupRelationshipsData:
description: Links data.
@@ -21965,13 +21965,13 @@ components:
ContainerImageItem:
description: Possible Container Image models.
oneOf:
- - $ref: "#/components/schemas/ContainerImage"
- - $ref: "#/components/schemas/ContainerImageGroup"
+ - $ref: '#/components/schemas/ContainerImage'
+ - $ref: '#/components/schemas/ContainerImageGroup'
ContainerImageMeta:
description: Response metadata object.
properties:
pagination:
- $ref: "#/components/schemas/ContainerImageMetaPage"
+ $ref: '#/components/schemas/ContainerImageMetaPage'
type: object
ContainerImageMetaPage:
description: Paging attributes.
@@ -21997,7 +21997,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ContainerImageMetaPageType"
+ $ref: '#/components/schemas/ContainerImageMetaPageType'
type: object
ContainerImageMetaPageType:
default: cursor_limit
@@ -22054,12 +22054,12 @@ components:
data:
description: Array of Container Image objects.
items:
- $ref: "#/components/schemas/ContainerImageItem"
+ $ref: '#/components/schemas/ContainerImageItem'
type: array
links:
- $ref: "#/components/schemas/ContainerImagesResponseLinks"
+ $ref: '#/components/schemas/ContainerImagesResponseLinks'
meta:
- $ref: "#/components/schemas/ContainerImageMeta"
+ $ref: '#/components/schemas/ContainerImageMeta'
type: object
ContainerImagesResponseLinks:
description: Pagination links.
@@ -22086,13 +22086,13 @@ components:
ContainerItem:
description: Possible Container models.
oneOf:
- - $ref: "#/components/schemas/Container"
- - $ref: "#/components/schemas/ContainerGroup"
+ - $ref: '#/components/schemas/Container'
+ - $ref: '#/components/schemas/ContainerGroup'
ContainerMeta:
description: Response metadata object.
properties:
pagination:
- $ref: "#/components/schemas/ContainerMetaPage"
+ $ref: '#/components/schemas/ContainerMetaPage'
type: object
ContainerMetaPage:
description: Paging attributes.
@@ -22118,7 +22118,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ContainerMetaPageType"
+ $ref: '#/components/schemas/ContainerMetaPageType'
type: object
ContainerMetaPageType:
default: cursor_limit
@@ -22133,11 +22133,11 @@ components:
description: A query for container-level metrics such as CPU and memory usage.
properties:
aggregator:
- $ref: "#/components/schemas/MetricsAggregator"
+ $ref: '#/components/schemas/MetricsAggregator'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ContainerDataSource"
+ $ref: '#/components/schemas/ContainerDataSource'
is_normalized_cpu:
description: Whether CPU metrics should be normalized by core count.
type: boolean
@@ -22154,7 +22154,7 @@ components:
example: query1
type: string
sort:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: Tag filters to narrow down containers.
items:
@@ -22174,9 +22174,9 @@ components:
description: A query for container-level metrics such as CPU and memory usage.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ContainerDataSource"
+ $ref: '#/components/schemas/ContainerDataSource'
is_normalized_cpu:
description: Whether CPU metrics should be normalized by core count.
type: boolean
@@ -22193,7 +22193,7 @@ components:
example: query1
type: string
sort:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: Tag filters to narrow down containers.
items:
@@ -22224,12 +22224,12 @@ components:
data:
description: Array of Container objects.
items:
- $ref: "#/components/schemas/ContainerItem"
+ $ref: '#/components/schemas/ContainerItem'
type: array
links:
- $ref: "#/components/schemas/ContainersResponseLinks"
+ $ref: '#/components/schemas/ContainersResponseLinks'
meta:
- $ref: "#/components/schemas/ContainerMeta"
+ $ref: '#/components/schemas/ContainerMeta'
type: object
ContainersResponseLinks:
description: Pagination links.
@@ -22276,7 +22276,7 @@ components:
example: "new_detection"
type: string
targets:
- $ref: "#/components/schemas/ControlNotificationTargetArray"
+ $ref: '#/components/schemas/ControlNotificationTargetArray'
required:
- event_type
- enabled
@@ -22285,13 +22285,13 @@ components:
ControlNotificationEventSettingsArray:
description: The notification settings for each supported event type on the control.
items:
- $ref: "#/components/schemas/ControlNotificationEventSetting"
+ $ref: '#/components/schemas/ControlNotificationEventSetting'
type: array
ControlNotificationSettingsAttributes:
description: The attributes of a governance control's notification settings.
properties:
event_settings:
- $ref: "#/components/schemas/ControlNotificationEventSettingsArray"
+ $ref: '#/components/schemas/ControlNotificationEventSettingsArray'
required:
- event_settings
type: object
@@ -22299,13 +22299,13 @@ components:
description: A control notification settings resource.
properties:
attributes:
- $ref: "#/components/schemas/ControlNotificationSettingsAttributes"
+ $ref: '#/components/schemas/ControlNotificationSettingsAttributes'
id:
description: The detection type the notification settings apply to.
example: "unused_api_keys"
type: string
type:
- $ref: "#/components/schemas/ControlNotificationSettingsResourceType"
+ $ref: '#/components/schemas/ControlNotificationSettingsResourceType'
required:
- id
- type
@@ -22323,7 +22323,7 @@ components:
description: The notification settings for a governance control.
properties:
data:
- $ref: "#/components/schemas/ControlNotificationSettingsData"
+ $ref: '#/components/schemas/ControlNotificationSettingsData'
required:
- data
type: object
@@ -22331,15 +22331,15 @@ components:
description: The attributes of a governance control's notification settings that can be updated.
properties:
event_settings:
- $ref: "#/components/schemas/ControlNotificationEventSettingsArray"
+ $ref: '#/components/schemas/ControlNotificationEventSettingsArray'
type: object
ControlNotificationSettingsUpdateData:
description: The data of a control notification settings update request.
properties:
attributes:
- $ref: "#/components/schemas/ControlNotificationSettingsUpdateAttributes"
+ $ref: '#/components/schemas/ControlNotificationSettingsUpdateAttributes'
type:
- $ref: "#/components/schemas/ControlNotificationSettingsResourceType"
+ $ref: '#/components/schemas/ControlNotificationSettingsResourceType'
required:
- type
type: object
@@ -22347,7 +22347,7 @@ components:
description: A request to update the notification settings for a governance control.
properties:
data:
- $ref: "#/components/schemas/ControlNotificationSettingsUpdateData"
+ $ref: '#/components/schemas/ControlNotificationSettingsUpdateData'
required:
- data
type: object
@@ -22359,7 +22359,7 @@ components:
example: "#governance-alerts"
type: string
type:
- $ref: "#/components/schemas/ControlNotificationTargetType"
+ $ref: '#/components/schemas/ControlNotificationTargetType'
required:
- type
- handle
@@ -22367,7 +22367,7 @@ components:
ControlNotificationTargetArray:
description: The destinations that receive notifications for an event type.
items:
- $ref: "#/components/schemas/ControlNotificationTarget"
+ $ref: '#/components/schemas/ControlNotificationTarget'
type: array
ControlNotificationTargetType:
description: The type of notification destination.
@@ -22407,7 +22407,7 @@ components:
example: A large number of failed login attempts.
type: string
signalSeverity:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
required:
- jobResultIds
- signalSeverity
@@ -22418,9 +22418,9 @@ components:
description: Data for converting historical job results to signals.
properties:
attributes:
- $ref: "#/components/schemas/ConvertJobResultsToSignalsAttributes"
+ $ref: '#/components/schemas/ConvertJobResultsToSignalsAttributes'
type:
- $ref: "#/components/schemas/ConvertJobResultsToSignalsDataType"
+ $ref: '#/components/schemas/ConvertJobResultsToSignalsDataType'
type: object
ConvertJobResultsToSignalsDataType:
description: Type of payload.
@@ -22433,7 +22433,7 @@ components:
description: Request for converting historical job results to signals.
properties:
data:
- $ref: "#/components/schemas/ConvertJobResultsToSignalsData"
+ $ref: '#/components/schemas/ConvertJobResultsToSignalsData'
type: object
CostAggregationType:
description: "Controls how costs are aggregated when using `start_date`. The `cumulative` option returns month-to-date running totals."
@@ -22446,19 +22446,19 @@ components:
description: Response object containing a list of detected Cloud Cost Management anomalies and aggregated totals.
properties:
data:
- $ref: "#/components/schemas/CostAnomaliesResponseData"
+ $ref: '#/components/schemas/CostAnomaliesResponseData'
type: object
CostAnomaliesResponseData:
description: Resource wrapper for the list of cost anomalies and aggregated totals.
properties:
attributes:
- $ref: "#/components/schemas/CostAnomaliesResponseDataAttributes"
+ $ref: '#/components/schemas/CostAnomaliesResponseDataAttributes'
id:
description: Static identifier of the cost anomalies collection resource.
example: anomalies
type: string
type:
- $ref: "#/components/schemas/CostAnomaliesResponseDataType"
+ $ref: '#/components/schemas/CostAnomaliesResponseDataType'
required:
- id
- type
@@ -22470,7 +22470,7 @@ components:
anomalies:
description: The list of cost anomalies that match the request.
items:
- $ref: "#/components/schemas/CostAnomaly"
+ $ref: '#/components/schemas/CostAnomaly'
type: array
avg_daily_anomalous_cost:
description: Average daily anomalous cost change across the queried window.
@@ -22532,11 +22532,11 @@ components:
format: int64
type: integer
correlated_tags:
- $ref: "#/components/schemas/CostAnomalyCorrelatedTags"
+ $ref: '#/components/schemas/CostAnomalyCorrelatedTags'
dimensions:
- $ref: "#/components/schemas/CostAnomalyDimensions"
+ $ref: '#/components/schemas/CostAnomalyDimensions'
dismissal:
- $ref: "#/components/schemas/CostAnomalyDismissal"
+ $ref: '#/components/schemas/CostAnomalyDismissal'
max_cost:
description: Maximum cost observed during the anomaly window.
example: 5000.5
@@ -22623,19 +22623,19 @@ components:
description: Response object containing a single Cloud Cost Management anomaly.
properties:
data:
- $ref: "#/components/schemas/CostAnomalyResponseData"
+ $ref: '#/components/schemas/CostAnomalyResponseData'
type: object
CostAnomalyResponseData:
description: Resource wrapper for a single cost anomaly.
properties:
attributes:
- $ref: "#/components/schemas/CostAnomaly"
+ $ref: '#/components/schemas/CostAnomaly'
id:
description: The unique identifier of the anomaly.
example: b0a6aaa9-3c4c-48cb-9447-a0d1338b3e09
type: string
type:
- $ref: "#/components/schemas/CostAnomaliesResponseDataType"
+ $ref: '#/components/schemas/CostAnomaliesResponseDataType'
required:
- id
- type
@@ -22644,7 +22644,7 @@ components:
CostAttributionAggregates:
description: An array of available aggregates.
items:
- $ref: "#/components/schemas/CostAttributionAggregatesBody"
+ $ref: '#/components/schemas/CostAttributionAggregatesBody'
type: array
CostAttributionAggregatesBody:
description: The object containing the aggregates.
@@ -22694,12 +22694,12 @@ components:
description: Cost data.
properties:
attributes:
- $ref: "#/components/schemas/CostByOrgAttributes"
+ $ref: '#/components/schemas/CostByOrgAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/CostByOrgType"
+ $ref: '#/components/schemas/CostByOrgType'
type: object
CostByOrgAttributes:
description: Cost attributes data.
@@ -22713,7 +22713,7 @@ components:
charges:
description: List of charges data reported for the requested month.
items:
- $ref: "#/components/schemas/ChargebackBreakdown"
+ $ref: '#/components/schemas/ChargebackBreakdown'
type: array
date:
description: The month requested.
@@ -22739,7 +22739,7 @@ components:
data:
description: Response containing Chargeback Summary.
items:
- $ref: "#/components/schemas/CostByOrg"
+ $ref: '#/components/schemas/CostByOrg'
type: array
type: object
CostByOrgType:
@@ -22759,7 +22759,7 @@ components:
example: USD
type: string
type:
- $ref: "#/components/schemas/CostCurrencyType"
+ $ref: '#/components/schemas/CostCurrencyType'
required:
- id
- type
@@ -22774,7 +22774,7 @@ components:
data:
description: The dominant billing currency. Empty when no data is available, or a single entry otherwise.
items:
- $ref: "#/components/schemas/CostCurrency"
+ $ref: '#/components/schemas/CostCurrency'
type: array
required:
- data
@@ -22796,7 +22796,7 @@ components:
example: aws.cost.net.amortized
type: string
type:
- $ref: "#/components/schemas/CostMetricType"
+ $ref: '#/components/schemas/CostMetricType'
required:
- id
- type
@@ -22822,7 +22822,7 @@ components:
data:
description: List of available metrics.
items:
- $ref: "#/components/schemas/CostMetric"
+ $ref: '#/components/schemas/CostMetric'
type: array
required:
- data
@@ -22835,7 +22835,7 @@ components:
example: kubernetes
type: string
type:
- $ref: "#/components/schemas/CostOrchestratorType"
+ $ref: '#/components/schemas/CostOrchestratorType'
required:
- id
- type
@@ -22861,7 +22861,7 @@ components:
data:
description: List of detected container orchestrators.
items:
- $ref: "#/components/schemas/CostOrchestrator"
+ $ref: '#/components/schemas/CostOrchestrator'
type: array
required:
- data
@@ -22872,10 +22872,10 @@ components:
data:
description: The list of cost recommendations on this page.
items:
- $ref: "#/components/schemas/CostRecommendationData"
+ $ref: '#/components/schemas/CostRecommendationData'
type: array
meta:
- $ref: "#/components/schemas/RecommendationsPageMeta"
+ $ref: '#/components/schemas/RecommendationsPageMeta'
required:
- data
type: object
@@ -22883,12 +22883,12 @@ components:
description: A single cost recommendation entry in JSON:API form.
properties:
attributes:
- $ref: "#/components/schemas/CostRecommendationDataAttributes"
+ $ref: '#/components/schemas/CostRecommendationDataAttributes'
id:
description: Unique identifier for the recommendation.
type: string
type:
- $ref: "#/components/schemas/CostRecommendationDataType"
+ $ref: '#/components/schemas/CostRecommendationDataType'
required:
- type
type: object
@@ -22899,7 +22899,7 @@ components:
description: Datadog resource key identifying the recommended resource.
type: string
potential_daily_savings:
- $ref: "#/components/schemas/CostRecommendationDataAttributesPotentialDailySavings"
+ $ref: '#/components/schemas/CostRecommendationDataAttributesPotentialDailySavings'
recommendation_type:
description: The kind of recommendation (for example, `terminate` or `rightsize`).
type: string
@@ -22940,13 +22940,13 @@ components:
description: A Cloud Cost Management tag.
properties:
attributes:
- $ref: "#/components/schemas/CostTagAttributes"
+ $ref: '#/components/schemas/CostTagAttributes'
id:
description: The tag identifier, equal to its `key:value` representation.
example: providername:aws
type: string
type:
- $ref: "#/components/schemas/CostTagType"
+ $ref: '#/components/schemas/CostTagType'
required:
- attributes
- id
@@ -22975,13 +22975,13 @@ components:
description: A Cloud Cost Management tag key description, either cross-cloud or scoped to a single cloud provider.
properties:
attributes:
- $ref: "#/components/schemas/CostTagDescriptionAttributes"
+ $ref: '#/components/schemas/CostTagDescriptionAttributes'
id:
description: Stable identifier of the tag description. Equals the tag key when the description is the cross-cloud default; encodes both the cloud and the tag key when the description is cloud-specific.
example: account_id
type: string
type:
- $ref: "#/components/schemas/CostTagDescriptionType"
+ $ref: '#/components/schemas/CostTagDescriptionType'
required:
- attributes
- id
@@ -23003,7 +23003,7 @@ components:
example: AWS account that owns this cost.
type: string
source:
- $ref: "#/components/schemas/CostTagDescriptionSource"
+ $ref: '#/components/schemas/CostTagDescriptionSource'
tag_key:
description: The tag key this description applies to.
example: account_id
@@ -23035,7 +23035,7 @@ components:
type: cost_tag_description
properties:
data:
- $ref: "#/components/schemas/CostTagDescription"
+ $ref: '#/components/schemas/CostTagDescription'
required:
- data
type: object
@@ -23071,7 +23071,7 @@ components:
type: cost_tag_description
properties:
data:
- $ref: "#/components/schemas/CostTagDescriptionUpsertRequestData"
+ $ref: '#/components/schemas/CostTagDescriptionUpsertRequestData'
required:
- data
type: object
@@ -23079,13 +23079,13 @@ components:
description: Resource envelope carrying the tag key description being upserted. The `id` is informational; the authoritative tag key is taken from the URL path.
properties:
attributes:
- $ref: "#/components/schemas/CostTagDescriptionUpsertRequestDataAttributes"
+ $ref: '#/components/schemas/CostTagDescriptionUpsertRequestDataAttributes'
id:
description: Identifier of the tag key the description applies to. Matches the `tag_key` path parameter.
example: account_id
type: string
type:
- $ref: "#/components/schemas/CostTagDescriptionType"
+ $ref: '#/components/schemas/CostTagDescriptionType'
required:
- attributes
- type
@@ -23121,7 +23121,7 @@ components:
data:
description: List of tag key descriptions.
items:
- $ref: "#/components/schemas/CostTagDescription"
+ $ref: '#/components/schemas/CostTagDescription'
type: array
required:
- data
@@ -23130,13 +23130,13 @@ components:
description: A Cloud Cost Management tag key.
properties:
attributes:
- $ref: "#/components/schemas/CostTagKeyAttributes"
+ $ref: '#/components/schemas/CostTagKeyAttributes'
id:
description: The tag key identifier.
example: providername
type: string
type:
- $ref: "#/components/schemas/CostTagKeyType"
+ $ref: '#/components/schemas/CostTagKeyType'
required:
- attributes
- id
@@ -23146,7 +23146,7 @@ components:
description: Attributes of a Cloud Cost Management tag key.
properties:
details:
- $ref: "#/components/schemas/CostTagKeyDetails"
+ $ref: '#/components/schemas/CostTagKeyDetails'
sources:
description: List of sources that define this tag key.
example:
@@ -23188,13 +23188,13 @@ components:
description: A Cloud Cost Management tag key metadata entry, aggregating coverage and example values for a single tag key, metric, and period.
properties:
attributes:
- $ref: "#/components/schemas/CostTagKeyMetadataAttributes"
+ $ref: '#/components/schemas/CostTagKeyMetadataAttributes'
id:
description: A composite identifier of the form `tag_key:metric` for monthly roll-ups, or `tag_key:metric:YYYY-MM-DD` when `filter[daily]=true`.
example: env:aws.cost.net.amortized
type: string
type:
- $ref: "#/components/schemas/CostTagKeyMetadataType"
+ $ref: '#/components/schemas/CostTagKeyMetadataType'
required:
- attributes
- id
@@ -23204,7 +23204,7 @@ components:
description: Attributes of a Cloud Cost Management tag key metadata entry.
properties:
cardinality_by_account:
- $ref: "#/components/schemas/CostTagKeyMetadataCardinalityByAccount"
+ $ref: '#/components/schemas/CostTagKeyMetadataCardinalityByAccount'
cost_covered:
description: Total cost (in the report currency) of cost line items that carry this tag key for the requested period.
example: 1234.56
@@ -23232,7 +23232,7 @@ components:
type: string
type: array
top_values_by_account:
- $ref: "#/components/schemas/CostTagKeyMetadataTopValuesByAccount"
+ $ref: '#/components/schemas/CostTagKeyMetadataTopValuesByAccount'
required:
- cardinality_by_account
- cost_covered
@@ -23272,7 +23272,7 @@ components:
data:
description: List of tag key metadata entries.
items:
- $ref: "#/components/schemas/CostTagKeyMetadata"
+ $ref: '#/components/schemas/CostTagKeyMetadata'
type: array
required:
- data
@@ -23317,7 +23317,7 @@ components:
type: cost_tag_key
properties:
data:
- $ref: "#/components/schemas/CostTagKey"
+ $ref: '#/components/schemas/CostTagKey'
required:
- data
type: object
@@ -23325,13 +23325,13 @@ components:
description: A Cloud Cost Management tag key paired with the sources that produced it.
properties:
attributes:
- $ref: "#/components/schemas/CostTagKeySourceAttributes"
+ $ref: '#/components/schemas/CostTagKeySourceAttributes'
id:
description: The tag key identifier. Equal to the empty-tag sentinel `__empty_tag_key__` when the tag key is empty.
example: env
type: string
type:
- $ref: "#/components/schemas/CostTagKeySourceType"
+ $ref: '#/components/schemas/CostTagKeySourceType'
required:
- attributes
- id
@@ -23387,7 +23387,7 @@ components:
data:
description: List of tag keys with their origin sources.
items:
- $ref: "#/components/schemas/CostTagKeySource"
+ $ref: '#/components/schemas/CostTagKeySource'
type: array
required:
- data
@@ -23420,7 +23420,7 @@ components:
data:
description: The list of Cloud Cost Management tag keys.
items:
- $ref: "#/components/schemas/CostTagKey"
+ $ref: '#/components/schemas/CostTagKey'
type: array
required:
- data
@@ -23443,7 +23443,7 @@ components:
example: "2026-04"
type: string
type:
- $ref: "#/components/schemas/CostTagMetadataMonthType"
+ $ref: '#/components/schemas/CostTagMetadataMonthType'
required:
- id
- type
@@ -23469,7 +23469,7 @@ components:
data:
description: List of months that have tag metadata available.
items:
- $ref: "#/components/schemas/CostTagMetadataMonth"
+ $ref: '#/components/schemas/CostTagMetadataMonth'
type: array
required:
- data
@@ -23503,7 +23503,7 @@ components:
data:
description: The list of Cloud Cost Management tags.
items:
- $ref: "#/components/schemas/CostTag"
+ $ref: '#/components/schemas/CostTag'
type: array
required:
- data
@@ -23513,7 +23513,7 @@ components:
properties:
codeowners:
additionalProperties:
- $ref: "#/components/schemas/CoverageSummaryCodeownerStats"
+ $ref: '#/components/schemas/CoverageSummaryCodeownerStats'
description: Coverage statistics broken down by code owner.
nullable: true
type: object
@@ -23535,7 +23535,7 @@ components:
type: number
services:
additionalProperties:
- $ref: "#/components/schemas/CoverageSummaryServiceStats"
+ $ref: '#/components/schemas/CoverageSummaryServiceStats'
description: Coverage statistics broken down by service.
nullable: true
type: object
@@ -23576,19 +23576,19 @@ components:
description: Data object for coverage summary response.
properties:
attributes:
- $ref: "#/components/schemas/CoverageSummaryAttributes"
+ $ref: '#/components/schemas/CoverageSummaryAttributes'
id:
description: Unique identifier for the coverage summary (base64-hashed).
example: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA=
type: string
type:
- $ref: "#/components/schemas/CoverageSummaryType"
+ $ref: '#/components/schemas/CoverageSummaryType'
type: object
CoverageSummaryResponse:
description: Response object containing code coverage summary.
properties:
data:
- $ref: "#/components/schemas/CoverageSummaryData"
+ $ref: '#/components/schemas/CoverageSummaryData'
type: object
CoverageSummaryServiceStats:
description: Coverage statistics for a specific service.
@@ -23645,7 +23645,7 @@ components:
description: Request used to create an action connection.
properties:
data:
- $ref: "#/components/schemas/ActionConnectionData"
+ $ref: '#/components/schemas/ActionConnectionData'
required:
- data
type: object
@@ -23653,13 +23653,13 @@ components:
description: The response for a created connection
properties:
data:
- $ref: "#/components/schemas/ActionConnectionData"
+ $ref: '#/components/schemas/ActionConnectionData'
type: object
CreateAllocationsRequest:
description: Request to create targeting rules (allocations) for a feature flag in an environment.
properties:
data:
- $ref: "#/components/schemas/AllocationDataRequest"
+ $ref: '#/components/schemas/AllocationDataRequest'
required:
- data
type: object
@@ -23705,15 +23705,15 @@ components:
type: appDefinitions
properties:
data:
- $ref: "#/components/schemas/CreateAppRequestData"
+ $ref: '#/components/schemas/CreateAppRequestData'
type: object
CreateAppRequestData:
description: The data object containing the app definition.
properties:
attributes:
- $ref: "#/components/schemas/CreateAppRequestDataAttributes"
+ $ref: '#/components/schemas/CreateAppRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- type
type: object
@@ -23723,7 +23723,7 @@ components:
components:
description: The UI components that make up the app.
items:
- $ref: "#/components/schemas/ComponentGrid"
+ $ref: '#/components/schemas/ComponentGrid'
type: array
description:
description: A human-readable description for the app.
@@ -23734,7 +23734,7 @@ components:
queries:
description: An array of queries, such as external actions and state variables, that the app uses.
items:
- $ref: "#/components/schemas/Query"
+ $ref: '#/components/schemas/Query'
type: array
rootInstanceName:
description: The name of the root component of the app. This must be a `grid` component that contains all other components.
@@ -23753,7 +23753,7 @@ components:
description: The response object after a new app is successfully created, with the app ID.
properties:
data:
- $ref: "#/components/schemas/CreateAppResponseData"
+ $ref: '#/components/schemas/CreateAppResponseData'
type: object
CreateAppResponseData:
description: The data object containing the app ID.
@@ -23764,7 +23764,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -23773,18 +23773,18 @@ components:
description: Request to create a new datastore with specified configuration and metadata.
properties:
data:
- $ref: "#/components/schemas/CreateAppsDatastoreRequestData"
+ $ref: '#/components/schemas/CreateAppsDatastoreRequestData'
type: object
CreateAppsDatastoreRequestData:
description: Data wrapper containing the configuration needed to create a new datastore.
properties:
attributes:
- $ref: "#/components/schemas/CreateAppsDatastoreRequestDataAttributes"
+ $ref: '#/components/schemas/CreateAppsDatastoreRequestDataAttributes'
id:
description: Optional ID for the new datastore. If not provided, one will be generated automatically.
type: string
type:
- $ref: "#/components/schemas/DatastoreDataType"
+ $ref: '#/components/schemas/DatastoreDataType'
required:
- type
type: object
@@ -23799,11 +23799,11 @@ components:
example: "datastore-name"
type: string
org_access:
- $ref: "#/components/schemas/CreateAppsDatastoreRequestDataAttributesOrgAccess"
+ $ref: '#/components/schemas/CreateAppsDatastoreRequestDataAttributesOrgAccess'
primary_column_name:
- $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName"
+ $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName'
primary_key_generation_strategy:
- $ref: "#/components/schemas/DatastorePrimaryKeyGenerationStrategy"
+ $ref: '#/components/schemas/DatastorePrimaryKeyGenerationStrategy'
required:
- name
- primary_column_name
@@ -23823,7 +23823,7 @@ components:
description: Response after successfully creating a new datastore, containing the datastore's assigned ID.
properties:
data:
- $ref: "#/components/schemas/CreateAppsDatastoreResponseData"
+ $ref: '#/components/schemas/CreateAppsDatastoreResponseData'
type: object
CreateAppsDatastoreResponseData:
description: The newly created datastore's data.
@@ -23832,7 +23832,7 @@ components:
description: The unique identifier assigned to the newly created datastore.
type: string
type:
- $ref: "#/components/schemas/DatastoreDataType"
+ $ref: '#/components/schemas/DatastoreDataType'
required:
- type
type: object
@@ -23840,18 +23840,18 @@ components:
description: Create request for an attachment.
properties:
data:
- $ref: "#/components/schemas/CreateAttachmentRequestData"
+ $ref: '#/components/schemas/CreateAttachmentRequestData'
type: object
CreateAttachmentRequestData:
description: Attachment data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/CreateAttachmentRequestDataAttributes"
+ $ref: '#/components/schemas/CreateAttachmentRequestDataAttributes'
id:
description: The unique identifier of the attachment.
type: string
type:
- $ref: "#/components/schemas/IncidentAttachmentType"
+ $ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
type: object
@@ -23859,9 +23859,9 @@ components:
description: The attributes for creating an attachment.
properties:
attachment:
- $ref: "#/components/schemas/CreateAttachmentRequestDataAttributesAttachment"
+ $ref: '#/components/schemas/CreateAttachmentRequestDataAttributesAttachment'
attachment_type:
- $ref: "#/components/schemas/AttachmentDataAttributesAttachmentType"
+ $ref: '#/components/schemas/AttachmentDataAttributesAttachmentType'
type: object
CreateAttachmentRequestDataAttributesAttachment:
description: The attachment object for creating an attachment.
@@ -23903,17 +23903,17 @@ components:
type: degradations
properties:
data:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequestData"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequestData'
type: object
CreateBackfilledDegradationRequestData:
description: The data object for creating a backfilled degradation.
properties:
attributes:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataAttributes"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataRelationships"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationRequestDataType'
required:
- type
type: object
@@ -23927,7 +23927,7 @@ components:
updates:
description: The list of status updates describing the timeline of the degradation.
items:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequestDataAttributesUpdatesItems'
type: array
required:
- title
@@ -23939,7 +23939,7 @@ components:
components_affected:
description: The components affected.
items:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems'
type: array
description:
description: A description of the update.
@@ -23950,7 +23950,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
required:
- started_at
- status
@@ -23966,7 +23966,7 @@ components:
description: The template used to create the backfilled degradation.
properties:
data:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -23978,7 +23978,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
- id
@@ -24005,17 +24005,17 @@ components:
type: maintenances
properties:
data:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestData"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequestData'
type: object
CreateBackfilledMaintenanceRequestData:
description: The data object for creating a backfilled maintenance.
properties:
attributes:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataAttributes"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationships"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataType'
required:
- type
type: object
@@ -24029,7 +24029,7 @@ components:
updates:
description: "The list of updates. Exactly two updates are required: the start (`in_progress`) and the end (`completed`)."
items:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequestDataAttributesUpdatesItems'
maxItems: 2
minItems: 2
type: array
@@ -24043,7 +24043,7 @@ components:
components_affected:
description: The components affected.
items:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems'
type: array
description:
description: A description of the update.
@@ -24055,7 +24055,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributesUpdatesItemsStatus"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesUpdatesItemsStatus'
required:
- description
- started_at
@@ -24072,7 +24072,7 @@ components:
description: The template used to create the backfilled maintenance.
properties:
data:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -24084,7 +24084,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
- id
@@ -24093,7 +24093,7 @@ components:
description: Request to create a new campaign.
properties:
data:
- $ref: "#/components/schemas/CreateCampaignRequestData"
+ $ref: '#/components/schemas/CreateCampaignRequestData'
required:
- data
type: object
@@ -24142,7 +24142,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CampaignStatus"
+ $ref: '#/components/schemas/CampaignStatus'
required:
- name
- key
@@ -24154,9 +24154,9 @@ components:
description: Data for creating a new campaign.
properties:
attributes:
- $ref: "#/components/schemas/CreateCampaignRequestAttributes"
+ $ref: '#/components/schemas/CreateCampaignRequestAttributes'
type:
- $ref: "#/components/schemas/CampaignType"
+ $ref: '#/components/schemas/CampaignType'
required:
- type
- attributes
@@ -24167,7 +24167,7 @@ components:
data:
description: Array of case creation request data objects.
items:
- $ref: "#/components/schemas/CreateCaseRequestData"
+ $ref: '#/components/schemas/CreateCaseRequestData'
type: array
required:
- data
@@ -24176,11 +24176,11 @@ components:
description: Data of the case to create.
properties:
attributes:
- $ref: "#/components/schemas/CreateCaseRequestDataAttributes"
+ $ref: '#/components/schemas/CreateCaseRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateCaseRequestDataRelationships"
+ $ref: '#/components/schemas/CreateCaseRequestDataRelationships'
type:
- $ref: "#/components/schemas/CaseDataType"
+ $ref: '#/components/schemas/CaseDataType'
required:
- type
type: object
@@ -24231,17 +24231,17 @@ components:
type: components
properties:
data:
- $ref: "#/components/schemas/CreateComponentRequestData"
+ $ref: '#/components/schemas/CreateComponentRequestData'
type: object
CreateComponentRequestData:
description: The data object for creating a component.
properties:
attributes:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributes"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateComponentRequestDataRelationships"
+ $ref: '#/components/schemas/CreateComponentRequestDataRelationships'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- attributes
- type
@@ -24259,7 +24259,7 @@ components:
position: 1
type: component
items:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesComponentsItems"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesComponentsItems'
type: array
name:
description: The name of the component.
@@ -24292,7 +24292,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
required:
- name
- position
@@ -24319,7 +24319,7 @@ components:
description: The group to create the component within.
properties:
data:
- $ref: "#/components/schemas/CreateComponentRequestDataRelationshipsGroupData"
+ $ref: '#/components/schemas/CreateComponentRequestDataRelationshipsGroupData'
required:
- data
type: object
@@ -24333,7 +24333,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- type
- id
@@ -24361,18 +24361,18 @@ components:
type: connection_id
properties:
data:
- $ref: "#/components/schemas/CreateConnectionRequestData"
+ $ref: '#/components/schemas/CreateConnectionRequestData'
type: object
CreateConnectionRequestData:
description: The data object containing the resource type and attributes for creating a new connection.
properties:
attributes:
- $ref: "#/components/schemas/CreateConnectionRequestDataAttributes"
+ $ref: '#/components/schemas/CreateConnectionRequestDataAttributes'
id:
description: Unique identifier for the new connection resource.
type: string
type:
- $ref: "#/components/schemas/UpdateConnectionRequestDataType"
+ $ref: '#/components/schemas/UpdateConnectionRequestDataType'
required:
- type
type: object
@@ -24382,7 +24382,7 @@ components:
fields:
description: List of custom attribute fields to import from the data source.
items:
- $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems"
+ $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems'
type: array
join_attribute:
description: The attribute in the data source used to join records with the entity.
@@ -24442,7 +24442,7 @@ components:
description: Request object to create a custom framework.
properties:
data:
- $ref: "#/components/schemas/CustomFrameworkData"
+ $ref: '#/components/schemas/CustomFrameworkData'
required:
- data
type: object
@@ -24450,7 +24450,7 @@ components:
description: Response object to create a custom framework.
properties:
data:
- $ref: "#/components/schemas/FrameworkHandleAndVersionResponseData"
+ $ref: '#/components/schemas/FrameworkHandleAndVersionResponseData'
required:
- data
type: object
@@ -24458,7 +24458,7 @@ components:
description: Object needed to create a data deletion request.
properties:
data:
- $ref: "#/components/schemas/CreateDataDeletionRequestBodyData"
+ $ref: '#/components/schemas/CreateDataDeletionRequestBodyData'
required:
- data
type: object
@@ -24504,9 +24504,9 @@ components:
description: Data needed to create a data deletion request.
properties:
attributes:
- $ref: "#/components/schemas/CreateDataDeletionRequestBodyAttributes"
+ $ref: '#/components/schemas/CreateDataDeletionRequestBodyAttributes'
type:
- $ref: "#/components/schemas/CreateDataDeletionRequestBodyDataType"
+ $ref: '#/components/schemas/CreateDataDeletionRequestBodyDataType'
required:
- attributes
- type
@@ -24523,9 +24523,9 @@ components:
description: The response from the create data deletion request endpoint.
properties:
data:
- $ref: "#/components/schemas/DataDeletionResponseItem"
+ $ref: '#/components/schemas/DataDeletionResponseItem'
meta:
- $ref: "#/components/schemas/DataDeletionResponseMeta"
+ $ref: '#/components/schemas/DataDeletionResponseMeta'
type: object
CreateDegradationRequest:
description: Request object for creating a degradation.
@@ -24541,7 +24541,7 @@ components:
type: degradations
properties:
data:
- $ref: "#/components/schemas/CreateDegradationRequestData"
+ $ref: '#/components/schemas/CreateDegradationRequestData'
meta:
$ref: "#/components/schemas/DegradationRequestMeta"
description: The supported metadata for creating a degradation.
@@ -24550,11 +24550,11 @@ components:
description: The data object for creating a degradation.
properties:
attributes:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributes"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateDegradationRequestDataRelationships"
+ $ref: '#/components/schemas/CreateDegradationRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationRequestDataType'
required:
- attributes
- type
@@ -24568,7 +24568,7 @@ components:
- id: 1234abcd-12ab-34cd-56ef-123456abcdef
status: degraded
items:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesComponentsAffectedItems'
type: array
description:
description: The description of the degradation.
@@ -24600,7 +24600,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
required:
- id
- status
@@ -24630,7 +24630,7 @@ components:
description: The template used to create the degradation.
properties:
data:
- $ref: "#/components/schemas/CreateDegradationRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/CreateDegradationRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -24642,7 +24642,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
- id
@@ -24651,15 +24651,15 @@ components:
description: Request object for creating a degradation template.
properties:
data:
- $ref: "#/components/schemas/CreateDegradationTemplateRequestData"
+ $ref: '#/components/schemas/CreateDegradationTemplateRequestData'
type: object
CreateDegradationTemplateRequestData:
description: The data object for creating a degradation template.
properties:
attributes:
- $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributes"
+ $ref: '#/components/schemas/CreateDegradationTemplateRequestDataAttributes'
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
type: object
@@ -24669,7 +24669,7 @@ components:
components_affected:
description: The components affected by a degradation created from this template.
items:
- $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateDegradationTemplateRequestDataAttributesComponentsAffectedItems'
type: array
degradation_title:
description: The title used for a degradation created from this template.
@@ -24681,7 +24681,7 @@ components:
updates:
description: The pre-filled updates for a degradation created from this template.
items:
- $ref: "#/components/schemas/CreateDegradationTemplateRequestDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/CreateDegradationTemplateRequestDataAttributesUpdatesItems'
type: array
required:
- name
@@ -24698,7 +24698,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -24710,7 +24710,7 @@ components:
description: The message of the update.
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
required:
- status
type: object
@@ -24718,7 +24718,7 @@ components:
description: Parameters for creating a deployment gate.
properties:
data:
- $ref: "#/components/schemas/CreateDeploymentGateParamsData"
+ $ref: '#/components/schemas/CreateDeploymentGateParamsData'
required:
- data
type: object
@@ -24726,9 +24726,9 @@ components:
description: Parameters for creating a deployment gate.
properties:
attributes:
- $ref: "#/components/schemas/CreateDeploymentGateParamsDataAttributes"
+ $ref: '#/components/schemas/CreateDeploymentGateParamsDataAttributes'
type:
- $ref: "#/components/schemas/DeploymentGateDataType"
+ $ref: '#/components/schemas/DeploymentGateDataType'
required:
- type
- attributes
@@ -24762,15 +24762,15 @@ components:
description: Parameters for creating a deployment rule.
properties:
data:
- $ref: "#/components/schemas/CreateDeploymentRuleParamsData"
+ $ref: '#/components/schemas/CreateDeploymentRuleParamsData'
type: object
CreateDeploymentRuleParamsData:
description: Parameters for creating a deployment rule.
properties:
attributes:
- $ref: "#/components/schemas/CreateDeploymentRuleParamsDataAttributes"
+ $ref: '#/components/schemas/CreateDeploymentRuleParamsDataAttributes'
type:
- $ref: "#/components/schemas/DeploymentRuleDataType"
+ $ref: '#/components/schemas/DeploymentRuleDataType'
required:
- type
- attributes
@@ -24788,7 +24788,7 @@ components:
example: "My deployment rule"
type: string
options:
- $ref: "#/components/schemas/DeploymentRulesOptions"
+ $ref: '#/components/schemas/DeploymentRulesOptions'
type:
description: The type of the deployment rule (faulty_deployment_detection or monitor).
example: "faulty_deployment_detection"
@@ -24810,10 +24810,10 @@ components:
example:
- html
items:
- $ref: "#/components/schemas/NotificationChannelEmailFormatType"
+ $ref: '#/components/schemas/NotificationChannelEmailFormatType'
type: array
type:
- $ref: "#/components/schemas/NotificationChannelEmailConfigType"
+ $ref: '#/components/schemas/NotificationChannelEmailConfigType'
required:
- type
- address
@@ -24852,9 +24852,9 @@ components:
description: Data for creating a new environment.
properties:
attributes:
- $ref: "#/components/schemas/CreateEnvironmentAttributes"
+ $ref: '#/components/schemas/CreateEnvironmentAttributes'
type:
- $ref: "#/components/schemas/CreateEnvironmentDataType"
+ $ref: '#/components/schemas/CreateEnvironmentDataType'
required:
- type
- attributes
@@ -24871,7 +24871,7 @@ components:
description: Request to create a new environment.
properties:
data:
- $ref: "#/components/schemas/CreateEnvironmentData"
+ $ref: '#/components/schemas/CreateEnvironmentData'
required:
- data
type: object
@@ -24888,7 +24888,7 @@ components:
example: "This is an example feature flag for demonstration"
type: string
distribution_channel:
- $ref: "#/components/schemas/FeatureFlagDistributionChannel"
+ $ref: '#/components/schemas/FeatureFlagDistributionChannel'
json_schema:
description: JSON schema for validation when value_type is JSON.
example: '{"type": "object", "properties": {"enabled": {"type": "boolean"}}}'
@@ -24907,7 +24907,7 @@ components:
example: false
type: boolean
staleness_status:
- $ref: "#/components/schemas/CreateFeatureFlagStalenessStatus"
+ $ref: '#/components/schemas/CreateFeatureFlagStalenessStatus'
tags:
description: Tags associated with the feature flag.
example: []
@@ -24916,11 +24916,11 @@ components:
type: string
type: array
value_type:
- $ref: "#/components/schemas/ValueType"
+ $ref: '#/components/schemas/ValueType'
variants:
description: The variants of the feature flag.
items:
- $ref: "#/components/schemas/CreateVariant"
+ $ref: '#/components/schemas/CreateVariant'
type: array
required:
- key
@@ -24932,9 +24932,9 @@ components:
description: Data for creating a new feature flag.
properties:
attributes:
- $ref: "#/components/schemas/CreateFeatureFlagAttributes"
+ $ref: '#/components/schemas/CreateFeatureFlagAttributes'
type:
- $ref: "#/components/schemas/CreateFeatureFlagDataType"
+ $ref: '#/components/schemas/CreateFeatureFlagDataType'
required:
- type
- attributes
@@ -24951,7 +24951,7 @@ components:
description: Request to create a new feature flag.
properties:
data:
- $ref: "#/components/schemas/CreateFeatureFlagData"
+ $ref: '#/components/schemas/CreateFeatureFlagData'
required:
- data
type: object
@@ -24969,9 +24969,9 @@ components:
description: The data for creating a form.
properties:
attributes:
- $ref: "#/components/schemas/CreateFormDataAttributes"
+ $ref: '#/components/schemas/CreateFormDataAttributes'
type:
- $ref: "#/components/schemas/FormType"
+ $ref: '#/components/schemas/FormType'
required:
- attributes
- type
@@ -24985,7 +24985,7 @@ components:
example: false
type: boolean
data_definition:
- $ref: "#/components/schemas/FormDataDefinition"
+ $ref: '#/components/schemas/FormDataDefinition'
description:
description: The description of the form.
example: A form to collect user feedback.
@@ -25005,7 +25005,7 @@ components:
example: false
type: boolean
ui_definition:
- $ref: "#/components/schemas/FormUiDefinition"
+ $ref: '#/components/schemas/FormUiDefinition'
required:
- data_definition
- name
@@ -25015,7 +25015,7 @@ components:
description: A request to create a form.
properties:
data:
- $ref: "#/components/schemas/CreateFormData"
+ $ref: '#/components/schemas/CreateFormData'
required:
- data
type: object
@@ -25023,7 +25023,7 @@ components:
description: Create request for a notification rule.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateData"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateData'
required:
- data
type: object
@@ -25031,7 +25031,7 @@ components:
description: Create request for a notification template.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationTemplateCreateData"
+ $ref: '#/components/schemas/IncidentNotificationTemplateCreateData'
required:
- data
type: object
@@ -25041,7 +25041,7 @@ components:
data:
description: Array of Jira issue creation request data objects.
items:
- $ref: "#/components/schemas/CreateJiraIssueRequestData"
+ $ref: '#/components/schemas/CreateJiraIssueRequestData'
type: array
required:
- data
@@ -25050,11 +25050,11 @@ components:
description: Data of the Jira issue to create.
properties:
attributes:
- $ref: "#/components/schemas/CreateJiraIssueRequestDataAttributes"
+ $ref: '#/components/schemas/CreateJiraIssueRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateJiraIssueRequestDataRelationships"
+ $ref: '#/components/schemas/CreateJiraIssueRequestDataRelationships'
type:
- $ref: "#/components/schemas/JiraIssuesDataType"
+ $ref: '#/components/schemas/JiraIssuesDataType'
required:
- type
type: object
@@ -25102,7 +25102,7 @@ components:
data:
description: Array of Linear issue creation request data objects.
items:
- $ref: "#/components/schemas/CreateLinearIssueRequestData"
+ $ref: '#/components/schemas/CreateLinearIssueRequestData'
type: array
required:
- data
@@ -25111,11 +25111,11 @@ components:
description: Data of the Linear issue to create.
properties:
attributes:
- $ref: "#/components/schemas/CreateLinearIssueRequestDataAttributes"
+ $ref: '#/components/schemas/CreateLinearIssueRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateLinearIssueRequestDataRelationships"
+ $ref: '#/components/schemas/CreateLinearIssueRequestDataRelationships'
type:
- $ref: "#/components/schemas/LinearIssuesDataType"
+ $ref: '#/components/schemas/LinearIssuesDataType'
required:
- type
type: object
@@ -25181,17 +25181,17 @@ components:
type: maintenances
properties:
data:
- $ref: "#/components/schemas/CreateMaintenanceRequestData"
+ $ref: '#/components/schemas/CreateMaintenanceRequestData'
type: object
CreateMaintenanceRequestData:
description: The data object for creating a maintenance.
properties:
attributes:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributes"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataRelationships"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataType'
required:
- attributes
- type
@@ -25211,7 +25211,7 @@ components:
components_affected:
description: The components affected by the maintenance.
items:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems'
type: array
in_progress_description:
description: The description shown while the maintenance is in progress.
@@ -25251,7 +25251,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -25277,7 +25277,7 @@ components:
description: The template used to create the maintenance.
properties:
data:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -25289,7 +25289,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
- id
@@ -25298,15 +25298,15 @@ components:
description: Request object for creating a maintenance template.
properties:
data:
- $ref: "#/components/schemas/CreateMaintenanceTemplateRequestData"
+ $ref: '#/components/schemas/CreateMaintenanceTemplateRequestData'
type: object
CreateMaintenanceTemplateRequestData:
description: The data object for creating a maintenance template.
properties:
attributes:
- $ref: "#/components/schemas/CreateMaintenanceTemplateRequestDataAttributes"
+ $ref: '#/components/schemas/CreateMaintenanceTemplateRequestDataAttributes'
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
type: object
@@ -25347,15 +25347,15 @@ components:
CreateNotificationChannelConfig:
description: "Defines the configuration for creating an On-Call notification channel"
oneOf:
- - $ref: "#/components/schemas/CreatePhoneNotificationChannelConfig"
- - $ref: "#/components/schemas/CreateEmailNotificationChannelConfig"
+ - $ref: '#/components/schemas/CreatePhoneNotificationChannelConfig'
+ - $ref: '#/components/schemas/CreateEmailNotificationChannelConfig'
CreateNotificationChannelData:
description: Data for creating an on-call notification channel
properties:
attributes:
- $ref: "#/components/schemas/CreateNotificationChannelAttributes"
+ $ref: '#/components/schemas/CreateNotificationChannelAttributes'
type:
- $ref: "#/components/schemas/NotificationChannelType"
+ $ref: '#/components/schemas/NotificationChannelType'
required:
- type
type: object
@@ -25363,16 +25363,16 @@ components:
description: Body of the notification rule create request.
properties:
data:
- $ref: "#/components/schemas/CreateNotificationRuleParametersData"
+ $ref: '#/components/schemas/CreateNotificationRuleParametersData'
type: object
CreateNotificationRuleParametersData:
description: |-
Data of the notification rule create request: the rule type, and the rule attributes. All fields are required.
properties:
attributes:
- $ref: "#/components/schemas/CreateNotificationRuleParametersDataAttributes"
+ $ref: '#/components/schemas/CreateNotificationRuleParametersDataAttributes'
type:
- $ref: "#/components/schemas/NotificationRulesType"
+ $ref: '#/components/schemas/NotificationRulesType'
required:
- attributes
- type
@@ -25382,17 +25382,17 @@ components:
Attributes of the notification rule create request.
properties:
enabled:
- $ref: "#/components/schemas/Enabled"
+ $ref: '#/components/schemas/Enabled'
name:
- $ref: "#/components/schemas/RuleName"
+ $ref: '#/components/schemas/RuleName'
routing:
- $ref: "#/components/schemas/NotificationRuleRouting"
+ $ref: '#/components/schemas/NotificationRuleRouting'
selectors:
- $ref: "#/components/schemas/Selectors"
+ $ref: '#/components/schemas/Selectors'
targets:
- $ref: "#/components/schemas/Targets"
+ $ref: '#/components/schemas/Targets'
time_aggregation:
- $ref: "#/components/schemas/TimeAggregation"
+ $ref: '#/components/schemas/TimeAggregation'
required:
- selectors
- name
@@ -25416,7 +25416,7 @@ components:
type: notification_rules
properties:
data:
- $ref: "#/components/schemas/CreateOnCallNotificationRuleRequestData"
+ $ref: '#/components/schemas/CreateOnCallNotificationRuleRequestData'
required:
- data
type: object
@@ -25424,11 +25424,11 @@ components:
description: Data for creating an on-call notification rule
properties:
attributes:
- $ref: "#/components/schemas/OnCallNotificationRuleRequestAttributes"
+ $ref: '#/components/schemas/OnCallNotificationRuleRequestAttributes'
relationships:
- $ref: "#/components/schemas/OnCallNotificationRuleRelationships"
+ $ref: '#/components/schemas/OnCallNotificationRuleRelationships'
type:
- $ref: "#/components/schemas/OnCallNotificationRuleType"
+ $ref: '#/components/schemas/OnCallNotificationRuleType'
required:
- type
type: object
@@ -25436,7 +25436,7 @@ components:
description: Response for `CreateOpenAPI` operation.
properties:
data:
- $ref: "#/components/schemas/CreateOpenAPIResponseData"
+ $ref: '#/components/schemas/CreateOpenAPIResponseData'
type: object
CreateOpenAPIResponseAttributes:
description: Attributes for `CreateOpenAPI`.
@@ -25444,22 +25444,22 @@ components:
failed_endpoints:
description: List of endpoints which couldn't be parsed.
items:
- $ref: "#/components/schemas/OpenAPIEndpoint"
+ $ref: '#/components/schemas/OpenAPIEndpoint'
type: array
type: object
CreateOpenAPIResponseData:
description: Data envelope for `CreateOpenAPIResponse`.
properties:
attributes:
- $ref: "#/components/schemas/CreateOpenAPIResponseAttributes"
+ $ref: '#/components/schemas/CreateOpenAPIResponseAttributes'
id:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
type: object
CreateOrUpdateWidgetRequest:
description: Request body for creating or updating a widget.
properties:
data:
- $ref: "#/components/schemas/CreateOrUpdateWidgetRequestData"
+ $ref: '#/components/schemas/CreateOrUpdateWidgetRequestData'
required:
- data
type: object
@@ -25467,7 +25467,7 @@ components:
description: Attributes for creating or updating a widget.
properties:
definition:
- $ref: "#/components/schemas/WidgetDefinition"
+ $ref: '#/components/schemas/WidgetDefinition'
tags:
description: User-defined tags for organizing the widget.
items:
@@ -25482,7 +25482,7 @@ components:
description: Data for creating or updating a widget.
properties:
attributes:
- $ref: "#/components/schemas/CreateOrUpdateWidgetRequestAttributes"
+ $ref: '#/components/schemas/CreateOrUpdateWidgetRequestAttributes'
type:
description: Widgets resource type.
example: widgets
@@ -25507,15 +25507,15 @@ components:
type: pages
properties:
data:
- $ref: "#/components/schemas/CreatePageRequestData"
+ $ref: '#/components/schemas/CreatePageRequestData'
type: object
CreatePageRequestData:
description: The main request body, including attributes and resource type.
properties:
attributes:
- $ref: "#/components/schemas/CreatePageRequestDataAttributes"
+ $ref: '#/components/schemas/CreatePageRequestDataAttributes'
type:
- $ref: "#/components/schemas/CreatePageRequestDataType"
+ $ref: '#/components/schemas/CreatePageRequestDataType'
required:
- type
type: object
@@ -25532,13 +25532,13 @@ components:
type: string
type: array
target:
- $ref: "#/components/schemas/CreatePageRequestDataAttributesTarget"
+ $ref: '#/components/schemas/CreatePageRequestDataAttributesTarget'
title:
description: The title of the page.
example: "Service: Test is down"
type: string
urgency:
- $ref: "#/components/schemas/PageUrgency"
+ $ref: '#/components/schemas/PageUrgency'
required:
- target
- title
@@ -25551,7 +25551,7 @@ components:
description: Identifier for the target (for example, team handle or user ID).
type: string
type:
- $ref: "#/components/schemas/OnCallPageTargetType"
+ $ref: '#/components/schemas/OnCallPageTargetType'
type: object
CreatePageRequestDataType:
default: pages
@@ -25570,7 +25570,7 @@ components:
type: pages
properties:
data:
- $ref: "#/components/schemas/CreatePageResponseData"
+ $ref: '#/components/schemas/CreatePageResponseData'
type: object
CreatePageResponseData:
description: The information returned after successfully creating a page.
@@ -25579,7 +25579,7 @@ components:
description: The unique ID of the created page.
type: string
type:
- $ref: "#/components/schemas/CreatePageResponseDataType"
+ $ref: '#/components/schemas/CreatePageResponseDataType'
required:
- type
type: object
@@ -25600,7 +25600,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/NotificationChannelPhoneConfigType"
+ $ref: '#/components/schemas/NotificationChannelPhoneConfigType'
required:
- type
- number
@@ -25615,15 +25615,15 @@ components:
type: publishRequest
properties:
data:
- $ref: "#/components/schemas/CreatePublishRequestRequestData"
+ $ref: '#/components/schemas/CreatePublishRequestRequestData'
type: object
CreatePublishRequestRequestData:
description: Data for creating a publish request.
properties:
attributes:
- $ref: "#/components/schemas/CreatePublishRequestRequestDataAttributes"
+ $ref: '#/components/schemas/CreatePublishRequestRequestDataAttributes'
type:
- $ref: "#/components/schemas/PublishRequestType"
+ $ref: '#/components/schemas/PublishRequestType'
type: object
CreatePublishRequestRequestDataAttributes:
description: Attributes for creating a publish request.
@@ -25643,33 +25643,33 @@ components:
description: Scorecard create rule request.
properties:
data:
- $ref: "#/components/schemas/CreateRuleRequestData"
+ $ref: '#/components/schemas/CreateRuleRequestData'
type: object
CreateRuleRequestData:
description: Scorecard create rule request data.
properties:
attributes:
- $ref: "#/components/schemas/RuleAttributesRequest"
+ $ref: '#/components/schemas/RuleAttributesRequest'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
CreateRuleResponse:
description: Created rule in response.
properties:
data:
- $ref: "#/components/schemas/CreateRuleResponseData"
+ $ref: '#/components/schemas/CreateRuleResponseData'
type: object
CreateRuleResponseData:
description: Create rule response data.
properties:
attributes:
- $ref: "#/components/schemas/RuleAttributes"
+ $ref: '#/components/schemas/RuleAttributes'
id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
relationships:
- $ref: "#/components/schemas/RelationshipToRule"
+ $ref: '#/components/schemas/RelationshipToRule'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
CreateRulesetRequest:
description: The definition of `CreateRulesetRequest` object.
@@ -25694,18 +25694,18 @@ components:
type: create_ruleset
properties:
data:
- $ref: "#/components/schemas/CreateRulesetRequestData"
+ $ref: '#/components/schemas/CreateRulesetRequestData'
type: object
CreateRulesetRequestData:
description: The definition of `CreateRulesetRequestData` object.
properties:
attributes:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributes"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributes'
id:
description: The `CreateRulesetRequestData` `id`.
type: string
type:
- $ref: "#/components/schemas/CreateRulesetRequestDataType"
+ $ref: '#/components/schemas/CreateRulesetRequestDataType'
required:
- type
type: object
@@ -25718,7 +25718,7 @@ components:
rules:
description: The `attributes` `rules`.
items:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItems"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItems'
type: array
required:
- rules
@@ -25731,17 +25731,17 @@ components:
example: false
type: boolean
mapping:
- $ref: "#/components/schemas/DataAttributesRulesItemsMapping"
+ $ref: '#/components/schemas/DataAttributesRulesItemsMapping'
metadata:
- $ref: "#/components/schemas/RulesetItemMetadata"
+ $ref: '#/components/schemas/RulesetItemMetadata'
name:
description: The `items` `name`.
example: ""
type: string
query:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQuery"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQuery'
reference_table:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTable"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTable'
required:
- enabled
- name
@@ -25751,7 +25751,7 @@ components:
nullable: true
properties:
addition:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQueryAddition"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsQueryAddition'
case_insensitivity:
description: The `query` `case_insensitivity`.
type: boolean
@@ -25760,7 +25760,7 @@ components:
description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
query:
description: The `query` `query`.
example: ""
@@ -25795,14 +25795,14 @@ components:
field_pairs:
description: The `reference_table` `field_pairs`.
items:
- $ref: "#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems"
+ $ref: '#/components/schemas/CreateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems'
type: array
if_not_exists:
deprecated: true
description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
source_keys:
description: The `reference_table` `source_keys`.
example:
@@ -25850,7 +25850,7 @@ components:
data:
description: Array of ServiceNow ticket creation request data objects.
items:
- $ref: "#/components/schemas/CreateServiceNowTicketRequestData"
+ $ref: '#/components/schemas/CreateServiceNowTicketRequestData'
type: array
required:
- data
@@ -25859,11 +25859,11 @@ components:
description: Data of the ServiceNow ticket to create.
properties:
attributes:
- $ref: "#/components/schemas/CreateServiceNowTicketRequestDataAttributes"
+ $ref: '#/components/schemas/CreateServiceNowTicketRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/CreateServiceNowTicketRequestDataRelationships"
+ $ref: '#/components/schemas/CreateServiceNowTicketRequestDataRelationships'
type:
- $ref: "#/components/schemas/ServiceNowTicketsDataType"
+ $ref: '#/components/schemas/ServiceNowTicketsDataType'
required:
- relationships
- type
@@ -25905,9 +25905,9 @@ components:
description: Additional configuration options for snapshot creation.
properties:
template_variables:
- $ref: "#/components/schemas/CreateSnapshotTemplateVariables"
+ $ref: '#/components/schemas/CreateSnapshotTemplateVariables'
timeseries_legend_type:
- $ref: "#/components/schemas/CreateSnapshotTimeseriesLegendType"
+ $ref: '#/components/schemas/CreateSnapshotTimeseriesLegendType'
timezone_offset_minutes:
description: Timezone offset in minutes from UTC. Positive values are west of UTC (for example, `300` for UTC-5). Use `0` for UTC.
example: 300
@@ -25918,7 +25918,7 @@ components:
description: Attributes for snapshot creation.
properties:
additional_config:
- $ref: "#/components/schemas/CreateSnapshotAdditionalConfig"
+ $ref: '#/components/schemas/CreateSnapshotAdditionalConfig'
end:
description: End of the time window for the snapshot, in milliseconds since Unix epoch.
example: 1692464800000
@@ -25939,7 +25939,7 @@ components:
format: int64
type: integer
ttl:
- $ref: "#/components/schemas/CreateSnapshotTTL"
+ $ref: '#/components/schemas/CreateSnapshotTTL'
widget_definition:
additionalProperties: {}
description: The widget definition to render as a snapshot. Must include a valid `type` field and non-empty `requests` array.
@@ -25972,9 +25972,9 @@ components:
description: Data envelope for snapshot creation.
properties:
attributes:
- $ref: "#/components/schemas/CreateSnapshotDataAttributesRequest"
+ $ref: '#/components/schemas/CreateSnapshotDataAttributesRequest'
type:
- $ref: "#/components/schemas/CreateSnapshotType"
+ $ref: '#/components/schemas/CreateSnapshotType'
required:
- type
- attributes
@@ -25983,13 +25983,13 @@ components:
description: Data envelope for the snapshot creation response.
properties:
attributes:
- $ref: "#/components/schemas/CreateSnapshotDataAttributesResponse"
+ $ref: '#/components/schemas/CreateSnapshotDataAttributesResponse'
id:
description: The unique identifier of the created snapshot.
example: 12345678-1234-5678-9abc-def123456789
type: string
type:
- $ref: "#/components/schemas/CreateSnapshotType"
+ $ref: '#/components/schemas/CreateSnapshotType'
required:
- id
- type
@@ -25999,7 +25999,7 @@ components:
description: Request body for creating a graph snapshot.
properties:
data:
- $ref: "#/components/schemas/CreateSnapshotDataRequest"
+ $ref: '#/components/schemas/CreateSnapshotDataRequest'
required:
- data
type: object
@@ -26007,7 +26007,7 @@ components:
description: Response body for a snapshot creation request.
properties:
data:
- $ref: "#/components/schemas/CreateSnapshotDataResponse"
+ $ref: '#/components/schemas/CreateSnapshotDataResponse'
required:
- data
type: object
@@ -26057,7 +26057,7 @@ components:
CreateSnapshotTemplateVariables:
description: List of template variable definitions for snapshot rendering.
items:
- $ref: "#/components/schemas/CreateSnapshotTemplateVariable"
+ $ref: '#/components/schemas/CreateSnapshotTemplateVariable'
type: array
CreateSnapshotTimeseriesLegendType:
description: The legend display type for timeseries widgets. A value of `none` hides the legend entirely; omitting the field lets the frontend choose automatically.
@@ -26112,15 +26112,15 @@ components:
type: status_pages
properties:
data:
- $ref: "#/components/schemas/CreateStatusPageRequestData"
+ $ref: '#/components/schemas/CreateStatusPageRequestData'
type: object
CreateStatusPageRequestData:
description: The data object for creating a status page.
properties:
attributes:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributes"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributes'
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- attributes
- type
@@ -26152,7 +26152,7 @@ components:
position: 2
type: component
items:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItems"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItems'
type: array
domain_prefix:
description: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages.
@@ -26198,7 +26198,7 @@ components:
components:
description: If creating a component of type `group`, the components to create within the group.
items:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems'
type: array
id:
description: The ID of the component.
@@ -26213,9 +26213,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesType'
type: object
CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems:
description: A grouped component to be created within a status page component group.
@@ -26233,9 +26233,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
type: object
CreateStatusPageRequestDataAttributesType:
description: The type of the status page controlling how the status page is accessed.
@@ -26263,16 +26263,16 @@ components:
description: Request body for creating a new reference table from a local file or cloud storage.
properties:
data:
- $ref: "#/components/schemas/CreateTableRequestData"
+ $ref: '#/components/schemas/CreateTableRequestData'
type: object
CreateTableRequestData:
additionalProperties: false
description: The data object containing the table definition.
properties:
attributes:
- $ref: "#/components/schemas/CreateTableRequestDataAttributes"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributes'
type:
- $ref: "#/components/schemas/CreateTableRequestDataType"
+ $ref: '#/components/schemas/CreateTableRequestDataType'
required:
- type
type: object
@@ -26283,11 +26283,11 @@ components:
description: Optional text describing the purpose or contents of this reference table.
type: string
file_metadata:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadata"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadata'
schema:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesSchema"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesSchema'
source:
- $ref: "#/components/schemas/ReferenceTableCreateSourceType"
+ $ref: '#/components/schemas/ReferenceTableCreateSourceType'
table_name:
description: Name to identify this reference table.
example: "table_1"
@@ -26309,14 +26309,14 @@ components:
CreateTableRequestDataAttributesFileMetadata:
description: Metadata specifying where and how to access the reference table's data file.
oneOf:
- - $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage"
- - $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile"
+ - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataCloudStorage'
+ - $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataLocalFile'
CreateTableRequestDataAttributesFileMetadataCloudStorage:
additionalProperties: false
description: Cloud storage file metadata for create requests. Both access_details and sync_enabled are required.
properties:
access_details:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetails'
sync_enabled:
description: Whether this table is synced automatically.
example: false
@@ -26342,11 +26342,11 @@ components:
description: Cloud storage access configuration for the reference table data file.
properties:
aws_detail:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail'
azure_detail:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail'
gcp_detail:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail'
type: object
CreateTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail:
description: Amazon Web Services S3 storage access configuration.
@@ -26435,7 +26435,7 @@ components:
fields:
description: The schema fields. Maximum of 200 columns.
items:
- $ref: "#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems"
+ $ref: '#/components/schemas/CreateTableRequestDataAttributesSchemaFieldsItems'
maxItems: 200
minItems: 1
type: array
@@ -26459,7 +26459,7 @@ components:
example: "field_1"
type: string
type:
- $ref: "#/components/schemas/ReferenceTableSchemaFieldType"
+ $ref: '#/components/schemas/ReferenceTableSchemaFieldType'
required:
- name
- type
@@ -26477,13 +26477,13 @@ components:
description: The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes.
properties:
attributes:
- $ref: "#/components/schemas/CreateTenancyConfigDataAttributes"
+ $ref: '#/components/schemas/CreateTenancyConfigDataAttributes'
id:
description: The OCID of the OCI tenancy to configure.
example: ""
type: string
type:
- $ref: "#/components/schemas/UpdateTenancyConfigDataType"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataType'
required:
- type
- id
@@ -26492,7 +26492,7 @@ components:
description: Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options.
properties:
auth_credentials:
- $ref: "#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials"
+ $ref: '#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials'
config_version:
description: Version number of the integration the tenancy is integrated with
format: int64
@@ -26512,11 +26512,11 @@ components:
example: ""
type: string
logs_config:
- $ref: "#/components/schemas/CreateTenancyConfigDataAttributesLogsConfig"
+ $ref: '#/components/schemas/CreateTenancyConfigDataAttributesLogsConfig'
metrics_config:
- $ref: "#/components/schemas/CreateTenancyConfigDataAttributesMetricsConfig"
+ $ref: '#/components/schemas/CreateTenancyConfigDataAttributesMetricsConfig'
regions_config:
- $ref: "#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig"
+ $ref: '#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig'
resource_collection_enabled:
description: Whether resource collection from OCI is enabled for the tenancy.
type: boolean
@@ -26664,7 +26664,7 @@ components:
type: oci_tenancy
properties:
data:
- $ref: "#/components/schemas/CreateTenancyConfigData"
+ $ref: '#/components/schemas/CreateTenancyConfigData'
required:
- data
type: object
@@ -26683,16 +26683,16 @@ components:
type: upload
properties:
data:
- $ref: "#/components/schemas/CreateUploadRequestData"
+ $ref: '#/components/schemas/CreateUploadRequestData'
type: object
CreateUploadRequestData:
additionalProperties: false
description: Request data for creating an upload for a file to be ingested into a reference table.
properties:
attributes:
- $ref: "#/components/schemas/CreateUploadRequestDataAttributes"
+ $ref: '#/components/schemas/CreateUploadRequestDataAttributes'
type:
- $ref: "#/components/schemas/CreateUploadRequestDataType"
+ $ref: '#/components/schemas/CreateUploadRequestDataType'
required:
- type
type: object
@@ -26744,19 +26744,19 @@ components:
description: Information about the upload created containing the upload ID and pre-signed URLs to PUT chunks of the CSV file to.
properties:
data:
- $ref: "#/components/schemas/CreateUploadResponseData"
+ $ref: '#/components/schemas/CreateUploadResponseData'
type: object
CreateUploadResponseData:
additionalProperties: false
description: Upload ID and attributes of the created upload.
properties:
attributes:
- $ref: "#/components/schemas/CreateUploadResponseDataAttributes"
+ $ref: '#/components/schemas/CreateUploadResponseDataAttributes'
id:
description: Unique identifier for this upload. Use this ID when creating the reference table.
type: string
type:
- $ref: "#/components/schemas/CreateUploadResponseDataType"
+ $ref: '#/components/schemas/CreateUploadResponseDataType'
required:
- type
type: object
@@ -26791,7 +26791,7 @@ components:
type: notification_channels
properties:
data:
- $ref: "#/components/schemas/CreateNotificationChannelData"
+ $ref: '#/components/schemas/CreateNotificationChannelData'
required:
- data
type: object
@@ -26879,7 +26879,7 @@ components:
type: "workflows"
properties:
data:
- $ref: "#/components/schemas/WorkflowData"
+ $ref: '#/components/schemas/WorkflowData'
required:
- data
type: object
@@ -26887,7 +26887,7 @@ components:
description: The response object after creating a new workflow.
properties:
data:
- $ref: "#/components/schemas/WorkflowData"
+ $ref: '#/components/schemas/WorkflowData'
required:
- data
type: object
@@ -26917,13 +26917,13 @@ components:
description: Single Agent Data.
properties:
attributes:
- $ref: "#/components/schemas/CsmAgentsAttributes"
+ $ref: '#/components/schemas/CsmAgentsAttributes'
id:
description: "The ID of the Agent."
example: "fffffc5505f6a006fdf7cf5aae053653"
type: string
type:
- $ref: "#/components/schemas/CSMAgentsType"
+ $ref: '#/components/schemas/CSMAgentsType'
type: object
CsmAgentlessHostAttributes:
description: Attributes of an agentless host.
@@ -26933,7 +26933,7 @@ components:
example: "123456789012"
type: string
cloud_provider:
- $ref: "#/components/schemas/CsmCloudProvider"
+ $ref: '#/components/schemas/CsmCloudProvider'
has_posture_management:
description: Whether CSM Misconfigurations is enabled for this host. `true` if enabled; `false` if disabled.
example: true
@@ -26943,7 +26943,7 @@ components:
example: true
type: boolean
resource_type:
- $ref: "#/components/schemas/CsmAgentlessHostResourceType"
+ $ref: '#/components/schemas/CsmAgentlessHostResourceType'
required:
- account_id
- cloud_provider
@@ -26955,13 +26955,13 @@ components:
description: A single agentless host resource.
properties:
attributes:
- $ref: "#/components/schemas/CsmAgentlessHostAttributes"
+ $ref: '#/components/schemas/CsmAgentlessHostAttributes'
id:
description: The resource identifier of the agentless host.
example: i-0123456789abcdef0
type: string
type:
- $ref: "#/components/schemas/CsmAgentlessHostType"
+ $ref: '#/components/schemas/CsmAgentlessHostType'
required:
- id
- type
@@ -26983,7 +26983,7 @@ components:
example: true
type: boolean
defaultValues:
- $ref: "#/components/schemas/CsmHostFacetDefaultValues"
+ $ref: '#/components/schemas/CsmHostFacetDefaultValues'
description:
description: A human-readable description of what the facet represents.
example: The cloud provider of the resource
@@ -26997,7 +26997,7 @@ components:
example: list
type: string
groups:
- $ref: "#/components/schemas/CsmHostFacetGroups"
+ $ref: '#/components/schemas/CsmHostFacetGroups'
name:
description: The display name of the facet.
example: Cloud Provider
@@ -27015,7 +27015,7 @@ components:
example: string
type: string
values:
- $ref: "#/components/schemas/CsmHostFacetValues"
+ $ref: '#/components/schemas/CsmHostFacetValues'
required:
- name
- path
@@ -27035,13 +27035,13 @@ components:
description: A single agentless host facet resource.
properties:
attributes:
- $ref: "#/components/schemas/CsmAgentlessHostFacetAttributes"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetAttributes'
id:
description: The identifier of the facet, corresponding to the field path.
example: cloud_provider
type: string
type:
- $ref: "#/components/schemas/CsmAgentlessHostFacetType"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetType'
required:
- id
- type
@@ -27050,7 +27050,7 @@ components:
CsmAgentlessHostFacetItems:
description: The list of available facets for agentless hosts.
items:
- $ref: "#/components/schemas/CsmAgentlessHostFacetData"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetData'
type: array
CsmAgentlessHostFacetType:
default: agentless_host_facet
@@ -27065,14 +27065,14 @@ components:
description: The response returned when listing facets for agentless hosts.
properties:
data:
- $ref: "#/components/schemas/CsmAgentlessHostFacetItems"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetItems'
required:
- data
type: object
CsmAgentlessHostItems:
description: The list of agentless hosts for the current page.
items:
- $ref: "#/components/schemas/CsmAgentlessHostData"
+ $ref: '#/components/schemas/CsmAgentlessHostData'
type: array
CsmAgentlessHostResourceType:
description: The type of cloud resource for an agentless host.
@@ -27101,9 +27101,9 @@ components:
description: The response returned when listing agentless hosts.
properties:
data:
- $ref: "#/components/schemas/CsmAgentlessHostItems"
+ $ref: '#/components/schemas/CsmAgentlessHostItems'
meta:
- $ref: "#/components/schemas/CsmSettingsMeta"
+ $ref: '#/components/schemas/CsmSettingsMeta'
required:
- data
- meta
@@ -27183,33 +27183,33 @@ components:
data:
description: A list of Agents.
items:
- $ref: "#/components/schemas/CsmAgentData"
+ $ref: '#/components/schemas/CsmAgentData'
type: array
meta:
- $ref: "#/components/schemas/CSMAgentsMetadata"
+ $ref: '#/components/schemas/CSMAgentsMetadata'
type: object
CsmCloudAccountsCoverageAnalysisAttributes:
description: CSM Cloud Accounts Coverage Analysis attributes.
properties:
aws_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
azure_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
gcp_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
org_id:
description: The ID of your organization.
example: 123456
format: int64
type: integer
total_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
type: object
CsmCloudAccountsCoverageAnalysisData:
description: CSM Cloud Accounts Coverage Analysis data.
properties:
attributes:
- $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes"
+ $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisAttributes'
id:
description: "The ID of your organization."
example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3"
@@ -27224,7 +27224,7 @@ components:
description: CSM Cloud Accounts Coverage Analysis response.
properties:
data:
- $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisData"
+ $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisData'
type: object
CsmCloudProvider:
description: The cloud provider of a host resource.
@@ -27290,7 +27290,7 @@ components:
description: Attributes of a facet info response, containing the value distribution for the requested facet.
properties:
items:
- $ref: "#/components/schemas/CsmHostFacetInfoItems"
+ $ref: '#/components/schemas/CsmHostFacetInfoItems'
required:
- items
type: object
@@ -27298,15 +27298,15 @@ components:
description: The data wrapper for a facet info response.
properties:
attributes:
- $ref: "#/components/schemas/CsmHostFacetInfoAttributes"
+ $ref: '#/components/schemas/CsmHostFacetInfoAttributes'
id:
description: The identifier of the facet.
example: cloud_provider
type: string
meta:
- $ref: "#/components/schemas/CsmHostFacetInfoMeta"
+ $ref: '#/components/schemas/CsmHostFacetInfoMeta'
type:
- $ref: "#/components/schemas/CsmFacetInfoType"
+ $ref: '#/components/schemas/CsmFacetInfoType'
required:
- id
- type
@@ -27332,7 +27332,7 @@ components:
CsmHostFacetInfoItems:
description: The list of facet value entries for the current page.
items:
- $ref: "#/components/schemas/CsmHostFacetInfoItem"
+ $ref: '#/components/schemas/CsmHostFacetInfoItem'
type: array
CsmHostFacetInfoMeta:
description: Metadata for the facet info response.
@@ -27349,7 +27349,7 @@ components:
description: The response returned when requesting value distribution for a specific facet.
properties:
data:
- $ref: "#/components/schemas/CsmHostFacetInfoData"
+ $ref: '#/components/schemas/CsmHostFacetInfoData'
required:
- data
type: object
@@ -27365,24 +27365,24 @@ components:
description: CSM Hosts and Containers Coverage Analysis attributes.
properties:
cspm_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
cws_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
org_id:
description: The ID of your organization.
example: 123456
format: int64
type: integer
total_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
vm_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
type: object
CsmHostsAndContainersCoverageAnalysisData:
description: CSM Hosts and Containers Coverage Analysis data.
properties:
attributes:
- $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes"
+ $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisAttributes'
id:
description: "The ID of your organization."
example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3"
@@ -27397,26 +27397,26 @@ components:
description: CSM Hosts and Containers Coverage Analysis response.
properties:
data:
- $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisData"
+ $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisData'
type: object
CsmServerlessCoverageAnalysisAttributes:
description: CSM Serverless Resources Coverage Analysis attributes.
properties:
cws_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
org_id:
description: The ID of your organization.
example: 123456
format: int64
type: integer
total_coverage:
- $ref: "#/components/schemas/CsmCoverageAnalysis"
+ $ref: '#/components/schemas/CsmCoverageAnalysis'
type: object
CsmServerlessCoverageAnalysisData:
description: CSM Serverless Resources Coverage Analysis data.
properties:
attributes:
- $ref: "#/components/schemas/CsmServerlessCoverageAnalysisAttributes"
+ $ref: '#/components/schemas/CsmServerlessCoverageAnalysisAttributes'
id:
description: "The ID of your organization."
example: "66b3c6b5-5c9a-457e-b1c3-f247ca23afa3"
@@ -27431,7 +27431,7 @@ components:
description: CSM Serverless Resources Coverage Analysis response.
properties:
data:
- $ref: "#/components/schemas/CsmServerlessCoverageAnalysisData"
+ $ref: '#/components/schemas/CsmServerlessCoverageAnalysisData'
type: object
CsmSettingsMeta:
description: Pagination metadata for a CSM settings list response.
@@ -27500,7 +27500,7 @@ components:
nullable: true
type: boolean
cloud_provider:
- $ref: "#/components/schemas/CsmCloudProvider"
+ $ref: '#/components/schemas/CsmCloudProvider'
cluster_name:
description: The name of the Kubernetes cluster the host belongs to, if applicable.
example: my-cluster
@@ -27536,9 +27536,9 @@ components:
nullable: true
type: string
resource_type:
- $ref: "#/components/schemas/CsmAgentlessHostResourceType"
+ $ref: '#/components/schemas/CsmAgentlessHostResourceType'
source:
- $ref: "#/components/schemas/CsmUnifiedHostSource"
+ $ref: '#/components/schemas/CsmUnifiedHostSource'
required:
- source
type: object
@@ -27546,13 +27546,13 @@ components:
description: A single unified host resource, combining agent and agentless data.
properties:
attributes:
- $ref: "#/components/schemas/CsmUnifiedHostAttributes"
+ $ref: '#/components/schemas/CsmUnifiedHostAttributes'
id:
description: The resource identifier of the unified host.
example: i-0123456789abcdef0
type: string
type:
- $ref: "#/components/schemas/CsmUnifiedHostType"
+ $ref: '#/components/schemas/CsmUnifiedHostType'
required:
- id
- type
@@ -27562,13 +27562,13 @@ components:
description: A single unified host facet resource.
properties:
attributes:
- $ref: "#/components/schemas/CsmAgentlessHostFacetAttributes"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetAttributes'
id:
description: The identifier of the facet, corresponding to the field path.
example: cloud_provider
type: string
type:
- $ref: "#/components/schemas/CsmUnifiedHostFacetType"
+ $ref: '#/components/schemas/CsmUnifiedHostFacetType'
required:
- id
- type
@@ -27577,7 +27577,7 @@ components:
CsmUnifiedHostFacetItems:
description: The list of available facets for unified hosts.
items:
- $ref: "#/components/schemas/CsmUnifiedHostFacetData"
+ $ref: '#/components/schemas/CsmUnifiedHostFacetData'
type: array
CsmUnifiedHostFacetType:
default: unified_host_facet
@@ -27592,14 +27592,14 @@ components:
description: The response returned when listing facets for unified hosts.
properties:
data:
- $ref: "#/components/schemas/CsmUnifiedHostFacetItems"
+ $ref: '#/components/schemas/CsmUnifiedHostFacetItems'
required:
- data
type: object
CsmUnifiedHostItems:
description: The list of unified hosts for the current page.
items:
- $ref: "#/components/schemas/CsmUnifiedHostData"
+ $ref: '#/components/schemas/CsmUnifiedHostData'
type: array
CsmUnifiedHostSource:
description: The source of a unified host entry, indicating whether it was discovered via agent, agentless scanning, or both.
@@ -27655,9 +27655,9 @@ components:
description: The response returned when listing unified hosts.
properties:
data:
- $ref: "#/components/schemas/CsmUnifiedHostItems"
+ $ref: '#/components/schemas/CsmUnifiedHostItems'
meta:
- $ref: "#/components/schemas/CsmUnifiedHostsMeta"
+ $ref: '#/components/schemas/CsmUnifiedHostsMeta'
required:
- data
- meta
@@ -27666,13 +27666,13 @@ components:
description: "A custom attribute configuration that defines an organization-specific metadata field on cases. Custom attributes are scoped to a case type and can hold text, URLs, numbers, or predefined select options."
properties:
attributes:
- $ref: "#/components/schemas/CustomAttributeConfigResourceAttributes"
+ $ref: '#/components/schemas/CustomAttributeConfigResourceAttributes'
id:
description: Custom attribute configs identifier
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/CustomAttributeConfigResourceType"
+ $ref: '#/components/schemas/CustomAttributeConfigResourceType'
type: object
CustomAttributeConfigAttributesCreate:
description: Attributes required to create a custom attribute configuration.
@@ -27694,7 +27694,7 @@ components:
example: "aws_region"
type: string
type:
- $ref: "#/components/schemas/CustomAttributeType"
+ $ref: '#/components/schemas/CustomAttributeType'
required:
- display_name
- key
@@ -27705,9 +27705,9 @@ components:
description: Data object for creating a custom attribute configuration.
properties:
attributes:
- $ref: "#/components/schemas/CustomAttributeConfigAttributesCreate"
+ $ref: '#/components/schemas/CustomAttributeConfigAttributesCreate'
type:
- $ref: "#/components/schemas/CustomAttributeConfigResourceType"
+ $ref: '#/components/schemas/CustomAttributeConfigResourceType'
required:
- attributes
- type
@@ -27716,7 +27716,7 @@ components:
description: Request payload for creating a custom attribute configuration.
properties:
data:
- $ref: "#/components/schemas/CustomAttributeConfigCreate"
+ $ref: '#/components/schemas/CustomAttributeConfigCreate'
required:
- data
type: object
@@ -27744,7 +27744,7 @@ components:
example: "aws_region"
type: string
type:
- $ref: "#/components/schemas/CustomAttributeType"
+ $ref: '#/components/schemas/CustomAttributeType'
required:
- case_type_id
- display_name
@@ -27765,15 +27765,15 @@ components:
description: Response containing a single custom attribute configuration.
properties:
data:
- $ref: "#/components/schemas/CustomAttributeConfig"
+ $ref: '#/components/schemas/CustomAttributeConfig'
type: object
CustomAttributeConfigUpdate:
description: Data object for updating a custom attribute configuration.
properties:
attributes:
- $ref: "#/components/schemas/CustomAttributeConfigUpdateAttributes"
+ $ref: '#/components/schemas/CustomAttributeConfigUpdateAttributes'
type:
- $ref: "#/components/schemas/CustomAttributeConfigResourceType"
+ $ref: '#/components/schemas/CustomAttributeConfigResourceType'
required:
- type
type: object
@@ -27792,15 +27792,15 @@ components:
description: An external field identifier to auto-populate this attribute from (used for integrations with external systems).
type: string
type:
- $ref: "#/components/schemas/CustomAttributeType"
+ $ref: '#/components/schemas/CustomAttributeType'
type_data:
- $ref: "#/components/schemas/CustomAttributeTypeData"
+ $ref: '#/components/schemas/CustomAttributeTypeData'
type: object
CustomAttributeConfigUpdateRequest:
description: Request payload for updating a custom attribute configuration.
properties:
data:
- $ref: "#/components/schemas/CustomAttributeConfigUpdate"
+ $ref: '#/components/schemas/CustomAttributeConfigUpdate'
required:
- data
type: object
@@ -27810,7 +27810,7 @@ components:
data:
description: List of custom attribute configs of case type
items:
- $ref: "#/components/schemas/CustomAttributeConfig"
+ $ref: '#/components/schemas/CustomAttributeConfig'
type: array
type: object
CustomAttributeMultiNumberValue:
@@ -27863,7 +27863,7 @@ components:
options:
description: Options for SELECT type custom attributes.
items:
- $ref: "#/components/schemas/CustomAttributeSelectOption"
+ $ref: '#/components/schemas/CustomAttributeSelectOption'
type: array
type: object
CustomAttributeValue:
@@ -27874,9 +27874,9 @@ components:
example: false
type: boolean
type:
- $ref: "#/components/schemas/CustomAttributeType"
+ $ref: '#/components/schemas/CustomAttributeType'
value:
- $ref: "#/components/schemas/CustomAttributeValuesUnion"
+ $ref: '#/components/schemas/CustomAttributeValuesUnion'
required:
- type
- is_multi
@@ -27886,22 +27886,22 @@ components:
description: The value of a custom attribute. The accepted format depends on the attribute's type and whether it accepts multiple values.
example: ""
oneOf:
- - $ref: "#/components/schemas/CustomAttributeStringValue"
- - $ref: "#/components/schemas/CustomAttributeMultiStringValue"
- - $ref: "#/components/schemas/CustomAttributeNumberValue"
- - $ref: "#/components/schemas/CustomAttributeMultiNumberValue"
+ - $ref: '#/components/schemas/CustomAttributeStringValue'
+ - $ref: '#/components/schemas/CustomAttributeMultiStringValue'
+ - $ref: '#/components/schemas/CustomAttributeNumberValue'
+ - $ref: '#/components/schemas/CustomAttributeMultiNumberValue'
CustomConnection:
description: A custom connection used by an app.
properties:
attributes:
- $ref: "#/components/schemas/CustomConnectionAttributes"
+ $ref: '#/components/schemas/CustomConnectionAttributes'
id:
description: The ID of the custom connection.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/CustomConnectionType"
+ $ref: '#/components/schemas/CustomConnectionType'
type: object
CustomConnectionAttributes:
description: The custom connection attributes.
@@ -27910,7 +27910,7 @@ components:
description: The name of the custom connection.
type: string
onPremRunner:
- $ref: "#/components/schemas/CustomConnectionAttributesOnPremRunner"
+ $ref: '#/components/schemas/CustomConnectionAttributesOnPremRunner'
type: object
CustomConnectionAttributesOnPremRunner:
description: Information about the Private Action Runner used by the custom connection, if the custom connection is associated with a Private Action Runner.
@@ -27972,9 +27972,9 @@ components:
description: Response for Get Custom Costs files.
properties:
data:
- $ref: "#/components/schemas/CustomCostsFileMetadataWithContentHighLevel"
+ $ref: '#/components/schemas/CustomCostsFileMetadataWithContentHighLevel'
meta:
- $ref: "#/components/schemas/CustomCostGetResponseMeta"
+ $ref: '#/components/schemas/CustomCostGetResponseMeta'
type: object
CustomCostsFileLineItem:
description: Line item details from a Custom Costs file.
@@ -28017,10 +28017,10 @@ components:
data:
description: List of Custom Costs files.
items:
- $ref: "#/components/schemas/CustomCostsFileMetadataHighLevel"
+ $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
type: array
meta:
- $ref: "#/components/schemas/CustomCostListResponseMeta"
+ $ref: '#/components/schemas/CustomCostListResponseMeta'
type: object
CustomCostsFileMetadata:
description: Schema of a Custom Costs metadata.
@@ -28035,7 +28035,7 @@ components:
example: "USD"
type: string
charge_period:
- $ref: "#/components/schemas/CustomCostsFileUsageChargePeriod"
+ $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
name:
description: Name of the Custom Costs file.
example: "my_file.json"
@@ -28057,13 +28057,13 @@ components:
format: double
type: number
uploaded_by:
- $ref: "#/components/schemas/CustomCostsUser"
+ $ref: '#/components/schemas/CustomCostsUser'
type: object
CustomCostsFileMetadataHighLevel:
description: JSON API format for a Custom Costs file.
properties:
attributes:
- $ref: "#/components/schemas/CustomCostsFileMetadata"
+ $ref: '#/components/schemas/CustomCostsFileMetadata'
id:
description: ID of the Custom Costs metadata.
type: string
@@ -28084,11 +28084,11 @@ components:
example: "USD"
type: string
charge_period:
- $ref: "#/components/schemas/CustomCostsFileUsageChargePeriod"
+ $ref: '#/components/schemas/CustomCostsFileUsageChargePeriod'
content:
description: Detail of the line items from the Custom Costs file.
items:
- $ref: "#/components/schemas/CustomCostsFileLineItem"
+ $ref: '#/components/schemas/CustomCostsFileLineItem'
type: array
name:
description: Name of the Custom Costs file.
@@ -28111,13 +28111,13 @@ components:
format: double
type: number
uploaded_by:
- $ref: "#/components/schemas/CustomCostsUser"
+ $ref: '#/components/schemas/CustomCostsUser'
type: object
CustomCostsFileMetadataWithContentHighLevel:
description: JSON API format of for a Custom Costs file with content.
properties:
attributes:
- $ref: "#/components/schemas/CustomCostsFileMetadataWithContent"
+ $ref: '#/components/schemas/CustomCostsFileMetadataWithContent'
id:
description: ID of the Custom Costs metadata.
type: string
@@ -28128,15 +28128,15 @@ components:
CustomCostsFileUploadRequest:
description: Request for uploading a Custom Costs file.
items:
- $ref: "#/components/schemas/CustomCostsFileLineItem"
+ $ref: '#/components/schemas/CustomCostsFileLineItem'
type: array
CustomCostsFileUploadResponse:
description: Response for Uploaded Custom Costs files.
properties:
data:
- $ref: "#/components/schemas/CustomCostsFileMetadataHighLevel"
+ $ref: '#/components/schemas/CustomCostsFileMetadataHighLevel'
meta:
- $ref: "#/components/schemas/CustomCostUploadResponseMeta"
+ $ref: '#/components/schemas/CustomCostUploadResponseMeta'
type: object
CustomCostsFileUsageChargePeriod:
description: Usage charge period of a Custom Costs file.
@@ -28188,7 +28188,7 @@ components:
description: The custom destination.
properties:
data:
- $ref: "#/components/schemas/CustomDestinationCreateRequestDefinition"
+ $ref: '#/components/schemas/CustomDestinationCreateRequestDefinition'
type: object
CustomDestinationCreateRequestAttributes:
description: The attributes associated with the custom destination.
@@ -28218,9 +28218,9 @@ components:
minItems: 0
type: array
forward_tags_restriction_list_type:
- $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType"
+ $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
forwarder_destination:
- $ref: "#/components/schemas/CustomDestinationForwardDestination"
+ $ref: '#/components/schemas/CustomDestinationForwardDestination'
name:
description: The custom destination name.
example: Nginx logs
@@ -28238,9 +28238,9 @@ components:
description: The definition of a custom destination.
properties:
attributes:
- $ref: "#/components/schemas/CustomDestinationCreateRequestAttributes"
+ $ref: '#/components/schemas/CustomDestinationCreateRequestAttributes'
type:
- $ref: "#/components/schemas/CustomDestinationType"
+ $ref: '#/components/schemas/CustomDestinationType'
required:
- type
- attributes
@@ -28265,15 +28265,15 @@ components:
CustomDestinationForwardDestination:
description: A custom destination's location to forward logs.
oneOf:
- - $ref: "#/components/schemas/CustomDestinationForwardDestinationHttp"
- - $ref: "#/components/schemas/CustomDestinationForwardDestinationSplunk"
- - $ref: "#/components/schemas/CustomDestinationForwardDestinationElasticsearch"
- - $ref: "#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel"
+ - $ref: '#/components/schemas/CustomDestinationForwardDestinationHttp'
+ - $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunk'
+ - $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearch'
+ - $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinel'
CustomDestinationForwardDestinationElasticsearch:
description: The Elasticsearch destination.
properties:
auth:
- $ref: "#/components/schemas/CustomDestinationElasticsearchDestinationAuth"
+ $ref: '#/components/schemas/CustomDestinationElasticsearchDestinationAuth'
endpoint:
description: |-
The destination for which logs will be forwarded to.
@@ -28299,7 +28299,7 @@ components:
example: yyyy-MM-dd
type: string
type:
- $ref: "#/components/schemas/CustomDestinationForwardDestinationElasticsearchType"
+ $ref: '#/components/schemas/CustomDestinationForwardDestinationElasticsearchType'
required:
- type
- endpoint
@@ -28319,7 +28319,7 @@ components:
description: The HTTP destination.
properties:
auth:
- $ref: "#/components/schemas/CustomDestinationHttpDestinationAuth"
+ $ref: '#/components/schemas/CustomDestinationHttpDestinationAuth'
endpoint:
description: |-
The destination for which logs will be forwarded to.
@@ -28327,7 +28327,7 @@ components:
example: https://example.com
type: string
type:
- $ref: "#/components/schemas/CustomDestinationForwardDestinationHttpType"
+ $ref: '#/components/schemas/CustomDestinationForwardDestinationHttpType'
required:
- type
- endpoint
@@ -28367,7 +28367,7 @@ components:
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
type: string
type:
- $ref: "#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType"
+ $ref: '#/components/schemas/CustomDestinationForwardDestinationMicrosoftSentinelType'
required:
- type
- tenant_id
@@ -28411,7 +28411,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/CustomDestinationForwardDestinationSplunkType"
+ $ref: '#/components/schemas/CustomDestinationForwardDestinationSplunkType'
required:
- type
- endpoint
@@ -28429,8 +28429,8 @@ components:
CustomDestinationHttpDestinationAuth:
description: Authentication method of the HTTP requests.
oneOf:
- - $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthBasic"
- - $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader"
+ - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasic'
+ - $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeader'
CustomDestinationHttpDestinationAuthBasic:
description: Basic access authentication.
properties:
@@ -28440,7 +28440,7 @@ components:
type: string
writeOnly: true
type:
- $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthBasicType"
+ $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthBasicType'
username:
description: The username of the authentication. This field is not returned by the API.
example: datadog-custom-destination-username
@@ -28473,7 +28473,7 @@ components:
type: string
writeOnly: true
type:
- $ref: "#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType"
+ $ref: '#/components/schemas/CustomDestinationHttpDestinationAuthCustomHeaderType'
required:
- type
- header_name
@@ -28492,7 +28492,7 @@ components:
description: The custom destination.
properties:
data:
- $ref: "#/components/schemas/CustomDestinationResponseDefinition"
+ $ref: '#/components/schemas/CustomDestinationResponseDefinition'
type: object
CustomDestinationResponseAttributes:
description: The attributes associated with the custom destination.
@@ -28522,9 +28522,9 @@ components:
minItems: 0
type: array
forward_tags_restriction_list_type:
- $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType"
+ $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
forwarder_destination:
- $ref: "#/components/schemas/CustomDestinationResponseForwardDestination"
+ $ref: '#/components/schemas/CustomDestinationResponseForwardDestination'
name:
description: The custom destination name.
example: Nginx logs
@@ -28539,14 +28539,14 @@ components:
description: The definition of a custom destination.
properties:
attributes:
- $ref: "#/components/schemas/CustomDestinationResponseAttributes"
+ $ref: '#/components/schemas/CustomDestinationResponseAttributes'
id:
description: The custom destination ID.
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
readOnly: true
type: string
type:
- $ref: "#/components/schemas/CustomDestinationType"
+ $ref: '#/components/schemas/CustomDestinationType'
type: object
CustomDestinationResponseElasticsearchDestinationAuth:
additionalProperties:
@@ -28556,15 +28556,15 @@ components:
CustomDestinationResponseForwardDestination:
description: A custom destination's location to forward logs.
oneOf:
- - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationHttp"
- - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunk"
- - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch"
- - $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel"
+ - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttp'
+ - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunk'
+ - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearch'
+ - $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinel'
CustomDestinationResponseForwardDestinationElasticsearch:
description: The Elasticsearch destination.
properties:
auth:
- $ref: "#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth"
+ $ref: '#/components/schemas/CustomDestinationResponseElasticsearchDestinationAuth'
endpoint:
description: |-
The destination for which logs will be forwarded to.
@@ -28590,7 +28590,7 @@ components:
example: yyyy-MM-dd
type: string
type:
- $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType"
+ $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationElasticsearchType'
required:
- type
- endpoint
@@ -28610,7 +28610,7 @@ components:
description: The HTTP destination.
properties:
auth:
- $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuth"
+ $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuth'
endpoint:
description: |-
The destination for which logs will be forwarded to.
@@ -28618,7 +28618,7 @@ components:
example: https://example.com
type: string
type:
- $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationHttpType"
+ $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationHttpType'
required:
- type
- endpoint
@@ -28658,7 +28658,7 @@ components:
example: f3c9a8a1-4c2e-4d2e-b911-9f3c28c3c8b2
type: string
type:
- $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType"
+ $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationMicrosoftSentinelType'
required:
- type
- tenant_id
@@ -28697,7 +28697,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType"
+ $ref: '#/components/schemas/CustomDestinationResponseForwardDestinationSplunkType'
required:
- type
- endpoint
@@ -28714,13 +28714,13 @@ components:
CustomDestinationResponseHttpDestinationAuth:
description: Authentication method of the HTTP requests.
oneOf:
- - $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic"
- - $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader"
+ - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasic'
+ - $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeader'
CustomDestinationResponseHttpDestinationAuthBasic:
description: Basic access authentication.
properties:
type:
- $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType"
+ $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthBasicType'
required:
- type
type: object
@@ -28741,7 +28741,7 @@ components:
example: CUSTOM-HEADER-NAME
type: string
type:
- $ref: "#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType"
+ $ref: '#/components/schemas/CustomDestinationResponseHttpDestinationAuthCustomHeaderType'
required:
- type
- header_name
@@ -28768,7 +28768,7 @@ components:
description: The custom destination.
properties:
data:
- $ref: "#/components/schemas/CustomDestinationUpdateRequestDefinition"
+ $ref: '#/components/schemas/CustomDestinationUpdateRequestDefinition'
type: object
CustomDestinationUpdateRequestAttributes:
description: The attributes associated with the custom destination.
@@ -28796,9 +28796,9 @@ components:
minItems: 0
type: array
forward_tags_restriction_list_type:
- $ref: "#/components/schemas/CustomDestinationAttributeTagsRestrictionListType"
+ $ref: '#/components/schemas/CustomDestinationAttributeTagsRestrictionListType'
forwarder_destination:
- $ref: "#/components/schemas/CustomDestinationForwardDestination"
+ $ref: '#/components/schemas/CustomDestinationForwardDestination'
name:
description: The custom destination name.
example: Nginx logs
@@ -28813,13 +28813,13 @@ components:
description: The definition of a custom destination.
properties:
attributes:
- $ref: "#/components/schemas/CustomDestinationUpdateRequestAttributes"
+ $ref: '#/components/schemas/CustomDestinationUpdateRequestAttributes'
id:
description: The custom destination ID.
example: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
type: string
type:
- $ref: "#/components/schemas/CustomDestinationType"
+ $ref: '#/components/schemas/CustomDestinationType'
required:
- type
- id
@@ -28830,7 +28830,7 @@ components:
data:
description: A list of custom destinations.
items:
- $ref: "#/components/schemas/CustomDestinationResponseDefinition"
+ $ref: '#/components/schemas/CustomDestinationResponseDefinition'
type: array
type: object
CustomForecastEntry:
@@ -28849,7 +28849,7 @@ components:
tag_filters:
description: Tag filters that scope this custom forecast entry to specific resources.
items:
- $ref: "#/components/schemas/CustomForecastEntryTagFilter"
+ $ref: '#/components/schemas/CustomForecastEntryTagFilter'
type: array
required:
- month
@@ -28875,7 +28875,7 @@ components:
description: Response object containing the custom forecast for a budget.
properties:
data:
- $ref: "#/components/schemas/CustomForecastResponseData"
+ $ref: '#/components/schemas/CustomForecastResponseData'
required:
- data
type: object
@@ -28883,13 +28883,13 @@ components:
description: Custom forecast resource wrapper in a response.
properties:
attributes:
- $ref: "#/components/schemas/CustomForecastResponseDataAttributes"
+ $ref: '#/components/schemas/CustomForecastResponseDataAttributes'
id:
description: The unique identifier of the custom forecast.
example: 11111111-1111-1111-1111-111111111111
type: string
type:
- $ref: "#/components/schemas/CustomForecastType"
+ $ref: '#/components/schemas/CustomForecastType'
required:
- id
- type
@@ -28914,7 +28914,7 @@ components:
entries:
description: Monthly custom forecast entries.
items:
- $ref: "#/components/schemas/CustomForecastEntry"
+ $ref: '#/components/schemas/CustomForecastEntry'
type: array
updated_at:
description: Timestamp the custom forecast was last updated, in Unix milliseconds.
@@ -28946,7 +28946,7 @@ components:
description: Request body to upsert (create or replace) the custom forecast for a budget.
properties:
data:
- $ref: "#/components/schemas/CustomForecastUpsertRequestData"
+ $ref: '#/components/schemas/CustomForecastUpsertRequestData'
required:
- data
type: object
@@ -28954,13 +28954,13 @@ components:
description: Custom forecast resource wrapper in an upsert request.
properties:
attributes:
- $ref: "#/components/schemas/CustomForecastUpsertRequestDataAttributes"
+ $ref: '#/components/schemas/CustomForecastUpsertRequestDataAttributes'
id:
description: Unused on upsert; the resource is keyed by `budget_uid`. Send an empty string.
example: ""
type: string
type:
- $ref: "#/components/schemas/CustomForecastType"
+ $ref: '#/components/schemas/CustomForecastType'
required:
- type
- attributes
@@ -28977,7 +28977,7 @@ components:
Monthly custom forecast entries. An empty list deletes any existing
custom forecast for the budget.
items:
- $ref: "#/components/schemas/CustomForecastEntry"
+ $ref: '#/components/schemas/CustomForecastEntry'
type: array
required:
- budget_uid
@@ -29006,9 +29006,9 @@ components:
description: Contains type and attributes for custom frameworks.
properties:
attributes:
- $ref: "#/components/schemas/CustomFrameworkDataAttributes"
+ $ref: '#/components/schemas/CustomFrameworkDataAttributes'
type:
- $ref: "#/components/schemas/CustomFrameworkType"
+ $ref: '#/components/schemas/CustomFrameworkType'
required:
- type
- attributes
@@ -29033,7 +29033,7 @@ components:
requirements:
description: Framework Requirements
items:
- $ref: "#/components/schemas/CustomFrameworkRequirement"
+ $ref: '#/components/schemas/CustomFrameworkRequirement'
type: array
version:
description: Framework Version
@@ -29061,13 +29061,13 @@ components:
description: Metadata for custom frameworks.
properties:
attributes:
- $ref: "#/components/schemas/CustomFrameworkWithoutRequirements"
+ $ref: '#/components/schemas/CustomFrameworkWithoutRequirements'
id:
description: The ID of the custom framework.
example: handle-version
type: string
type:
- $ref: "#/components/schemas/CustomFrameworkType"
+ $ref: '#/components/schemas/CustomFrameworkType'
type: object
CustomFrameworkRequirement:
description: Framework Requirement.
@@ -29075,7 +29075,7 @@ components:
controls:
description: Requirement Controls.
items:
- $ref: "#/components/schemas/CustomFrameworkControl"
+ $ref: '#/components/schemas/CustomFrameworkControl'
type: array
name:
description: Requirement Name.
@@ -29159,18 +29159,18 @@ components:
description: Request body for creating or updating a custom rule.
properties:
data:
- $ref: "#/components/schemas/CustomRuleRequestData"
+ $ref: '#/components/schemas/CustomRuleRequestData'
type: object
CustomRuleRequestData:
description: Data object for a custom rule create or update request.
properties:
attributes:
- $ref: "#/components/schemas/CustomRuleRequestDataAttributes"
+ $ref: '#/components/schemas/CustomRuleRequestDataAttributes'
id:
description: Rule identifier
type: string
type:
- $ref: "#/components/schemas/CustomRuleDataType"
+ $ref: '#/components/schemas/CustomRuleDataType'
type: object
CustomRuleRequestDataAttributes:
description: Attributes for creating or updating a custom rule.
@@ -29183,7 +29183,7 @@ components:
description: Response containing a single custom rule.
properties:
data:
- $ref: "#/components/schemas/CustomRuleResponseData"
+ $ref: '#/components/schemas/CustomRuleResponseData'
required:
- data
type: object
@@ -29191,13 +29191,13 @@ components:
description: Data object returned in a custom rule response, including its ID, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/CustomRule"
+ $ref: '#/components/schemas/CustomRule'
id:
description: Rule identifier
example: my-rule
type: string
type:
- $ref: "#/components/schemas/CustomRuleDataType"
+ $ref: '#/components/schemas/CustomRuleDataType'
required:
- id
- type
@@ -29207,13 +29207,13 @@ components:
description: A specific revision of a custom static analysis rule.
properties:
attributes:
- $ref: "#/components/schemas/CustomRuleRevisionAttributes"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributes'
id:
description: Revision identifier
example: revision-123
type: string
type:
- $ref: "#/components/schemas/CustomRuleRevisionDataType"
+ $ref: '#/components/schemas/CustomRuleRevisionDataType'
required:
- id
- type
@@ -29225,10 +29225,10 @@ components:
arguments:
description: Rule arguments
items:
- $ref: "#/components/schemas/Argument"
+ $ref: '#/components/schemas/Argument'
type: array
category:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory'
checksum:
description: Code checksum
example: 8a66c4e4e631099ad71be3c1ea3ea8fc2d57193e56db2c296e2dd8a508b26b99
@@ -29278,9 +29278,9 @@ components:
example: false
type: boolean
language:
- $ref: "#/components/schemas/Language"
+ $ref: '#/components/schemas/Language'
severity:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity'
short_description:
description: Short description
example: c2hvcnQgZGVzY3JpcHRpb24=
@@ -29301,7 +29301,7 @@ components:
tests:
description: Rule tests
items:
- $ref: "#/components/schemas/CustomRuleRevisionTest"
+ $ref: '#/components/schemas/CustomRuleRevisionTest'
type: array
tree_sitter_query:
description: Tree-sitter query
@@ -29362,10 +29362,10 @@ components:
arguments:
description: Rule arguments
items:
- $ref: "#/components/schemas/Argument"
+ $ref: '#/components/schemas/Argument'
type: array
category:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesCategory"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesCategory'
code:
description: Rule code
example: Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==
@@ -29402,9 +29402,9 @@ components:
example: false
type: boolean
language:
- $ref: "#/components/schemas/Language"
+ $ref: '#/components/schemas/Language'
severity:
- $ref: "#/components/schemas/CustomRuleRevisionAttributesSeverity"
+ $ref: '#/components/schemas/CustomRuleRevisionAttributesSeverity'
short_description:
description: Short description
example: c2hvcnQgZGVzY3JpcHRpb24=
@@ -29425,7 +29425,7 @@ components:
tests:
description: Rule tests
items:
- $ref: "#/components/schemas/CustomRuleRevisionTest"
+ $ref: '#/components/schemas/CustomRuleRevisionTest'
type: array
tree_sitter_query:
description: Tree-sitter query
@@ -29454,24 +29454,24 @@ components:
description: Request body for creating a new custom rule revision.
properties:
data:
- $ref: "#/components/schemas/CustomRuleRevisionRequestData"
+ $ref: '#/components/schemas/CustomRuleRevisionRequestData'
type: object
CustomRuleRevisionRequestData:
description: Data object for a custom rule revision create request.
properties:
attributes:
- $ref: "#/components/schemas/CustomRuleRevisionInputAttributes"
+ $ref: '#/components/schemas/CustomRuleRevisionInputAttributes'
id:
description: Revision identifier
type: string
type:
- $ref: "#/components/schemas/CustomRuleRevisionDataType"
+ $ref: '#/components/schemas/CustomRuleRevisionDataType'
type: object
CustomRuleRevisionResponse:
description: Response containing a single custom rule revision.
properties:
data:
- $ref: "#/components/schemas/CustomRuleRevision"
+ $ref: '#/components/schemas/CustomRuleRevision'
required:
- data
type: object
@@ -29502,20 +29502,20 @@ components:
data:
description: List of custom rule revisions.
items:
- $ref: "#/components/schemas/CustomRuleRevision"
+ $ref: '#/components/schemas/CustomRuleRevision'
type: array
type: object
CustomRuleset:
description: A custom static analysis ruleset containing a set of user-defined rules.
properties:
attributes:
- $ref: "#/components/schemas/CustomRulesetAttributes"
+ $ref: '#/components/schemas/CustomRulesetAttributes'
id:
description: Ruleset identifier
example: my-ruleset
type: string
type:
- $ref: "#/components/schemas/CustomRulesetDataType"
+ $ref: '#/components/schemas/CustomRulesetDataType'
required:
- id
- type
@@ -29544,7 +29544,7 @@ components:
rules:
description: Rules in the ruleset
items:
- $ref: "#/components/schemas/CustomRule"
+ $ref: '#/components/schemas/CustomRule'
nullable: true
type: array
short_description:
@@ -29572,7 +29572,7 @@ components:
data:
description: The list of custom rulesets.
items:
- $ref: "#/components/schemas/CustomRuleset"
+ $ref: '#/components/schemas/CustomRuleset'
type: array
required:
- data
@@ -29581,18 +29581,18 @@ components:
description: Request body for creating or updating a custom ruleset.
properties:
data:
- $ref: "#/components/schemas/CustomRulesetRequestData"
+ $ref: '#/components/schemas/CustomRulesetRequestData'
type: object
CustomRulesetRequestData:
description: Data object for a custom ruleset create or update request.
properties:
attributes:
- $ref: "#/components/schemas/CustomRulesetRequestDataAttributes"
+ $ref: '#/components/schemas/CustomRulesetRequestDataAttributes'
id:
description: Ruleset identifier
type: string
type:
- $ref: "#/components/schemas/CustomRulesetDataType"
+ $ref: '#/components/schemas/CustomRulesetDataType'
type: object
CustomRulesetRequestDataAttributes:
description: Attributes for creating or updating a custom ruleset.
@@ -29606,7 +29606,7 @@ components:
rules:
description: Rules in the ruleset
items:
- $ref: "#/components/schemas/CustomRule"
+ $ref: '#/components/schemas/CustomRule'
nullable: true
type: array
short_description:
@@ -29617,7 +29617,7 @@ components:
description: Response containing a single custom ruleset.
properties:
data:
- $ref: "#/components/schemas/CustomRuleset"
+ $ref: '#/components/schemas/CustomRuleset'
required:
- data
type: object
@@ -29625,7 +29625,7 @@ components:
description: Request payload for disabling the authenticated customer organization.
properties:
data:
- $ref: "#/components/schemas/CustomerOrgDisableRequestData"
+ $ref: '#/components/schemas/CustomerOrgDisableRequestData'
required:
- data
type: object
@@ -29645,7 +29645,7 @@ components:
description: Data object for a customer org disable request.
properties:
attributes:
- $ref: "#/components/schemas/CustomerOrgDisableRequestAttributes"
+ $ref: '#/components/schemas/CustomerOrgDisableRequestAttributes'
id:
description: |-
Optional client-supplied identifier for the request. Useful for client-side
@@ -29653,7 +29653,7 @@ components:
example: "1"
type: string
type:
- $ref: "#/components/schemas/CustomerOrgDisableType"
+ $ref: '#/components/schemas/CustomerOrgDisableType'
required:
- type
type: object
@@ -29661,7 +29661,7 @@ components:
description: Response describing the outcome of disabling the customer organization.
properties:
data:
- $ref: "#/components/schemas/CustomerOrgDisableResponseData"
+ $ref: '#/components/schemas/CustomerOrgDisableResponseData'
required:
- data
type: object
@@ -29669,7 +29669,7 @@ components:
description: Attributes describing the outcome of the disable action on the customer organization.
properties:
status:
- $ref: "#/components/schemas/CustomerOrgDisableStatus"
+ $ref: '#/components/schemas/CustomerOrgDisableStatus'
required:
- status
type: object
@@ -29677,13 +29677,13 @@ components:
description: Data object returned after disabling the customer organization.
properties:
attributes:
- $ref: "#/components/schemas/CustomerOrgDisableResponseAttributes"
+ $ref: '#/components/schemas/CustomerOrgDisableResponseAttributes'
id:
description: Identifier of the disabled organization.
example: "abcdef01-2345-6789-abcd-ef0123456789"
type: string
type:
- $ref: "#/components/schemas/CustomerOrgDisableResponseType"
+ $ref: '#/components/schemas/CustomerOrgDisableResponseType'
required:
- type
- id
@@ -29725,10 +29725,10 @@ components:
components:
description: The list of scanned software components. Cannot be empty.
items:
- $ref: "#/components/schemas/CycloneDXComponent"
+ $ref: '#/components/schemas/CycloneDXComponent'
type: array
metadata:
- $ref: "#/components/schemas/CycloneDXMetadata"
+ $ref: '#/components/schemas/CycloneDXMetadata'
specVersion:
description: The CycloneDX specification version. Must be `1.5`.
example: "1.5"
@@ -29741,7 +29741,7 @@ components:
vulnerabilities:
description: The list of detected vulnerabilities. Cannot be empty.
items:
- $ref: "#/components/schemas/CycloneDXVulnerability"
+ $ref: '#/components/schemas/CycloneDXVulnerability'
type: array
required:
- bomFormat
@@ -29766,7 +29766,7 @@ components:
example: "pkg:npm/lodash@4.17.21"
type: string
type:
- $ref: "#/components/schemas/CycloneDXComponentType"
+ $ref: '#/components/schemas/CycloneDXComponentType'
version:
description: The version of the component.
example: 4.17.21
@@ -29793,9 +29793,9 @@ components:
description: Metadata about the BOM, including the scanned asset and the scanner tool.
properties:
component:
- $ref: "#/components/schemas/CycloneDXMetadataComponent"
+ $ref: '#/components/schemas/CycloneDXMetadataComponent'
tools:
- $ref: "#/components/schemas/CycloneDXMetadataTools"
+ $ref: '#/components/schemas/CycloneDXMetadataTools'
required:
- component
- tools
@@ -29825,7 +29825,7 @@ components:
components:
description: The scanner tool components. Must contain exactly one element.
items:
- $ref: "#/components/schemas/CycloneDXToolComponent"
+ $ref: '#/components/schemas/CycloneDXToolComponent'
type: array
required:
- components
@@ -29850,16 +29850,16 @@ components:
advisories:
description: External advisory references for the vulnerability.
items:
- $ref: "#/components/schemas/CycloneDXVulnerabilityAdvisory"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityAdvisory'
type: array
affects:
description: >-
The components affected by this vulnerability. Must be non-empty. Each `ref` must match a `bom-ref` in `components`.
items:
- $ref: "#/components/schemas/CycloneDXVulnerabilityAffects"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityAffects'
type: array
analysis:
- $ref: "#/components/schemas/CycloneDXVulnerabilityAnalysis"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityAnalysis'
cwes:
description: CWE identifiers associated with the vulnerability.
example: [123, 345]
@@ -29882,12 +29882,12 @@ components:
ratings:
description: The severity ratings for the vulnerability. Must contain exactly one element.
items:
- $ref: "#/components/schemas/CycloneDXVulnerabilityRating"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityRating'
type: array
references:
description: External reference identifiers for the vulnerability.
items:
- $ref: "#/components/schemas/CycloneDXVulnerabilityReference"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityReference'
type: array
required:
- id
@@ -29948,7 +29948,7 @@ components:
example: GHSA-35m5-8cvj-8783
type: string
source:
- $ref: "#/components/schemas/CycloneDXVulnerabilityReferenceSource"
+ $ref: '#/components/schemas/CycloneDXVulnerabilityReferenceSource'
type: object
CycloneDXVulnerabilityReferenceSource:
description: The source of an external vulnerability reference.
@@ -29972,7 +29972,7 @@ components:
description: Response for fetching a single deployment event.
properties:
data:
- $ref: "#/components/schemas/DORADeploymentObject"
+ $ref: '#/components/schemas/DORADeploymentObject'
type: object
DORADeploymentObject:
description: A DORA deployment event.
@@ -29995,18 +29995,18 @@ components:
type: "dora_deployment"
properties:
attributes:
- $ref: "#/components/schemas/DORADeploymentObjectAttributes"
+ $ref: '#/components/schemas/DORADeploymentObjectAttributes'
id:
description: The ID of the deployment event.
type: string
type:
- $ref: "#/components/schemas/DORADeploymentType"
+ $ref: '#/components/schemas/DORADeploymentType'
type: object
DORADeploymentObjectAttributes:
description: The attributes of the deployment event.
properties:
custom_tags:
- $ref: "#/components/schemas/DORACustomTags"
+ $ref: '#/components/schemas/DORACustomTags'
env:
description: Environment name to where the service was deployed.
example: production
@@ -30017,7 +30017,7 @@ components:
format: date-time
type: string
git:
- $ref: "#/components/schemas/DORAGitInfoResponse"
+ $ref: '#/components/schemas/DORAGitInfoResponse'
service:
description: Service name.
example: shopist
@@ -30042,8 +30042,8 @@ components:
DORADeploymentPatchByVersionRemediation:
description: Remediation details for the deployment. Optional, but required to calculate failed deployment recovery time. Specify either `id` or `version` to identify the remediation deployment, but not both.
oneOf:
- - $ref: "#/components/schemas/DORADeploymentPatchByVersionRemediationByID"
- - $ref: "#/components/schemas/DORADeploymentPatchByVersionRemediationByVersion"
+ - $ref: '#/components/schemas/DORADeploymentPatchByVersionRemediationByID'
+ - $ref: '#/components/schemas/DORADeploymentPatchByVersionRemediationByVersion'
DORADeploymentPatchByVersionRemediationByID:
additionalProperties: false
description: Remediation details identified by the ID of the remediation deployment.
@@ -30053,7 +30053,7 @@ components:
example: eG42zNIkVjM
type: string
type:
- $ref: "#/components/schemas/DORADeploymentPatchRemediationType"
+ $ref: '#/components/schemas/DORADeploymentPatchRemediationType'
required:
- id
- type
@@ -30063,7 +30063,7 @@ components:
description: Remediation details identified by the version of the remediation deployment, matched against the same service and environment as the failed deployment.
properties:
type:
- $ref: "#/components/schemas/DORADeploymentPatchRemediationType"
+ $ref: '#/components/schemas/DORADeploymentPatchRemediationType'
version:
description: The version of the remediation deployment.
example: v1.2.4
@@ -30087,7 +30087,7 @@ components:
type: "dora_deployment_patch_request"
properties:
data:
- $ref: "#/components/schemas/DORADeploymentPatchByVersionRequestData"
+ $ref: '#/components/schemas/DORADeploymentPatchByVersionRequestData'
required:
- data
type: object
@@ -30103,7 +30103,7 @@ components:
example: prod
type: string
remediation:
- $ref: "#/components/schemas/DORADeploymentPatchByVersionRemediation"
+ $ref: '#/components/schemas/DORADeploymentPatchByVersionRemediation'
service:
description: The name of the service that was deployed.
example: my-service
@@ -30122,9 +30122,9 @@ components:
description: The JSON:API data for patching a deployment identified by service, environment, and version.
properties:
attributes:
- $ref: "#/components/schemas/DORADeploymentPatchByVersionRequestAttributes"
+ $ref: '#/components/schemas/DORADeploymentPatchByVersionRequestAttributes'
type:
- $ref: "#/components/schemas/DORADeploymentPatchRequestDataType"
+ $ref: '#/components/schemas/DORADeploymentPatchRequestDataType'
required:
- type
- attributes
@@ -30137,7 +30137,7 @@ components:
example: eG42zNIkVjM
type: string
type:
- $ref: "#/components/schemas/DORADeploymentPatchRemediationType"
+ $ref: '#/components/schemas/DORADeploymentPatchRemediationType'
version:
description: The version of the remediation deployment, matched against the same service and environment as the failed deployment. Use this or `id` to identify the remediation deployment, but not both.
example: v1.2.4
@@ -30166,7 +30166,7 @@ components:
type: "dora_deployment_patch_request"
properties:
data:
- $ref: "#/components/schemas/DORADeploymentPatchRequestData"
+ $ref: '#/components/schemas/DORADeploymentPatchRequestData'
required:
- data
type: object
@@ -30178,7 +30178,7 @@ components:
example: true
type: boolean
remediation:
- $ref: "#/components/schemas/DORADeploymentPatchRemediation"
+ $ref: '#/components/schemas/DORADeploymentPatchRemediation'
type: object
DORADeploymentPatchRequestData:
description: The JSON:API data for patching a deployment.
@@ -30192,13 +30192,13 @@ components:
type: "dora_deployment_patch_request"
properties:
attributes:
- $ref: "#/components/schemas/DORADeploymentPatchRequestAttributes"
+ $ref: '#/components/schemas/DORADeploymentPatchRequestAttributes'
id:
description: The ID of the deployment to patch.
example: z_RwVLi7v4Y
type: string
type:
- $ref: "#/components/schemas/DORADeploymentPatchRequestDataType"
+ $ref: '#/components/schemas/DORADeploymentPatchRequestDataType'
required:
- type
- id
@@ -30217,7 +30217,7 @@ components:
description: Request to create a DORA deployment event.
properties:
data:
- $ref: "#/components/schemas/DORADeploymentRequestData"
+ $ref: '#/components/schemas/DORADeploymentRequestData'
required:
- data
type: object
@@ -30225,7 +30225,7 @@ components:
description: Attributes to create a DORA deployment event.
properties:
custom_tags:
- $ref: "#/components/schemas/DORACustomTags"
+ $ref: '#/components/schemas/DORACustomTags'
env:
description: Environment name to where the service was deployed.
example: staging
@@ -30236,7 +30236,7 @@ components:
format: int64
type: integer
git:
- $ref: "#/components/schemas/DORAGitInfo"
+ $ref: '#/components/schemas/DORAGitInfo'
id:
description: Deployment ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
type: string
@@ -30266,7 +30266,7 @@ components:
description: The JSON:API data.
properties:
attributes:
- $ref: "#/components/schemas/DORADeploymentRequestAttributes"
+ $ref: '#/components/schemas/DORADeploymentRequestAttributes'
required:
- attributes
type: object
@@ -30274,7 +30274,7 @@ components:
description: Response after receiving a DORA deployment event.
properties:
data:
- $ref: "#/components/schemas/DORADeploymentResponseData"
+ $ref: '#/components/schemas/DORADeploymentResponseData'
required:
- data
type: object
@@ -30286,7 +30286,7 @@ components:
example: 4242fcdd31586083
type: string
type:
- $ref: "#/components/schemas/DORADeploymentType"
+ $ref: '#/components/schemas/DORADeploymentType'
required:
- id
type: object
@@ -30338,20 +30338,20 @@ components:
data:
description: The list of DORA deployment events.
items:
- $ref: "#/components/schemas/DORADeploymentObject"
+ $ref: '#/components/schemas/DORADeploymentObject'
type: array
type: object
DORAFailureFetchResponse:
description: Response for fetching a single incident event.
properties:
data:
- $ref: "#/components/schemas/DORAIncidentObject"
+ $ref: '#/components/schemas/DORAIncidentObject'
type: object
DORAFailureRequest:
description: Request to create a DORA incident event.
properties:
data:
- $ref: "#/components/schemas/DORAFailureRequestData"
+ $ref: '#/components/schemas/DORAFailureRequestData'
required:
- data
type: object
@@ -30359,7 +30359,7 @@ components:
description: Attributes to create a DORA incident event.
properties:
custom_tags:
- $ref: "#/components/schemas/DORACustomTags"
+ $ref: '#/components/schemas/DORACustomTags'
env:
description: Environment name that was impacted by the incident.
example: staging
@@ -30370,7 +30370,7 @@ components:
format: int64
type: integer
git:
- $ref: "#/components/schemas/DORAGitInfo"
+ $ref: '#/components/schemas/DORAGitInfo'
id:
description: Incident ID. Must be 16-128 characters and contain only alphanumeric characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9, -, _, ., :).
type: string
@@ -30409,7 +30409,7 @@ components:
description: The JSON:API data.
properties:
attributes:
- $ref: "#/components/schemas/DORAFailureRequestAttributes"
+ $ref: '#/components/schemas/DORAFailureRequestAttributes'
required:
- attributes
type: object
@@ -30417,7 +30417,7 @@ components:
description: Response after receiving a DORA incident event.
properties:
data:
- $ref: "#/components/schemas/DORAFailureResponseData"
+ $ref: '#/components/schemas/DORAFailureResponseData'
required:
- data
type: object
@@ -30429,7 +30429,7 @@ components:
example: 4242fcdd31586083
type: string
type:
- $ref: "#/components/schemas/DORAFailureType"
+ $ref: '#/components/schemas/DORAFailureType'
required:
- id
type: object
@@ -30479,16 +30479,16 @@ components:
data:
description: The list of DORA incident events.
items:
- $ref: "#/components/schemas/DORAIncidentObject"
+ $ref: '#/components/schemas/DORAIncidentObject'
type: array
type: object
DORAGitInfo:
description: "Git info for DORA Metrics events."
properties:
commit_sha:
- $ref: "#/components/schemas/GitCommitSHA"
+ $ref: '#/components/schemas/GitCommitSHA'
repository_url:
- $ref: "#/components/schemas/GitRepositoryURL"
+ $ref: '#/components/schemas/GitRepositoryURL'
required:
- repository_url
- commit_sha
@@ -30497,9 +30497,9 @@ components:
description: "Git info returned by DORA Metrics events."
properties:
commit_sha:
- $ref: "#/components/schemas/GitCommitSHA"
+ $ref: '#/components/schemas/GitCommitSHA'
repository_id:
- $ref: "#/components/schemas/GitRepositoryID"
+ $ref: '#/components/schemas/GitRepositoryID'
required:
- repository_id
- commit_sha
@@ -30526,18 +30526,18 @@ components:
type: "dora_incident"
properties:
attributes:
- $ref: "#/components/schemas/DORAIncidentObjectAttributes"
+ $ref: '#/components/schemas/DORAIncidentObjectAttributes'
id:
description: The ID of the incident event.
type: string
type:
- $ref: "#/components/schemas/DORAFailureType"
+ $ref: '#/components/schemas/DORAFailureType'
type: object
DORAIncidentObjectAttributes:
description: The attributes of the incident event.
properties:
custom_tags:
- $ref: "#/components/schemas/DORACustomTags"
+ $ref: '#/components/schemas/DORACustomTags'
env:
description: Environment name that was impacted by the incident.
example: production
@@ -30548,7 +30548,7 @@ components:
format: date-time
type: string
git:
- $ref: "#/components/schemas/DORAGitInfo"
+ $ref: '#/components/schemas/DORAGitInfo'
name:
description: Incident name.
example: Database outage
@@ -30591,7 +30591,7 @@ components:
type: "dora_deployments_list_request"
properties:
data:
- $ref: "#/components/schemas/DORAListDeploymentsRequestData"
+ $ref: '#/components/schemas/DORAListDeploymentsRequestData'
required:
- data
type: object
@@ -30636,9 +30636,9 @@ components:
type: "dora_deployments_list_request"
properties:
attributes:
- $ref: "#/components/schemas/DORAListDeploymentsRequestAttributes"
+ $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
type:
- $ref: "#/components/schemas/DORAListDeploymentsRequestDataType"
+ $ref: '#/components/schemas/DORAListDeploymentsRequestDataType'
required:
- attributes
type: object
@@ -30664,7 +30664,7 @@ components:
type: "dora_failures_list_request"
properties:
data:
- $ref: "#/components/schemas/DORAListFailuresRequestData"
+ $ref: '#/components/schemas/DORAListFailuresRequestData'
required:
- data
type: object
@@ -30709,9 +30709,9 @@ components:
type: "dora_failures_list_request"
properties:
attributes:
- $ref: "#/components/schemas/DORAListFailuresRequestAttributes"
+ $ref: '#/components/schemas/DORAListFailuresRequestAttributes'
type:
- $ref: "#/components/schemas/DORAListFailuresRequestDataType"
+ $ref: '#/components/schemas/DORAListFailuresRequestDataType'
required:
- attributes
type: object
@@ -30730,7 +30730,7 @@ components:
dashboards:
description: List of dashboards to add the dashboard list.
items:
- $ref: "#/components/schemas/DashboardListItemRequest"
+ $ref: '#/components/schemas/DashboardListItemRequest'
type: array
type: object
DashboardListAddItemsResponse:
@@ -30739,7 +30739,7 @@ components:
added_dashboards_to_list:
description: List of dashboards added to the dashboard list.
items:
- $ref: "#/components/schemas/DashboardListItemResponse"
+ $ref: '#/components/schemas/DashboardListItemResponse'
type: array
type: object
DashboardListDeleteItemsRequest:
@@ -30748,7 +30748,7 @@ components:
dashboards:
description: List of dashboards to delete from the dashboard list.
items:
- $ref: "#/components/schemas/DashboardListItemRequest"
+ $ref: '#/components/schemas/DashboardListItemRequest'
type: array
type: object
DashboardListDeleteItemsResponse:
@@ -30757,14 +30757,14 @@ components:
deleted_dashboards_from_list:
description: List of dashboards deleted from the dashboard list.
items:
- $ref: "#/components/schemas/DashboardListItemResponse"
+ $ref: '#/components/schemas/DashboardListItemResponse'
type: array
type: object
DashboardListItem:
description: A dashboard within a list.
properties:
author:
- $ref: "#/components/schemas/Creator"
+ $ref: '#/components/schemas/Creator'
created:
description: Date of creation of the dashboard.
format: date-time
@@ -30821,7 +30821,7 @@ components:
readOnly: true
type: string
type:
- $ref: "#/components/schemas/DashboardType"
+ $ref: '#/components/schemas/DashboardType'
url:
description: URL path to the dashboard.
readOnly: true
@@ -30838,7 +30838,7 @@ components:
example: "q5j-nti-fv6"
type: string
type:
- $ref: "#/components/schemas/DashboardType"
+ $ref: '#/components/schemas/DashboardType'
required:
- type
- id
@@ -30852,7 +30852,7 @@ components:
readOnly: true
type: string
type:
- $ref: "#/components/schemas/DashboardType"
+ $ref: '#/components/schemas/DashboardType'
required:
- type
- id
@@ -30864,7 +30864,7 @@ components:
description: List of dashboards in the dashboard list.
example: []
items:
- $ref: "#/components/schemas/DashboardListItem"
+ $ref: '#/components/schemas/DashboardListItem'
type: array
total:
description: Number of dashboards in the dashboard list.
@@ -30880,7 +30880,7 @@ components:
dashboards:
description: List of dashboards to update the dashboard list to.
items:
- $ref: "#/components/schemas/DashboardListItemRequest"
+ $ref: '#/components/schemas/DashboardListItemRequest'
type: array
type: object
DashboardListUpdateItemsResponse:
@@ -30889,7 +30889,7 @@ components:
dashboards:
description: List of dashboards in the dashboard list.
items:
- $ref: "#/components/schemas/DashboardListItemResponse"
+ $ref: '#/components/schemas/DashboardListItemResponse'
type: array
type: object
DashboardTriggerWrapper:
@@ -30899,7 +30899,7 @@ components:
description: "Trigger a workflow from a Dashboard."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- dashboardTrigger
type: object
@@ -30923,13 +30923,13 @@ components:
description: A single dashboard usage record.
properties:
attributes:
- $ref: "#/components/schemas/DashboardUsageAttributes"
+ $ref: '#/components/schemas/DashboardUsageAttributes'
id:
description: The dashboard ID.
example: "q5j-nti-fv6"
type: string
type:
- $ref: "#/components/schemas/DashboardUsageType"
+ $ref: '#/components/schemas/DashboardUsageType'
required:
- id
- type
@@ -30939,7 +30939,7 @@ components:
description: Usage statistics for a dashboard. The `viewer` field and all view-count fields (`total_views`, `viewed_at`, `total_views_by_type`) are populated only when Real User Monitoring (RUM) is active for the org.
properties:
author:
- $ref: "#/components/schemas/DashboardUsageUser"
+ $ref: '#/components/schemas/DashboardUsageUser'
created_at:
description: When the dashboard was created.
example: "2026-01-15T09:30:00.000Z"
@@ -30994,7 +30994,7 @@ components:
nullable: true
type: string
viewer:
- $ref: "#/components/schemas/DashboardUsageUser"
+ $ref: '#/components/schemas/DashboardUsageUser'
widget_count:
description: The total number of widgets on the dashboard.
example: 12
@@ -31016,7 +31016,7 @@ components:
description: Response containing usage statistics for a single dashboard.
properties:
data:
- $ref: "#/components/schemas/DashboardUsage"
+ $ref: '#/components/schemas/DashboardUsage'
required:
- data
type: object
@@ -31073,7 +31073,7 @@ components:
description: Deprecated. Use `if_tag_exists` instead. The `mapping` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
source_keys:
description: The `mapping` `source_keys`.
example:
@@ -31090,7 +31090,7 @@ components:
description: The created data deletion request information.
properties:
attributes:
- $ref: "#/components/schemas/DataDeletionResponseItemAttributes"
+ $ref: '#/components/schemas/DataDeletionResponseItemAttributes'
id:
description: The ID of the created data deletion request.
example: "1"
@@ -31286,7 +31286,7 @@ components:
data:
description: An array of team references for this schedule.
items:
- $ref: "#/components/schemas/DataRelationshipsTeamsDataItems"
+ $ref: '#/components/schemas/DataRelationshipsTeamsDataItems'
type: array
type: object
DataRelationshipsTeamsDataItems:
@@ -31298,7 +31298,7 @@ components:
example: "00000000-da3a-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/DataRelationshipsTeamsDataItemsType"
+ $ref: '#/components/schemas/DataRelationshipsTeamsDataItemsType'
required:
- type
- id
@@ -31317,13 +31317,13 @@ components:
description: A column containing the numerical results for a formula or query.
properties:
meta:
- $ref: "#/components/schemas/ScalarMeta"
+ $ref: '#/components/schemas/ScalarMeta'
name:
description: The name referencing the formula or query for this column.
example: a
type: string
type:
- $ref: "#/components/schemas/ScalarColumnTypeNumber"
+ $ref: '#/components/schemas/ScalarColumnTypeNumber'
values:
description: The array of numerical values for one formula or query.
example: [0.5]
@@ -31348,9 +31348,9 @@ components:
example: "combineTwoOrders"
type: string
properties:
- $ref: "#/components/schemas/DataTransformProperties"
+ $ref: '#/components/schemas/DataTransformProperties'
type:
- $ref: "#/components/schemas/DataTransformType"
+ $ref: '#/components/schemas/DataTransformType'
required:
- id
- name
@@ -31381,7 +31381,7 @@ components:
description: "Trigger a workflow from Database Monitoring."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- databaseMonitoringTrigger
type: object
@@ -31404,7 +31404,7 @@ components:
description: Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses `https://acme.datadoghq.com` to access Datadog, set this field to `acme`. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)).
type: string
type:
- $ref: "#/components/schemas/DatadogAPIKeyType"
+ $ref: '#/components/schemas/DatadogAPIKeyType'
required:
- type
- datacenter
@@ -31435,25 +31435,25 @@ components:
description: Custom subdomain used for Datadog URLs generated with this Connection. For example, if this org uses `https://acme.datadoghq.com` to access Datadog, set this field to `acme`. If this field is omitted, generated URLs will use the default site URL for its datacenter (see [https://docs.datadoghq.com/getting_started/site](https://docs.datadoghq.com/getting_started/site)).
type: string
type:
- $ref: "#/components/schemas/DatadogAPIKeyType"
+ $ref: '#/components/schemas/DatadogAPIKeyType'
required:
- type
type: object
DatadogCredentials:
description: The definition of the `DatadogCredentials` object.
oneOf:
- - $ref: "#/components/schemas/DatadogAPIKey"
+ - $ref: '#/components/schemas/DatadogAPIKey'
DatadogCredentialsUpdate:
description: The definition of the `DatadogCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/DatadogAPIKeyUpdate"
+ - $ref: '#/components/schemas/DatadogAPIKeyUpdate'
DatadogIntegration:
description: The definition of the `DatadogIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/DatadogCredentials"
+ $ref: '#/components/schemas/DatadogCredentials'
type:
- $ref: "#/components/schemas/DatadogIntegrationType"
+ $ref: '#/components/schemas/DatadogIntegrationType'
required:
- type
- credentials
@@ -31470,9 +31470,9 @@ components:
description: The definition of the `DatadogIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/DatadogCredentialsUpdate"
+ $ref: '#/components/schemas/DatadogCredentialsUpdate'
type:
- $ref: "#/components/schemas/DatadogIntegrationType"
+ $ref: '#/components/schemas/DatadogIntegrationType'
required:
- type
type: object
@@ -31496,7 +31496,7 @@ components:
product_filters:
description: List of product-specific filters.
items:
- $ref: "#/components/schemas/FiltersPerProduct"
+ $ref: '#/components/schemas/FiltersPerProduct'
type: array
required:
- name
@@ -31532,14 +31532,14 @@ components:
product_filters:
description: List of product-specific filters.
items:
- $ref: "#/components/schemas/FiltersPerProduct"
+ $ref: '#/components/schemas/FiltersPerProduct'
type: array
type: object
DatasetCreateRequest:
description: Create request for a dataset.
properties:
data:
- $ref: "#/components/schemas/DatasetRequest"
+ $ref: '#/components/schemas/DatasetRequest'
required:
- data
type: object
@@ -31549,12 +31549,12 @@ components:
data:
description: A list of report schedules for the dataset.
items:
- $ref: "#/components/schemas/DatasetReportScheduleResponseData"
+ $ref: '#/components/schemas/DatasetReportScheduleResponseData'
type: array
included:
description: Related resources included with the report schedules, such as authors.
items:
- $ref: "#/components/schemas/ReportScheduleIncludedResource"
+ $ref: '#/components/schemas/ReportScheduleIncludedResource'
type: array
required:
- data
@@ -31627,13 +31627,13 @@ components:
example: "aaaabbbb-1111-2222-3333-444455556666"
type: string
resource_type:
- $ref: "#/components/schemas/DatasetReportScheduleResourceType"
+ $ref: '#/components/schemas/DatasetReportScheduleResourceType'
rrule:
description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string.
example: "DTSTART;TZID=America/New_York:20240912T090000\nRRULE:FREQ=DAILY;BYHOUR=9;BYMINUTE=0"
type: string
status:
- $ref: "#/components/schemas/ReportScheduleStatus"
+ $ref: '#/components/schemas/ReportScheduleStatus'
timeframe:
description: The relative timeframe of data included in the report.
example: "calendar_day"
@@ -31667,16 +31667,16 @@ components:
description: The JSON:API data object representing a dataset report schedule.
properties:
attributes:
- $ref: "#/components/schemas/DatasetReportScheduleResponseAttributes"
+ $ref: '#/components/schemas/DatasetReportScheduleResponseAttributes'
id:
description: The unique identifier of the dataset report schedule.
example: "e1234567-1234-1234-1234-123456789012"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/ReportScheduleResponseRelationships"
+ $ref: '#/components/schemas/ReportScheduleResponseRelationships'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- id
- type
@@ -31698,9 +31698,9 @@ components:
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
properties:
attributes:
- $ref: "#/components/schemas/DatasetAttributesRequest"
+ $ref: '#/components/schemas/DatasetAttributesRequest'
type:
- $ref: "#/components/schemas/DatasetType"
+ $ref: '#/components/schemas/DatasetType'
required:
- type
- attributes
@@ -31720,13 +31720,13 @@ components:
- A tag value used in one dataset cannot be reused in another dataset of the same telemetry type.
properties:
attributes:
- $ref: "#/components/schemas/DatasetAttributesResponse"
+ $ref: '#/components/schemas/DatasetAttributesResponse'
id:
description: Unique identifier for the dataset.
example: "123e4567-e89b-12d3-a456-426614174000"
type: string
type:
- $ref: "#/components/schemas/DatasetType"
+ $ref: '#/components/schemas/DatasetType'
type: object
DatasetResponseMulti:
description: Response containing a list of datasets.
@@ -31734,14 +31734,14 @@ components:
data:
description: The list of datasets returned in response.
items:
- $ref: "#/components/schemas/DatasetResponse"
+ $ref: '#/components/schemas/DatasetResponse'
type: array
type: object
DatasetResponseSingle:
description: Response containing a single dataset object.
properties:
data:
- $ref: "#/components/schemas/DatasetResponse"
+ $ref: '#/components/schemas/DatasetResponse'
type: object
DatasetType:
default: dataset
@@ -31756,7 +31756,7 @@ components:
description: Edit request for a dataset.
properties:
data:
- $ref: "#/components/schemas/DatasetRequest"
+ $ref: '#/components/schemas/DatasetRequest'
required:
- data
type: object
@@ -31764,7 +31764,7 @@ components:
description: A datastore's complete configuration and metadata.
properties:
data:
- $ref: "#/components/schemas/DatastoreData"
+ $ref: '#/components/schemas/DatastoreData'
type: object
DatastoreArray:
description: A collection of datastores returned by list operations.
@@ -31772,7 +31772,7 @@ components:
data:
description: An array of datastore objects containing their configurations and metadata.
items:
- $ref: "#/components/schemas/DatastoreData"
+ $ref: '#/components/schemas/DatastoreData'
type: array
required:
- data
@@ -31789,12 +31789,12 @@ components:
description: Core information about a datastore, including its unique identifier and attributes.
properties:
attributes:
- $ref: "#/components/schemas/DatastoreDataAttributes"
+ $ref: '#/components/schemas/DatastoreDataAttributes'
id:
description: The unique identifier of the datastore.
type: string
type:
- $ref: "#/components/schemas/DatastoreDataType"
+ $ref: '#/components/schemas/DatastoreDataType'
required:
- type
type: object
@@ -31827,9 +31827,9 @@ components:
format: int64
type: integer
primary_column_name:
- $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName"
+ $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName'
primary_key_generation_strategy:
- $ref: "#/components/schemas/DatastorePrimaryKeyGenerationStrategy"
+ $ref: '#/components/schemas/DatastorePrimaryKeyGenerationStrategy'
type: object
DatastoreDataType:
default: datastores
@@ -31885,15 +31885,15 @@ components:
description: "Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
DatastoreTriggerWrapper:
description: "Schema for a Datastore-based trigger."
properties:
datastoreTrigger:
- $ref: "#/components/schemas/DatastoreTrigger"
+ $ref: '#/components/schemas/DatastoreTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- datastoreTrigger
type: object
@@ -31946,13 +31946,13 @@ components:
Column-major result set. Each element carries one column's name, type, and values,
with one value per row of the result. Set when `state` is `completed`.
items:
- $ref: "#/components/schemas/DdsqlTabularQueryColumn"
+ $ref: '#/components/schemas/DdsqlTabularQueryColumn'
type: array
DdsqlTabularQueryFetchRequest:
description: Wrapper for a DDSQL tabular query fetch request.
properties:
data:
- $ref: "#/components/schemas/DdsqlTabularQueryFetchRequestData"
+ $ref: '#/components/schemas/DdsqlTabularQueryFetchRequestData'
required:
- data
type: object
@@ -31972,9 +31972,9 @@ components:
description: JSON:API resource object for a DDSQL tabular query fetch request.
properties:
attributes:
- $ref: "#/components/schemas/DdsqlTabularQueryFetchRequestAttributes"
+ $ref: '#/components/schemas/DdsqlTabularQueryFetchRequestAttributes'
type:
- $ref: "#/components/schemas/DdsqlTabularQueryFetchRequestType"
+ $ref: '#/components/schemas/DdsqlTabularQueryFetchRequestType'
required:
- type
- attributes
@@ -31992,7 +31992,7 @@ components:
description: Wrapper for a DDSQL tabular query execution request.
properties:
data:
- $ref: "#/components/schemas/DdsqlTabularQueryRequestData"
+ $ref: '#/components/schemas/DdsqlTabularQueryRequestData'
required:
- data
type: object
@@ -32015,7 +32015,7 @@ components:
minimum: 1
type: integer
time:
- $ref: "#/components/schemas/DdsqlTabularQueryTimeWindow"
+ $ref: '#/components/schemas/DdsqlTabularQueryTimeWindow'
required:
- query
- time
@@ -32024,9 +32024,9 @@ components:
description: JSON:API resource object for a DDSQL tabular query execution request.
properties:
attributes:
- $ref: "#/components/schemas/DdsqlTabularQueryRequestAttributes"
+ $ref: '#/components/schemas/DdsqlTabularQueryRequestAttributes'
type:
- $ref: "#/components/schemas/DdsqlTabularQueryRequestType"
+ $ref: '#/components/schemas/DdsqlTabularQueryRequestType'
required:
- type
- attributes
@@ -32047,9 +32047,9 @@ components:
request-scoped observability handles.
properties:
data:
- $ref: "#/components/schemas/DdsqlTabularQueryResponseData"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponseData'
meta:
- $ref: "#/components/schemas/DdsqlTabularQueryResponseMeta"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponseMeta'
required:
- data
- meta
@@ -32060,7 +32060,7 @@ components:
`state` is `running`; `columns` is set when `state` is `completed`.
properties:
columns:
- $ref: "#/components/schemas/DdsqlTabularQueryColumns"
+ $ref: '#/components/schemas/DdsqlTabularQueryColumns'
query_id:
description: |-
Opaque token to pass to the fetch endpoint to poll for results.
@@ -32068,9 +32068,9 @@ components:
example: "eyJxdWVyeSI6ICJTRUxFQ1QgKiBGUk9NIGxvZ3MifQ=="
type: string
state:
- $ref: "#/components/schemas/DdsqlTabularQueryState"
+ $ref: '#/components/schemas/DdsqlTabularQueryState'
warnings:
- $ref: "#/components/schemas/DdsqlTabularQueryWarnings"
+ $ref: '#/components/schemas/DdsqlTabularQueryWarnings'
required:
- state
type: object
@@ -32078,13 +32078,13 @@ components:
description: JSON:API resource object for a DDSQL tabular query response.
properties:
attributes:
- $ref: "#/components/schemas/DdsqlTabularQueryResponseAttributes"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponseAttributes'
id:
description: Stable identifier for the query response resource.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/DdsqlTabularQueryResponseType"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponseType'
required:
- id
- type
@@ -32165,13 +32165,13 @@ components:
description: The primary data object in the default rulesets per language response.
properties:
attributes:
- $ref: "#/components/schemas/DefaultRulesetsPerLanguageDataAttributes"
+ $ref: '#/components/schemas/DefaultRulesetsPerLanguageDataAttributes'
id:
description: The language identifier used as the resource identifier.
example: python
type: string
type:
- $ref: "#/components/schemas/DefaultRulesetsPerLanguageDataType"
+ $ref: '#/components/schemas/DefaultRulesetsPerLanguageDataType'
required:
- id
- type
@@ -32203,7 +32203,7 @@ components:
description: The response payload containing the default ruleset names for a programming language.
properties:
data:
- $ref: "#/components/schemas/DefaultRulesetsPerLanguageData"
+ $ref: '#/components/schemas/DefaultRulesetsPerLanguageData'
required:
- data
type: object
@@ -32211,11 +32211,11 @@ components:
description: Response object for a single degradation.
properties:
data:
- $ref: "#/components/schemas/DegradationData"
+ $ref: '#/components/schemas/DegradationData'
included:
description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
type: object
DegradationArray:
@@ -32224,15 +32224,15 @@ components:
data:
description: A list of degradation data objects.
items:
- $ref: "#/components/schemas/DegradationData"
+ $ref: '#/components/schemas/DegradationData'
type: array
included:
description: The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
meta:
- $ref: "#/components/schemas/PaginationMeta"
+ $ref: '#/components/schemas/PaginationMeta'
required:
- data
type: object
@@ -32240,15 +32240,15 @@ components:
description: The data object for a degradation.
properties:
attributes:
- $ref: "#/components/schemas/DegradationDataAttributes"
+ $ref: '#/components/schemas/DegradationDataAttributes'
id:
description: The ID of the degradation.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/DegradationDataRelationships"
+ $ref: '#/components/schemas/DegradationDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationRequestDataType'
required:
- type
type: object
@@ -32258,7 +32258,7 @@ components:
components_affected:
description: Components affected by the degradation.
items:
- $ref: "#/components/schemas/DegradationDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/DegradationDataAttributesComponentsAffectedItems'
type: array
created_at:
description: Timestamp of when the degradation was created.
@@ -32275,16 +32275,16 @@ components:
format: date-time
type: string
source:
- $ref: "#/components/schemas/DegradationDataAttributesSource"
+ $ref: '#/components/schemas/DegradationDataAttributesSource'
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
title:
description: Title of the degradation.
type: string
updates:
description: Past updates made to the degradation.
items:
- $ref: "#/components/schemas/DegradationDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/DegradationDataAttributesUpdatesItems'
type: array
type: object
DegradationDataAttributesComponentsAffectedItems:
@@ -32300,7 +32300,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
required:
- id
- status
@@ -32318,7 +32318,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/DegradationDataAttributesSourceType"
+ $ref: '#/components/schemas/DegradationDataAttributesSourceType'
required:
- created_at
- source_id
@@ -32338,7 +32338,7 @@ components:
components_affected:
description: The components affected at the time of the update.
items:
- $ref: "#/components/schemas/DegradationDataAttributesUpdatesItemsComponentsAffectedItems"
+ $ref: '#/components/schemas/DegradationDataAttributesUpdatesItemsComponentsAffectedItems'
type: array
created_at:
description: Timestamp of when the update was created.
@@ -32372,7 +32372,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
type: object
DegradationDataAttributesUpdatesItemsComponentsAffectedItems:
description: A component affected at the time of a degradation update.
@@ -32413,7 +32413,7 @@ components:
description: The Datadog user who created the degradation.
properties:
data:
- $ref: "#/components/schemas/DegradationDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/DegradationDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -32425,7 +32425,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -32434,7 +32434,7 @@ components:
description: The Datadog user who last modified the degradation.
properties:
data:
- $ref: "#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -32446,7 +32446,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -32455,7 +32455,7 @@ components:
description: The status page the degradation belongs to.
properties:
data:
- $ref: "#/components/schemas/DegradationDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/DegradationDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -32468,7 +32468,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -32477,7 +32477,7 @@ components:
description: The template the degradation was created from.
properties:
data:
- $ref: "#/components/schemas/DegradationDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/DegradationDataRelationshipsTemplateData'
required:
- data
type: object
@@ -32489,7 +32489,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
- id
@@ -32497,8 +32497,8 @@ components:
DegradationIncluded:
description: An included resource related to a degradation or maintenance.
oneOf:
- - $ref: "#/components/schemas/StatusPagesUser"
- - $ref: "#/components/schemas/StatusPageAsIncluded"
+ - $ref: '#/components/schemas/StatusPagesUser'
+ - $ref: '#/components/schemas/StatusPageAsIncluded'
DegradationRequestMeta:
description: The supported metadata for a degradation request.
properties:
@@ -32512,11 +32512,11 @@ components:
description: Response object for a single degradation template.
properties:
data:
- $ref: "#/components/schemas/DegradationTemplateData"
+ $ref: '#/components/schemas/DegradationTemplateData'
included:
description: The included related resources of a degradation template. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
type: object
DegradationTemplateArray:
@@ -32525,12 +32525,12 @@ components:
data:
description: A list of degradation template data objects.
items:
- $ref: "#/components/schemas/DegradationTemplateData"
+ $ref: '#/components/schemas/DegradationTemplateData'
type: array
included:
description: The included related resources of a degradation template. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
required:
- data
@@ -32539,14 +32539,14 @@ components:
description: The data object for a degradation template.
properties:
attributes:
- $ref: "#/components/schemas/DegradationTemplateDataAttributes"
+ $ref: '#/components/schemas/DegradationTemplateDataAttributes'
id:
description: The ID of the degradation template.
type: string
relationships:
- $ref: "#/components/schemas/DegradationTemplateDataRelationships"
+ $ref: '#/components/schemas/DegradationTemplateDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
type: object
@@ -32556,7 +32556,7 @@ components:
components_affected:
description: The components affected by a degradation created from this template.
items:
- $ref: "#/components/schemas/DegradationTemplateDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/DegradationTemplateDataAttributesComponentsAffectedItems'
type: array
created_at:
description: Timestamp of when the degradation template was created.
@@ -32575,7 +32575,7 @@ components:
updates:
description: The pre-filled updates for a degradation created from this template.
items:
- $ref: "#/components/schemas/DegradationTemplateDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/DegradationTemplateDataAttributesUpdatesItems'
type: array
type: object
DegradationTemplateDataAttributesComponentsAffectedItems:
@@ -32590,7 +32590,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -32602,7 +32602,7 @@ components:
description: The message of the update.
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
required:
- status
type: object
@@ -32623,7 +32623,7 @@ components:
description: The Datadog user who created the degradation template.
properties:
data:
- $ref: "#/components/schemas/DegradationTemplateDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/DegradationTemplateDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -32635,7 +32635,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -32644,7 +32644,7 @@ components:
description: The Datadog user who last modified the degradation template.
properties:
data:
- $ref: "#/components/schemas/DegradationTemplateDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/DegradationTemplateDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -32656,7 +32656,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -32665,7 +32665,7 @@ components:
description: The status page the degradation template belongs to.
properties:
data:
- $ref: "#/components/schemas/DegradationTemplateDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/DegradationTemplateDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -32677,7 +32677,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -32686,25 +32686,25 @@ components:
description: Response object for a degradation update.
properties:
data:
- $ref: "#/components/schemas/DegradationUpdateData"
+ $ref: '#/components/schemas/DegradationUpdateData'
included:
description: Resources related to the degradation update.
items:
- $ref: "#/components/schemas/DegradationUpdateIncluded"
+ $ref: '#/components/schemas/DegradationUpdateIncluded'
type: array
type: object
DegradationUpdateData:
description: The data object for a degradation update.
properties:
attributes:
- $ref: "#/components/schemas/DegradationUpdateDataAttributes"
+ $ref: '#/components/schemas/DegradationUpdateDataAttributes'
id:
description: The ID of the degradation update.
type: string
relationships:
- $ref: "#/components/schemas/DegradationUpdateDataRelationships"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationUpdateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequestDataType'
required:
- type
type: object
@@ -32714,7 +32714,7 @@ components:
components_affected:
description: Components affected by this update.
items:
- $ref: "#/components/schemas/DegradationUpdateDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/DegradationUpdateDataAttributesComponentsAffectedItems'
type: array
created_at:
description: The date and time the update was created.
@@ -32736,7 +32736,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
type: object
DegradationUpdateDataAttributesComponentsAffectedItems:
description: A component affected by a degradation update.
@@ -32750,7 +32750,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
required:
- id
- status
@@ -32759,21 +32759,21 @@ components:
description: Relationships of a degradation update resource.
properties:
created_by_user:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsUser"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsUser'
degradation:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsDegradation"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsDegradation'
deleted_by_user:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsUser"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsUser'
last_modified_by_user:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsUser"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsUser'
status_page:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsStatusPage"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsStatusPage'
type: object
DegradationUpdateDataRelationshipsDegradation:
description: The degradation relationship of a degradation update.
properties:
data:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsDegradationData"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsDegradationData'
required:
- data
type: object
@@ -32785,7 +32785,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationRequestDataType'
required:
- type
- id
@@ -32794,7 +32794,7 @@ components:
description: The status page relationship of a degradation update.
properties:
data:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -32806,7 +32806,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -32815,7 +32815,7 @@ components:
description: A user relationship of a degradation update.
properties:
data:
- $ref: "#/components/schemas/DegradationUpdateDataRelationshipsUserData"
+ $ref: '#/components/schemas/DegradationUpdateDataRelationshipsUserData'
required:
- data
type: object
@@ -32827,7 +32827,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -32835,14 +32835,14 @@ components:
DegradationUpdateIncluded:
description: Resources included in a degradation update response.
oneOf:
- - $ref: "#/components/schemas/StatusPagesUser"
- - $ref: "#/components/schemas/Degradation"
- - $ref: "#/components/schemas/StatusPageAsIncluded"
+ - $ref: '#/components/schemas/StatusPagesUser'
+ - $ref: '#/components/schemas/Degradation'
+ - $ref: '#/components/schemas/StatusPageAsIncluded'
DeleteAppResponse:
description: The response object after an app is successfully deleted.
properties:
data:
- $ref: "#/components/schemas/DeleteAppResponseData"
+ $ref: '#/components/schemas/DeleteAppResponseData'
type: object
DeleteAppResponseData:
description: The definition of `DeleteAppResponseData` object.
@@ -32853,7 +32853,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -32862,15 +32862,15 @@ components:
description: Request to delete a specific item from a datastore by its primary key.
properties:
data:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemRequestData"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemRequestData'
type: object
DeleteAppsDatastoreItemRequestData:
description: Data wrapper containing the information needed to identify and delete a specific datastore item.
properties:
attributes:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemRequestDataAttributes"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemRequestDataAttributes'
type:
- $ref: "#/components/schemas/DatastoreItemsDataType"
+ $ref: '#/components/schemas/DatastoreItemsDataType'
required:
- type
type: object
@@ -32893,7 +32893,7 @@ components:
description: Response from successfully deleting a datastore item.
properties:
data:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseData"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
type: object
DeleteAppsDatastoreItemResponseArray:
description: The definition of `DeleteAppsDatastoreItemResponseArray` object.
@@ -32901,7 +32901,7 @@ components:
data:
description: The `DeleteAppsDatastoreItemResponseArray` `data`.
items:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseData"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
type: array
required:
- data
@@ -32913,7 +32913,7 @@ components:
description: The unique identifier of the item that was deleted.
type: string
type:
- $ref: "#/components/schemas/DatastoreItemsDataType"
+ $ref: '#/components/schemas/DatastoreItemsDataType'
required:
- type
type: object
@@ -32931,7 +32931,7 @@ components:
data:
description: An array of objects containing the IDs of the apps to delete.
items:
- $ref: "#/components/schemas/DeleteAppsRequestDataItems"
+ $ref: '#/components/schemas/DeleteAppsRequestDataItems'
type: array
type: object
DeleteAppsRequestDataItems:
@@ -32943,7 +32943,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -32954,7 +32954,7 @@ components:
data:
description: An array of objects containing the IDs of the deleted apps.
items:
- $ref: "#/components/schemas/DeleteAppsResponseDataItems"
+ $ref: '#/components/schemas/DeleteAppsResponseDataItems'
type: array
type: object
DeleteAppsResponseDataItems:
@@ -32966,7 +32966,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -32975,7 +32975,7 @@ components:
description: Response object to delete a custom framework.
properties:
data:
- $ref: "#/components/schemas/CustomFrameworkMetadata"
+ $ref: '#/components/schemas/CustomFrameworkMetadata'
required:
- data
type: object
@@ -32988,7 +32988,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/FormType"
+ $ref: '#/components/schemas/FormType'
required:
- id
- type
@@ -32997,18 +32997,18 @@ components:
description: A response returned after deleting a form.
properties:
data:
- $ref: "#/components/schemas/DeleteFormData"
+ $ref: '#/components/schemas/DeleteFormData'
type: object
DeletedSuiteResponseData:
description: Data object for a deleted Synthetic test suite.
properties:
attributes:
- $ref: "#/components/schemas/DeletedSuiteResponseDataAttributes"
+ $ref: '#/components/schemas/DeletedSuiteResponseDataAttributes'
id:
description: The public ID of the deleted Synthetic test suite.
type: string
type:
- $ref: "#/components/schemas/SyntheticsSuiteTypes"
+ $ref: '#/components/schemas/SyntheticsSuiteTypes'
type: object
DeletedSuiteResponseDataAttributes:
description: Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID.
@@ -33024,12 +33024,12 @@ components:
description: Data object for a bulk delete Synthetic test suites request.
properties:
attributes:
- $ref: "#/components/schemas/DeletedSuitesRequestDeleteAttributes"
+ $ref: '#/components/schemas/DeletedSuitesRequestDeleteAttributes'
id:
description: An optional identifier for the delete request.
type: string
type:
- $ref: "#/components/schemas/DeletedSuitesRequestType"
+ $ref: '#/components/schemas/DeletedSuitesRequestType'
required:
- attributes
type: object
@@ -33054,7 +33054,7 @@ components:
description: Request body for bulk deleting Synthetic test suites.
properties:
data:
- $ref: "#/components/schemas/DeletedSuitesRequestDelete"
+ $ref: '#/components/schemas/DeletedSuitesRequestDelete'
required:
- data
type: object
@@ -33073,19 +33073,19 @@ components:
data:
description: List of deleted Synthetic suite data objects.
items:
- $ref: "#/components/schemas/DeletedSuiteResponseData"
+ $ref: '#/components/schemas/DeletedSuiteResponseData'
type: array
type: object
DeletedTestResponseData:
description: Data object for a deleted Synthetic test.
properties:
attributes:
- $ref: "#/components/schemas/DeletedTestResponseDataAttributes"
+ $ref: '#/components/schemas/DeletedTestResponseDataAttributes'
id:
description: The public ID of the deleted Synthetic test.
type: string
type:
- $ref: "#/components/schemas/DeletedTestsResponseType"
+ $ref: '#/components/schemas/DeletedTestsResponseType'
type: object
DeletedTestResponseDataAttributes:
description: Attributes of a deleted Synthetic test, including deletion timestamp and public ID.
@@ -33101,12 +33101,12 @@ components:
description: Data object for a bulk delete Synthetic tests request.
properties:
attributes:
- $ref: "#/components/schemas/DeletedTestsRequestDeleteAttributes"
+ $ref: '#/components/schemas/DeletedTestsRequestDeleteAttributes'
id:
description: An optional identifier for the delete request.
type: string
type:
- $ref: "#/components/schemas/DeletedTestsRequestType"
+ $ref: '#/components/schemas/DeletedTestsRequestType'
required:
- attributes
type: object
@@ -33131,7 +33131,7 @@ components:
description: Request body for bulk deleting Synthetic tests.
properties:
data:
- $ref: "#/components/schemas/DeletedTestsRequestDelete"
+ $ref: '#/components/schemas/DeletedTestsRequestDelete'
required:
- data
type: object
@@ -33150,7 +33150,7 @@ components:
data:
description: List of deleted Synthetic test data objects.
items:
- $ref: "#/components/schemas/DeletedTestResponseData"
+ $ref: '#/components/schemas/DeletedTestResponseData'
type: array
type: object
DeletedTestsResponseType:
@@ -33200,16 +33200,16 @@ components:
description: The version of the app that was published.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentAttributes"
+ $ref: '#/components/schemas/DeploymentAttributes'
id:
description: The deployment ID.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
meta:
- $ref: "#/components/schemas/DeploymentMetadata"
+ $ref: '#/components/schemas/DeploymentMetadata'
type:
- $ref: "#/components/schemas/AppDeploymentType"
+ $ref: '#/components/schemas/AppDeploymentType'
type: object
DeploymentAttributes:
description: The attributes object containing the version ID of the published app.
@@ -33232,19 +33232,19 @@ components:
description: Response for a deployment gate.
properties:
data:
- $ref: "#/components/schemas/DeploymentGateResponseData"
+ $ref: '#/components/schemas/DeploymentGateResponseData'
type: object
DeploymentGateResponseData:
description: Data for a deployment gate.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentGateResponseDataAttributes"
+ $ref: '#/components/schemas/DeploymentGateResponseDataAttributes'
id:
description: Unique identifier of the deployment gate.
example: "1111-2222-3333-4444-555566667777"
type: string
type:
- $ref: "#/components/schemas/DeploymentGateDataType"
+ $ref: '#/components/schemas/DeploymentGateDataType'
required:
- type
- attributes
@@ -33259,7 +33259,7 @@ components:
format: date-time
type: string
created_by:
- $ref: "#/components/schemas/DeploymentGateResponseDataAttributesCreatedBy"
+ $ref: '#/components/schemas/DeploymentGateResponseDataAttributesCreatedBy'
dry_run:
description: Whether this gate is run in dry-run mode.
example: false
@@ -33282,7 +33282,7 @@ components:
format: date-time
type: string
updated_by:
- $ref: "#/components/schemas/DeploymentGateResponseDataAttributesUpdatedBy"
+ $ref: '#/components/schemas/DeploymentGateResponseDataAttributesUpdatedBy'
required:
- created_at
- created_by
@@ -33331,7 +33331,7 @@ components:
description: Response for a deployment gate rules.
properties:
data:
- $ref: "#/components/schemas/ListDeploymentRuleResponseData"
+ $ref: '#/components/schemas/ListDeploymentRuleResponseData'
type: object
DeploymentGatesEvaluationConfiguration:
description: |-
@@ -33346,7 +33346,7 @@ components:
rules:
description: The list of rules to evaluate. At least one rule is required.
items:
- $ref: "#/components/schemas/DeploymentGatesEvaluationRule"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationRule'
minItems: 1
type: array
required:
@@ -33356,7 +33356,7 @@ components:
description: Request body for triggering a deployment gate evaluation.
properties:
data:
- $ref: "#/components/schemas/DeploymentGatesEvaluationRequestData"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationRequestData'
required:
- data
type: object
@@ -33367,7 +33367,7 @@ components:
When omitted, rules are resolved from the preconfigured gate for the given service and environment.
properties:
configuration:
- $ref: "#/components/schemas/DeploymentGatesEvaluationConfiguration"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationConfiguration'
env:
description: The environment of the deployment.
example: "staging"
@@ -33397,9 +33397,9 @@ components:
description: Data for a deployment gate evaluation request.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentGatesEvaluationRequestAttributes"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationRequestAttributes'
type:
- $ref: "#/components/schemas/DeploymentGatesEvaluationRequestDataType"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationRequestDataType'
required:
- type
- attributes
@@ -33417,7 +33417,7 @@ components:
description: Response for a deployment gate evaluation request.
properties:
data:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResponseData"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResponseData'
type: object
DeploymentGatesEvaluationResponseAttributes:
description: Attributes for a deployment gate evaluation response.
@@ -33433,14 +33433,14 @@ components:
description: Data for a deployment gate evaluation response.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResponseAttributes"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResponseAttributes'
id:
description: The unique identifier of the evaluation response.
example: "e9d2f04f-4f4b-494b-86e5-52f03e10c8e9"
format: uuid
type: string
type:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResponseDataType"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResponseDataType'
required:
- type
- attributes
@@ -33459,7 +33459,7 @@ components:
description: Response containing the result of a deployment gate evaluation.
properties:
data:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponseData"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponseData'
type: object
DeploymentGatesEvaluationResultResponseAttributes:
description: Attributes for a deployment gate evaluation result response.
@@ -33482,11 +33482,11 @@ components:
format: uuid
type: string
gate_status:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponseAttributesGateStatus"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponseAttributesGateStatus'
rules:
description: The results of individual rule evaluations.
items:
- $ref: "#/components/schemas/DeploymentGatesRuleResponse"
+ $ref: '#/components/schemas/DeploymentGatesRuleResponse'
type: array
required:
- dry_run
@@ -33516,13 +33516,13 @@ components:
description: Data for a deployment gate evaluation result response.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponseAttributes"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponseAttributes'
id:
description: The unique identifier of the evaluation.
example: "e9d2f04f-4f4b-494b-86e5-52f03e10c8e9"
type: string
type:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponseDataType"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponseDataType'
required:
- type
- attributes
@@ -33545,8 +33545,8 @@ components:
monitor: "#/components/schemas/DeploymentGatesMonitorRule"
propertyName: type
oneOf:
- - $ref: "#/components/schemas/DeploymentGatesMonitorRule"
- - $ref: "#/components/schemas/DeploymentGatesFDDRule"
+ - $ref: '#/components/schemas/DeploymentGatesMonitorRule'
+ - $ref: '#/components/schemas/DeploymentGatesFDDRule'
DeploymentGatesFDDRule:
description: A faulty deployment detection rule to evaluate as part of a deployment gate evaluation.
properties:
@@ -33559,9 +33559,9 @@ components:
example: "apm faulty deployment"
type: string
options:
- $ref: "#/components/schemas/DeploymentGatesFDDRuleOptions"
+ $ref: '#/components/schemas/DeploymentGatesFDDRuleOptions'
type:
- $ref: "#/components/schemas/DeploymentGatesFDDRuleType"
+ $ref: '#/components/schemas/DeploymentGatesFDDRuleType'
required:
- type
- name
@@ -33604,16 +33604,16 @@ components:
data:
description: Array of deployment gates.
items:
- $ref: "#/components/schemas/DeploymentGateResponseData"
+ $ref: '#/components/schemas/DeploymentGateResponseData'
type: array
meta:
- $ref: "#/components/schemas/DeploymentGatesListResponseMeta"
+ $ref: '#/components/schemas/DeploymentGatesListResponseMeta'
type: object
DeploymentGatesListResponseMeta:
description: Metadata for a list of deployment gates response.
properties:
page:
- $ref: "#/components/schemas/DeploymentGatesListResponseMetaPage"
+ $ref: '#/components/schemas/DeploymentGatesListResponseMetaPage'
type: object
DeploymentGatesListResponseMetaPage:
description: Pagination information for a list of deployment gates.
@@ -33644,9 +33644,9 @@ components:
example: "error rate monitors"
type: string
options:
- $ref: "#/components/schemas/DeploymentGatesMonitorRuleOptions"
+ $ref: '#/components/schemas/DeploymentGatesMonitorRuleOptions'
type:
- $ref: "#/components/schemas/DeploymentGatesMonitorRuleType"
+ $ref: '#/components/schemas/DeploymentGatesMonitorRuleType'
required:
- type
- name
@@ -33691,7 +33691,7 @@ components:
example: "One or more monitors in ALERT state"
type: string
status:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponseAttributesGateStatus"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponseAttributesGateStatus'
type: object
DeploymentMetadata:
description: Metadata object containing the publication creation information.
@@ -33717,9 +33717,9 @@ components:
description: Information pointing to the app's publication status.
properties:
data:
- $ref: "#/components/schemas/DeploymentRelationshipData"
+ $ref: '#/components/schemas/DeploymentRelationshipData'
meta:
- $ref: "#/components/schemas/DeploymentMetadata"
+ $ref: '#/components/schemas/DeploymentMetadata'
type: object
DeploymentRelationshipData:
description: Data object containing the deployment ID.
@@ -33730,7 +33730,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDeploymentType"
+ $ref: '#/components/schemas/AppDeploymentType'
type: object
DeploymentRuleDataType:
description: Deployment rule resource type.
@@ -33766,7 +33766,7 @@ components:
type: object
DeploymentRuleOptionsMonitor:
additionalProperties: false
- description: Monitor options for deployment rules.
+ description: Monitor query options for deployment rules.
properties:
duration:
description: Seconds the monitor needs to stay in OK status for the rule to pass.
@@ -33784,7 +33784,7 @@ components:
example: false
type: boolean
query:
- description: Monitors that match this query are evaluated.
+ description: A query that selects the monitors to evaluate.
example: "service:my-service env:prod"
type: string
warmup:
@@ -33797,23 +33797,83 @@ components:
required:
- query
type: object
+ DeploymentRuleOptionsMonitorId:
+ additionalProperties: false
+ description: A specific monitor and the groups to evaluate for it.
+ properties:
+ groups:
+ description: The exact monitor group names to evaluate. An empty array evaluates all groups.
+ example: []
+ items:
+ description: An exact monitor group name.
+ minLength: 1
+ type: string
+ type: array
+ uniqueItems: true
+ id:
+ description: The monitor's decimal ID.
+ example: "123456"
+ pattern: "^[1-9][0-9]*$"
+ type: string
+ required:
+ - id
+ - groups
+ type: object
+ DeploymentRuleOptionsMonitorIds:
+ additionalProperties: false
+ description: Specific monitor options for deployment rules.
+ properties:
+ duration:
+ description: Seconds the monitors need to stay in OK status for the rule to pass.
+ example: 3600
+ format: int64
+ type: integer
+ fail_on_no_data:
+ default: true
+ description: Whether the rule should fail if a selected monitor group is in a NO DATA state.
+ example: false
+ type: boolean
+ fail_on_no_groups_found:
+ default: false
+ description: Whether the rule should fail if no monitor groups are found for the selected monitors.
+ example: false
+ type: boolean
+ monitor_ids:
+ description: A non-empty list of specific monitors to evaluate.
+ example:
+ - groups: []
+ id: "123456"
+ items:
+ $ref: '#/components/schemas/DeploymentRuleOptionsMonitorId'
+ minItems: 1
+ type: array
+ warmup:
+ default: 0
+ description: Seconds to wait after a deployment starts before evaluating the monitors' statuses.
+ example: 0
+ format: int64
+ minimum: 0
+ type: integer
+ required:
+ - monitor_ids
+ type: object
DeploymentRuleResponse:
description: Response for a deployment rule.
properties:
data:
- $ref: "#/components/schemas/DeploymentRuleResponseData"
+ $ref: '#/components/schemas/DeploymentRuleResponseData'
type: object
DeploymentRuleResponseData:
description: Data for a deployment rule.
properties:
attributes:
- $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes"
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributes'
id:
description: Unique identifier of the deployment rule.
example: "1111-2222-3333-4444-555566667777"
type: string
type:
- $ref: "#/components/schemas/DeploymentRuleDataType"
+ $ref: '#/components/schemas/DeploymentRuleDataType'
required:
- type
- attributes
@@ -33828,7 +33888,7 @@ components:
format: date-time
type: string
created_by:
- $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesCreatedBy"
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesCreatedBy'
dry_run:
description: Whether this rule is run in dry-run mode.
example: false
@@ -33842,15 +33902,15 @@ components:
example: "My deployment rule"
type: string
options:
- $ref: "#/components/schemas/DeploymentRulesOptions"
+ $ref: '#/components/schemas/DeploymentRulesOptions'
type:
- $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesType"
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesType'
updated_at:
description: The timestamp when the deployment rule was last updated.
format: date-time
type: string
updated_by:
- $ref: "#/components/schemas/DeploymentRuleResponseDataAttributesUpdatedBy"
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributesUpdatedBy'
required:
- created_at
- created_by
@@ -33909,13 +33969,14 @@ components:
DeploymentRulesOptions:
description: Options for deployment rule response representing either faulty deployment detection or monitor options.
oneOf:
- - $ref: "#/components/schemas/DeploymentRuleOptionsFaultyDeploymentDetection"
- - $ref: "#/components/schemas/DeploymentRuleOptionsMonitor"
+ - $ref: '#/components/schemas/DeploymentRuleOptionsFaultyDeploymentDetection'
+ - $ref: '#/components/schemas/DeploymentRuleOptionsMonitor'
+ - $ref: '#/components/schemas/DeploymentRuleOptionsMonitorIds'
DetachCaseRequest:
description: Request for detaching security findings from their case.
properties:
data:
- $ref: "#/components/schemas/DetachCaseRequestData"
+ $ref: '#/components/schemas/DetachCaseRequestData'
type: object
DetachCaseRequestData:
description: Data for detaching security findings from their case.
@@ -33925,9 +33986,9 @@ components:
example: "c1234567-89ab-cdef-0123-456789abcdef"
type: string
relationships:
- $ref: "#/components/schemas/DetachCaseRequestDataRelationships"
+ $ref: '#/components/schemas/DetachCaseRequestDataRelationships'
type:
- $ref: "#/components/schemas/CaseDataType"
+ $ref: '#/components/schemas/CaseDataType'
required:
- type
type: object
@@ -33944,40 +34005,40 @@ components:
description: A single finding with with message and resource configuration.
properties:
attributes:
- $ref: "#/components/schemas/DetailedFindingAttributes"
+ $ref: '#/components/schemas/DetailedFindingAttributes'
id:
- $ref: "#/components/schemas/FindingID"
+ $ref: '#/components/schemas/FindingID'
type:
- $ref: "#/components/schemas/DetailedFindingType"
+ $ref: '#/components/schemas/DetailedFindingType'
type: object
DetailedFindingAttributes:
description: The JSON:API attributes of the detailed finding.
properties:
evaluation:
- $ref: "#/components/schemas/FindingEvaluation"
+ $ref: '#/components/schemas/FindingEvaluation'
evaluation_changed_at:
- $ref: "#/components/schemas/FindingEvaluationChangedAt"
+ $ref: '#/components/schemas/FindingEvaluationChangedAt'
message:
description: The remediation message for this finding.
example: "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data."
type: string
mute:
- $ref: "#/components/schemas/FindingMute"
+ $ref: '#/components/schemas/FindingMute'
resource:
- $ref: "#/components/schemas/FindingResource"
+ $ref: '#/components/schemas/FindingResource'
resource_configuration:
description: The resource configuration for this finding.
type: object
resource_discovery_date:
- $ref: "#/components/schemas/FindingResourceDiscoveryDate"
+ $ref: '#/components/schemas/FindingResourceDiscoveryDate'
resource_type:
- $ref: "#/components/schemas/FindingResourceType"
+ $ref: '#/components/schemas/FindingResourceType'
rule:
- $ref: "#/components/schemas/FindingRule"
+ $ref: '#/components/schemas/FindingRule'
status:
- $ref: "#/components/schemas/FindingStatus"
+ $ref: '#/components/schemas/FindingStatus'
tags:
- $ref: "#/components/schemas/FindingTags"
+ $ref: '#/components/schemas/FindingTags'
type: object
DetailedFindingType:
default: detailed_finding
@@ -34003,7 +34064,7 @@ components:
example: snmp
type: string
interface_statuses:
- $ref: "#/components/schemas/DeviceAttributesInterfaceStatuses"
+ $ref: '#/components/schemas/DeviceAttributesInterfaceStatuses'
ip_address:
description: The device IP address
example: 1.2.3.4
@@ -34100,7 +34161,7 @@ components:
description: The devices list data
properties:
attributes:
- $ref: "#/components/schemas/DeviceAttributes"
+ $ref: '#/components/schemas/DeviceAttributes'
id:
description: The device ID
example: example:1.2.3.4
@@ -34149,13 +34210,13 @@ components:
description: The email domain allowlist for an org.
properties:
attributes:
- $ref: "#/components/schemas/DomainAllowlistAttributes"
+ $ref: '#/components/schemas/DomainAllowlistAttributes'
id:
description: The unique identifier of the org.
nullable: true
type: string
type:
- $ref: "#/components/schemas/DomainAllowlistType"
+ $ref: '#/components/schemas/DomainAllowlistType'
required:
- type
type: object
@@ -34176,7 +34237,7 @@ components:
description: Request containing the desired email domain allowlist configuration.
properties:
data:
- $ref: "#/components/schemas/DomainAllowlist"
+ $ref: '#/components/schemas/DomainAllowlist'
required:
- data
type: object
@@ -34184,19 +34245,19 @@ components:
description: Response containing information about the email domain allowlist.
properties:
data:
- $ref: "#/components/schemas/DomainAllowlistResponseData"
+ $ref: '#/components/schemas/DomainAllowlistResponseData'
type: object
DomainAllowlistResponseData:
description: The email domain allowlist response for an org.
properties:
attributes:
- $ref: "#/components/schemas/DomainAllowlistResponseDataAttributes"
+ $ref: '#/components/schemas/DomainAllowlistResponseDataAttributes'
id:
description: The unique identifier of the org.
nullable: true
type: string
type:
- $ref: "#/components/schemas/DomainAllowlistType"
+ $ref: '#/components/schemas/DomainAllowlistType'
required:
- type
type: object
@@ -34226,7 +34287,7 @@ components:
description: Request for creating a downtime.
properties:
data:
- $ref: "#/components/schemas/DowntimeCreateRequestData"
+ $ref: '#/components/schemas/DowntimeCreateRequestData'
required:
- data
type: object
@@ -34234,21 +34295,21 @@ components:
description: Downtime details.
properties:
display_timezone:
- $ref: "#/components/schemas/DowntimeDisplayTimezone"
+ $ref: '#/components/schemas/DowntimeDisplayTimezone'
message:
- $ref: "#/components/schemas/DowntimeMessage"
+ $ref: '#/components/schemas/DowntimeMessage'
monitor_identifier:
- $ref: "#/components/schemas/DowntimeMonitorIdentifier"
+ $ref: '#/components/schemas/DowntimeMonitorIdentifier'
mute_first_recovery_notification:
- $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification"
+ $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
notify_end_states:
- $ref: "#/components/schemas/DowntimeNotifyEndStates"
+ $ref: '#/components/schemas/DowntimeNotifyEndStates'
notify_end_types:
- $ref: "#/components/schemas/DowntimeNotifyEndTypes"
+ $ref: '#/components/schemas/DowntimeNotifyEndTypes'
schedule:
- $ref: "#/components/schemas/DowntimeScheduleCreateRequest"
+ $ref: '#/components/schemas/DowntimeScheduleCreateRequest'
scope:
- $ref: "#/components/schemas/DowntimeScope"
+ $ref: '#/components/schemas/DowntimeScope'
required:
- scope
- monitor_identifier
@@ -34257,9 +34318,9 @@ components:
description: Object to create a downtime.
properties:
attributes:
- $ref: "#/components/schemas/DowntimeCreateRequestAttributes"
+ $ref: '#/components/schemas/DowntimeCreateRequestAttributes'
type:
- $ref: "#/components/schemas/DowntimeResourceType"
+ $ref: '#/components/schemas/DowntimeResourceType'
required:
- type
- attributes
@@ -34292,7 +34353,7 @@ components:
description: Pagination metadata returned by the API.
properties:
page:
- $ref: "#/components/schemas/DowntimeMetaPage"
+ $ref: '#/components/schemas/DowntimeMetaPage'
type: object
DowntimeMetaPage:
description: Object containing the total filtered count.
@@ -34305,8 +34366,8 @@ components:
DowntimeMonitorIdentifier:
description: Monitor identifier for the downtime.
oneOf:
- - $ref: "#/components/schemas/DowntimeMonitorIdentifierId"
- - $ref: "#/components/schemas/DowntimeMonitorIdentifierTags"
+ - $ref: '#/components/schemas/DowntimeMonitorIdentifierId'
+ - $ref: '#/components/schemas/DowntimeMonitorIdentifierTags'
DowntimeMonitorIdentifierId:
additionalProperties: {}
description: Object of the monitor identifier.
@@ -34351,14 +34412,14 @@ components:
description: Information about the monitor identified by the downtime.
properties:
attributes:
- $ref: "#/components/schemas/DowntimeMonitorIncludedAttributes"
+ $ref: '#/components/schemas/DowntimeMonitorIncludedAttributes'
id:
description: ID of the monitor identified by the downtime.
example: 12345
format: int64
type: integer
type:
- $ref: "#/components/schemas/DowntimeIncludedMonitorType"
+ $ref: '#/components/schemas/DowntimeIncludedMonitorType'
type: object
DowntimeMuteFirstRecoveryNotification:
description: If the first recovery notification during a downtime should be muted.
@@ -34390,27 +34451,27 @@ components:
description: States that will trigger a monitor notification when the `notify_end_types` action occurs.
example: ["alert", "warn"]
items:
- $ref: "#/components/schemas/DowntimeNotifyEndStateTypes"
+ $ref: '#/components/schemas/DowntimeNotifyEndStateTypes'
type: array
DowntimeNotifyEndTypes:
description: Actions that will trigger a monitor notification if the downtime is in the `notify_end_types` state.
example: ["canceled", "expired"]
items:
- $ref: "#/components/schemas/DowntimeNotifyEndStateActions"
+ $ref: '#/components/schemas/DowntimeNotifyEndStateActions'
type: array
DowntimeRelationships:
description: All relationships associated with downtime.
properties:
created_by:
- $ref: "#/components/schemas/DowntimeRelationshipsCreatedBy"
+ $ref: '#/components/schemas/DowntimeRelationshipsCreatedBy'
monitor:
- $ref: "#/components/schemas/DowntimeRelationshipsMonitor"
+ $ref: '#/components/schemas/DowntimeRelationshipsMonitor'
type: object
DowntimeRelationshipsCreatedBy:
description: The user who created the downtime.
properties:
data:
- $ref: "#/components/schemas/DowntimeRelationshipsCreatedByData"
+ $ref: '#/components/schemas/DowntimeRelationshipsCreatedByData'
type: object
DowntimeRelationshipsCreatedByData:
description: Data for the user who created the downtime.
@@ -34421,13 +34482,13 @@ components:
example: "00000000-0000-1234-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
type: object
DowntimeRelationshipsMonitor:
description: The monitor identified by the downtime.
properties:
data:
- $ref: "#/components/schemas/DowntimeRelationshipsMonitorData"
+ $ref: '#/components/schemas/DowntimeRelationshipsMonitorData'
type: object
DowntimeRelationshipsMonitorData:
description: Data for the monitor.
@@ -34438,7 +34499,7 @@ components:
example: "12345"
type: string
type:
- $ref: "#/components/schemas/DowntimeIncludedMonitorType"
+ $ref: '#/components/schemas/DowntimeIncludedMonitorType'
type: object
DowntimeResourceType:
default: downtime
@@ -34457,11 +34518,11 @@ components:
prevent all alerting related to specified Datadog tags.
properties:
data:
- $ref: "#/components/schemas/DowntimeResponseData"
+ $ref: '#/components/schemas/DowntimeResponseData'
included:
description: Array of objects related to the downtime that the user requested.
items:
- $ref: "#/components/schemas/DowntimeResponseIncludedItem"
+ $ref: '#/components/schemas/DowntimeResponseIncludedItem'
type: array
type: object
DowntimeResponseAttributes:
@@ -34479,53 +34540,53 @@ components:
format: date-time
type: string
display_timezone:
- $ref: "#/components/schemas/DowntimeDisplayTimezone"
+ $ref: '#/components/schemas/DowntimeDisplayTimezone'
message:
- $ref: "#/components/schemas/DowntimeMessage"
+ $ref: '#/components/schemas/DowntimeMessage'
modified:
description: Time that the downtime was last modified.
example: "2020-01-02T03:04:05.282979+0000"
format: date-time
type: string
monitor_identifier:
- $ref: "#/components/schemas/DowntimeMonitorIdentifier"
+ $ref: '#/components/schemas/DowntimeMonitorIdentifier'
mute_first_recovery_notification:
- $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification"
+ $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
notify_end_states:
- $ref: "#/components/schemas/DowntimeNotifyEndStates"
+ $ref: '#/components/schemas/DowntimeNotifyEndStates'
notify_end_types:
- $ref: "#/components/schemas/DowntimeNotifyEndTypes"
+ $ref: '#/components/schemas/DowntimeNotifyEndTypes'
schedule:
- $ref: "#/components/schemas/DowntimeScheduleResponse"
+ $ref: '#/components/schemas/DowntimeScheduleResponse'
scope:
- $ref: "#/components/schemas/DowntimeScope"
+ $ref: '#/components/schemas/DowntimeScope'
status:
- $ref: "#/components/schemas/DowntimeStatus"
+ $ref: '#/components/schemas/DowntimeStatus'
type: object
DowntimeResponseData:
description: Downtime data.
properties:
attributes:
- $ref: "#/components/schemas/DowntimeResponseAttributes"
+ $ref: '#/components/schemas/DowntimeResponseAttributes'
id:
description: The downtime ID.
example: "00000000-0000-1234-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/DowntimeRelationships"
+ $ref: '#/components/schemas/DowntimeRelationships'
type:
- $ref: "#/components/schemas/DowntimeResourceType"
+ $ref: '#/components/schemas/DowntimeResourceType'
type: object
DowntimeResponseIncludedItem:
description: An object related to a downtime.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/DowntimeMonitorIncludedItem"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/DowntimeMonitorIncludedItem'
DowntimeScheduleCreateRequest:
description: Schedule for the downtime.
oneOf:
- - $ref: "#/components/schemas/DowntimeScheduleRecurrencesCreateRequest"
- - $ref: "#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest"
+ - $ref: '#/components/schemas/DowntimeScheduleRecurrencesCreateRequest'
+ - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
DowntimeScheduleCurrentDowntimeResponse:
description: |-
The most recent actual start and end dates for a recurring downtime. For a canceled downtime,
@@ -34587,9 +34648,9 @@ components:
description: An object defining the recurrence of the downtime.
properties:
duration:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceDuration"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
rrule:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceRrule"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
start:
description: |-
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the
@@ -34609,9 +34670,9 @@ components:
description: An RRULE-based recurring downtime.
properties:
duration:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceDuration"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceDuration'
rrule:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceRrule"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceRrule'
start:
description: |-
ISO-8601 Datetime to start the downtime. Must not include a UTC offset. If not provided, the
@@ -34635,7 +34696,7 @@ components:
recurrences:
description: A list of downtime recurrences.
items:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
type: array
timezone:
default: UTC
@@ -34649,11 +34710,11 @@ components:
description: A recurring downtime schedule definition.
properties:
current_downtime:
- $ref: "#/components/schemas/DowntimeScheduleCurrentDowntimeResponse"
+ $ref: '#/components/schemas/DowntimeScheduleCurrentDowntimeResponse'
recurrences:
description: A list of downtime recurrences.
items:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceResponse"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceResponse'
maxItems: 5
minItems: 1
type: array
@@ -34674,7 +34735,7 @@ components:
recurrences:
description: A list of downtime recurrences.
items:
- $ref: "#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest"
+ $ref: '#/components/schemas/DowntimeScheduleRecurrenceCreateUpdateRequest'
type: array
timezone:
default: UTC
@@ -34688,13 +34749,13 @@ components:
one-time and recurring. Recurring schedules may have up to five RRULE-based recurrences. If no schedules are
provided, the downtime will begin immediately and never end.
oneOf:
- - $ref: "#/components/schemas/DowntimeScheduleRecurrencesResponse"
- - $ref: "#/components/schemas/DowntimeScheduleOneTimeResponse"
+ - $ref: '#/components/schemas/DowntimeScheduleRecurrencesResponse'
+ - $ref: '#/components/schemas/DowntimeScheduleOneTimeResponse'
DowntimeScheduleUpdateRequest:
description: Schedule for the downtime.
oneOf:
- - $ref: "#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest"
- - $ref: "#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest"
+ - $ref: '#/components/schemas/DowntimeScheduleRecurrencesUpdateRequest'
+ - $ref: '#/components/schemas/DowntimeScheduleOneTimeCreateUpdateRequest'
DowntimeScope:
description: |-
The scope to which the downtime applies. Must follow the [common search syntax](https://docs.datadoghq.com/logs/explorer/search_syntax/).
@@ -34718,7 +34779,7 @@ components:
description: Request for editing a downtime.
properties:
data:
- $ref: "#/components/schemas/DowntimeUpdateRequestData"
+ $ref: '#/components/schemas/DowntimeUpdateRequestData'
required:
- data
type: object
@@ -34726,33 +34787,33 @@ components:
description: Attributes of the downtime to update.
properties:
display_timezone:
- $ref: "#/components/schemas/DowntimeDisplayTimezone"
+ $ref: '#/components/schemas/DowntimeDisplayTimezone'
message:
- $ref: "#/components/schemas/DowntimeMessage"
+ $ref: '#/components/schemas/DowntimeMessage'
monitor_identifier:
- $ref: "#/components/schemas/DowntimeMonitorIdentifier"
+ $ref: '#/components/schemas/DowntimeMonitorIdentifier'
mute_first_recovery_notification:
- $ref: "#/components/schemas/DowntimeMuteFirstRecoveryNotification"
+ $ref: '#/components/schemas/DowntimeMuteFirstRecoveryNotification'
notify_end_states:
- $ref: "#/components/schemas/DowntimeNotifyEndStates"
+ $ref: '#/components/schemas/DowntimeNotifyEndStates'
notify_end_types:
- $ref: "#/components/schemas/DowntimeNotifyEndTypes"
+ $ref: '#/components/schemas/DowntimeNotifyEndTypes'
schedule:
- $ref: "#/components/schemas/DowntimeScheduleUpdateRequest"
+ $ref: '#/components/schemas/DowntimeScheduleUpdateRequest'
scope:
- $ref: "#/components/schemas/DowntimeScope"
+ $ref: '#/components/schemas/DowntimeScope'
type: object
DowntimeUpdateRequestData:
description: Object to update a downtime.
properties:
attributes:
- $ref: "#/components/schemas/DowntimeUpdateRequestAttributes"
+ $ref: '#/components/schemas/DowntimeUpdateRequestAttributes'
id:
description: ID of this downtime.
example: "00000000-0000-1234-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/DowntimeResourceType"
+ $ref: '#/components/schemas/DowntimeResourceType'
required:
- id
- type
@@ -34779,7 +34840,7 @@ components:
minimum: 1
type: integer
severity:
- $ref: "#/components/schemas/DueDateSeverity"
+ $ref: '#/components/schemas/DueDateSeverity'
required:
- severity
- due_in_days
@@ -34787,15 +34848,15 @@ components:
DueDatePerSeverityList:
description: A list of severity-to-due-date mappings. Each severity may appear at most once.
items:
- $ref: "#/components/schemas/DueDatePerSeverityItem"
+ $ref: '#/components/schemas/DueDatePerSeverityItem'
type: array
DueDateRuleAction:
description: The action to take when the due date rule matches a finding.
properties:
due_days_per_severity:
- $ref: "#/components/schemas/DueDatePerSeverityList"
+ $ref: '#/components/schemas/DueDatePerSeverityList'
due_from:
- $ref: "#/components/schemas/DueDateFrom"
+ $ref: '#/components/schemas/DueDateFrom'
reason_description:
description: An optional description providing more context for the due date assignment.
example: "Applied for production findings only"
@@ -34809,7 +34870,7 @@ components:
description: Attributes for creating or updating a due date rule.
properties:
action:
- $ref: "#/components/schemas/DueDateRuleAction"
+ $ref: '#/components/schemas/DueDateRuleAction'
enabled:
description: Whether the due date rule is enabled.
example: true
@@ -34821,7 +34882,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- rule
@@ -34831,14 +34892,14 @@ components:
description: Attributes of a due date rule returned by the API.
properties:
action:
- $ref: "#/components/schemas/DueDateRuleAction"
+ $ref: '#/components/schemas/DueDateRuleAction'
created_at:
description: The Unix timestamp in milliseconds when the rule was created.
example: 1722439510282
format: int64
type: integer
created_by:
- $ref: "#/components/schemas/AutomationRuleCreatedBy"
+ $ref: '#/components/schemas/AutomationRuleCreatedBy'
enabled:
description: Whether the due date rule is enabled.
example: true
@@ -34849,7 +34910,7 @@ components:
format: int64
type: integer
modified_by:
- $ref: "#/components/schemas/AutomationRuleModifiedBy"
+ $ref: '#/components/schemas/AutomationRuleModifiedBy'
name:
description: The name of the due date rule.
example: "Critical findings due in 7 days"
@@ -34857,7 +34918,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- enabled
@@ -34872,7 +34933,7 @@ components:
description: The body of a due date rule create request.
properties:
data:
- $ref: "#/components/schemas/DueDateRuleDataCreate"
+ $ref: '#/components/schemas/DueDateRuleDataCreate'
required:
- data
type: object
@@ -34880,9 +34941,9 @@ components:
description: The data object for a due date rule create or update request.
properties:
attributes:
- $ref: "#/components/schemas/DueDateRuleAttributesCreate"
+ $ref: '#/components/schemas/DueDateRuleAttributesCreate'
type:
- $ref: "#/components/schemas/DueDateRuleType"
+ $ref: '#/components/schemas/DueDateRuleType'
required:
- type
- attributes
@@ -34891,14 +34952,14 @@ components:
description: The data object for a due date rule returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/DueDateRuleAttributesResponse"
+ $ref: '#/components/schemas/DueDateRuleAttributesResponse'
id:
description: The ID of the due date rule.
example: "00000000-0000-0000-0000-000000000000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/DueDateRuleType"
+ $ref: '#/components/schemas/DueDateRuleType'
required:
- id
- type
@@ -34907,7 +34968,7 @@ components:
DueDateRuleReorderData:
description: The ordered list of all due date rules; every rule must be included.
items:
- $ref: "#/components/schemas/DueDateRuleReorderItem"
+ $ref: '#/components/schemas/DueDateRuleReorderItem'
type: array
DueDateRuleReorderItem:
description: A reference to a due date rule used for reordering.
@@ -34918,7 +34979,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/DueDateRuleType"
+ $ref: '#/components/schemas/DueDateRuleType'
required:
- type
- id
@@ -34927,7 +34988,7 @@ components:
description: The body of the due date rule reorder request.
properties:
data:
- $ref: "#/components/schemas/DueDateRuleReorderData"
+ $ref: '#/components/schemas/DueDateRuleReorderData'
required:
- data
type: object
@@ -34935,7 +34996,7 @@ components:
description: A single due date rule response.
properties:
data:
- $ref: "#/components/schemas/DueDateRuleDataResponse"
+ $ref: '#/components/schemas/DueDateRuleDataResponse'
required:
- data
type: object
@@ -34951,24 +35012,24 @@ components:
description: The body of a due date rule update request.
properties:
data:
- $ref: "#/components/schemas/DueDateRuleDataCreate"
+ $ref: '#/components/schemas/DueDateRuleDataCreate'
required:
- data
type: object
DueDateRulesDataList:
description: A list of due date rule data objects.
items:
- $ref: "#/components/schemas/DueDateRuleDataResponse"
+ $ref: '#/components/schemas/DueDateRuleDataResponse'
type: array
DueDateRulesResponse:
description: A list of due date rules with pagination metadata.
properties:
data:
- $ref: "#/components/schemas/DueDateRulesDataList"
+ $ref: '#/components/schemas/DueDateRulesDataList'
links:
- $ref: "#/components/schemas/SecurityAutomationRulesLinks"
+ $ref: '#/components/schemas/SecurityAutomationRulesLinks'
meta:
- $ref: "#/components/schemas/SecurityAutomationRulesMeta"
+ $ref: '#/components/schemas/SecurityAutomationRulesMeta'
required:
- data
- meta
@@ -35052,13 +35113,13 @@ components:
description: ELF symbol file data object.
properties:
attributes:
- $ref: "#/components/schemas/ELFSourcemapAttributes"
+ $ref: '#/components/schemas/ELFSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "6"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -35110,7 +35171,7 @@ components:
maxLength: 200
type: string
type:
- $ref: "#/components/schemas/ELFSymbolFileFormDataType"
+ $ref: '#/components/schemas/ELFSymbolFileFormDataType'
required:
- type
type: object
@@ -35123,7 +35184,7 @@ components:
format: binary
type: string
event:
- $ref: "#/components/schemas/ELFSymbolFileEvent"
+ $ref: '#/components/schemas/ELFSymbolFileEvent'
required:
- event
- elf_symbol_file
@@ -35145,7 +35206,7 @@ components:
format: double
type: number
severity:
- $ref: "#/components/schemas/VulnerabilitySeverity"
+ $ref: '#/components/schemas/VulnerabilitySeverity'
required:
- score
- severity
@@ -35166,7 +35227,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudIndexStatsIntegrationDataflowRequest:
description: The Elastic Cloud index stats dataflow.
@@ -35184,33 +35245,33 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudIntegrationAccountAuthenticationRequest:
description: Authentication for creating the Elastic Cloud integration account. Exactly one method is set.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthRequest"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthRequest'
ElasticCloudIntegrationAccountAuthenticationResponse:
description: Authentication configured on the Elastic Cloud integration account.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthResponse"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthResponse'
ElasticCloudIntegrationAccountAuthenticationUpdate:
description: Authentication for updating the Elastic Cloud integration account. Exactly one method is set.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthUpdate"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthUpdate'
ElasticCloudIntegrationAccountCreateAttributes:
description: Writable attributes used to create an Elastic Cloud integration account.
properties:
authentication:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountAuthenticationRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountAuthenticationRequest'
dataflows:
- $ref: "#/components/schemas/ElasticCloudIntegrationDataflowsRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationDataflowsRequest'
name:
description: Human-readable name of the Elastic Cloud integration account.
example: elastic-cloud-prod
type: string
settings:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountSettingsRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountSettingsRequest'
required:
- name
- authentication
@@ -35220,9 +35281,9 @@ components:
description: Data envelope for creating an Elastic Cloud integration account.
properties:
attributes:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountCreateAttributes"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountCreateAttributes'
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- type
- attributes
@@ -35231,7 +35292,7 @@ components:
description: Request payload to create an Elastic Cloud integration account.
properties:
data:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountCreateData"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountCreateData'
required:
- data
type: object
@@ -35239,7 +35300,7 @@ components:
description: Response payload for a single Elastic Cloud integration account.
properties:
data:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponseData"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponseData'
required:
- data
type: object
@@ -35247,15 +35308,15 @@ components:
description: Attributes of an Elastic Cloud integration account returned in responses.
properties:
authentication:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountAuthenticationResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountAuthenticationResponse'
dataflows:
- $ref: "#/components/schemas/ElasticCloudIntegrationDataflowsResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationDataflowsResponse'
name:
description: Human-readable name of the Elastic Cloud integration account.
example: elastic-cloud-prod
type: string
settings:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountSettingsResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountSettingsResponse'
required:
- name
- settings
@@ -35264,14 +35325,14 @@ components:
description: Data envelope of an Elastic Cloud integration account, including server-assigned identity.
properties:
attributes:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponseAttributes"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponseAttributes'
id:
description: Server-generated unique identifier of the Elastic Cloud integration account.
example: 953a0060-81ec-4221-aed4-d4733b59cd96
readOnly: true
type: string
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- id
- attributes
@@ -35322,27 +35383,27 @@ components:
Writable attributes used to update an Elastic Cloud integration account. Every field is optional; only the fields provided are changed. When `dataflows` is provided, only the dataflow ids included in the request are modified; dataflows omitted from the map keep their current configuration.
properties:
authentication:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountAuthenticationUpdate"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountAuthenticationUpdate'
dataflows:
- $ref: "#/components/schemas/ElasticCloudIntegrationDataflowsRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationDataflowsRequest'
name:
description: Human-readable name of the Elastic Cloud integration account.
example: elastic-cloud-prod
type: string
settings:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountSettingsUpdate"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountSettingsUpdate'
type: object
ElasticCloudIntegrationAccountUpdateData:
description: Data envelope for updating an Elastic Cloud integration account.
properties:
attributes:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateAttributes"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountUpdateAttributes'
id:
description: Unique identifier of the Elastic Cloud integration account to update.
example: 953a0060-81ec-4221-aed4-d4733b59cd96
type: string
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- id
- type
@@ -35352,7 +35413,7 @@ components:
description: Request payload to update an Elastic Cloud integration account.
properties:
data:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateData"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountUpdateData'
required:
- data
type: object
@@ -35362,7 +35423,7 @@ components:
data:
description: List of Elastic Cloud integration accounts.
items:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponseData"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponseData'
type: array
required:
- data
@@ -35372,39 +35433,39 @@ components:
description: Dataflows to configure on the Elastic Cloud integration account, keyed by dataflow id.
properties:
elastic-cloud-detailed-index-stats:
- $ref: "#/components/schemas/ElasticCloudDetailedIndexStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudDetailedIndexStatsIntegrationDataflowRequest'
elastic-cloud-index-stats:
- $ref: "#/components/schemas/ElasticCloudIndexStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudIndexStatsIntegrationDataflowRequest'
elastic-cloud-pending-task-stats:
- $ref: "#/components/schemas/ElasticCloudPendingTaskStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudPendingTaskStatsIntegrationDataflowRequest'
elastic-cloud-primary-shard-graceful-timeout:
- $ref: "#/components/schemas/ElasticCloudPrimaryShardGracefulTimeoutIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudPrimaryShardGracefulTimeoutIntegrationDataflowRequest'
elastic-cloud-primary-shard-stats:
- $ref: "#/components/schemas/ElasticCloudPrimaryShardStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudPrimaryShardStatsIntegrationDataflowRequest'
elastic-cloud-shard-allocation-stats:
- $ref: "#/components/schemas/ElasticCloudShardAllocationStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudShardAllocationStatsIntegrationDataflowRequest'
elastic-cloud-slm-stats:
- $ref: "#/components/schemas/ElasticCloudSlmStatsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/ElasticCloudSlmStatsIntegrationDataflowRequest'
type: object
ElasticCloudIntegrationDataflowsResponse:
description: Dataflows configured on the Elastic Cloud integration account, keyed by dataflow id.
properties:
elastic-cloud-detailed-index-stats:
- $ref: "#/components/schemas/ElasticCloudDetailedIndexStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudDetailedIndexStatsIntegrationDataflowResponse'
elastic-cloud-index-stats:
- $ref: "#/components/schemas/ElasticCloudIndexStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudIndexStatsIntegrationDataflowResponse'
elastic-cloud-metrics:
- $ref: "#/components/schemas/ElasticCloudMetricsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudMetricsIntegrationDataflowResponse'
elastic-cloud-pending-task-stats:
- $ref: "#/components/schemas/ElasticCloudPendingTaskStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudPendingTaskStatsIntegrationDataflowResponse'
elastic-cloud-primary-shard-graceful-timeout:
- $ref: "#/components/schemas/ElasticCloudPrimaryShardGracefulTimeoutIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudPrimaryShardGracefulTimeoutIntegrationDataflowResponse'
elastic-cloud-primary-shard-stats:
- $ref: "#/components/schemas/ElasticCloudPrimaryShardStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudPrimaryShardStatsIntegrationDataflowResponse'
elastic-cloud-shard-allocation-stats:
- $ref: "#/components/schemas/ElasticCloudShardAllocationStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudShardAllocationStatsIntegrationDataflowResponse'
elastic-cloud-slm-stats:
- $ref: "#/components/schemas/ElasticCloudSlmStatsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/ElasticCloudSlmStatsIntegrationDataflowResponse'
type: object
ElasticCloudMetricsIntegrationDataflowResponse:
description: The Elastic Cloud metrics dataflow.
@@ -35415,7 +35476,7 @@ components:
readOnly: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudPendingTaskStatsIntegrationDataflowRequest:
description: The Elastic Cloud pending task stats dataflow.
@@ -35433,7 +35494,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudPrimaryShardGracefulTimeoutIntegrationDataflowRequest:
description: The Elastic Cloud primary shard graceful timeout dataflow.
@@ -35451,7 +35512,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudPrimaryShardStatsIntegrationDataflowRequest:
description: The Elastic Cloud primary shard stats dataflow.
@@ -35469,7 +35530,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudShardAllocationStatsIntegrationDataflowRequest:
description: The Elastic Cloud shard allocation stats dataflow.
@@ -35487,7 +35548,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
ElasticCloudSlmStatsIntegrationDataflowRequest:
description: The Elastic Cloud snapshot lifecycle management stats dataflow.
@@ -35505,7 +35566,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
EmailTypeType:
description: The type of email.
@@ -35553,13 +35614,13 @@ components:
description: A single entity returned by the entity context endpoint.
properties:
attributes:
- $ref: "#/components/schemas/EntityContextEntityAttributes"
+ $ref: '#/components/schemas/EntityContextEntityAttributes'
id:
description: The unique identifier of the entity.
example: user@example.com
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringEntityContextEntityType"
+ $ref: '#/components/schemas/SecurityMonitoringEntityContextEntityType'
required:
- id
- type
@@ -35571,7 +35632,7 @@ components:
revisions:
description: The historical revisions of the entity, ordered chronologically.
items:
- $ref: "#/components/schemas/EntityContextRevision"
+ $ref: '#/components/schemas/EntityContextRevision'
type: array
required:
- revisions
@@ -35592,10 +35653,10 @@ components:
data:
description: The list of entities matching the query.
items:
- $ref: "#/components/schemas/EntityContextEntity"
+ $ref: '#/components/schemas/EntityContextEntity'
type: array
meta:
- $ref: "#/components/schemas/EntityContextResponseMeta"
+ $ref: '#/components/schemas/EntityContextResponseMeta'
required:
- data
- meta
@@ -35604,7 +35665,7 @@ components:
description: Metadata returned alongside the entity context response.
properties:
page:
- $ref: "#/components/schemas/EntityContextPage"
+ $ref: '#/components/schemas/EntityContextPage'
total_count:
description: The total number of entities matching the query, irrespective of pagination.
example: 1
@@ -35619,7 +35680,7 @@ components:
description: A single historical revision of an entity, including the time range during which the revision was observed.
properties:
attributes:
- $ref: "#/components/schemas/EntityContextRevisionAttributes"
+ $ref: '#/components/schemas/EntityContextRevisionAttributes'
first_seen_at:
description: The first time the entity was observed at this revision.
example: "2026-04-01T00:00:00Z"
@@ -35649,14 +35710,14 @@ components:
description: Entity data.
properties:
attributes:
- $ref: "#/components/schemas/EntityAttributes"
+ $ref: '#/components/schemas/EntityAttributes'
id:
description: Entity ID.
type: string
meta:
- $ref: "#/components/schemas/EntityMeta"
+ $ref: '#/components/schemas/EntityMeta'
relationships:
- $ref: "#/components/schemas/EntityRelationships"
+ $ref: '#/components/schemas/EntityRelationships'
type:
description: Entity.
type: string
@@ -35665,7 +35726,7 @@ components:
description: The organization ID, integration identifier, and integration-specific configuration payload for an entity integration configuration.
properties:
config:
- $ref: "#/components/schemas/EntityIntegrationConfigPayload"
+ $ref: '#/components/schemas/EntityIntegrationConfigPayload'
integration_id:
description: The identifier of the integration this configuration applies to (for example, `github`, `jira`, or `pagerduty`).
example: github
@@ -35684,13 +35745,13 @@ components:
description: JSON:API resource object for an entity integration configuration.
properties:
attributes:
- $ref: "#/components/schemas/EntityIntegrationConfigAttributes"
+ $ref: '#/components/schemas/EntityIntegrationConfigAttributes'
id:
description: Unique identifier of the entity integration configuration.
example: 01HJABCD12345678ABCDEFGHIJ
type: string
type:
- $ref: "#/components/schemas/EntityIntegrationConfigType"
+ $ref: '#/components/schemas/EntityIntegrationConfigType'
required:
- id
- type
@@ -35709,7 +35770,7 @@ components:
description: Request body used to create or replace the configuration for a given integration.
properties:
data:
- $ref: "#/components/schemas/EntityIntegrationConfigRequestData"
+ $ref: '#/components/schemas/EntityIntegrationConfigRequestData'
required:
- data
type: object
@@ -35717,7 +35778,7 @@ components:
description: Attributes used to create or update an entity integration configuration.
properties:
config:
- $ref: "#/components/schemas/EntityIntegrationConfigPayload"
+ $ref: '#/components/schemas/EntityIntegrationConfigPayload'
required:
- config
type: object
@@ -35725,9 +35786,9 @@ components:
description: JSON:API resource object used in a request to create or update an entity integration configuration.
properties:
attributes:
- $ref: "#/components/schemas/EntityIntegrationConfigRequestAttributes"
+ $ref: '#/components/schemas/EntityIntegrationConfigRequestAttributes'
type:
- $ref: "#/components/schemas/EntityIntegrationConfigRequestType"
+ $ref: '#/components/schemas/EntityIntegrationConfigRequestType'
required:
- type
- attributes
@@ -35745,7 +35806,7 @@ components:
description: JSON:API document containing a single entity integration configuration resource.
properties:
data:
- $ref: "#/components/schemas/EntityIntegrationConfigData"
+ $ref: '#/components/schemas/EntityIntegrationConfigData'
required:
- data
type: object
@@ -35790,15 +35851,15 @@ components:
description: Entity relationships.
properties:
incidents:
- $ref: "#/components/schemas/EntityToIncidents"
+ $ref: '#/components/schemas/EntityToIncidents'
oncall:
- $ref: "#/components/schemas/EntityToOncalls"
+ $ref: '#/components/schemas/EntityToOncalls'
rawSchema:
- $ref: "#/components/schemas/EntityToRawSchema"
+ $ref: '#/components/schemas/EntityToRawSchema'
relatedEntities:
- $ref: "#/components/schemas/EntityToRelatedEntities"
+ $ref: '#/components/schemas/EntityToRelatedEntities'
schema:
- $ref: "#/components/schemas/EntityToSchema"
+ $ref: '#/components/schemas/EntityToSchema'
type: object
EntityResponseArray:
description: Response object containing an array of entity data items.
@@ -35806,7 +35867,7 @@ components:
data:
description: Array of entity response data items.
items:
- $ref: "#/components/schemas/PreviewEntityResponseData"
+ $ref: '#/components/schemas/PreviewEntityResponseData'
type: array
required:
- data
@@ -35814,7 +35875,7 @@ components:
EntityResponseData:
description: List of entity data.
items:
- $ref: "#/components/schemas/EntityData"
+ $ref: '#/components/schemas/EntityData'
type: array
EntityResponseDataAttributes:
description: Entity response attributes containing core entity metadata fields.
@@ -35855,15 +35916,15 @@ components:
description: Entity relationships including incidents, oncalls, schemas, and related entities.
properties:
incidents:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidents"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidents'
oncalls:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsOncalls"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsOncalls'
rawSchema:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchema"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchema'
relatedEntities:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntities"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntities'
schema:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsSchema"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsSchema'
type: object
EntityResponseDataRelationshipsIncidents:
description: Incidents relationship containing a list of incident resources associated with this entity.
@@ -35871,7 +35932,7 @@ components:
data:
description: List of incident relationship data items.
items:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems'
type: array
type: object
EntityResponseDataRelationshipsIncidentsDataItems:
@@ -35882,7 +35943,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItemsType"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItemsType'
required:
- type
- id
@@ -35902,7 +35963,7 @@ components:
data:
description: List of oncall relationship data items.
items:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems'
type: array
type: object
EntityResponseDataRelationshipsOncallsDataItems:
@@ -35913,7 +35974,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItemsType"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItemsType'
required:
- type
- id
@@ -35931,7 +35992,7 @@ components:
description: Raw schema relationship linking an entity to its raw schema resource.
properties:
data:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaData"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaData'
required:
- data
type: object
@@ -35943,7 +36004,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaDataType"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaDataType'
required:
- type
- id
@@ -35963,7 +36024,7 @@ components:
data:
description: List of related entity relationship data items.
items:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems'
type: array
type: object
EntityResponseDataRelationshipsRelatedEntitiesDataItems:
@@ -35974,7 +36035,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItemsType"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItemsType'
required:
- type
- id
@@ -35992,7 +36053,7 @@ components:
description: Schema relationship linking an entity to its associated schema resource.
properties:
data:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaData"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaData'
required:
- data
type: object
@@ -36004,7 +36065,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaDataType"
+ $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaDataType'
required:
- type
- id
@@ -36031,12 +36092,12 @@ components:
description: Included incident.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedIncidentAttributes'
id:
description: Incident ID.
type: string
type:
- $ref: "#/components/schemas/EntityResponseIncludedIncidentType"
+ $ref: '#/components/schemas/EntityResponseIncludedIncidentType'
type: object
EntityResponseIncludedIncidentType:
description: Incident description.
@@ -36049,12 +36110,12 @@ components:
description: Included oncall.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallAttributes"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallAttributes'
id:
description: Oncall ID.
type: string
type:
- $ref: "#/components/schemas/EntityResponseIncludedOncallType"
+ $ref: '#/components/schemas/EntityResponseIncludedOncallType'
type: object
EntityResponseIncludedOncallType:
description: Oncall type.
@@ -36067,12 +36128,12 @@ components:
description: Included raw schema.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseIncludedRawSchemaAttributes"
+ $ref: '#/components/schemas/EntityResponseIncludedRawSchemaAttributes'
id:
description: Raw schema ID.
type: string
type:
- $ref: "#/components/schemas/EntityResponseIncludedRawSchemaType"
+ $ref: '#/components/schemas/EntityResponseIncludedRawSchemaType'
type: object
EntityResponseIncludedRawSchemaAttributes:
description: Included raw schema attributes.
@@ -36092,14 +36153,14 @@ components:
description: Included related entity.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityAttributes"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityAttributes'
id:
description: Entity UUID.
type: string
meta:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityMeta"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityMeta'
type:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedEntityType"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedEntityType'
type: object
EntityResponseIncludedRelatedEntityAttributes:
description: Related entity attributes.
@@ -36166,7 +36227,7 @@ components:
description: Included related oncall attributes.
properties:
escalations:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallEscalations"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalations'
provider:
description: Oncall provider.
type: string
@@ -36188,24 +36249,24 @@ components:
EntityResponseIncludedRelatedOncallEscalations:
description: Oncall escalations.
items:
- $ref: "#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem"
+ $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalationItem'
type: array
EntityResponseIncludedSchema:
description: Included detail entity schema.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseIncludedSchemaAttributes"
+ $ref: '#/components/schemas/EntityResponseIncludedSchemaAttributes'
id:
description: Entity ID.
type: string
type:
- $ref: "#/components/schemas/EntityResponseIncludedSchemaType"
+ $ref: '#/components/schemas/EntityResponseIncludedSchemaType'
type: object
EntityResponseIncludedSchemaAttributes:
description: Included schema.
properties:
schema:
- $ref: "#/components/schemas/EntityV3"
+ $ref: '#/components/schemas/EntityV3'
type: object
EntityResponseIncludedSchemaType:
description: Schema type.
@@ -36230,60 +36291,60 @@ components:
description: Entity to incidents relationship.
properties:
data:
- $ref: "#/components/schemas/RelationshipArray"
+ $ref: '#/components/schemas/RelationshipArray'
type: object
EntityToOncalls:
description: Entity to oncalls relationship.
properties:
data:
- $ref: "#/components/schemas/RelationshipArray"
+ $ref: '#/components/schemas/RelationshipArray'
type: object
EntityToRawSchema:
description: Entity to raw schema relationship.
properties:
data:
- $ref: "#/components/schemas/RelationshipItem"
+ $ref: '#/components/schemas/RelationshipItem'
type: object
EntityToRelatedEntities:
description: Entity to related entities relationship.
properties:
data:
- $ref: "#/components/schemas/RelationshipArray"
+ $ref: '#/components/schemas/RelationshipArray'
type: object
EntityToSchema:
description: Entity to detail schema relationship.
properties:
data:
- $ref: "#/components/schemas/RelationshipItem"
+ $ref: '#/components/schemas/RelationshipItem'
type: object
EntityV3:
description: Entity schema v3.
oneOf:
- - $ref: "#/components/schemas/EntityV3Service"
- - $ref: "#/components/schemas/EntityV3Datastore"
- - $ref: "#/components/schemas/EntityV3Queue"
- - $ref: "#/components/schemas/EntityV3System"
- - $ref: "#/components/schemas/EntityV3API"
+ - $ref: '#/components/schemas/EntityV3Service'
+ - $ref: '#/components/schemas/EntityV3Datastore'
+ - $ref: '#/components/schemas/EntityV3Queue'
+ - $ref: '#/components/schemas/EntityV3System'
+ - $ref: '#/components/schemas/EntityV3API'
EntityV3API:
additionalProperties: false
description: Schema for API entities.
properties:
apiVersion:
- $ref: "#/components/schemas/EntityV3APIVersion"
+ $ref: '#/components/schemas/EntityV3APIVersion'
datadog:
- $ref: "#/components/schemas/EntityV3APIDatadog"
+ $ref: '#/components/schemas/EntityV3APIDatadog'
extensions:
additionalProperties: {}
description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
type: object
integrations:
- $ref: "#/components/schemas/EntityV3Integrations"
+ $ref: '#/components/schemas/EntityV3Integrations'
kind:
- $ref: "#/components/schemas/EntityV3APIKind"
+ $ref: '#/components/schemas/EntityV3APIKind'
metadata:
- $ref: "#/components/schemas/EntityV3Metadata"
+ $ref: '#/components/schemas/EntityV3Metadata'
spec:
- $ref: "#/components/schemas/EntityV3APISpec"
+ $ref: '#/components/schemas/EntityV3APISpec'
required:
- apiVersion
- kind
@@ -36294,15 +36355,15 @@ components:
description: Datadog product integrations for the API entity.
properties:
codeLocations:
- $ref: "#/components/schemas/EntityV3DatadogCodeLocations"
+ $ref: '#/components/schemas/EntityV3DatadogCodeLocations'
events:
- $ref: "#/components/schemas/EntityV3DatadogEvents"
+ $ref: '#/components/schemas/EntityV3DatadogEvents'
logs:
- $ref: "#/components/schemas/EntityV3DatadogLogs"
+ $ref: '#/components/schemas/EntityV3DatadogLogs'
performanceData:
- $ref: "#/components/schemas/EntityV3DatadogPerformance"
+ $ref: '#/components/schemas/EntityV3DatadogPerformance'
pipelines:
- $ref: "#/components/schemas/EntityV3DatadogPipelines"
+ $ref: '#/components/schemas/EntityV3DatadogPipelines'
type: object
EntityV3APIKind:
description: The definition of Entity V3 API Kind object.
@@ -36323,7 +36384,7 @@ components:
type: string
type: array
interface:
- $ref: "#/components/schemas/EntityV3APISpecInterface"
+ $ref: '#/components/schemas/EntityV3APISpecInterface'
lifecycle:
description: The lifecycle state of the component.
minLength: 1
@@ -36340,8 +36401,8 @@ components:
additionalProperties: false
description: The API definition.
oneOf:
- - $ref: "#/components/schemas/EntityV3APISpecInterfaceFileRef"
- - $ref: "#/components/schemas/EntityV3APISpecInterfaceDefinition"
+ - $ref: '#/components/schemas/EntityV3APISpecInterfaceFileRef'
+ - $ref: '#/components/schemas/EntityV3APISpecInterfaceDefinition'
EntityV3APISpecInterfaceDefinition:
additionalProperties: false
description: The definition of `EntityV3APISpecInterfaceDefinition` object.
@@ -36390,7 +36451,7 @@ components:
additionalProperties: false
description: Schema for mapping source code locations to an entity.
items:
- $ref: "#/components/schemas/EntityV3DatadogCodeLocationItem"
+ $ref: '#/components/schemas/EntityV3DatadogCodeLocationItem'
type: array
EntityV3DatadogEventItem:
additionalProperties: false
@@ -36407,7 +36468,7 @@ components:
additionalProperties: false
description: Events associations.
items:
- $ref: "#/components/schemas/EntityV3DatadogEventItem"
+ $ref: '#/components/schemas/EntityV3DatadogEventItem'
type: array
EntityV3DatadogIntegrationOpsgenie:
additionalProperties: false
@@ -36452,7 +36513,7 @@ components:
additionalProperties: false
description: Logs association.
items:
- $ref: "#/components/schemas/EntityV3DatadogLogItem"
+ $ref: '#/components/schemas/EntityV3DatadogLogItem'
type: array
EntityV3DatadogPerformance:
additionalProperties: false
@@ -36481,21 +36542,21 @@ components:
description: Schema for datastore entities.
properties:
apiVersion:
- $ref: "#/components/schemas/EntityV3APIVersion"
+ $ref: '#/components/schemas/EntityV3APIVersion'
datadog:
- $ref: "#/components/schemas/EntityV3DatastoreDatadog"
+ $ref: '#/components/schemas/EntityV3DatastoreDatadog'
extensions:
additionalProperties: {}
description: Custom extensions. This is the free-formed field to send client side metadata. No Datadog features are affected by this field.
type: object
integrations:
- $ref: "#/components/schemas/EntityV3Integrations"
+ $ref: '#/components/schemas/EntityV3Integrations'
kind:
- $ref: "#/components/schemas/EntityV3DatastoreKind"
+ $ref: '#/components/schemas/EntityV3DatastoreKind'
metadata:
- $ref: "#/components/schemas/EntityV3Metadata"
+ $ref: '#/components/schemas/EntityV3Metadata'
spec:
- $ref: "#/components/schemas/EntityV3DatastoreSpec"
+ $ref: '#/components/schemas/EntityV3DatastoreSpec'
required:
- apiVersion
- kind
@@ -36506,11 +36567,11 @@ components:
description: Datadog product integrations for the datastore entity.
properties:
events:
- $ref: "#/components/schemas/EntityV3DatadogEvents"
+ $ref: '#/components/schemas/EntityV3DatadogEvents'
logs:
- $ref: "#/components/schemas/EntityV3DatadogLogs"
+ $ref: '#/components/schemas/EntityV3DatadogLogs'
performanceData:
- $ref: "#/components/schemas/EntityV3DatadogPerformance"
+ $ref: '#/components/schemas/EntityV3DatadogPerformance'
type: object
EntityV3DatastoreKind:
description: The definition of Entity V3 Datastore Kind object.
@@ -36547,9 +36608,9 @@ components:
description: A base schema for defining third-party integrations.
properties:
opsgenie:
- $ref: "#/components/schemas/EntityV3DatadogIntegrationOpsgenie"
+ $ref: '#/components/schemas/EntityV3DatadogIntegrationOpsgenie'
pagerduty:
- $ref: "#/components/schemas/EntityV3DatadogIntegrationPagerduty"
+ $ref: '#/components/schemas/EntityV3DatadogIntegrationPagerduty'
type: object
EntityV3Metadata:
additionalProperties: false
@@ -36559,13 +36620,13 @@ components:
additionalProperties: false
description: The additional owners of the entity, usually a team.
items:
- $ref: "#/components/schemas/EntityV3MetadataAdditionalOwnersItems"
+ $ref: '#/components/schemas/EntityV3MetadataAdditionalOwnersItems'
type: array
contacts:
additionalProperties: false
description: A list of contacts for the entity.
items:
- $ref: "#/components/schemas/EntityV3MetadataContactsItems"
+ $ref: '#/components/schemas/EntityV3MetadataContactsItems'
type: array
description:
description: Short description of the entity. The UI can leverage the description for display.
@@ -36586,7 +36647,7 @@ components:
additionalProperties: false
description: A list of links for the entity.
items:
- $ref: "#/components/schemas/EntityV3MetadataLinksItems"
+ $ref: '#/components/schemas/EntityV3MetadataLinksItems'
type: array
managed:
additionalProperties: {}
@@ -36678,21 +36739,21 @@ components:
description: Schema for queue entities.
properties:
apiVersion:
- $ref: "#/components/schemas/EntityV3APIVersion"
+ $ref: '#/components/schemas/EntityV3APIVersion'
datadog:
- $ref: "#/components/schemas/EntityV3QueueDatadog"
+ $ref: '#/components/schemas/EntityV3QueueDatadog'
extensions:
additionalProperties: {}
description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
type: object
integrations:
- $ref: "#/components/schemas/EntityV3Integrations"
+ $ref: '#/components/schemas/EntityV3Integrations'
kind:
- $ref: "#/components/schemas/EntityV3QueueKind"
+ $ref: '#/components/schemas/EntityV3QueueKind'
metadata:
- $ref: "#/components/schemas/EntityV3Metadata"
+ $ref: '#/components/schemas/EntityV3Metadata'
spec:
- $ref: "#/components/schemas/EntityV3QueueSpec"
+ $ref: '#/components/schemas/EntityV3QueueSpec'
required:
- apiVersion
- kind
@@ -36703,11 +36764,11 @@ components:
description: Datadog product integrations for the datastore entity.
properties:
events:
- $ref: "#/components/schemas/EntityV3DatadogEvents"
+ $ref: '#/components/schemas/EntityV3DatadogEvents'
logs:
- $ref: "#/components/schemas/EntityV3DatadogLogs"
+ $ref: '#/components/schemas/EntityV3DatadogLogs'
performanceData:
- $ref: "#/components/schemas/EntityV3DatadogPerformance"
+ $ref: '#/components/schemas/EntityV3DatadogPerformance'
type: object
EntityV3QueueKind:
description: The definition of Entity V3 Queue Kind object.
@@ -36744,21 +36805,21 @@ components:
description: Schema for service entities.
properties:
apiVersion:
- $ref: "#/components/schemas/EntityV3APIVersion"
+ $ref: '#/components/schemas/EntityV3APIVersion'
datadog:
- $ref: "#/components/schemas/EntityV3ServiceDatadog"
+ $ref: '#/components/schemas/EntityV3ServiceDatadog'
extensions:
additionalProperties: {}
description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
type: object
integrations:
- $ref: "#/components/schemas/EntityV3Integrations"
+ $ref: '#/components/schemas/EntityV3Integrations'
kind:
- $ref: "#/components/schemas/EntityV3ServiceKind"
+ $ref: '#/components/schemas/EntityV3ServiceKind'
metadata:
- $ref: "#/components/schemas/EntityV3Metadata"
+ $ref: '#/components/schemas/EntityV3Metadata'
spec:
- $ref: "#/components/schemas/EntityV3ServiceSpec"
+ $ref: '#/components/schemas/EntityV3ServiceSpec'
required:
- apiVersion
- kind
@@ -36769,15 +36830,15 @@ components:
description: Datadog product integrations for the service entity.
properties:
codeLocations:
- $ref: "#/components/schemas/EntityV3DatadogCodeLocations"
+ $ref: '#/components/schemas/EntityV3DatadogCodeLocations'
events:
- $ref: "#/components/schemas/EntityV3DatadogEvents"
+ $ref: '#/components/schemas/EntityV3DatadogEvents'
logs:
- $ref: "#/components/schemas/EntityV3DatadogLogs"
+ $ref: '#/components/schemas/EntityV3DatadogLogs'
performanceData:
- $ref: "#/components/schemas/EntityV3DatadogPerformance"
+ $ref: '#/components/schemas/EntityV3DatadogPerformance'
pipelines:
- $ref: "#/components/schemas/EntityV3DatadogPipelines"
+ $ref: '#/components/schemas/EntityV3DatadogPipelines'
type: object
EntityV3ServiceKind:
description: The definition of Entity V3 Service Kind object.
@@ -36826,21 +36887,21 @@ components:
description: Schema for system entities.
properties:
apiVersion:
- $ref: "#/components/schemas/EntityV3APIVersion"
+ $ref: '#/components/schemas/EntityV3APIVersion'
datadog:
- $ref: "#/components/schemas/EntityV3SystemDatadog"
+ $ref: '#/components/schemas/EntityV3SystemDatadog'
extensions:
additionalProperties: {}
description: Custom extensions. This is the free-formed field to send client-side metadata. No Datadog features are affected by this field.
type: object
integrations:
- $ref: "#/components/schemas/EntityV3Integrations"
+ $ref: '#/components/schemas/EntityV3Integrations'
kind:
- $ref: "#/components/schemas/EntityV3SystemKind"
+ $ref: '#/components/schemas/EntityV3SystemKind'
metadata:
- $ref: "#/components/schemas/EntityV3Metadata"
+ $ref: '#/components/schemas/EntityV3Metadata'
spec:
- $ref: "#/components/schemas/EntityV3SystemSpec"
+ $ref: '#/components/schemas/EntityV3SystemSpec'
required:
- apiVersion
- kind
@@ -36851,13 +36912,13 @@ components:
description: Datadog product integrations for the service entity.
properties:
events:
- $ref: "#/components/schemas/EntityV3DatadogEvents"
+ $ref: '#/components/schemas/EntityV3DatadogEvents'
logs:
- $ref: "#/components/schemas/EntityV3DatadogLogs"
+ $ref: '#/components/schemas/EntityV3DatadogLogs'
performanceData:
- $ref: "#/components/schemas/EntityV3DatadogPerformance"
+ $ref: '#/components/schemas/EntityV3DatadogPerformance'
pipelines:
- $ref: "#/components/schemas/EntityV3DatadogPipelines"
+ $ref: '#/components/schemas/EntityV3DatadogPipelines'
type: object
EntityV3SystemKind:
description: The definition of Entity V3 System Kind object.
@@ -36890,14 +36951,14 @@ components:
description: A feature flag environment resource.
properties:
attributes:
- $ref: "#/components/schemas/EnvironmentAttributes"
+ $ref: '#/components/schemas/EnvironmentAttributes'
id:
description: The unique identifier of the environment.
example: "550e8400-e29b-41d4-a716-446655440001"
format: uuid
type: string
type:
- $ref: "#/components/schemas/CreateEnvironmentDataType"
+ $ref: '#/components/schemas/CreateEnvironmentDataType'
required:
- id
- type
@@ -36952,7 +37013,7 @@ components:
description: Response containing an environment.
properties:
data:
- $ref: "#/components/schemas/Environment"
+ $ref: '#/components/schemas/Environment'
required:
- data
type: object
@@ -36960,7 +37021,7 @@ components:
description: Pagination metadata for environments.
properties:
page:
- $ref: "#/components/schemas/EnvironmentsPaginationMetaPage"
+ $ref: '#/components/schemas/EnvironmentsPaginationMetaPage'
type: object
EnvironmentsPaginationMetaPage:
description: Pagination metadata for environments list responses.
@@ -36985,7 +37046,7 @@ components:
example: ""
type: string
retryStrategy:
- $ref: "#/components/schemas/RetryStrategy"
+ $ref: '#/components/schemas/RetryStrategy'
required:
- retryStrategy
- fallbackStepName
@@ -36997,9 +37058,9 @@ components:
description: Unique identifier of the escalation step.
type: string
relationships:
- $ref: "#/components/schemas/EscalationRelationships"
+ $ref: '#/components/schemas/EscalationRelationships'
type:
- $ref: "#/components/schemas/EscalationType"
+ $ref: '#/components/schemas/EscalationType'
required:
- type
type: object
@@ -37063,11 +37124,11 @@ components:
type: teams
properties:
data:
- $ref: "#/components/schemas/EscalationPolicyData"
+ $ref: '#/components/schemas/EscalationPolicyData'
included:
description: "Provides any included related resources, such as steps or targets, returned with the policy."
items:
- $ref: "#/components/schemas/EscalationPolicyIncluded"
+ $ref: '#/components/schemas/EscalationPolicyIncluded'
type: array
type: object
EscalationPolicyCreateRequest:
@@ -37106,7 +37167,7 @@ components:
type: policies
properties:
data:
- $ref: "#/components/schemas/EscalationPolicyCreateRequestData"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequestData'
required:
- data
type: object
@@ -37114,11 +37175,11 @@ components:
description: "Represents the data for creating an escalation policy, including its attributes, relationships, and resource type."
properties:
attributes:
- $ref: "#/components/schemas/EscalationPolicyCreateRequestDataAttributes"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/EscalationPolicyCreateRequestDataRelationships"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequestDataRelationships'
type:
- $ref: "#/components/schemas/EscalationPolicyCreateRequestDataType"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequestDataType'
required:
- type
- attributes
@@ -37143,7 +37204,7 @@ components:
steps:
description: "A list of escalation steps, each defining assignment, escalation timeout, and targets for the new policy."
items:
- $ref: "#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequestDataAttributesStepsItems'
maxItems: 10
minItems: 1
type: array
@@ -37155,7 +37216,7 @@ components:
description: "Defines a single escalation step within an escalation policy creation request. Contains assignment strategy, escalation timeout, and a list of targets."
properties:
assignment:
- $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment"
+ $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment'
escalate_after_seconds:
description: "Defines how many seconds to wait before escalating to the next step."
example: 3600
@@ -37168,7 +37229,7 @@ components:
example:
- "users"
items:
- $ref: "#/components/schemas/EscalationPolicyStepTarget"
+ $ref: '#/components/schemas/EscalationPolicyStepTarget'
type: array
required:
- targets
@@ -37177,7 +37238,7 @@ components:
description: "Represents relationships in an escalation policy creation request, including references to teams."
properties:
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
type: object
EscalationPolicyCreateRequestDataType:
default: policies
@@ -37192,15 +37253,15 @@ components:
description: "Represents the data for a single escalation policy, including its attributes, ID, relationships, and resource type."
properties:
attributes:
- $ref: "#/components/schemas/EscalationPolicyDataAttributes"
+ $ref: '#/components/schemas/EscalationPolicyDataAttributes'
id:
description: "Specifies the unique identifier of the escalation policy."
example: "ab000000-0000-0000-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/EscalationPolicyDataRelationships"
+ $ref: '#/components/schemas/EscalationPolicyDataRelationships'
type:
- $ref: "#/components/schemas/EscalationPolicyDataType"
+ $ref: '#/components/schemas/EscalationPolicyDataType'
required:
- type
type: object
@@ -37228,9 +37289,9 @@ components:
description: "Represents the relationships for an escalation policy, including references to steps and teams."
properties:
steps:
- $ref: "#/components/schemas/EscalationPolicyDataRelationshipsSteps"
+ $ref: '#/components/schemas/EscalationPolicyDataRelationshipsSteps'
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
required:
- steps
type: object
@@ -37240,7 +37301,7 @@ components:
data:
description: "An array of references to the steps defined in this escalation policy."
items:
- $ref: "#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItems"
+ $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItems'
type: array
type: object
EscalationPolicyDataRelationshipsStepsDataItems:
@@ -37251,7 +37312,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItemsType"
+ $ref: '#/components/schemas/EscalationPolicyDataRelationshipsStepsDataItemsType'
required:
- type
- id
@@ -37277,23 +37338,23 @@ components:
EscalationPolicyIncluded:
description: "Represents included related resources when retrieving an escalation policy, such as teams, steps, or targets."
oneOf:
- - $ref: "#/components/schemas/EscalationPolicyStep"
- - $ref: "#/components/schemas/EscalationPolicyUser"
- - $ref: "#/components/schemas/ScheduleData"
- - $ref: "#/components/schemas/ConfiguredSchedule"
- - $ref: "#/components/schemas/TeamReference"
+ - $ref: '#/components/schemas/EscalationPolicyStep'
+ - $ref: '#/components/schemas/EscalationPolicyUser'
+ - $ref: '#/components/schemas/ScheduleData'
+ - $ref: '#/components/schemas/ConfiguredSchedule'
+ - $ref: '#/components/schemas/TeamReference'
EscalationPolicyStep:
description: "Represents a single step in an escalation policy, including its attributes, relationships, and resource type."
properties:
attributes:
- $ref: "#/components/schemas/EscalationPolicyStepAttributes"
+ $ref: '#/components/schemas/EscalationPolicyStepAttributes'
id:
description: "Specifies the unique identifier of this escalation policy step."
type: string
relationships:
- $ref: "#/components/schemas/EscalationPolicyStepRelationships"
+ $ref: '#/components/schemas/EscalationPolicyStepRelationships'
type:
- $ref: "#/components/schemas/EscalationPolicyStepType"
+ $ref: '#/components/schemas/EscalationPolicyStepType'
required:
- type
type: object
@@ -37301,7 +37362,7 @@ components:
description: "Defines attributes for an escalation policy step, such as assignment strategy and escalation timeout."
properties:
assignment:
- $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment"
+ $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment'
escalate_after_seconds:
description: "Specifies how many seconds to wait before escalating to the next step."
format: int64
@@ -37320,31 +37381,31 @@ components:
description: "Represents the relationship of an escalation policy step to its targets."
properties:
targets:
- $ref: "#/components/schemas/EscalationTargets"
+ $ref: '#/components/schemas/EscalationTargets'
type: object
EscalationPolicyStepTarget:
description: "Defines a single escalation target within a step for an escalation policy creation request. Contains `id`, `type`, and optional `config`."
properties:
config:
- $ref: "#/components/schemas/EscalationPolicyStepTargetConfig"
+ $ref: '#/components/schemas/EscalationPolicyStepTargetConfig'
id:
description: "Specifies the unique identifier for this target."
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/EscalationPolicyStepTargetType"
+ $ref: '#/components/schemas/EscalationPolicyStepTargetType'
type: object
EscalationPolicyStepTargetConfig:
description: "Configuration for an escalation target, such as schedule position."
properties:
schedule:
- $ref: "#/components/schemas/EscalationPolicyStepTargetConfigSchedule"
+ $ref: '#/components/schemas/EscalationPolicyStepTargetConfigSchedule'
type: object
EscalationPolicyStepTargetConfigSchedule:
description: "Schedule-specific configuration for an escalation target."
properties:
position:
- $ref: "#/components/schemas/ScheduleTargetPosition"
+ $ref: '#/components/schemas/ScheduleTargetPosition'
type: object
EscalationPolicyStepTargetType:
description: "Specifies the type of escalation target (example `users`, `schedules`, or `teams`)."
@@ -37393,7 +37454,7 @@ components:
type: policies
properties:
data:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequestData"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequestData'
required:
- data
type: object
@@ -37401,15 +37462,15 @@ components:
description: "Represents the data for updating an existing escalation policy, including its ID, attributes, relationships, and resource type."
properties:
attributes:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataAttributes"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributes'
id:
description: "Specifies the unique identifier of the escalation policy being updated."
example: "00000000-aba1-0000-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataRelationships"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataRelationships'
type:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataType"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataType'
required:
- type
- id
@@ -37435,7 +37496,7 @@ components:
steps:
description: "A list of escalation steps, each defining assignment, escalation timeout, and targets."
items:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequestDataAttributesStepsItems'
maxItems: 10
minItems: 1
type: array
@@ -37447,7 +37508,7 @@ components:
description: "Defines a single escalation step within an escalation policy update request. Contains assignment strategy, escalation timeout, an optional step ID, and a list of targets."
properties:
assignment:
- $ref: "#/components/schemas/EscalationPolicyStepAttributesAssignment"
+ $ref: '#/components/schemas/EscalationPolicyStepAttributesAssignment'
escalate_after_seconds:
description: "Defines how many seconds to wait before escalating to the next step."
example: 3600
@@ -37462,7 +37523,7 @@ components:
targets:
description: "Specifies the collection of escalation targets for this step."
items:
- $ref: "#/components/schemas/EscalationPolicyStepTarget"
+ $ref: '#/components/schemas/EscalationPolicyStepTarget'
type: array
required:
- targets
@@ -37471,7 +37532,7 @@ components:
description: "Represents relationships in an escalation policy update request, including references to teams."
properties:
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
type: object
EscalationPolicyUpdateRequestDataType:
default: policies
@@ -37486,12 +37547,12 @@ components:
description: Represents a user object in the context of an escalation policy, including their `id`, type, and basic attributes.
properties:
attributes:
- $ref: "#/components/schemas/EscalationPolicyUserAttributes"
+ $ref: '#/components/schemas/EscalationPolicyUserAttributes'
id:
description: The unique user identifier.
type: string
type:
- $ref: "#/components/schemas/EscalationPolicyUserType"
+ $ref: '#/components/schemas/EscalationPolicyUserType'
required:
- type
type: object
@@ -37507,7 +37568,7 @@ components:
example: "Jane Doe"
type: string
status:
- $ref: "#/components/schemas/UserAttributesStatus"
+ $ref: '#/components/schemas/UserAttributesStatus'
type: object
EscalationPolicyUserType:
default: users
@@ -37523,7 +37584,7 @@ components:
description: Contains the relationships of an escalation object, including its responders.
properties:
responders:
- $ref: "#/components/schemas/EscalationRelationshipsResponders"
+ $ref: '#/components/schemas/EscalationRelationshipsResponders'
type: object
EscalationRelationshipsResponders:
description: Lists the users involved in a specific step of the escalation policy.
@@ -37531,7 +37592,7 @@ components:
data:
description: Array of user references assigned as responders for this escalation step.
items:
- $ref: "#/components/schemas/EscalationRelationshipsRespondersDataItems"
+ $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItems'
type: array
type: object
EscalationRelationshipsRespondersDataItems:
@@ -37542,7 +37603,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/EscalationRelationshipsRespondersDataItemsType"
+ $ref: '#/components/schemas/EscalationRelationshipsRespondersDataItemsType'
required:
- type
- id
@@ -37559,17 +37620,17 @@ components:
EscalationTarget:
description: "Represents an escalation target, which can be a team, user, schedule, or configured schedule target."
oneOf:
- - $ref: "#/components/schemas/TeamTarget"
- - $ref: "#/components/schemas/UserTarget"
- - $ref: "#/components/schemas/ScheduleTarget"
- - $ref: "#/components/schemas/ConfiguredScheduleTarget"
+ - $ref: '#/components/schemas/TeamTarget'
+ - $ref: '#/components/schemas/UserTarget'
+ - $ref: '#/components/schemas/ScheduleTarget'
+ - $ref: '#/components/schemas/ConfiguredScheduleTarget'
EscalationTargets:
description: "A list of escalation targets for a step"
properties:
data:
description: The `EscalationTargets` `data`.
items:
- $ref: "#/components/schemas/EscalationTarget"
+ $ref: '#/components/schemas/EscalationTarget'
type: array
type: object
EscalationType:
@@ -37585,7 +37646,7 @@ components:
description: Recommended resource values for a Spark driver or executor, derived from recent real usage metrics. Used by SPA to propose more efficient pod sizing.
properties:
cpu:
- $ref: "#/components/schemas/Cpu"
+ $ref: '#/components/schemas/Cpu'
ephemeral_storage:
description: Recommended ephemeral storage allocation (in MiB). Derived from job temporary storage patterns.
format: int64
@@ -37657,14 +37718,14 @@ components:
example: "Did you hear the news today?"
type: string
evt:
- $ref: "#/components/schemas/Event"
+ $ref: '#/components/schemas/Event'
hostname:
description: |-
Host name to associate with the event.
Any tags associated with the host are also applied to this event.
type: string
monitor:
- $ref: "#/components/schemas/MonitorType"
+ $ref: '#/components/schemas/MonitorType'
monitor_groups:
description: List of groups referred to in the event.
items:
@@ -37678,7 +37739,7 @@ components:
nullable: true
type: integer
priority:
- $ref: "#/components/schemas/EventPriority"
+ $ref: '#/components/schemas/EventPriority'
related_event_id:
description: Related event ID.
format: int64
@@ -37697,7 +37758,7 @@ components:
description: Identifier for the source of the event, such as a monitor alert, an externally-submitted event, or an integration.
type: string
status:
- $ref: "#/components/schemas/EventStatusType"
+ $ref: '#/components/schemas/EventStatusType'
tags:
description: A list of tags to apply to the event.
example: ["environment:test"]
@@ -37730,9 +37791,9 @@ components:
description: An event object.
properties:
attributes:
- $ref: "#/components/schemas/EventPayload"
+ $ref: '#/components/schemas/EventPayload'
type:
- $ref: "#/components/schemas/EventCreateRequestType"
+ $ref: '#/components/schemas/EventCreateRequestType'
required:
- type
- attributes
@@ -37741,7 +37802,7 @@ components:
description: Payload for creating an event.
properties:
data:
- $ref: "#/components/schemas/EventCreateRequest"
+ $ref: '#/components/schemas/EventCreateRequest'
required:
- data
type: object
@@ -37757,7 +37818,7 @@ components:
description: Event object.
properties:
attributes:
- $ref: "#/components/schemas/EventCreateResponseAttributes"
+ $ref: '#/components/schemas/EventCreateResponseAttributes'
type:
description: Entity type.
example: "event"
@@ -37767,13 +37828,13 @@ components:
description: Event attributes.
properties:
attributes:
- $ref: "#/components/schemas/EventCreateResponseAttributesAttributes"
+ $ref: '#/components/schemas/EventCreateResponseAttributesAttributes'
type: object
EventCreateResponseAttributesAttributes:
description: JSON object for category-specific attributes.
properties:
evt:
- $ref: "#/components/schemas/EventCreateResponseAttributesAttributesEvt"
+ $ref: '#/components/schemas/EventCreateResponseAttributesAttributesEvt'
type: object
EventCreateResponseAttributesAttributesEvt:
description: JSON object of event system attributes.
@@ -37792,9 +37853,9 @@ components:
description: Event creation response.
properties:
data:
- $ref: "#/components/schemas/EventCreateResponse"
+ $ref: '#/components/schemas/EventCreateResponse'
links:
- $ref: "#/components/schemas/EventCreateResponsePayloadLinks"
+ $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
type: object
EventCreateResponsePayloadLinks:
description: |-
@@ -37817,9 +37878,9 @@ components:
minLength: 1
type: string
attributes:
- $ref: "#/components/schemas/EventPayloadAttributes"
+ $ref: '#/components/schemas/EventPayloadAttributes'
category:
- $ref: "#/components/schemas/EventCategory"
+ $ref: '#/components/schemas/EventCategory'
host:
description: |-
Host name to associate with the event. Any tags associated with the host are also applied to this event. Limited to 255 characters.
@@ -37828,7 +37889,7 @@ components:
minLength: 1
type: string
integration_id:
- $ref: "#/components/schemas/EventPayloadIntegrationId"
+ $ref: '#/components/schemas/EventPayloadIntegrationId'
message:
description: |-
Free formed text associated with the event. It's suggested to use `data.attributes.attributes.custom` for well-structured attributes. Limited to 4000 characters.
@@ -37870,8 +37931,8 @@ components:
description: |-
JSON object for category-specific attributes. Schema is different per event category.
oneOf:
- - $ref: "#/components/schemas/ChangeEventCustomAttributes"
- - $ref: "#/components/schemas/AlertEventCustomAttributes"
+ - $ref: '#/components/schemas/ChangeEventCustomAttributes'
+ - $ref: '#/components/schemas/AlertEventCustomAttributes'
EventPayloadIntegrationId:
description: |-
Integration ID sourced from integration manifests.
@@ -37908,19 +37969,19 @@ components:
description: The object description of an event after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/EventResponseAttributes"
+ $ref: '#/components/schemas/EventResponseAttributes'
id:
description: the unique ID of the event.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/EventType"
+ $ref: '#/components/schemas/EventType'
type: object
EventResponseAttributes:
description: The object description of an event response attribute.
properties:
attributes:
- $ref: "#/components/schemas/EventAttributes"
+ $ref: '#/components/schemas/EventAttributes'
message:
description: The message of the event.
type: string
@@ -37970,12 +38031,12 @@ components:
description: JSON object of event system attributes.
properties:
category:
- $ref: "#/components/schemas/EventSystemAttributesCategory"
+ $ref: '#/components/schemas/EventSystemAttributesCategory'
id:
description: Event identifier. This field is deprecated and will be removed in a future version. Use the `uid` field instead.
type: string
integration_id:
- $ref: "#/components/schemas/EventSystemAttributesIntegrationId"
+ $ref: '#/components/schemas/EventSystemAttributesIntegrationId'
source_id:
description: The source type ID of the event.
format: int64
@@ -38044,7 +38105,7 @@ components:
description: The instructions for what to compute for this query.
properties:
aggregation:
- $ref: "#/components/schemas/EventsAggregation"
+ $ref: '#/components/schemas/EventsAggregation'
interval:
description: Interval for compute in milliseconds.
example: 60000
@@ -38108,7 +38169,7 @@ components:
maximum: 10000
type: integer
sort:
- $ref: "#/components/schemas/EventsGroupBySort"
+ $ref: '#/components/schemas/EventsGroupBySort'
required:
- facet
type: object
@@ -38116,15 +38177,15 @@ components:
description: The dimension by which to sort a query's results.
properties:
aggregation:
- $ref: "#/components/schemas/EventsAggregation"
+ $ref: '#/components/schemas/EventsAggregation'
metric:
description: The metric's calculated value which should be used to define the sort order of a query's results.
example: "@duration"
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
type:
- $ref: "#/components/schemas/EventsSortType"
+ $ref: '#/components/schemas/EventsSortType'
required:
- aggregation
type: object
@@ -38133,13 +38194,13 @@ components:
The object sent with the request to retrieve a list of events from your organization.
properties:
filter:
- $ref: "#/components/schemas/EventsQueryFilter"
+ $ref: '#/components/schemas/EventsQueryFilter'
options:
- $ref: "#/components/schemas/EventsQueryOptions"
+ $ref: '#/components/schemas/EventsQueryOptions'
page:
- $ref: "#/components/schemas/EventsRequestPage"
+ $ref: '#/components/schemas/EventsRequestPage'
sort:
- $ref: "#/components/schemas/EventsSort"
+ $ref: '#/components/schemas/EventsSort'
type: object
EventsListResponse:
description: The response object with all events matching the request and pagination information.
@@ -38147,12 +38208,12 @@ components:
data:
description: An array of events matching the request.
items:
- $ref: "#/components/schemas/EventResponse"
+ $ref: '#/components/schemas/EventResponse'
type: array
links:
- $ref: "#/components/schemas/EventsListResponseLinks"
+ $ref: '#/components/schemas/EventsListResponseLinks'
meta:
- $ref: "#/components/schemas/EventsResponseMetadata"
+ $ref: '#/components/schemas/EventsResponseMetadata'
type: object
EventsListResponseLinks:
description: Links attributes.
@@ -38188,7 +38249,7 @@ components:
EventsQueryGroupBys:
description: The list of facets on which to split results.
items:
- $ref: "#/components/schemas/EventsGroupBy"
+ $ref: '#/components/schemas/EventsGroupBy'
type: array
EventsQueryOptions:
description: |-
@@ -38230,7 +38291,7 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/EventsResponseMetadataPage"
+ $ref: '#/components/schemas/EventsResponseMetadataPage'
request_id:
description: The identifier of the request.
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
@@ -38244,7 +38305,7 @@ components:
A list of warnings (non-fatal errors) encountered. Partial results might be returned if
warnings are present in the response.
items:
- $ref: "#/components/schemas/EventsWarning"
+ $ref: '#/components/schemas/EventsWarning'
type: array
type: object
EventsResponseMetadataPage:
@@ -38262,13 +38323,13 @@ components:
An individual scalar query for logs, RUM, traces, CI pipelines, security signals, and other event-based data sources. Use this query type for any data source powered by the Events Platform. See the data_source field for the full list of supported sources.
properties:
compute:
- $ref: "#/components/schemas/EventsCompute"
+ $ref: '#/components/schemas/EventsCompute'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/EventsDataSource"
+ $ref: '#/components/schemas/EventsDataSource'
group_by:
- $ref: "#/components/schemas/EventsQueryGroupBys"
+ $ref: '#/components/schemas/EventsQueryGroupBys'
indexes:
description: The indexes in which to search.
example: ["main"]
@@ -38281,7 +38342,7 @@ components:
description: The variable name for use in formulas.
type: string
search:
- $ref: "#/components/schemas/EventsSearch"
+ $ref: '#/components/schemas/EventsSearch'
required:
- data_source
- compute
@@ -38317,13 +38378,13 @@ components:
An individual timeseries query for logs, RUM, traces, CI pipelines, security signals, and other event-based data sources. Use this query type for any data source powered by the Events Platform. See the data_source field for the full list of supported sources.
properties:
compute:
- $ref: "#/components/schemas/EventsCompute"
+ $ref: '#/components/schemas/EventsCompute'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/EventsDataSource"
+ $ref: '#/components/schemas/EventsDataSource'
group_by:
- $ref: "#/components/schemas/EventsQueryGroupBys"
+ $ref: '#/components/schemas/EventsQueryGroupBys'
indexes:
description: The indexes in which to search.
example: ["main"]
@@ -38336,7 +38397,7 @@ components:
description: The variable name for use in formulas.
type: string
search:
- $ref: "#/components/schemas/EventsSearch"
+ $ref: '#/components/schemas/EventsSearch'
required:
- data_source
- compute
@@ -38384,7 +38445,7 @@ components:
type: string
type: array
integration:
- $ref: "#/components/schemas/ExecutionPolicyIntegration"
+ $ref: '#/components/schemas/ExecutionPolicyIntegration'
required:
- integration
- action_fqns
@@ -38393,7 +38454,7 @@ components:
description: An execution policy.
properties:
action_pattern:
- $ref: "#/components/schemas/ExecutionPolicyActionPattern"
+ $ref: '#/components/schemas/ExecutionPolicyActionPattern'
created_at:
description: The date and time the execution policy was created.
example: "2026-01-15T10:00:00.000Z"
@@ -38404,17 +38465,17 @@ components:
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: string
effect:
- $ref: "#/components/schemas/ExecutionPolicyEffect"
+ $ref: '#/components/schemas/ExecutionPolicyEffect'
name:
description: The name of the execution policy.
example: "Block prod restarts"
type: string
scope:
- $ref: "#/components/schemas/ExecutionPolicyScope"
+ $ref: '#/components/schemas/ExecutionPolicyScope'
targets:
description: The targets this policy applies to.
items:
- $ref: "#/components/schemas/ExecutionPolicyTarget"
+ $ref: '#/components/schemas/ExecutionPolicyTarget'
type: array
updated_at:
description: The date and time the execution policy was last updated.
@@ -38446,7 +38507,7 @@ components:
description: Request object that includes the execution policy to create.
properties:
data:
- $ref: "#/components/schemas/ExecutionPolicyCreateRequestData"
+ $ref: '#/components/schemas/ExecutionPolicyCreateRequestData'
required:
- data
type: object
@@ -38454,9 +38515,9 @@ components:
description: Object for a single execution policy.
properties:
attributes:
- $ref: "#/components/schemas/ExecutionPolicyWriteAttributes"
+ $ref: '#/components/schemas/ExecutionPolicyWriteAttributes'
type:
- $ref: "#/components/schemas/ExecutionPolicyType"
+ $ref: '#/components/schemas/ExecutionPolicyType'
required:
- type
- attributes
@@ -38489,7 +38550,7 @@ components:
rules:
description: The Kubernetes scope rules.
items:
- $ref: "#/components/schemas/ExecutionPolicyKubernetesScopeRule"
+ $ref: '#/components/schemas/ExecutionPolicyKubernetesScopeRule'
type: array
required:
- rules
@@ -38513,10 +38574,10 @@ components:
data:
description: The execution policies.
items:
- $ref: "#/components/schemas/ExecutionPolicyResponseData"
+ $ref: '#/components/schemas/ExecutionPolicyResponseData'
type: array
meta:
- $ref: "#/components/schemas/ExecutionPolicyListResponseMeta"
+ $ref: '#/components/schemas/ExecutionPolicyListResponseMeta'
required:
- data
- meta
@@ -38525,7 +38586,7 @@ components:
description: Pagination metadata for the list of execution policies.
properties:
page:
- $ref: "#/components/schemas/ExecutionPolicyListResponsePage"
+ $ref: '#/components/schemas/ExecutionPolicyListResponsePage'
required:
- page
type: object
@@ -38557,7 +38618,7 @@ components:
rules:
description: The remote shell scope rules.
items:
- $ref: "#/components/schemas/ExecutionPolicyRemoteActionRshellScopeRule"
+ $ref: '#/components/schemas/ExecutionPolicyRemoteActionRshellScopeRule'
type: array
required:
- rules
@@ -38566,7 +38627,7 @@ components:
description: A rule restricting remote shell access to specific paths.
properties:
access:
- $ref: "#/components/schemas/ExecutionPolicyRemoteActionRshellAccess"
+ $ref: '#/components/schemas/ExecutionPolicyRemoteActionRshellAccess'
target_paths:
description: The file system paths this rule applies to.
example:
@@ -38582,7 +38643,7 @@ components:
description: Response object that includes a single execution policy.
properties:
data:
- $ref: "#/components/schemas/ExecutionPolicyResponseData"
+ $ref: '#/components/schemas/ExecutionPolicyResponseData'
required:
- data
type: object
@@ -38590,14 +38651,14 @@ components:
description: Object for a single execution policy.
properties:
attributes:
- $ref: "#/components/schemas/ExecutionPolicyAttributes"
+ $ref: '#/components/schemas/ExecutionPolicyAttributes'
id:
description: The ID of the execution policy.
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
readOnly: true
type: string
type:
- $ref: "#/components/schemas/ExecutionPolicyType"
+ $ref: '#/components/schemas/ExecutionPolicyType'
required:
- id
- type
@@ -38610,11 +38671,11 @@ components:
no scope restriction.
properties:
kubernetes:
- $ref: "#/components/schemas/ExecutionPolicyKubernetesScope"
+ $ref: '#/components/schemas/ExecutionPolicyKubernetesScope'
remote_action_rshell:
- $ref: "#/components/schemas/ExecutionPolicyRemoteActionRshellScope"
+ $ref: '#/components/schemas/ExecutionPolicyRemoteActionRshellScope'
scripts:
- $ref: "#/components/schemas/ExecutionPolicyScriptScope"
+ $ref: '#/components/schemas/ExecutionPolicyScriptScope'
type: object
ExecutionPolicyScriptScope:
description: Restricts the policy to specific scripts.
@@ -38622,7 +38683,7 @@ components:
rules:
description: The script scope rules.
items:
- $ref: "#/components/schemas/ExecutionPolicyScriptScopeRule"
+ $ref: '#/components/schemas/ExecutionPolicyScriptScopeRule'
type: array
required:
- rules
@@ -38671,7 +38732,7 @@ components:
description: Request object that includes the execution policy to update.
properties:
data:
- $ref: "#/components/schemas/ExecutionPolicyUpdateRequestData"
+ $ref: '#/components/schemas/ExecutionPolicyUpdateRequestData'
required:
- data
type: object
@@ -38679,13 +38740,13 @@ components:
description: Object for a single execution policy.
properties:
attributes:
- $ref: "#/components/schemas/ExecutionPolicyWriteAttributes"
+ $ref: '#/components/schemas/ExecutionPolicyWriteAttributes'
id:
description: The ID of the execution policy.
example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: string
type:
- $ref: "#/components/schemas/ExecutionPolicyType"
+ $ref: '#/components/schemas/ExecutionPolicyType'
required:
- id
- type
@@ -38695,19 +38756,19 @@ components:
description: Attributes used to create or update an execution policy.
properties:
action_pattern:
- $ref: "#/components/schemas/ExecutionPolicyActionPattern"
+ $ref: '#/components/schemas/ExecutionPolicyActionPattern'
effect:
- $ref: "#/components/schemas/ExecutionPolicyEffect"
+ $ref: '#/components/schemas/ExecutionPolicyEffect'
name:
description: The name of the execution policy.
example: "Block prod restarts"
type: string
scope:
- $ref: "#/components/schemas/ExecutionPolicyScope"
+ $ref: '#/components/schemas/ExecutionPolicyScope'
targets:
description: The targets this policy applies to.
items:
- $ref: "#/components/schemas/ExecutionPolicyTarget"
+ $ref: '#/components/schemas/ExecutionPolicyTarget'
type: array
required:
- name
@@ -38775,11 +38836,11 @@ components:
format: uuid
type: string
rollout_options:
- $ref: "#/components/schemas/RolloutOptionsRequest"
+ $ref: '#/components/schemas/RolloutOptionsRequest'
rollout_steps:
description: Ordered progression steps for exposure.
items:
- $ref: "#/components/schemas/ExposureRolloutStepRequest"
+ $ref: '#/components/schemas/ExposureRolloutStepRequest'
minItems: 1
type: array
required:
@@ -38795,19 +38856,19 @@ components:
emails:
description: Email addresses for the user.
items:
- $ref: "#/components/schemas/ExternalUserEmailType"
+ $ref: '#/components/schemas/ExternalUserEmailType'
type: array
id:
description: The identifier of the resource. Not required when creating a user.
type: string
meta:
- $ref: "#/components/schemas/ExternalUserMeta"
+ $ref: '#/components/schemas/ExternalUserMeta'
name:
- $ref: "#/components/schemas/ExternalUserNameType"
+ $ref: '#/components/schemas/ExternalUserNameType'
roles:
description: Datadog roles assigned to the user. Provide the role UUID in `value` when provisioning or updating roles through SCIM.
items:
- $ref: "#/components/schemas/ExternalUserRole"
+ $ref: '#/components/schemas/ExternalUserRole'
maxItems: 50
type: array
schemas:
@@ -38832,7 +38893,7 @@ components:
description: Boolean indicating if this email is the primary email address.
type: boolean
type:
- $ref: "#/components/schemas/EmailTypeType"
+ $ref: '#/components/schemas/EmailTypeType'
value:
description: Email addresses for the user.
type: string
@@ -38852,10 +38913,10 @@ components:
members:
description: Members of the group.
items:
- $ref: "#/components/schemas/ExternalUserGroupMembersItems"
+ $ref: '#/components/schemas/ExternalUserGroupMembersItems'
type: array
meta:
- $ref: "#/components/schemas/ExternalUserGroupMeta"
+ $ref: '#/components/schemas/ExternalUserGroupMeta'
schemas:
description: Input JSON Schemas.
example:
@@ -38913,7 +38974,7 @@ components:
Operations:
description: A list of update operations to be performed on a group.
items:
- $ref: "#/components/schemas/ExternalUserGroupPatchRequestOperationsItems"
+ $ref: '#/components/schemas/ExternalUserGroupPatchRequestOperationsItems'
type: array
schemas:
description: Input JSON Schemas
@@ -38928,7 +38989,7 @@ components:
description: The definition of an individual patch operation in a patch request.
properties:
op:
- $ref: "#/components/schemas/ExternalUserGroupPatchRequestOperationsItemsOp"
+ $ref: '#/components/schemas/ExternalUserGroupPatchRequestOperationsItemsOp'
path:
description: An attribute path describing the target of the operation.
example: members
@@ -38987,7 +39048,7 @@ components:
Operations:
description: A list of update operations to be performed on a user.
items:
- $ref: "#/components/schemas/ExternalUserPatchRequestOperationsItems"
+ $ref: '#/components/schemas/ExternalUserPatchRequestOperationsItems'
type: array
schemas:
description: Input JSON Schemas
@@ -39002,7 +39063,7 @@ components:
description: The definition of an individual patch operation in a patch request.
properties:
op:
- $ref: "#/components/schemas/ExternalUserPatchRequestOperationsItemsOp"
+ $ref: '#/components/schemas/ExternalUserPatchRequestOperationsItemsOp'
path:
description: An attribute path describing the target of the operation.
example: roles
@@ -39051,18 +39112,18 @@ components:
type: users_facet_info_request
properties:
data:
- $ref: "#/components/schemas/FacetInfoRequestData"
+ $ref: '#/components/schemas/FacetInfoRequestData'
type: object
FacetInfoRequestData:
description: The data object containing the resource type and attributes for the facet info request.
properties:
attributes:
- $ref: "#/components/schemas/FacetInfoRequestDataAttributes"
+ $ref: '#/components/schemas/FacetInfoRequestDataAttributes'
id:
description: Unique identifier for the facet info request resource.
type: string
type:
- $ref: "#/components/schemas/FacetInfoRequestDataType"
+ $ref: '#/components/schemas/FacetInfoRequestDataType'
required:
- type
type: object
@@ -39079,9 +39140,9 @@ components:
format: int64
type: integer
search:
- $ref: "#/components/schemas/FacetInfoRequestDataAttributesSearch"
+ $ref: '#/components/schemas/FacetInfoRequestDataAttributesSearch'
term_search:
- $ref: "#/components/schemas/FacetInfoRequestDataAttributesTermSearch"
+ $ref: '#/components/schemas/FacetInfoRequestDataAttributesTermSearch'
required:
- facet_id
- limit
@@ -39130,18 +39191,18 @@ components:
type: users_facet_info
properties:
data:
- $ref: "#/components/schemas/FacetInfoResponseData"
+ $ref: '#/components/schemas/FacetInfoResponseData'
type: object
FacetInfoResponseData:
description: The data object containing the resource type and attributes for the facet info response.
properties:
attributes:
- $ref: "#/components/schemas/FacetInfoResponseDataAttributes"
+ $ref: '#/components/schemas/FacetInfoResponseDataAttributes'
id:
description: Unique identifier for the facet info response resource.
type: string
type:
- $ref: "#/components/schemas/FacetInfoResponseDataType"
+ $ref: '#/components/schemas/FacetInfoResponseDataType'
required:
- type
type: object
@@ -39149,17 +39210,17 @@ components:
description: Attributes of the facet info response, containing the facet result data.
properties:
result:
- $ref: "#/components/schemas/FacetInfoResponseDataAttributesResult"
+ $ref: '#/components/schemas/FacetInfoResponseDataAttributesResult'
type: object
FacetInfoResponseDataAttributesResult:
description: The facet query result containing discrete value counts or a numeric range for the requested facet.
properties:
range:
- $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultRange"
+ $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultRange'
values:
description: List of discrete facet values with their occurrence counts.
items:
- $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems"
+ $ref: '#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems'
type: array
type: object
FacetInfoResponseDataAttributesResultRange:
@@ -39200,7 +39261,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/FastlyAPIKeyType"
+ $ref: '#/components/schemas/FastlyAPIKeyType'
required:
- type
- api_key
@@ -39220,7 +39281,7 @@ components:
description: The `FastlyAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/FastlyAPIKeyType"
+ $ref: '#/components/schemas/FastlyAPIKeyType'
required:
- type
type: object
@@ -39234,7 +39295,7 @@ components:
services:
description: A list of services belonging to the parent account.
items:
- $ref: "#/components/schemas/FastlyService"
+ $ref: '#/components/schemas/FastlyService'
type: array
required:
- name
@@ -39243,7 +39304,7 @@ components:
description: Payload schema when adding a Fastly account.
properties:
data:
- $ref: "#/components/schemas/FastlyAccountCreateRequestData"
+ $ref: '#/components/schemas/FastlyAccountCreateRequestData'
required:
- data
type: object
@@ -39261,7 +39322,7 @@ components:
services:
description: A list of services belonging to the parent account.
items:
- $ref: "#/components/schemas/FastlyService"
+ $ref: '#/components/schemas/FastlyService'
type: array
required:
- api_key
@@ -39271,9 +39332,9 @@ components:
description: Data object for creating a Fastly account.
properties:
attributes:
- $ref: "#/components/schemas/FastlyAccountCreateRequestAttributes"
+ $ref: '#/components/schemas/FastlyAccountCreateRequestAttributes'
type:
- $ref: "#/components/schemas/FastlyAccountType"
+ $ref: '#/components/schemas/FastlyAccountType'
required:
- attributes
- type
@@ -39282,19 +39343,19 @@ components:
description: The expected response schema when getting a Fastly account.
properties:
data:
- $ref: "#/components/schemas/FastlyAccountResponseData"
+ $ref: '#/components/schemas/FastlyAccountResponseData'
type: object
FastlyAccountResponseData:
description: Data object of a Fastly account.
properties:
attributes:
- $ref: "#/components/schemas/FastlyAccounResponseAttributes"
+ $ref: '#/components/schemas/FastlyAccounResponseAttributes'
id:
description: The ID of the Fastly account, a hash of the account name.
example: "abc123"
type: string
type:
- $ref: "#/components/schemas/FastlyAccountType"
+ $ref: '#/components/schemas/FastlyAccountType'
required:
- attributes
- id
@@ -39313,7 +39374,7 @@ components:
description: Payload schema when updating a Fastly account.
properties:
data:
- $ref: "#/components/schemas/FastlyAccountUpdateRequestData"
+ $ref: '#/components/schemas/FastlyAccountUpdateRequestData'
required:
- data
type: object
@@ -39332,9 +39393,9 @@ components:
description: Data object for updating a Fastly account.
properties:
attributes:
- $ref: "#/components/schemas/FastlyAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/FastlyAccountUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/FastlyAccountType"
+ $ref: '#/components/schemas/FastlyAccountType'
type: object
FastlyAccountsResponse:
description: The expected response schema when getting Fastly accounts.
@@ -39342,24 +39403,24 @@ components:
data:
description: The JSON:API data schema.
items:
- $ref: "#/components/schemas/FastlyAccountResponseData"
+ $ref: '#/components/schemas/FastlyAccountResponseData'
type: array
type: object
FastlyCredentials:
description: The definition of the `FastlyCredentials` object.
oneOf:
- - $ref: "#/components/schemas/FastlyAPIKey"
+ - $ref: '#/components/schemas/FastlyAPIKey'
FastlyCredentialsUpdate:
description: The definition of the `FastlyCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/FastlyAPIKeyUpdate"
+ - $ref: '#/components/schemas/FastlyAPIKeyUpdate'
FastlyIntegration:
description: The definition of the `FastlyIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/FastlyCredentials"
+ $ref: '#/components/schemas/FastlyCredentials'
type:
- $ref: "#/components/schemas/FastlyIntegrationType"
+ $ref: '#/components/schemas/FastlyIntegrationType'
required:
- type
- credentials
@@ -39376,9 +39437,9 @@ components:
description: The definition of the `FastlyIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/FastlyCredentialsUpdate"
+ $ref: '#/components/schemas/FastlyCredentialsUpdate'
type:
- $ref: "#/components/schemas/FastlyIntegrationType"
+ $ref: '#/components/schemas/FastlyIntegrationType'
required:
- type
type: object
@@ -39418,13 +39479,13 @@ components:
description: Data object for Fastly service requests.
properties:
attributes:
- $ref: "#/components/schemas/FastlyServiceAttributes"
+ $ref: '#/components/schemas/FastlyServiceAttributes'
id:
description: The ID of the Fastly service.
example: "abc123"
type: string
type:
- $ref: "#/components/schemas/FastlyServiceType"
+ $ref: '#/components/schemas/FastlyServiceType'
required:
- id
- type
@@ -39433,7 +39494,7 @@ components:
description: Payload schema for Fastly service requests.
properties:
data:
- $ref: "#/components/schemas/FastlyServiceData"
+ $ref: '#/components/schemas/FastlyServiceData'
required:
- data
type: object
@@ -39441,7 +39502,7 @@ components:
description: The expected response schema when getting a Fastly service.
properties:
data:
- $ref: "#/components/schemas/FastlyServiceData"
+ $ref: '#/components/schemas/FastlyServiceData'
type: object
FastlyServiceType:
default: fastly-services
@@ -39458,21 +39519,21 @@ components:
data:
description: The JSON:API data schema.
items:
- $ref: "#/components/schemas/FastlyServiceData"
+ $ref: '#/components/schemas/FastlyServiceData'
type: array
type: object
FeatureFlag:
description: A feature flag resource.
properties:
attributes:
- $ref: "#/components/schemas/FeatureFlagAttributes"
+ $ref: '#/components/schemas/FeatureFlagAttributes'
id:
description: The unique identifier of the feature flag.
example: "550e8400-e29b-41d4-a716-446655440000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/CreateFeatureFlagDataType"
+ $ref: '#/components/schemas/CreateFeatureFlagDataType'
required:
- id
- type
@@ -39508,7 +39569,7 @@ components:
feature_flag_environments:
description: Environment-specific settings for the feature flag.
items:
- $ref: "#/components/schemas/FeatureFlagEnvironment"
+ $ref: '#/components/schemas/FeatureFlagEnvironment'
type: array
json_schema:
description: JSON schema for validation when value_type is JSON.
@@ -39549,11 +39610,11 @@ components:
format: date-time
type: string
value_type:
- $ref: "#/components/schemas/ValueType"
+ $ref: '#/components/schemas/ValueType'
variants:
description: The variants of the feature flag.
items:
- $ref: "#/components/schemas/Variant"
+ $ref: '#/components/schemas/Variant'
type: array
required:
- key
@@ -39632,7 +39693,7 @@ components:
example: false
type: boolean
status:
- $ref: "#/components/schemas/FeatureFlagStatus"
+ $ref: '#/components/schemas/FeatureFlagStatus'
required:
- environment_id
- status
@@ -39690,7 +39751,7 @@ components:
example: false
type: boolean
status:
- $ref: "#/components/schemas/FeatureFlagStatus"
+ $ref: '#/components/schemas/FeatureFlagStatus'
required:
- environment_id
- status
@@ -39699,14 +39760,14 @@ components:
description: A feature flag resource for list responses.
properties:
attributes:
- $ref: "#/components/schemas/FeatureFlagListItemAttributes"
+ $ref: '#/components/schemas/FeatureFlagListItemAttributes'
id:
description: The unique identifier of the feature flag.
example: "550e8400-e29b-41d4-a716-446655440000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/CreateFeatureFlagDataType"
+ $ref: '#/components/schemas/CreateFeatureFlagDataType'
required:
- id
- type
@@ -39742,7 +39803,7 @@ components:
feature_flag_environments:
description: Environment-specific settings for the feature flag.
items:
- $ref: "#/components/schemas/FeatureFlagEnvironmentListItem"
+ $ref: '#/components/schemas/FeatureFlagEnvironmentListItem'
type: array
json_schema:
description: JSON schema for validation when value_type is JSON.
@@ -39783,11 +39844,11 @@ components:
format: date-time
type: string
value_type:
- $ref: "#/components/schemas/ValueType"
+ $ref: '#/components/schemas/ValueType'
variants:
description: The variants of the feature flag.
items:
- $ref: "#/components/schemas/Variant"
+ $ref: '#/components/schemas/Variant'
type: array
required:
- key
@@ -39800,7 +39861,7 @@ components:
description: Response containing a feature flag.
properties:
data:
- $ref: "#/components/schemas/FeatureFlag"
+ $ref: '#/components/schemas/FeatureFlag'
required:
- data
type: object
@@ -39818,7 +39879,7 @@ components:
description: Pagination metadata for feature flags.
properties:
page:
- $ref: "#/components/schemas/FeatureFlagsPaginationMetaPage"
+ $ref: '#/components/schemas/FeatureFlagsPaginationMetaPage'
type: object
FeatureFlagsPaginationMetaPage:
description: Pagination metadata for feature flags list responses.
@@ -39864,47 +39925,47 @@ components:
description: A single finding without the message and resource configuration.
properties:
attributes:
- $ref: "#/components/schemas/FindingAttributes"
+ $ref: '#/components/schemas/FindingAttributes'
id:
- $ref: "#/components/schemas/FindingID"
+ $ref: '#/components/schemas/FindingID'
type:
- $ref: "#/components/schemas/FindingType"
+ $ref: '#/components/schemas/FindingType'
type: object
FindingAttributes:
description: The JSON:API attributes of the finding.
properties:
datadog_link:
- $ref: "#/components/schemas/FindingDatadogLink"
+ $ref: '#/components/schemas/FindingDatadogLink'
description:
- $ref: "#/components/schemas/FindingDescription"
+ $ref: '#/components/schemas/FindingDescription'
evaluation:
- $ref: "#/components/schemas/FindingEvaluation"
+ $ref: '#/components/schemas/FindingEvaluation'
evaluation_changed_at:
- $ref: "#/components/schemas/FindingEvaluationChangedAt"
+ $ref: '#/components/schemas/FindingEvaluationChangedAt'
external_id:
- $ref: "#/components/schemas/FindingExternalId"
+ $ref: '#/components/schemas/FindingExternalId'
mute:
- $ref: "#/components/schemas/FindingMute"
+ $ref: '#/components/schemas/FindingMute'
resource:
- $ref: "#/components/schemas/FindingResource"
+ $ref: '#/components/schemas/FindingResource'
resource_discovery_date:
- $ref: "#/components/schemas/FindingResourceDiscoveryDate"
+ $ref: '#/components/schemas/FindingResourceDiscoveryDate'
resource_type:
- $ref: "#/components/schemas/FindingResourceType"
+ $ref: '#/components/schemas/FindingResourceType'
rule:
- $ref: "#/components/schemas/FindingRule"
+ $ref: '#/components/schemas/FindingRule'
status:
- $ref: "#/components/schemas/FindingStatus"
+ $ref: '#/components/schemas/FindingStatus'
tags:
- $ref: "#/components/schemas/FindingTags"
+ $ref: '#/components/schemas/FindingTags'
vulnerability_type:
- $ref: "#/components/schemas/FindingVulnerabilityType"
+ $ref: '#/components/schemas/FindingVulnerabilityType'
type: object
FindingCaseResponse:
description: Case response.
properties:
data:
- $ref: "#/components/schemas/FindingCaseResponseData"
+ $ref: '#/components/schemas/FindingCaseResponseData'
type: object
FindingCaseResponseArray:
description: List of case responses.
@@ -39912,7 +39973,7 @@ components:
data:
description: Array of case response data objects.
items:
- $ref: "#/components/schemas/FindingCaseResponseData"
+ $ref: '#/components/schemas/FindingCaseResponseData'
type: array
required:
- data
@@ -39921,15 +39982,15 @@ components:
description: Data of the case.
properties:
attributes:
- $ref: "#/components/schemas/FindingCaseResponseDataAttributes"
+ $ref: '#/components/schemas/FindingCaseResponseDataAttributes'
id:
description: Unique identifier of the case.
example: "c1234567-89ab-cdef-0123-456789abcdef"
type: string
relationships:
- $ref: "#/components/schemas/FindingCaseResponseDataRelationships"
+ $ref: '#/components/schemas/FindingCaseResponseDataRelationships'
type:
- $ref: "#/components/schemas/CaseDataType"
+ $ref: '#/components/schemas/CaseDataType'
required:
- type
type: object
@@ -39977,7 +40038,7 @@ components:
insights:
description: Insights of the case.
items:
- $ref: "#/components/schemas/CaseInsightsItems"
+ $ref: '#/components/schemas/CaseInsightsItems'
type: array
jira_issue:
$ref: "#/components/schemas/FindingJiraIssue"
@@ -40043,7 +40104,7 @@ components:
example: "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw=="
type: string
type:
- $ref: "#/components/schemas/FindingDataType"
+ $ref: '#/components/schemas/FindingDataType'
required:
- type
- id
@@ -40095,7 +40156,7 @@ components:
example: '{"errorMessages":["An error occured."],"errors":{}}'
type: string
result:
- $ref: "#/components/schemas/FindingJiraIssueResult"
+ $ref: '#/components/schemas/FindingJiraIssueResult'
status:
description: Status of the Jira issue creation. Can be "COMPLETED" if the Jira issue was created successfully, or "FAILED" if the Jira issue creation failed.
example: "COMPLETED"
@@ -40129,7 +40190,7 @@ components:
example: "Linear issue creation failed."
type: string
result:
- $ref: "#/components/schemas/FindingLinearIssueResult"
+ $ref: '#/components/schemas/FindingLinearIssueResult'
status:
description: Status of the Linear issue creation. Can be "COMPLETED" if the Linear issue was created successfully, or "FAILED" if the Linear issue creation failed.
example: "COMPLETED"
@@ -40177,7 +40238,7 @@ components:
example: true
type: boolean
reason:
- $ref: "#/components/schemas/FindingMuteReason"
+ $ref: '#/components/schemas/FindingMuteReason'
start_date:
description: The start of the mute period.
example: 1678721573794
@@ -40232,7 +40293,7 @@ components:
description: ServiceNow ticket associated with the case.
properties:
result:
- $ref: "#/components/schemas/FindingServiceNowTicketResult"
+ $ref: '#/components/schemas/FindingServiceNowTicketResult'
status:
description: Status of the ServiceNow ticket operation. Can be "COMPLETED" if successful, or "FAILED" if the operation failed.
example: "COMPLETED"
@@ -40314,14 +40375,14 @@ components:
data:
description: Array of security finding data objects.
items:
- $ref: "#/components/schemas/FindingData"
+ $ref: '#/components/schemas/FindingData'
type: array
type: object
FlakyTest:
description: A flaky test object.
properties:
attributes:
- $ref: "#/components/schemas/FlakyTestAttributes"
+ $ref: '#/components/schemas/FlakyTestAttributes'
id:
description: |-
Test's ID. This ID is the hash of the test's Fully Qualified Name and Git repository ID. It is the
@@ -40330,7 +40391,7 @@ components:
`fingerprint_fqn` search key.
type: string
type:
- $ref: "#/components/schemas/FlakyTestType"
+ $ref: '#/components/schemas/FlakyTestType'
type: object
FlakyTestAttributes:
description: Attributes of a flaky test.
@@ -40376,7 +40437,7 @@ components:
nullable: true
type: string
flaky_state:
- $ref: "#/components/schemas/FlakyTestAttributesFlakyState"
+ $ref: '#/components/schemas/FlakyTestAttributesFlakyState'
history:
description: |-
Chronological history of status changes for this flaky test, ordered from most recent to oldest.
@@ -40398,7 +40459,7 @@ components:
status: new
timestamp: 1703980800000
items:
- $ref: "#/components/schemas/FlakyTestHistory"
+ $ref: '#/components/schemas/FlakyTestHistory'
type: array
impact_level:
$ref: "#/components/schemas/FlakyTestImpactLevel"
@@ -40458,9 +40519,9 @@ components:
example: TestSuite
type: string
test_run_metadata:
- $ref: "#/components/schemas/FlakyTestRunMetadata"
+ $ref: '#/components/schemas/FlakyTestRunMetadata'
test_stats:
- $ref: "#/components/schemas/FlakyTestStats"
+ $ref: '#/components/schemas/FlakyTestStats'
type: object
FlakyTestAttributesFlakyState:
description: The current state of the flaky test.
@@ -40476,7 +40537,7 @@ components:
example: abc123def456
type: string
policy_id:
- $ref: "#/components/schemas/FlakyTestHistoryPolicyId"
+ $ref: '#/components/schemas/FlakyTestHistoryPolicyId'
policy_meta:
$ref: "#/components/schemas/FlakyTestHistoryPolicyMeta"
nullable: true
@@ -40753,25 +40814,25 @@ components:
description: The request for a flaky tests search.
properties:
data:
- $ref: "#/components/schemas/FlakyTestsSearchRequestData"
+ $ref: '#/components/schemas/FlakyTestsSearchRequestData'
type: object
FlakyTestsSearchRequestAttributes:
description: Attributes for the flaky tests search request.
properties:
filter:
- $ref: "#/components/schemas/FlakyTestsSearchFilter"
+ $ref: '#/components/schemas/FlakyTestsSearchFilter'
page:
- $ref: "#/components/schemas/FlakyTestsSearchPageOptions"
+ $ref: '#/components/schemas/FlakyTestsSearchPageOptions'
sort:
- $ref: "#/components/schemas/FlakyTestsSearchSort"
+ $ref: '#/components/schemas/FlakyTestsSearchSort'
type: object
FlakyTestsSearchRequestData:
description: The JSON:API data for flaky tests search request.
properties:
attributes:
- $ref: "#/components/schemas/FlakyTestsSearchRequestAttributes"
+ $ref: '#/components/schemas/FlakyTestsSearchRequestAttributes'
type:
- $ref: "#/components/schemas/FlakyTestsSearchRequestDataType"
+ $ref: '#/components/schemas/FlakyTestsSearchRequestDataType'
type: object
FlakyTestsSearchRequestDataType:
description: The definition of `FlakyTestsSearchRequestDataType` object.
@@ -40786,16 +40847,16 @@ components:
data:
description: Array of flaky tests matching the request.
items:
- $ref: "#/components/schemas/FlakyTest"
+ $ref: '#/components/schemas/FlakyTest'
type: array
meta:
- $ref: "#/components/schemas/FlakyTestsSearchResponseMeta"
+ $ref: '#/components/schemas/FlakyTestsSearchResponseMeta'
type: object
FlakyTestsSearchResponseMeta:
description: Metadata for the flaky tests search response.
properties:
pagination:
- $ref: "#/components/schemas/FlakyTestsPagination"
+ $ref: '#/components/schemas/FlakyTestsPagination'
type: object
FlakyTestsSearchSort:
description: Parameter for sorting flaky test results. The default sort is by ascending Fully Qualified Name (FQN). The FQN is the concatenation of the test module, suite, and name.
@@ -40841,31 +40902,31 @@ components:
description: Configuration details for an agent, organized by configuration layer.
properties:
agent_configuration:
- $ref: "#/components/schemas/FleetConfigurationLayer"
+ $ref: '#/components/schemas/FleetConfigurationLayer'
application_monitoring_configuration:
- $ref: "#/components/schemas/FleetConfigurationLayer"
+ $ref: '#/components/schemas/FleetConfigurationLayer'
otel_collectors_configuration:
description: >-
Configuration for OpenTelemetry collectors associated with the agent. Present only when the agent has associated OpenTelemetry collectors.
items:
- $ref: "#/components/schemas/FleetOtelCollectorConfigurationV2"
+ $ref: '#/components/schemas/FleetOtelCollectorConfigurationV2'
type: array
security_agent_configuration:
- $ref: "#/components/schemas/FleetConfigurationLayer"
+ $ref: '#/components/schemas/FleetConfigurationLayer'
system_probe_configuration:
- $ref: "#/components/schemas/FleetConfigurationLayer"
+ $ref: '#/components/schemas/FleetConfigurationLayer'
type: object
FleetAgentDetailV2:
description: Detailed information about a specific Datadog Agent.
properties:
attributes:
- $ref: "#/components/schemas/FleetAgentDetailV2Attributes"
+ $ref: '#/components/schemas/FleetAgentDetailV2Attributes'
id:
description: The unique agent key identifier.
example: "a1b2c3d4e5f67890a1b2c3d4e5f67890"
type: string
type:
- $ref: "#/components/schemas/FleetAgentV2ResourceType"
+ $ref: '#/components/schemas/FleetAgentV2ResourceType'
required:
- id
- type
@@ -40875,7 +40936,7 @@ components:
description: Attributes for the v2 agent detail response.
properties:
agent_infos:
- $ref: "#/components/schemas/FleetAgentInfoDetailsV2"
+ $ref: '#/components/schemas/FleetAgentInfoDetailsV2'
configuration_files:
$ref: "#/components/schemas/FleetAgentConfigurationFilesV2"
description: Configuration file details, present only when `configuration_files` is included in the `include` query parameter.
@@ -40889,7 +40950,7 @@ components:
description: Response containing detailed information about a specific Datadog Agent.
properties:
data:
- $ref: "#/components/schemas/FleetAgentDetailV2"
+ $ref: '#/components/schemas/FleetAgentDetailV2'
required:
- data
type: object
@@ -41004,7 +41065,7 @@ components:
otel_collectors:
description: OpenTelemetry collectors associated with the agent (if applicable).
items:
- $ref: "#/components/schemas/FleetOtelCollector"
+ $ref: '#/components/schemas/FleetOtelCollector'
type: array
pod_name:
description: Kubernetes pod name (if applicable).
@@ -41053,13 +41114,13 @@ components:
description: A Datadog Agent resource in the v2 list response.
properties:
attributes:
- $ref: "#/components/schemas/FleetAgentV2Attributes"
+ $ref: '#/components/schemas/FleetAgentV2Attributes'
id:
description: The unique agent key identifier.
example: "my-agent-hostname"
type: string
type:
- $ref: "#/components/schemas/FleetAgentV2ResourceType"
+ $ref: '#/components/schemas/FleetAgentV2ResourceType'
required:
- id
- type
@@ -41134,7 +41195,7 @@ components:
format: int64
type: integer
instrumentation_status:
- $ref: "#/components/schemas/FleetAgentV2AttributesInstrumentationStatus"
+ $ref: '#/components/schemas/FleetAgentV2AttributesInstrumentationStatus'
integrations:
description: Names of integrations configured on the agent.
items:
@@ -41206,7 +41267,7 @@ components:
description: >-
Tags associated with the agent. Returned as an empty array when the agent has no tags.
items:
- $ref: "#/components/schemas/FleetAgentAttributesTagsItems"
+ $ref: '#/components/schemas/FleetAgentAttributesTagsItems'
type: array
team:
description: The team associated with the agent.
@@ -41236,13 +41297,13 @@ components:
description: An available Datadog Agent version resource.
properties:
attributes:
- $ref: "#/components/schemas/FleetAgentVersionV2Attributes"
+ $ref: '#/components/schemas/FleetAgentVersionV2Attributes'
id:
description: The agent version string used as the unique identifier.
example: "7.81.1"
type: string
type:
- $ref: "#/components/schemas/FleetAgentVersionV2ResourceType"
+ $ref: '#/components/schemas/FleetAgentVersionV2ResourceType'
required:
- id
- type
@@ -41280,10 +41341,10 @@ components:
data:
description: Array of available agent versions.
items:
- $ref: "#/components/schemas/FleetAgentVersionV2"
+ $ref: '#/components/schemas/FleetAgentVersionV2'
type: array
meta:
- $ref: "#/components/schemas/FleetAgentVersionsV2ResponseMeta"
+ $ref: '#/components/schemas/FleetAgentVersionsV2ResponseMeta'
required:
- data
type: object
@@ -41291,7 +41352,7 @@ components:
description: Metadata for the v2 list of agent versions.
properties:
page:
- $ref: "#/components/schemas/FleetAgentVersionsV2Page"
+ $ref: '#/components/schemas/FleetAgentVersionsV2Page'
type: object
FleetAgentsV2Page:
description: Pagination details for the v2 list of agents.
@@ -41313,10 +41374,10 @@ components:
data:
description: Array of agents matching the query criteria.
items:
- $ref: "#/components/schemas/FleetAgentV2"
+ $ref: '#/components/schemas/FleetAgentV2'
type: array
meta:
- $ref: "#/components/schemas/FleetAgentsV2ResponseMeta"
+ $ref: '#/components/schemas/FleetAgentsV2ResponseMeta'
required:
- data
type: object
@@ -41324,7 +41385,7 @@ components:
description: Metadata for the v2 list of agents, including pagination information.
properties:
page:
- $ref: "#/components/schemas/FleetAgentsV2Page"
+ $ref: '#/components/schemas/FleetAgentsV2Page'
type: object
FleetConfigurationFileV2:
description: A configuration file for an integration.
@@ -41367,13 +41428,13 @@ components:
description: A deployment that defines automated configuration changes for a fleet of hosts.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentAttributes"
+ $ref: '#/components/schemas/FleetDeploymentAttributes'
id:
description: Unique identifier for the deployment.
example: "aeadc05e-98a8-11ec-ac2c-da7ad0900001"
type: string
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- id
- type
@@ -41385,7 +41446,7 @@ components:
config_operations:
description: Ordered list of configuration file operations to perform on the target hosts.
items:
- $ref: "#/components/schemas/FleetDeploymentOperation"
+ $ref: '#/components/schemas/FleetDeploymentOperation'
type: array
estimated_end_time_unix:
description: Estimated completion time of the deployment as a Unix timestamp (seconds since epoch).
@@ -41408,12 +41469,12 @@ components:
when fetching a single deployment by ID. Use the `limit` and `page` query parameters to
navigate through pages. Pagination metadata is included in the response `meta.hosts` field.
items:
- $ref: "#/components/schemas/FleetDeploymentHost"
+ $ref: '#/components/schemas/FleetDeploymentHost'
type: array
packages:
description: List of packages to deploy to target hosts. Present only for package upgrade deployments.
items:
- $ref: "#/components/schemas/FleetDeploymentPackage"
+ $ref: '#/components/schemas/FleetDeploymentPackage'
type: array
total_hosts:
description: Total number of hosts targeted by this deployment.
@@ -41427,7 +41488,7 @@ components:
config_operations:
description: Ordered list of configuration file operations to perform on the target hosts.
items:
- $ref: "#/components/schemas/FleetDeploymentOperation"
+ $ref: '#/components/schemas/FleetDeploymentOperation'
type: array
dry_run:
description: |-
@@ -41445,7 +41506,7 @@ components:
List of packages and their target versions to additionally deploy alongside
the configuration change.
items:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2Package"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2Package'
type: array
required:
- filter_query
@@ -41455,9 +41516,9 @@ components:
description: Data for creating a new v2 configuration deployment.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2Attributes"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2Attributes'
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- type
- attributes
@@ -41466,7 +41527,7 @@ components:
description: Request payload for creating a new v2 configuration deployment.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2Create"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2Create'
required:
- data
type: object
@@ -41474,7 +41535,7 @@ components:
description: The result of a configuration deployment dry run.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2DryRunAttributes"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2DryRunAttributes'
id:
description: |-
Always `"dry-run"` for a dry-run response. Does not identify a real deployment
@@ -41482,7 +41543,7 @@ components:
example: "dry-run"
type: string
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- id
- type
@@ -41492,7 +41553,7 @@ components:
description: Attributes of a configuration deployment dry-run response.
properties:
dry_run:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2DryRunResult"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2DryRunResult'
query:
description: Query used to filter and select target hosts for the deployment.
example: "env:prod AND service:web"
@@ -41507,7 +41568,7 @@ components:
description: Response containing the result of a configuration deployment dry run.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2DryRun"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2DryRun'
required:
- data
type: object
@@ -41584,7 +41645,7 @@ components:
versions:
description: List of packages and their versions currently installed on this host.
items:
- $ref: "#/components/schemas/FleetDeploymentHostPackage"
+ $ref: '#/components/schemas/FleetDeploymentHostPackage'
type: array
type: object
FleetDeploymentHostPackage:
@@ -41637,7 +41698,7 @@ components:
description: A single configuration file operation to perform on the target hosts.
properties:
file_op:
- $ref: "#/components/schemas/FleetDeploymentFileOp"
+ $ref: '#/components/schemas/FleetDeploymentFileOp'
file_path:
description: Absolute path to the target configuration file on the host.
example: "/datadog.yaml"
@@ -41685,7 +41746,7 @@ components:
target_packages:
description: List of packages and their target versions to deploy to the selected hosts.
items:
- $ref: "#/components/schemas/FleetDeploymentPackage"
+ $ref: '#/components/schemas/FleetDeploymentPackage'
type: array
required:
- filter_query
@@ -41695,9 +41756,9 @@ components:
description: Data for creating a new v2 package upgrade deployment.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentPackageUpgradeV2Attributes"
+ $ref: '#/components/schemas/FleetDeploymentPackageUpgradeV2Attributes'
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- type
- attributes
@@ -41706,7 +41767,7 @@ components:
description: Request payload for creating a new v2 package upgrade deployment.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentPackageUpgradeV2Create"
+ $ref: '#/components/schemas/FleetDeploymentPackageUpgradeV2Create'
required:
- data
type: object
@@ -41723,27 +41784,27 @@ components:
description: Response containing a single deployment.
properties:
data:
- $ref: "#/components/schemas/FleetDeployment"
+ $ref: '#/components/schemas/FleetDeployment'
meta:
- $ref: "#/components/schemas/FleetDeploymentResponseMeta"
+ $ref: '#/components/schemas/FleetDeploymentResponseMeta'
type: object
FleetDeploymentResponseMeta:
description: Metadata for a single deployment response, including pagination information for hosts.
properties:
hosts:
- $ref: "#/components/schemas/FleetDeploymentHostsPage"
+ $ref: '#/components/schemas/FleetDeploymentHostsPage'
type: object
FleetDeploymentV2:
description: A deployment in the v2 API response.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentV2Attributes"
+ $ref: '#/components/schemas/FleetDeploymentV2Attributes'
id:
description: Unique identifier for the deployment.
example: "k7Q-3mX-p9Z"
type: string
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- id
- type
@@ -41761,7 +41822,7 @@ components:
Ordered list of configuration file operations applied by this deployment.
Absent for package deployments, which have no configuration file operations.
items:
- $ref: "#/components/schemas/FleetDeploymentOperation"
+ $ref: '#/components/schemas/FleetDeploymentOperation'
type: array
duration_seconds:
description: |-
@@ -41829,13 +41890,13 @@ components:
description: A deployment cancellation response.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentV2CancelAttributes"
+ $ref: '#/components/schemas/FleetDeploymentV2CancelAttributes'
id:
description: Unique identifier for the deployment.
example: "k7Q-3mX-p9Z"
type: string
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- id
- type
@@ -41857,7 +41918,7 @@ components:
description: Response containing the result of a deployment cancellation request.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentV2Cancel"
+ $ref: '#/components/schemas/FleetDeploymentV2Cancel'
required:
- data
type: object
@@ -41865,7 +41926,7 @@ components:
description: Response containing the newly created deployment.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentV2"
+ $ref: '#/components/schemas/FleetDeploymentV2'
required:
- data
type: object
@@ -41873,13 +41934,13 @@ components:
description: Detailed information about a deployment.
properties:
attributes:
- $ref: "#/components/schemas/FleetDeploymentV2DetailAttributes"
+ $ref: '#/components/schemas/FleetDeploymentV2DetailAttributes'
id:
description: Unique identifier for the deployment.
example: "k7Q-3mX-p9Z"
type: string
type:
- $ref: "#/components/schemas/FleetDeploymentResourceType"
+ $ref: '#/components/schemas/FleetDeploymentResourceType'
required:
- id
- type
@@ -41911,7 +41972,7 @@ components:
versions:
description: Package version details for this host.
items:
- $ref: "#/components/schemas/FleetDeploymentHostPackage"
+ $ref: '#/components/schemas/FleetDeploymentHostPackage'
type: array
type: object
FleetDeploymentV2DetailAttributes:
@@ -41932,7 +41993,7 @@ components:
Ordered list of configuration file operations applied by this deployment.
Absent for package deployments, which have no configuration file operations.
items:
- $ref: "#/components/schemas/FleetDeploymentOperation"
+ $ref: '#/components/schemas/FleetDeploymentOperation'
type: array
duration_seconds:
description: |-
@@ -41965,7 +42026,7 @@ components:
hosts:
description: Per-host status list for this deployment.
items:
- $ref: "#/components/schemas/FleetDeploymentV2DetailAgent"
+ $ref: '#/components/schemas/FleetDeploymentV2DetailAgent'
type: array
is_scheduled:
description: Whether this deployment was triggered by a schedule (`schedule_id` is non-empty).
@@ -42019,7 +42080,7 @@ components:
description: Response containing detailed information about a single deployment.
properties:
data:
- $ref: "#/components/schemas/FleetDeploymentV2Detail"
+ $ref: '#/components/schemas/FleetDeploymentV2Detail'
required:
- data
type: object
@@ -42043,10 +42104,10 @@ components:
data:
description: Array of deployments matching the query criteria.
items:
- $ref: "#/components/schemas/FleetDeploymentV2"
+ $ref: '#/components/schemas/FleetDeploymentV2'
type: array
meta:
- $ref: "#/components/schemas/FleetDeploymentsV2ResponseMeta"
+ $ref: '#/components/schemas/FleetDeploymentsV2ResponseMeta'
required:
- data
type: object
@@ -42054,7 +42115,7 @@ components:
description: Metadata for the v2 list of deployments, including pagination information.
properties:
page:
- $ref: "#/components/schemas/FleetDeploymentsV2Page"
+ $ref: '#/components/schemas/FleetDeploymentsV2Page'
type: object
FleetDetectedIntegration:
description: An integration detected on the agent but not necessarily configured.
@@ -42125,27 +42186,27 @@ components:
configuration_files:
description: Configuration files for integrations.
items:
- $ref: "#/components/schemas/FleetConfigurationFileV2"
+ $ref: '#/components/schemas/FleetConfigurationFileV2'
type: array
error_integrations:
description: Integrations with errors.
items:
- $ref: "#/components/schemas/FleetIntegrationDetailsV2"
+ $ref: '#/components/schemas/FleetIntegrationDetailsV2'
type: array
missing_integrations:
description: Detected but not configured integrations.
items:
- $ref: "#/components/schemas/FleetDetectedIntegration"
+ $ref: '#/components/schemas/FleetDetectedIntegration'
type: array
warning_integrations:
description: Integrations with warnings.
items:
- $ref: "#/components/schemas/FleetIntegrationDetailsV2"
+ $ref: '#/components/schemas/FleetIntegrationDetailsV2'
type: array
working_integrations:
description: Integrations that are working correctly.
items:
- $ref: "#/components/schemas/FleetIntegrationDetailsV2"
+ $ref: '#/components/schemas/FleetIntegrationDetailsV2'
type: array
type: object
FleetOtelCollector:
@@ -42169,13 +42230,13 @@ components:
description: A schedule that automatically creates deployments based on a recurrence rule.
properties:
attributes:
- $ref: "#/components/schemas/FleetScheduleAttributes"
+ $ref: '#/components/schemas/FleetScheduleAttributes'
id:
description: Unique identifier for the schedule.
example: "abc-def-ghi-123"
type: string
type:
- $ref: "#/components/schemas/FleetScheduleResourceType"
+ $ref: '#/components/schemas/FleetScheduleResourceType'
required:
- id
- type
@@ -42202,9 +42263,9 @@ components:
example: "env:prod AND service:web"
type: string
rule:
- $ref: "#/components/schemas/FleetScheduleRecurrenceRule"
+ $ref: '#/components/schemas/FleetScheduleRecurrenceRule'
status:
- $ref: "#/components/schemas/FleetScheduleStatus"
+ $ref: '#/components/schemas/FleetScheduleStatus'
updated_at_unix:
description: Unix timestamp (seconds since epoch) when the schedule was last updated.
example: 1699999999
@@ -42231,9 +42292,9 @@ components:
description: Data for creating a new schedule.
properties:
attributes:
- $ref: "#/components/schemas/FleetScheduleCreateAttributes"
+ $ref: '#/components/schemas/FleetScheduleCreateAttributes'
type:
- $ref: "#/components/schemas/FleetScheduleResourceType"
+ $ref: '#/components/schemas/FleetScheduleResourceType'
required:
- type
- attributes
@@ -42250,9 +42311,9 @@ components:
example: "env:prod AND service:web"
type: string
rule:
- $ref: "#/components/schemas/FleetScheduleRecurrenceRule"
+ $ref: '#/components/schemas/FleetScheduleRecurrenceRule'
status:
- $ref: "#/components/schemas/FleetScheduleStatus"
+ $ref: '#/components/schemas/FleetScheduleStatus'
version_to_latest:
description: |-
Number of major versions behind the latest to target for upgrades.
@@ -42274,7 +42335,7 @@ components:
description: Request payload for creating a new schedule.
properties:
data:
- $ref: "#/components/schemas/FleetScheduleCreate"
+ $ref: '#/components/schemas/FleetScheduleCreate'
required:
- data
type: object
@@ -42282,9 +42343,9 @@ components:
description: Data for partially updating a schedule.
properties:
attributes:
- $ref: "#/components/schemas/FleetSchedulePatchAttributes"
+ $ref: '#/components/schemas/FleetSchedulePatchAttributes'
type:
- $ref: "#/components/schemas/FleetScheduleResourceType"
+ $ref: '#/components/schemas/FleetScheduleResourceType'
required:
- type
type: object
@@ -42300,9 +42361,9 @@ components:
example: "env:prod AND service:web"
type: string
rule:
- $ref: "#/components/schemas/FleetScheduleRecurrenceRule"
+ $ref: '#/components/schemas/FleetScheduleRecurrenceRule'
status:
- $ref: "#/components/schemas/FleetScheduleStatus"
+ $ref: '#/components/schemas/FleetScheduleStatus'
version_to_latest:
description: |-
Number of major versions behind the latest to target for upgrades.
@@ -42320,7 +42381,7 @@ components:
description: Request payload for partially updating a schedule.
properties:
data:
- $ref: "#/components/schemas/FleetSchedulePatch"
+ $ref: '#/components/schemas/FleetSchedulePatch'
required:
- data
type: object
@@ -42372,7 +42433,7 @@ components:
description: Response containing a single schedule.
properties:
data:
- $ref: "#/components/schemas/FleetSchedule"
+ $ref: '#/components/schemas/FleetSchedule'
type: object
FleetScheduleStatus:
description: |-
@@ -42391,13 +42452,13 @@ components:
description: A fleet upgrade schedule resource in the v2 API response.
properties:
attributes:
- $ref: "#/components/schemas/FleetScheduleV2Attributes"
+ $ref: '#/components/schemas/FleetScheduleV2Attributes'
id:
description: Unique identifier for the schedule.
example: "abc-def-ghi-123"
type: string
type:
- $ref: "#/components/schemas/FleetScheduleResourceType"
+ $ref: '#/components/schemas/FleetScheduleResourceType'
required:
- id
- type
@@ -42429,15 +42490,15 @@ components:
example: "2025-01-06T02:00:00Z"
type: string
notification_rule:
- $ref: "#/components/schemas/FleetScheduleV2NotificationRule"
+ $ref: '#/components/schemas/FleetScheduleV2NotificationRule'
query:
description: Query used to filter and select target hosts for scheduled deployments.
example: "env:prod AND service:web"
type: string
rule:
- $ref: "#/components/schemas/FleetScheduleV2RecurrenceRule"
+ $ref: '#/components/schemas/FleetScheduleV2RecurrenceRule'
status:
- $ref: "#/components/schemas/FleetScheduleStatus"
+ $ref: '#/components/schemas/FleetScheduleStatus'
updated_at:
description: RFC3339 timestamp when the schedule was last updated.
example: "2023-11-14T22:13:19Z"
@@ -42518,7 +42579,7 @@ components:
description: Response containing a single fleet schedule.
properties:
data:
- $ref: "#/components/schemas/FleetScheduleV2"
+ $ref: '#/components/schemas/FleetScheduleV2'
required:
- data
type: object
@@ -42537,10 +42598,10 @@ components:
data:
description: Array of schedules for the organization.
items:
- $ref: "#/components/schemas/FleetScheduleV2"
+ $ref: '#/components/schemas/FleetScheduleV2'
type: array
meta:
- $ref: "#/components/schemas/FleetSchedulesV2ResponseMeta"
+ $ref: '#/components/schemas/FleetSchedulesV2ResponseMeta'
required:
- data
type: object
@@ -42548,7 +42609,7 @@ components:
description: Metadata for the v2 list of schedules response.
properties:
page:
- $ref: "#/components/schemas/FleetSchedulesV2Page"
+ $ref: '#/components/schemas/FleetSchedulesV2Page'
type: object
FleetTracerAttributes:
description: Attributes of a fleet tracer representing a service instance reporting telemetry.
@@ -42600,9 +42661,9 @@ components:
description: Response containing a paginated list of fleet tracers.
properties:
data:
- $ref: "#/components/schemas/FleetTracersResponseData"
+ $ref: '#/components/schemas/FleetTracersResponseData'
meta:
- $ref: "#/components/schemas/FleetTracersResponseMeta"
+ $ref: '#/components/schemas/FleetTracersResponseMeta'
required:
- data
type: object
@@ -42610,7 +42671,7 @@ components:
description: The response data containing status and tracers array.
properties:
attributes:
- $ref: "#/components/schemas/FleetTracersResponseDataAttributes"
+ $ref: '#/components/schemas/FleetTracersResponseDataAttributes'
id:
description: Status identifier.
example: "done"
@@ -42630,7 +42691,7 @@ components:
tracers:
description: Array of tracers matching the query criteria.
items:
- $ref: "#/components/schemas/FleetTracerAttributes"
+ $ref: '#/components/schemas/FleetTracerAttributes'
type: array
type: object
FleetTracersResponseMeta:
@@ -42684,13 +42745,13 @@ components:
description: Flutter symbol file data object.
properties:
attributes:
- $ref: "#/components/schemas/FlutterSourcemapAttributes"
+ $ref: '#/components/schemas/FlutterSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "12"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -42722,7 +42783,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/FlutterSymbolFileFormDataType"
+ $ref: '#/components/schemas/FlutterSymbolFileFormDataType'
variant:
description: Build variant (1-200 characters).
example: release
@@ -42747,7 +42808,7 @@ components:
description: Multipart form data for uploading Flutter symbol files for crash symbolication.
properties:
event:
- $ref: "#/components/schemas/FlutterSymbolFileEvent"
+ $ref: '#/components/schemas/FlutterSymbolFileEvent'
flutter_symbol_file:
description: The Flutter symbol file.
example: app.symbols
@@ -42769,14 +42830,14 @@ components:
description: A form resource object.
properties:
attributes:
- $ref: "#/components/schemas/FormDataAttributes"
+ $ref: '#/components/schemas/FormDataAttributes'
id:
description: The ID of the form.
example: 22f6006a-2302-4926-9396-d2dfcf7b0b34
format: uuid
type: string
type:
- $ref: "#/components/schemas/FormType"
+ $ref: '#/components/schemas/FormType'
required:
- id
- type
@@ -42799,7 +42860,7 @@ components:
format: date-time
type: string
datastore_config:
- $ref: "#/components/schemas/FormDatastoreConfigAttributes"
+ $ref: '#/components/schemas/FormDatastoreConfigAttributes'
description:
description: The description of the form.
example: A form to collect user feedback.
@@ -42833,7 +42894,7 @@ components:
format: int64
type: integer
publication:
- $ref: "#/components/schemas/FormPublicationAttributes"
+ $ref: '#/components/schemas/FormPublicationAttributes'
self_service:
description: Whether the form is available in the self-service catalog.
example: false
@@ -42853,7 +42914,7 @@ components:
format: uuid
type: string
version:
- $ref: "#/components/schemas/FormVersionAttributes"
+ $ref: '#/components/schemas/FormVersionAttributes'
required:
- active
- anonymous
@@ -42891,7 +42952,7 @@ components:
example: Developer Experience Survey
type: string
type:
- $ref: "#/components/schemas/FormDataDefinitionType"
+ $ref: '#/components/schemas/FormDataDefinitionType'
type: object
FormDataDefinitionType:
default: object
@@ -42904,7 +42965,7 @@ components:
FormDataList:
description: A list of form resource objects.
items:
- $ref: "#/components/schemas/FormData"
+ $ref: '#/components/schemas/FormData'
type: array
FormDatastoreConfigAttributes:
description: The datastore configuration for a form.
@@ -42988,13 +43049,13 @@ components:
description: A form publication resource object.
properties:
attributes:
- $ref: "#/components/schemas/FormPublicationAttributes"
+ $ref: '#/components/schemas/FormPublicationAttributes'
id:
description: The ID of the form publication.
example: "42"
type: string
type:
- $ref: "#/components/schemas/FormPublicationType"
+ $ref: '#/components/schemas/FormPublicationType'
required:
- id
- type
@@ -43004,7 +43065,7 @@ components:
description: A response containing a single form publication.
properties:
data:
- $ref: "#/components/schemas/FormPublicationData"
+ $ref: '#/components/schemas/FormPublicationData'
required:
- data
type: object
@@ -43021,7 +43082,7 @@ components:
description: A response containing a single form.
properties:
data:
- $ref: "#/components/schemas/FormData"
+ $ref: '#/components/schemas/FormData'
required:
- data
type: object
@@ -43037,9 +43098,9 @@ components:
description: "Schema for a Form-based trigger."
properties:
formTrigger:
- $ref: "#/components/schemas/FormTrigger"
+ $ref: '#/components/schemas/FormTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- formTrigger
type: object
@@ -43062,13 +43123,13 @@ components:
type: string
type: array
"ui:theme":
- $ref: "#/components/schemas/FormUiDefinitionUiTheme"
+ $ref: '#/components/schemas/FormUiDefinitionUiTheme'
type: object
FormUiDefinitionUiTheme:
description: The visual theme applied to the form.
properties:
primaryColor:
- $ref: "#/components/schemas/FormUiDefinitionUiThemePrimaryColor"
+ $ref: '#/components/schemas/FormUiDefinitionUiThemePrimaryColor'
type: object
FormUiDefinitionUiThemePrimaryColor:
description: The primary color of the form theme.
@@ -43097,7 +43158,7 @@ components:
description: The fields to update on a form. At least one field must be provided.
properties:
datastore_config:
- $ref: "#/components/schemas/FormDatastoreConfigAttributes"
+ $ref: '#/components/schemas/FormDatastoreConfigAttributes'
description:
description: The updated description of the form.
example: An updated description.
@@ -43116,7 +43177,7 @@ components:
format: date-time
type: string
data_definition:
- $ref: "#/components/schemas/FormDataDefinition"
+ $ref: '#/components/schemas/FormDataDefinition'
definition_signature:
description: The signature of the version definition.
example: '{"signature":"b7f312957a80cea2c8c9950532b205a90a3f8a7ebb7e52fc25437a25d903d545","version":1}'
@@ -43136,9 +43197,9 @@ components:
format: date-time
type: string
state:
- $ref: "#/components/schemas/FormVersionState"
+ $ref: '#/components/schemas/FormVersionState'
ui_definition:
- $ref: "#/components/schemas/FormUiDefinition"
+ $ref: '#/components/schemas/FormUiDefinition'
user_id:
description: The ID of the user who created this version.
example: 10001
@@ -43170,13 +43231,13 @@ components:
description: A form version resource object.
properties:
attributes:
- $ref: "#/components/schemas/FormVersionAttributes"
+ $ref: '#/components/schemas/FormVersionAttributes'
id:
description: The ID of the form version.
example: "126"
type: string
type:
- $ref: "#/components/schemas/FormVersionType"
+ $ref: '#/components/schemas/FormVersionType'
required:
- id
- type
@@ -43186,7 +43247,7 @@ components:
description: A response containing a single form version.
properties:
data:
- $ref: "#/components/schemas/FormVersionData"
+ $ref: '#/components/schemas/FormVersionData'
required:
- data
type: object
@@ -43213,7 +43274,7 @@ components:
description: A response containing a list of forms.
properties:
data:
- $ref: "#/components/schemas/FormDataList"
+ $ref: '#/components/schemas/FormDataList'
required:
- data
type: object
@@ -43229,19 +43290,19 @@ components:
maximum: 2147483647
type: integer
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
type: object
FrameworkHandleAndVersionResponseData:
description: Contains type and attributes for custom frameworks.
properties:
attributes:
- $ref: "#/components/schemas/CustomFrameworkDataHandleAndVersion"
+ $ref: '#/components/schemas/CustomFrameworkDataHandleAndVersion'
id:
description: The ID of the custom framework.
example: handle-version
type: string
type:
- $ref: "#/components/schemas/CustomFrameworkType"
+ $ref: '#/components/schemas/CustomFrameworkType'
required:
- id
- type
@@ -43259,7 +43320,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/FreshserviceAPIKeyType"
+ $ref: '#/components/schemas/FreshserviceAPIKeyType'
required:
- type
- domain
@@ -43283,25 +43344,25 @@ components:
description: The `FreshserviceAPIKeyUpdate` `domain`.
type: string
type:
- $ref: "#/components/schemas/FreshserviceAPIKeyType"
+ $ref: '#/components/schemas/FreshserviceAPIKeyType'
required:
- type
type: object
FreshserviceCredentials:
description: The definition of the `FreshserviceCredentials` object.
oneOf:
- - $ref: "#/components/schemas/FreshserviceAPIKey"
+ - $ref: '#/components/schemas/FreshserviceAPIKey'
FreshserviceCredentialsUpdate:
description: The definition of the `FreshserviceCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/FreshserviceAPIKeyUpdate"
+ - $ref: '#/components/schemas/FreshserviceAPIKeyUpdate'
FreshserviceIntegration:
description: The definition of the `FreshserviceIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/FreshserviceCredentials"
+ $ref: '#/components/schemas/FreshserviceCredentials'
type:
- $ref: "#/components/schemas/FreshserviceIntegrationType"
+ $ref: '#/components/schemas/FreshserviceIntegrationType'
required:
- type
- credentials
@@ -43318,9 +43379,9 @@ components:
description: The definition of the `FreshserviceIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/FreshserviceCredentialsUpdate"
+ $ref: '#/components/schemas/FreshserviceCredentialsUpdate'
type:
- $ref: "#/components/schemas/FreshserviceIntegrationType"
+ $ref: '#/components/schemas/FreshserviceIntegrationType'
required:
- type
type: object
@@ -43328,14 +43389,14 @@ components:
description: Datadog API key.
properties:
attributes:
- $ref: "#/components/schemas/FullAPIKeyAttributes"
+ $ref: '#/components/schemas/FullAPIKeyAttributes'
id:
description: ID of the API key.
type: string
relationships:
- $ref: "#/components/schemas/APIKeyRelationships"
+ $ref: '#/components/schemas/APIKeyRelationships'
type:
- $ref: "#/components/schemas/APIKeysType"
+ $ref: '#/components/schemas/APIKeysType'
type: object
FullAPIKeyAttributes:
description: Attributes of a full API key.
@@ -43385,14 +43446,14 @@ components:
description: Datadog application key.
properties:
attributes:
- $ref: "#/components/schemas/FullApplicationKeyAttributes"
+ $ref: '#/components/schemas/FullApplicationKeyAttributes'
id:
description: ID of the application key.
type: string
relationships:
- $ref: "#/components/schemas/ApplicationKeyRelationships"
+ $ref: '#/components/schemas/ApplicationKeyRelationships'
type:
- $ref: "#/components/schemas/ApplicationKeysType"
+ $ref: '#/components/schemas/ApplicationKeysType'
type: object
FullApplicationKeyAttributes:
description: Attributes of a full application key.
@@ -43438,13 +43499,13 @@ components:
description: Contains type and attributes for custom frameworks.
properties:
attributes:
- $ref: "#/components/schemas/FullCustomFrameworkDataAttributes"
+ $ref: '#/components/schemas/FullCustomFrameworkDataAttributes'
id:
description: The ID of the custom framework.
example: handle-version
type: string
type:
- $ref: "#/components/schemas/CustomFrameworkType"
+ $ref: '#/components/schemas/CustomFrameworkType'
required:
- id
- type
@@ -43468,7 +43529,7 @@ components:
requirements:
description: Framework Requirements
items:
- $ref: "#/components/schemas/CustomFrameworkRequirement"
+ $ref: '#/components/schemas/CustomFrameworkRequirement'
type: array
version:
description: Framework Version
@@ -43484,14 +43545,14 @@ components:
description: Datadog access token, including the token key.
properties:
attributes:
- $ref: "#/components/schemas/FullPersonalAccessTokenAttributes"
+ $ref: '#/components/schemas/FullPersonalAccessTokenAttributes'
id:
description: ID of the access token.
type: string
relationships:
- $ref: "#/components/schemas/PersonalAccessTokenRelationships"
+ $ref: '#/components/schemas/PersonalAccessTokenRelationships'
type:
- $ref: "#/components/schemas/PersonalAccessTokensType"
+ $ref: '#/components/schemas/PersonalAccessTokensType'
type: object
FullPersonalAccessTokenAttributes:
description: Attributes of a full access token, including the token key.
@@ -43536,14 +43597,14 @@ components:
description: Datadog access token, including the token key.
properties:
attributes:
- $ref: "#/components/schemas/FullServiceAccessTokenAttributes"
+ $ref: '#/components/schemas/FullServiceAccessTokenAttributes'
id:
description: ID of the access token.
type: string
relationships:
- $ref: "#/components/schemas/ServiceAccessTokenRelationships"
+ $ref: '#/components/schemas/ServiceAccessTokenRelationships'
type:
- $ref: "#/components/schemas/ServiceAccessTokensType"
+ $ref: '#/components/schemas/ServiceAccessTokensType'
type: object
FullServiceAccessTokenAttributes:
description: Attributes of a full access token, including the token key.
@@ -43587,18 +43648,18 @@ components:
GCPCredentials:
description: The definition of the `GCPCredentials` object.
oneOf:
- - $ref: "#/components/schemas/GCPServiceAccount"
+ - $ref: '#/components/schemas/GCPServiceAccount'
GCPCredentialsUpdate:
description: The definition of the `GCPCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/GCPServiceAccountUpdate"
+ - $ref: '#/components/schemas/GCPServiceAccountUpdate'
GCPIntegration:
description: The definition of the `GCPIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/GCPCredentials"
+ $ref: '#/components/schemas/GCPCredentials'
type:
- $ref: "#/components/schemas/GCPIntegrationType"
+ $ref: '#/components/schemas/GCPIntegrationType'
required:
- type
- credentials
@@ -43615,9 +43676,9 @@ components:
description: The definition of the `GCPIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/GCPCredentialsUpdate"
+ $ref: '#/components/schemas/GCPCredentialsUpdate'
type:
- $ref: "#/components/schemas/GCPIntegrationType"
+ $ref: '#/components/schemas/GCPIntegrationType'
required:
- type
type: object
@@ -43655,7 +43716,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/GCPMonitoredResourceConfigType"
+ $ref: '#/components/schemas/GCPMonitoredResourceConfigType'
type: object
GCPMonitoredResourceConfigType:
description: The GCP monitored resource type. Only a subset of resource types are supported.
@@ -43670,13 +43731,13 @@ components:
description: Datadog principal service account info.
properties:
attributes:
- $ref: "#/components/schemas/GCPSTSDelegateAccountAttributes"
+ $ref: '#/components/schemas/GCPSTSDelegateAccountAttributes'
id:
description: The ID of the delegate service account.
example: "ddgci-1a19n28hb1a812221893@datadog-gci-sts-us5-prod.iam.gserviceaccount.com"
type: string
type:
- $ref: "#/components/schemas/GCPSTSDelegateAccountType"
+ $ref: '#/components/schemas/GCPSTSDelegateAccountType'
type: object
GCPSTSDelegateAccountAttributes:
description: Your delegate account attributes.
@@ -43690,7 +43751,7 @@ components:
description: Your delegate service account response data.
properties:
data:
- $ref: "#/components/schemas/GCPSTSDelegateAccount"
+ $ref: '#/components/schemas/GCPSTSDelegateAccount'
type: object
GCPSTSDelegateAccountType:
default: gcp_sts_delegate
@@ -43705,15 +43766,15 @@ components:
description: Info on your service account.
properties:
attributes:
- $ref: "#/components/schemas/GCPSTSServiceAccountAttributes"
+ $ref: '#/components/schemas/GCPSTSServiceAccountAttributes'
id:
description: Your service account's unique ID.
example: "d291291f-12c2-22g4-j290-123456678897"
type: string
meta:
- $ref: "#/components/schemas/GCPServiceAccountMeta"
+ $ref: '#/components/schemas/GCPServiceAccountMeta'
type:
- $ref: "#/components/schemas/GCPServiceAccountType"
+ $ref: '#/components/schemas/GCPServiceAccountType'
type: object
GCPSTSServiceAccountAttributes:
description: Attributes associated with your service account.
@@ -43785,13 +43846,13 @@ components:
description: Configurations for GCP metric namespaces.
example: [{"disabled": true, "id": "aiplatform"}, {"filters": ["snapshot.*", "!*_by_region"], "id": "pubsub"}]
items:
- $ref: "#/components/schemas/GCPMetricNamespaceConfig"
+ $ref: '#/components/schemas/GCPMetricNamespaceConfig'
type: array
monitored_resource_configs:
description: Configurations for GCP monitored resources.
example: [{"filters": ["$KEY:$VALUE"], "type": "gce_instance"}]
items:
- $ref: "#/components/schemas/GCPMonitoredResourceConfig"
+ $ref: '#/components/schemas/GCPMonitoredResourceConfig'
type: array
region_filter_configs:
description: Configurations for GCP location filtering, such as region, multi-region, or zone. Only monitored resources that match the specified regions are imported into Datadog. By default, Datadog collects from all locations.
@@ -43809,39 +43870,39 @@ components:
description: Data on your newly generated service account.
properties:
data:
- $ref: "#/components/schemas/GCPSTSServiceAccountData"
+ $ref: '#/components/schemas/GCPSTSServiceAccountData'
type: object
GCPSTSServiceAccountData:
description: Additional metadata on your generated service account.
properties:
attributes:
- $ref: "#/components/schemas/GCPSTSServiceAccountAttributes"
+ $ref: '#/components/schemas/GCPSTSServiceAccountAttributes'
type:
- $ref: "#/components/schemas/GCPServiceAccountType"
+ $ref: '#/components/schemas/GCPServiceAccountType'
type: object
GCPSTSServiceAccountResponse:
description: The account creation response.
properties:
data:
- $ref: "#/components/schemas/GCPSTSServiceAccount"
+ $ref: '#/components/schemas/GCPSTSServiceAccount'
type: object
GCPSTSServiceAccountUpdateRequest:
description: Service account info.
properties:
data:
- $ref: "#/components/schemas/GCPSTSServiceAccountUpdateRequestData"
+ $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequestData'
type: object
GCPSTSServiceAccountUpdateRequestData:
description: Data on your service account.
properties:
attributes:
- $ref: "#/components/schemas/GCPSTSServiceAccountAttributes"
+ $ref: '#/components/schemas/GCPSTSServiceAccountAttributes'
id:
description: Your service account's unique ID.
example: "d291291f-12c2-22g4-j290-123456678897"
type: string
type:
- $ref: "#/components/schemas/GCPServiceAccountType"
+ $ref: '#/components/schemas/GCPServiceAccountType'
type: object
GCPSTSServiceAccountsResponse:
description: Object containing all your STS enabled accounts.
@@ -43849,7 +43910,7 @@ components:
data:
description: Array of GCP STS enabled service accounts.
items:
- $ref: "#/components/schemas/GCPSTSServiceAccount"
+ $ref: '#/components/schemas/GCPSTSServiceAccount'
type: array
type: object
GCPServiceAccount:
@@ -43864,7 +43925,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/GCPServiceAccountCredentialType"
+ $ref: '#/components/schemas/GCPServiceAccountCredentialType'
required:
- type
- service_account_email
@@ -43907,7 +43968,7 @@ components:
description: The `GCPServiceAccountUpdate` `service_account_email`.
type: string
type:
- $ref: "#/components/schemas/GCPServiceAccountCredentialType"
+ $ref: '#/components/schemas/GCPServiceAccountCredentialType'
required:
- type
type: object
@@ -43915,12 +43976,12 @@ components:
description: Google Cloud Usage Cost config.
properties:
attributes:
- $ref: "#/components/schemas/GCPUsageCostConfigAttributes"
+ $ref: '#/components/schemas/GCPUsageCostConfigAttributes'
id:
description: The ID of the Google Cloud Usage Cost config.
type: string
type:
- $ref: "#/components/schemas/GCPUsageCostConfigType"
+ $ref: '#/components/schemas/GCPUsageCostConfigType'
required:
- attributes
- type
@@ -43998,9 +44059,9 @@ components:
description: Google Cloud Usage Cost config patch data.
properties:
attributes:
- $ref: "#/components/schemas/GCPUsageCostConfigPatchRequestAttributes"
+ $ref: '#/components/schemas/GCPUsageCostConfigPatchRequestAttributes'
type:
- $ref: "#/components/schemas/GCPUsageCostConfigPatchRequestType"
+ $ref: '#/components/schemas/GCPUsageCostConfigPatchRequestType'
required:
- attributes
- type
@@ -44009,7 +44070,7 @@ components:
description: Google Cloud Usage Cost config patch request.
properties:
data:
- $ref: "#/components/schemas/GCPUsageCostConfigPatchData"
+ $ref: '#/components/schemas/GCPUsageCostConfigPatchData'
required:
- data
type: object
@@ -44036,9 +44097,9 @@ components:
description: Google Cloud Usage Cost config post data.
properties:
attributes:
- $ref: "#/components/schemas/GCPUsageCostConfigPostRequestAttributes"
+ $ref: '#/components/schemas/GCPUsageCostConfigPostRequestAttributes'
type:
- $ref: "#/components/schemas/GCPUsageCostConfigPostRequestType"
+ $ref: '#/components/schemas/GCPUsageCostConfigPostRequestType'
required:
- type
type: object
@@ -44046,7 +44107,7 @@ components:
description: Google Cloud Usage Cost config post request.
properties:
data:
- $ref: "#/components/schemas/GCPUsageCostConfigPostData"
+ $ref: '#/components/schemas/GCPUsageCostConfigPostData'
required:
- data
type: object
@@ -44097,7 +44158,7 @@ components:
description: Response of Google Cloud Usage Cost config.
properties:
data:
- $ref: "#/components/schemas/GCPUsageCostConfig"
+ $ref: '#/components/schemas/GCPUsageCostConfig'
type: object
GCPUsageCostConfigType:
default: gcp_uc_config
@@ -44114,7 +44175,7 @@ components:
data:
description: A Google Cloud Usage Cost config.
items:
- $ref: "#/components/schemas/GCPUsageCostConfig"
+ $ref: '#/components/schemas/GCPUsageCostConfig'
type: array
required:
- data
@@ -44132,7 +44193,7 @@ components:
type: gcp_scan_options
properties:
data:
- $ref: "#/components/schemas/GcpScanOptionsData"
+ $ref: '#/components/schemas/GcpScanOptionsData'
type: object
GcpScanOptionsArray:
description: Response object containing a list of GCP scan options.
@@ -44149,7 +44210,7 @@ components:
data:
description: A list of GCP scan options.
items:
- $ref: "#/components/schemas/GcpScanOptionsData"
+ $ref: '#/components/schemas/GcpScanOptionsData'
type: array
required:
- data
@@ -44158,13 +44219,13 @@ components:
description: Single GCP scan options entry.
properties:
attributes:
- $ref: "#/components/schemas/GcpScanOptionsDataAttributes"
+ $ref: '#/components/schemas/GcpScanOptionsDataAttributes'
id:
description: The GCP project ID.
example: ""
type: string
type:
- $ref: "#/components/schemas/GcpScanOptionsDataType"
+ $ref: '#/components/schemas/GcpScanOptionsDataType'
required:
- type
- id
@@ -44202,19 +44263,19 @@ components:
type: gcp_scan_options
properties:
data:
- $ref: "#/components/schemas/GcpScanOptionsInputUpdateData"
+ $ref: '#/components/schemas/GcpScanOptionsInputUpdateData'
type: object
GcpScanOptionsInputUpdateData:
description: Data object for updating the scan options of a single GCP project.
properties:
attributes:
- $ref: "#/components/schemas/GcpScanOptionsInputUpdateDataAttributes"
+ $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataAttributes'
id:
description: The GCP project ID.
example: ""
type: string
type:
- $ref: "#/components/schemas/GcpScanOptionsInputUpdateDataType"
+ $ref: '#/components/schemas/GcpScanOptionsInputUpdateDataType'
required:
- type
- id
@@ -44266,18 +44327,18 @@ components:
type: gcp_uc_config
properties:
data:
- $ref: "#/components/schemas/GcpUcConfigResponseData"
+ $ref: '#/components/schemas/GcpUcConfigResponseData'
type: object
GcpUcConfigResponseData:
description: The definition of `GcpUcConfigResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/GcpUcConfigResponseDataAttributes"
+ $ref: '#/components/schemas/GcpUcConfigResponseDataAttributes'
id:
description: The `GcpUcConfigResponseData` `id`.
type: string
type:
- $ref: "#/components/schemas/GcpUcConfigResponseDataType"
+ $ref: '#/components/schemas/GcpUcConfigResponseDataType'
required:
- type
type: object
@@ -44346,7 +44407,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/GeminiAPIKeyType"
+ $ref: '#/components/schemas/GeminiAPIKeyType'
required:
- type
- api_key
@@ -44366,25 +44427,25 @@ components:
description: The `GeminiAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/GeminiAPIKeyType"
+ $ref: '#/components/schemas/GeminiAPIKeyType'
required:
- type
type: object
GeminiCredentials:
description: The definition of the `GeminiCredentials` object.
oneOf:
- - $ref: "#/components/schemas/GeminiAPIKey"
+ - $ref: '#/components/schemas/GeminiAPIKey'
GeminiCredentialsUpdate:
description: The definition of the `GeminiCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/GeminiAPIKeyUpdate"
+ - $ref: '#/components/schemas/GeminiAPIKeyUpdate'
GeminiIntegration:
description: The definition of the `GeminiIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/GeminiCredentials"
+ $ref: '#/components/schemas/GeminiCredentials'
type:
- $ref: "#/components/schemas/GeminiIntegrationType"
+ $ref: '#/components/schemas/GeminiIntegrationType'
required:
- type
- credentials
@@ -44401,9 +44462,9 @@ components:
description: The definition of the `GeminiIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/GeminiCredentialsUpdate"
+ $ref: '#/components/schemas/GeminiCredentialsUpdate'
type:
- $ref: "#/components/schemas/GeminiIntegrationType"
+ $ref: '#/components/schemas/GeminiIntegrationType'
required:
- type
type: object
@@ -44417,7 +44478,7 @@ components:
type: cost_generated_tag_description
properties:
data:
- $ref: "#/components/schemas/GeneratedCostTagDescription"
+ $ref: '#/components/schemas/GeneratedCostTagDescription'
required:
- data
type: object
@@ -44425,13 +44486,13 @@ components:
description: AI-generated Cloud Cost Management tag key description returned by the generate endpoint. The result is returned to the client but is not persisted by this endpoint.
properties:
attributes:
- $ref: "#/components/schemas/GeneratedCostTagDescriptionAttributes"
+ $ref: '#/components/schemas/GeneratedCostTagDescriptionAttributes'
id:
description: The tag key the AI description was generated for.
example: account_id
type: string
type:
- $ref: "#/components/schemas/GeneratedCostTagDescriptionType"
+ $ref: '#/components/schemas/GeneratedCostTagDescriptionType'
required:
- attributes
- id
@@ -44460,41 +44521,41 @@ components:
description: The response for found connection
properties:
data:
- $ref: "#/components/schemas/ActionConnectionData"
+ $ref: '#/components/schemas/ActionConnectionData'
type: object
GetAppKeyRegistrationResponse:
description: The response object after getting an app key registration.
properties:
data:
- $ref: "#/components/schemas/AppKeyRegistrationData"
+ $ref: '#/components/schemas/AppKeyRegistrationData'
type: object
GetAppResponse:
description: The full app definition response object.
properties:
data:
- $ref: "#/components/schemas/GetAppResponseData"
+ $ref: '#/components/schemas/GetAppResponseData'
included:
description: Data on the version of the app that was published.
items:
- $ref: "#/components/schemas/Deployment"
+ $ref: '#/components/schemas/Deployment'
type: array
meta:
- $ref: "#/components/schemas/AppMeta"
+ $ref: '#/components/schemas/AppMeta'
relationship:
- $ref: "#/components/schemas/AppRelationship"
+ $ref: '#/components/schemas/AppRelationship'
type: object
GetAppResponseData:
description: The data object containing the app definition.
properties:
attributes:
- $ref: "#/components/schemas/GetAppResponseDataAttributes"
+ $ref: '#/components/schemas/GetAppResponseDataAttributes'
id:
description: The ID of the app.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -44506,7 +44567,7 @@ components:
components:
description: The UI components that make up the app.
items:
- $ref: "#/components/schemas/ComponentGrid"
+ $ref: '#/components/schemas/ComponentGrid'
type: array
description:
description: A human-readable description for the app.
@@ -44520,7 +44581,7 @@ components:
queries:
description: An array of queries, such as external actions and state variables, that the app uses.
items:
- $ref: "#/components/schemas/Query"
+ $ref: '#/components/schemas/Query'
type: array
rootInstanceName:
description: The name of the root component of the app. This must be a `grid` component that contains all other components.
@@ -44539,7 +44600,7 @@ components:
description: The request payload for parsing source code into an abstract syntax tree.
properties:
data:
- $ref: "#/components/schemas/GetAstRequestData"
+ $ref: '#/components/schemas/GetAstRequestData'
required:
- data
type: object
@@ -44547,12 +44608,12 @@ components:
description: The primary data object in the get-AST request.
properties:
attributes:
- $ref: "#/components/schemas/GetAstRequestDataAttributes"
+ $ref: '#/components/schemas/GetAstRequestDataAttributes'
id:
description: An optional identifier for the get-AST request resource.
type: string
type:
- $ref: "#/components/schemas/GetAstRequestDataType"
+ $ref: '#/components/schemas/GetAstRequestDataType'
required:
- type
- attributes
@@ -44590,7 +44651,7 @@ components:
description: The response payload containing the parsed abstract syntax tree.
properties:
data:
- $ref: "#/components/schemas/GetAstResponseData"
+ $ref: '#/components/schemas/GetAstResponseData'
required:
- data
type: object
@@ -44598,12 +44659,12 @@ components:
description: The primary data object in the get-AST response.
properties:
attributes:
- $ref: "#/components/schemas/GetAstResponseDataAttributes"
+ $ref: '#/components/schemas/GetAstResponseDataAttributes'
id:
description: The identifier of the get-AST response resource.
type: string
type:
- $ref: "#/components/schemas/GetAstResponseDataType"
+ $ref: '#/components/schemas/GetAstResponseDataType'
required:
- type
- attributes
@@ -44631,7 +44692,7 @@ components:
description: The response for retrieving a single blueprint.
properties:
data:
- $ref: "#/components/schemas/BlueprintData"
+ $ref: '#/components/schemas/BlueprintData'
type: object
GetBlueprintsResponse:
description: The response for retrieving multiple blueprints.
@@ -44639,14 +44700,14 @@ components:
data:
description: An array of blueprints.
items:
- $ref: "#/components/schemas/BlueprintData"
+ $ref: '#/components/schemas/BlueprintData'
type: array
type: object
GetCustomFrameworkResponse:
description: Response object to get a custom framework.
properties:
data:
- $ref: "#/components/schemas/FullCustomFrameworkData"
+ $ref: '#/components/schemas/FullCustomFrameworkData'
required:
- data
type: object
@@ -44656,16 +44717,16 @@ components:
data:
description: The list of data deletion requests that matches the query.
items:
- $ref: "#/components/schemas/DataDeletionResponseItem"
+ $ref: '#/components/schemas/DataDeletionResponseItem'
type: array
meta:
- $ref: "#/components/schemas/DataDeletionResponseMeta"
+ $ref: '#/components/schemas/DataDeletionResponseMeta'
type: object
GetDataObservabilityMonitorRunStatusResponse:
description: The response for getting the status of a data observability monitor run.
properties:
data:
- $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData"
+ $ref: '#/components/schemas/GetDataObservabilityMonitorRunStatusResponseData'
required:
- data
type: object
@@ -44677,7 +44738,7 @@ components:
example: "run completed but produced no metric data"
type: string
status:
- $ref: "#/components/schemas/DataObservabilityMonitorRunStatus"
+ $ref: '#/components/schemas/DataObservabilityMonitorRunStatus'
required:
- status
type: object
@@ -44685,13 +44746,13 @@ components:
description: The data object for a data observability monitor run status response.
properties:
attributes:
- $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes"
+ $ref: '#/components/schemas/GetDataObservabilityMonitorRunStatusResponseAttributes'
id:
description: The unique identifier of the monitor run.
example: "abc123def456"
type: string
type:
- $ref: "#/components/schemas/DataObservabilityMonitorRunType"
+ $ref: '#/components/schemas/DataObservabilityMonitorRunType'
required:
- id
- type
@@ -44784,7 +44845,7 @@ components:
description: Get device response data.
properties:
attributes:
- $ref: "#/components/schemas/GetDeviceAttributes"
+ $ref: '#/components/schemas/GetDeviceAttributes'
id:
description: The device ID
example: example:1.2.3.4
@@ -44797,13 +44858,13 @@ components:
description: The `GetDevice` operation's response.
properties:
data:
- $ref: "#/components/schemas/GetDeviceData"
+ $ref: '#/components/schemas/GetDeviceData'
type: object
GetFindingResponse:
description: The expected response schema when getting a finding.
properties:
data:
- $ref: "#/components/schemas/DetailedFinding"
+ $ref: '#/components/schemas/DetailedFinding'
required:
- data
type: object
@@ -44811,7 +44872,7 @@ components:
description: The interfaces list data
properties:
attributes:
- $ref: "#/components/schemas/InterfaceAttributes"
+ $ref: '#/components/schemas/InterfaceAttributes'
id:
description: The interface ID
example: example:1.2.3.4:99
@@ -44826,16 +44887,16 @@ components:
data:
description: Get Interfaces response
items:
- $ref: "#/components/schemas/GetInterfacesData"
+ $ref: '#/components/schemas/GetInterfacesData'
type: array
type: object
GetInvestigationResponse:
description: Response for a single Bits AI investigation.
properties:
data:
- $ref: "#/components/schemas/GetInvestigationResponseData"
+ $ref: '#/components/schemas/GetInvestigationResponseData'
links:
- $ref: "#/components/schemas/GetInvestigationResponseLinks"
+ $ref: '#/components/schemas/GetInvestigationResponseLinks'
required:
- data
- links
@@ -44844,13 +44905,13 @@ components:
description: Data for the get investigation response.
properties:
attributes:
- $ref: "#/components/schemas/GetInvestigationResponseDataAttributes"
+ $ref: '#/components/schemas/GetInvestigationResponseDataAttributes'
id:
description: The unique identifier of the investigation.
example: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
type: string
type:
- $ref: "#/components/schemas/InvestigationType"
+ $ref: '#/components/schemas/InvestigationType'
required:
- id
- type
@@ -44862,7 +44923,7 @@ components:
conclusions:
description: The conclusions drawn from the investigation.
items:
- $ref: "#/components/schemas/InvestigationConclusion"
+ $ref: '#/components/schemas/InvestigationConclusion'
type: array
status:
description: The current status of the investigation.
@@ -44891,19 +44952,19 @@ components:
description: Response for the get indicator of compromise endpoint.
properties:
data:
- $ref: "#/components/schemas/GetIoCIndicatorResponseData"
+ $ref: '#/components/schemas/GetIoCIndicatorResponseData'
type: object
GetIoCIndicatorResponseAttributes:
description: Attributes of the get indicator response.
properties:
data:
- $ref: "#/components/schemas/IoCIndicatorDetailed"
+ $ref: '#/components/schemas/IoCIndicatorDetailed'
type: object
GetIoCIndicatorResponseData:
description: IoC indicator response data object.
properties:
attributes:
- $ref: "#/components/schemas/GetIoCIndicatorResponseAttributes"
+ $ref: '#/components/schemas/GetIoCIndicatorResponseAttributes'
id:
description: Unique identifier for the response.
type: string
@@ -44962,18 +45023,18 @@ components:
type: get_mappings_response
properties:
data:
- $ref: "#/components/schemas/GetMappingResponseData"
+ $ref: '#/components/schemas/GetMappingResponseData'
type: object
GetMappingResponseData:
description: The data object containing the resource type and attributes for the get mapping response.
properties:
attributes:
- $ref: "#/components/schemas/GetMappingResponseDataAttributes"
+ $ref: '#/components/schemas/GetMappingResponseDataAttributes'
id:
description: Unique identifier for the get mapping response resource.
type: string
type:
- $ref: "#/components/schemas/GetMappingResponseDataType"
+ $ref: '#/components/schemas/GetMappingResponseDataType'
required:
- type
type: object
@@ -44983,7 +45044,7 @@ components:
attributes:
description: The list of entity attributes and their mapping configurations.
items:
- $ref: "#/components/schemas/GetMappingResponseDataAttributesAttributesItems"
+ $ref: '#/components/schemas/GetMappingResponseDataAttributesAttributesItems'
type: array
type: object
GetMappingResponseDataAttributesAttributesItems:
@@ -45024,18 +45085,18 @@ components:
description: The request payload for retrieving rules for multiple rulesets in a single batch call.
properties:
data:
- $ref: "#/components/schemas/GetMultipleRulesetsRequestData"
+ $ref: '#/components/schemas/GetMultipleRulesetsRequestData'
type: object
GetMultipleRulesetsRequestData:
description: The primary data object in the get-multiple-rulesets request, containing request attributes and resource type.
properties:
attributes:
- $ref: "#/components/schemas/GetMultipleRulesetsRequestDataAttributes"
+ $ref: '#/components/schemas/GetMultipleRulesetsRequestDataAttributes'
id:
description: An optional identifier for the get-multiple-rulesets request resource.
type: string
type:
- $ref: "#/components/schemas/GetMultipleRulesetsRequestDataType"
+ $ref: '#/components/schemas/GetMultipleRulesetsRequestDataType'
required:
- type
type: object
@@ -45068,18 +45129,18 @@ components:
description: The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules.
properties:
data:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseData"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseData'
type: object
GetMultipleRulesetsResponseData:
description: The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type.
properties:
attributes:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributes"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributes'
id:
description: The unique identifier of the get-multiple-rulesets response resource.
type: string
type:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataType"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataType'
required:
- type
type: object
@@ -45089,14 +45150,14 @@ components:
rulesets:
description: The list of rulesets returned in response to the batch request.
items:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItems'
type: array
type: object
GetMultipleRulesetsResponseDataAttributesRulesetsItems:
description: A ruleset returned in the response, containing its metadata and associated rules.
properties:
data:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData'
description:
description: A detailed description of the ruleset's purpose and the types of issues it targets.
type: string
@@ -45106,7 +45167,7 @@ components:
rules:
description: The list of static analysis rules included in this ruleset.
items:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems'
type: array
short_description:
description: A brief summary of the ruleset, suitable for display in listings.
@@ -45121,7 +45182,7 @@ components:
description: The unique identifier of the ruleset resource.
type: string
type:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType'
required:
- type
type: object
@@ -45140,7 +45201,7 @@ components:
arguments:
description: The list of configurable arguments accepted by this rule.
items:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems'
type: array
category:
description: The category classifying the type of issue this rule detects (e.g., security, style, performance).
@@ -45165,7 +45226,7 @@ components:
description: The CWE identifier associated with the weakness category this rule detects, if applicable.
type: string
data:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData'
description:
description: A detailed explanation of what the rule detects and why it matters.
type: string
@@ -45209,7 +45270,7 @@ components:
tests:
description: The list of test cases used to validate the rule's behavior.
items:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems'
type: array
tree_sitter_query:
description: The Tree-sitter query expression used by the rule to match code patterns in the AST.
@@ -45237,7 +45298,7 @@ components:
description: The unique identifier of the rule resource.
type: string
type:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType'
required:
- type
type: object
@@ -45279,7 +45340,7 @@ components:
description: The definition of `GetResourceEvaluationFiltersResponse` object.
properties:
data:
- $ref: "#/components/schemas/GetResourceEvaluationFiltersResponseData"
+ $ref: '#/components/schemas/GetResourceEvaluationFiltersResponseData'
required:
- data
type: object
@@ -45287,24 +45348,24 @@ components:
description: The definition of `GetResourceFilterResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/ResourceFilterAttributes"
+ $ref: '#/components/schemas/ResourceFilterAttributes'
id:
description: The `data` `id`.
example: csm_resource_filter
type: string
type:
- $ref: "#/components/schemas/ResourceFilterRequestType"
+ $ref: '#/components/schemas/ResourceFilterRequestType'
type: object
GetRuleVersionHistoryData:
description: Data for the rule version history.
properties:
attributes:
- $ref: "#/components/schemas/RuleVersionHistory"
+ $ref: '#/components/schemas/RuleVersionHistory'
id:
description: ID of the rule.
type: string
type:
- $ref: "#/components/schemas/GetRuleVersionHistoryDataType"
+ $ref: '#/components/schemas/GetRuleVersionHistoryDataType'
type: object
GetRuleVersionHistoryDataType:
description: Type of data.
@@ -45317,13 +45378,13 @@ components:
description: Response for getting the rule version history.
properties:
data:
- $ref: "#/components/schemas/GetRuleVersionHistoryData"
+ $ref: '#/components/schemas/GetRuleVersionHistoryData'
type: object
GetSBOMResponse:
description: The expected response schema when getting an SBOM.
properties:
data:
- $ref: "#/components/schemas/SBOM"
+ $ref: '#/components/schemas/SBOM'
required:
- data
type: object
@@ -45331,12 +45392,12 @@ components:
description: Data for the suppression version history.
properties:
attributes:
- $ref: "#/components/schemas/SuppressionVersionHistory"
+ $ref: '#/components/schemas/SuppressionVersionHistory'
id:
description: ID of the suppression.
type: string
type:
- $ref: "#/components/schemas/GetSuppressionVersionHistoryDataType"
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryDataType'
type: object
GetSuppressionVersionHistoryDataType:
description: Type of data.
@@ -45349,7 +45410,7 @@ components:
description: Response for getting the suppression version history.
properties:
data:
- $ref: "#/components/schemas/GetSuppressionVersionHistoryData"
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryData'
type: object
GetTeamMembershipsSort:
description: Specifies the order of returned team memberships
@@ -45376,7 +45437,7 @@ components:
description: The response object after getting a workflow.
properties:
data:
- $ref: "#/components/schemas/WorkflowData"
+ $ref: '#/components/schemas/WorkflowData'
type: object
GitCommitSHA:
description: "Git Commit SHA."
@@ -45395,15 +45456,15 @@ components:
description: 'Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published.'
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
GithubWebhookTriggerWrapper:
description: "Schema for a GitHub webhook-based trigger."
properties:
githubWebhookTrigger:
- $ref: "#/components/schemas/GithubWebhookTrigger"
+ $ref: '#/components/schemas/GithubWebhookTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- githubWebhookTrigger
type: object
@@ -45415,7 +45476,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/GitlabAPIKeyType"
+ $ref: '#/components/schemas/GitlabAPIKeyType'
required:
- type
- api_token
@@ -45435,25 +45496,25 @@ components:
description: The `GitlabAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/GitlabAPIKeyType"
+ $ref: '#/components/schemas/GitlabAPIKeyType'
required:
- type
type: object
GitlabCredentials:
description: The definition of the `GitlabCredentials` object.
oneOf:
- - $ref: "#/components/schemas/GitlabAPIKey"
+ - $ref: '#/components/schemas/GitlabAPIKey'
GitlabCredentialsUpdate:
description: The definition of the `GitlabCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/GitlabAPIKeyUpdate"
+ - $ref: '#/components/schemas/GitlabAPIKeyUpdate'
GitlabIntegration:
description: The definition of the `GitlabIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/GitlabCredentials"
+ $ref: '#/components/schemas/GitlabCredentials'
type:
- $ref: "#/components/schemas/GitlabIntegrationType"
+ $ref: '#/components/schemas/GitlabIntegrationType'
required:
- type
- credentials
@@ -45470,9 +45531,9 @@ components:
description: The definition of the `GitlabIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/GitlabCredentialsUpdate"
+ $ref: '#/components/schemas/GitlabCredentialsUpdate'
type:
- $ref: "#/components/schemas/GitlabIntegrationType"
+ $ref: '#/components/schemas/GitlabIntegrationType'
required:
- type
type: object
@@ -45519,9 +45580,9 @@ components:
description: Data object in the global incident settings request.
properties:
attributes:
- $ref: "#/components/schemas/GlobalIncidentSettingsAttributesRequest"
+ $ref: '#/components/schemas/GlobalIncidentSettingsAttributesRequest'
type:
- $ref: "#/components/schemas/GlobalIncidentSettingsType"
+ $ref: '#/components/schemas/GlobalIncidentSettingsType'
required:
- type
type: object
@@ -45529,13 +45590,13 @@ components:
description: Data object in the global incident settings response.
properties:
attributes:
- $ref: "#/components/schemas/GlobalIncidentSettingsAttributesResponse"
+ $ref: '#/components/schemas/GlobalIncidentSettingsAttributesResponse'
id:
description: The unique identifier for the global incident settings
example: f8b9a915-ed85-48b4-9071-ceba567a3db5
type: string
type:
- $ref: "#/components/schemas/GlobalIncidentSettingsType"
+ $ref: '#/components/schemas/GlobalIncidentSettingsType'
required:
- id
- type
@@ -45545,7 +45606,7 @@ components:
description: Request payload for updating global incident settings.
properties:
data:
- $ref: "#/components/schemas/GlobalIncidentSettingsDataRequest"
+ $ref: '#/components/schemas/GlobalIncidentSettingsDataRequest'
required:
- data
type: object
@@ -45553,7 +45614,7 @@ components:
description: Response payload containing global incident settings.
properties:
data:
- $ref: "#/components/schemas/GlobalIncidentSettingsDataResponse"
+ $ref: '#/components/schemas/GlobalIncidentSettingsDataResponse'
required:
- data
type: object
@@ -45595,7 +45656,7 @@ components:
description: Attributes of an organization associated with the authenticated user.
properties:
org:
- $ref: "#/components/schemas/GlobalOrg"
+ $ref: '#/components/schemas/GlobalOrg'
redirect_url:
description: The login URL used to switch into the organization, if available.
example: "https://app.datadoghq.com/account/login/password?dd_oid=13d10a96-6ff2-49be-be7b-4f56ebb13335&login_hint=user%40example.com"
@@ -45606,7 +45667,7 @@ components:
example: us1.prod.dog
type: string
user:
- $ref: "#/components/schemas/GlobalOrgUser"
+ $ref: '#/components/schemas/GlobalOrgUser'
required:
- user
- org
@@ -45616,9 +45677,9 @@ components:
description: An organization associated with the authenticated user.
properties:
attributes:
- $ref: "#/components/schemas/GlobalOrgAttributes"
+ $ref: '#/components/schemas/GlobalOrgAttributes'
type:
- $ref: "#/components/schemas/GlobalOrgType"
+ $ref: '#/components/schemas/GlobalOrgType'
required:
- type
- attributes
@@ -45683,7 +45744,7 @@ components:
description: Response metadata object.
properties:
page:
- $ref: "#/components/schemas/GlobalOrgsMetaPage"
+ $ref: '#/components/schemas/GlobalOrgsMetaPage'
type: object
GlobalOrgsMetaPage:
description: Paging attributes.
@@ -45708,7 +45769,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/GlobalOrgsMetaPageType"
+ $ref: '#/components/schemas/GlobalOrgsMetaPageType'
type: object
GlobalOrgsMetaPageType:
description: Type of global orgs pagination.
@@ -45723,12 +45784,12 @@ components:
data:
description: Organizations across regions for the authenticated user.
items:
- $ref: "#/components/schemas/GlobalOrgData"
+ $ref: '#/components/schemas/GlobalOrgData'
type: array
links:
- $ref: "#/components/schemas/GlobalOrgsLinks"
+ $ref: '#/components/schemas/GlobalOrgsLinks'
meta:
- $ref: "#/components/schemas/GlobalOrgsMeta"
+ $ref: '#/components/schemas/GlobalOrgsMeta'
required:
- data
type: object
@@ -45736,18 +45797,18 @@ components:
description: Synthetics global variable data. Wrapper around the global variable object.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsGlobalVariable"
+ $ref: '#/components/schemas/SyntheticsGlobalVariable'
id:
description: Global variable identifier.
type: string
type:
- $ref: "#/components/schemas/GlobalVariableType"
+ $ref: '#/components/schemas/GlobalVariableType'
type: object
GlobalVariableJsonPatchRequest:
description: JSON Patch request for global variable.
properties:
data:
- $ref: "#/components/schemas/GlobalVariableJsonPatchRequestData"
+ $ref: '#/components/schemas/GlobalVariableJsonPatchRequestData'
required:
- data
type: object
@@ -45755,9 +45816,9 @@ components:
description: Data object for a JSON Patch request on a Synthetic global variable.
properties:
attributes:
- $ref: "#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes"
+ $ref: '#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes'
type:
- $ref: "#/components/schemas/GlobalVariableJsonPatchType"
+ $ref: '#/components/schemas/GlobalVariableJsonPatchType'
type: object
GlobalVariableJsonPatchRequestDataAttributes:
description: Attributes for a JSON Patch request on a Synthetic global variable.
@@ -45765,7 +45826,7 @@ components:
json_patch:
description: JSON Patch operations following RFC 6902.
items:
- $ref: "#/components/schemas/JsonPatchOperation"
+ $ref: '#/components/schemas/JsonPatchOperation'
type: array
type: object
GlobalVariableJsonPatchType:
@@ -45779,7 +45840,7 @@ components:
description: Global variable response.
properties:
data:
- $ref: "#/components/schemas/GlobalVariableData"
+ $ref: '#/components/schemas/GlobalVariableData'
type: object
GlobalVariableType:
description: Global variable type.
@@ -45792,7 +45853,7 @@ components:
description: Response with Google Chat space information.
properties:
data:
- $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponseData"
+ $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseData'
required:
- data
type: object
@@ -45824,7 +45885,7 @@ components:
description: Google Chat space data from a response.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponseAttributes"
+ $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponseAttributes'
id:
description: The ID of the Google Chat space.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -45832,7 +45893,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/GoogleChatAppNamedSpaceType"
+ $ref: '#/components/schemas/GoogleChatAppNamedSpaceType'
type: object
GoogleChatAppNamedSpaceType:
default: google-chat-app-named-space
@@ -45847,9 +45908,9 @@ components:
description: Create organization handle request.
properties:
data:
- $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequestData"
+ $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestData'
type:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleType"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleType'
required:
- type
- data
@@ -45875,7 +45936,7 @@ components:
description: Organization handle data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequestAttributes"
+ $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequestAttributes'
required:
- attributes
type: object
@@ -45900,7 +45961,7 @@ components:
description: Google Chat delegated user data from a response.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatDelegatedUserAttributes"
+ $ref: '#/components/schemas/GoogleChatDelegatedUserAttributes'
id:
description: The ID of the delegated user.
example: "2b3c4d5e-6f78-9012-bcde-f23456789012"
@@ -45908,13 +45969,13 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/GoogleChatDelegatedUserType"
+ $ref: '#/components/schemas/GoogleChatDelegatedUserType'
type: object
GoogleChatDelegatedUserResponse:
description: Response containing a Google Chat delegated user.
properties:
data:
- $ref: "#/components/schemas/GoogleChatDelegatedUserData"
+ $ref: '#/components/schemas/GoogleChatDelegatedUserData'
required:
- data
type: object
@@ -45945,7 +46006,7 @@ components:
description: Google Chat organization data from a response.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatOrganizationAttributes"
+ $ref: '#/components/schemas/GoogleChatOrganizationAttributes'
id:
description: The ID of the Google Chat organization binding.
example: "5ce87709-a12f-4086-fcc8-147045b73a19"
@@ -45953,15 +46014,15 @@ components:
minLength: 1
type: string
relationships:
- $ref: "#/components/schemas/GoogleChatOrganizationRelationships"
+ $ref: '#/components/schemas/GoogleChatOrganizationRelationships'
type:
- $ref: "#/components/schemas/GoogleChatOrganizationType"
+ $ref: '#/components/schemas/GoogleChatOrganizationType'
type: object
GoogleChatOrganizationHandleResponse:
description: Organization handle for monitor notifications to a Google Chat space within a Google organization.
properties:
data:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseData"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData'
required:
- data
type: object
@@ -45988,7 +46049,7 @@ components:
description: Organization handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseAttributes"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseAttributes'
id:
description: The ID of the organization handle.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -45996,7 +46057,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleType"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleType'
type: object
GoogleChatOrganizationHandleType:
default: google-chat-organization-handle
@@ -46014,7 +46075,7 @@ components:
description: An array of organization handles.
example: [{"attributes": {"name": "general-handle", "space_display_name": "General", "space_resource_name": "spaces/AAAAAAAAA"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "google-chat-organization-handle"}, {"attributes": {"name": "general-handle-2", "space_display_name": "General2", "space_resource_name": "spaces/BBBBBBBBB"}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "google-chat-organization-handle"}]
items:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponseData"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponseData'
type: array
required:
- data
@@ -46023,13 +46084,13 @@ components:
description: Google Chat organization relationships.
properties:
delegated_user:
- $ref: "#/components/schemas/GoogleChatOrganizationRelationshipsDelegatedUser"
+ $ref: '#/components/schemas/GoogleChatOrganizationRelationshipsDelegatedUser'
type: object
GoogleChatOrganizationRelationshipsDelegatedUser:
description: The delegated user relationship.
properties:
data:
- $ref: "#/components/schemas/GoogleChatOrganizationRelationshipsDelegatedUserData"
+ $ref: '#/components/schemas/GoogleChatOrganizationRelationshipsDelegatedUserData'
type: object
GoogleChatOrganizationRelationshipsDelegatedUserData:
description: Delegated user relationship data.
@@ -46039,13 +46100,13 @@ components:
example: "2b3c4d5e-6f78-9012-bcde-f23456789012"
type: string
type:
- $ref: "#/components/schemas/GoogleChatDelegatedUserType"
+ $ref: '#/components/schemas/GoogleChatDelegatedUserType'
type: object
GoogleChatOrganizationResponse:
description: Response containing a Google Chat organization binding.
properties:
data:
- $ref: "#/components/schemas/GoogleChatOrganizationData"
+ $ref: '#/components/schemas/GoogleChatOrganizationData'
required:
- data
type: object
@@ -46064,7 +46125,7 @@ components:
data:
description: An array of Google Chat organization bindings.
items:
- $ref: "#/components/schemas/GoogleChatOrganizationData"
+ $ref: '#/components/schemas/GoogleChatOrganizationData'
type: array
required:
- data
@@ -46090,7 +46151,7 @@ components:
description: Create target audience request.
properties:
data:
- $ref: "#/components/schemas/GoogleChatTargetAudienceCreateRequestData"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceCreateRequestData'
required:
- data
type: object
@@ -46115,9 +46176,9 @@ components:
description: Data for a create target audience request.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatTargetAudienceCreateRequestAttributes"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceCreateRequestAttributes'
type:
- $ref: "#/components/schemas/GoogleChatTargetAudienceType"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceType'
required:
- type
- attributes
@@ -46126,7 +46187,7 @@ components:
description: Google Chat target audience data from a response.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatTargetAudienceAttributes"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceAttributes'
id:
description: The ID of the target audience.
example: "1f3e5ce6-944a-4075-97ae-105b5920b5cb"
@@ -46134,13 +46195,13 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/GoogleChatTargetAudienceType"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceType'
type: object
GoogleChatTargetAudienceResponse:
description: Response containing a Google Chat target audience.
properties:
data:
- $ref: "#/components/schemas/GoogleChatTargetAudienceData"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceData'
required:
- data
type: object
@@ -46157,7 +46218,7 @@ components:
description: Update target audience request.
properties:
data:
- $ref: "#/components/schemas/GoogleChatTargetAudienceUpdateRequestData"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceUpdateRequestData'
required:
- data
type: object
@@ -46179,9 +46240,9 @@ components:
description: Data for an update target audience request.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatTargetAudienceUpdateRequestAttributes"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/GoogleChatTargetAudienceType"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceType'
required:
- type
- attributes
@@ -46192,7 +46253,7 @@ components:
data:
description: An array of Google Chat target audiences.
items:
- $ref: "#/components/schemas/GoogleChatTargetAudienceData"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceData'
type: array
required:
- data
@@ -46201,9 +46262,9 @@ components:
description: Update organization handle request.
properties:
data:
- $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequestData"
+ $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestData'
type:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleType"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleType'
required:
- type
- data
@@ -46226,7 +46287,7 @@ components:
description: Organization handle data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequestAttributes"
+ $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequestAttributes'
required:
- attributes
type: object
@@ -46250,7 +46311,7 @@ components:
nullable: true
properties:
data:
- $ref: "#/components/schemas/GoogleMeetConfigurationReferenceData"
+ $ref: '#/components/schemas/GoogleMeetConfigurationReferenceData'
required:
- data
type: object
@@ -46301,7 +46362,7 @@ components:
description: A Governance Console configuration resource.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceConfigAttributes"
+ $ref: '#/components/schemas/GovernanceConfigAttributes'
id:
description: |-
The unique identifier of the organization the Governance Console configuration applies
@@ -46310,7 +46371,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/GovernanceConsoleConfigResourceType"
+ $ref: '#/components/schemas/GovernanceConsoleConfigResourceType'
required:
- id
- type
@@ -46320,7 +46381,7 @@ components:
description: The Governance Console configuration for an organization.
properties:
data:
- $ref: "#/components/schemas/GovernanceConfigData"
+ $ref: '#/components/schemas/GovernanceConfigData'
required:
- data
type: object
@@ -46386,7 +46447,7 @@ components:
example: "revoke_api_key"
type: string
mitigations:
- $ref: "#/components/schemas/GovernanceControlMitigationDefinitionArray"
+ $ref: '#/components/schemas/GovernanceControlMitigationDefinitionArray'
name:
description: Human-readable name of the control.
example: "Unused API Keys"
@@ -46408,7 +46469,7 @@ components:
example: "API Key"
type: string
supported_detection_parameters:
- $ref: "#/components/schemas/GovernanceControlParameterDefinitionArray"
+ $ref: '#/components/schemas/GovernanceControlParameterDefinitionArray'
type:
description: The control type, such as `Proactive` or `Detection`.
example: "Proactive"
@@ -46438,13 +46499,13 @@ components:
description: A governance control resource.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceControlAttributes"
+ $ref: '#/components/schemas/GovernanceControlAttributes'
id:
description: The detection type that uniquely identifies the control.
example: "unused_api_keys"
type: string
type:
- $ref: "#/components/schemas/GovernanceControlResourceType"
+ $ref: '#/components/schemas/GovernanceControlResourceType'
required:
- id
- type
@@ -46476,7 +46537,7 @@ components:
example: "11111111-2222-3333-4444-555555555555"
type: string
assignment_source:
- $ref: "#/components/schemas/GovernanceControlDetectionAssignmentSource"
+ $ref: '#/components/schemas/GovernanceControlDetectionAssignmentSource'
control_id:
deprecated: true
description: |-
@@ -46534,7 +46595,7 @@ components:
example: "api_key"
type: string
state:
- $ref: "#/components/schemas/GovernanceControlDetectionState"
+ $ref: '#/components/schemas/GovernanceControlDetectionState'
required:
- state
- control_id
@@ -46550,13 +46611,13 @@ components:
description: A governance control detection resource.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceControlDetectionAttributes"
+ $ref: '#/components/schemas/GovernanceControlDetectionAttributes'
id:
description: The unique identifier of the detection.
example: "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
type: string
type:
- $ref: "#/components/schemas/GovernanceControlDetectionResourceType"
+ $ref: '#/components/schemas/GovernanceControlDetectionResourceType'
required:
- id
- type
@@ -46574,7 +46635,7 @@ components:
description: A single governance control detection.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlDetectionData"
+ $ref: '#/components/schemas/GovernanceControlDetectionData'
required:
- data
type: object
@@ -46615,15 +46676,15 @@ components:
format: date-time
type: string
state:
- $ref: "#/components/schemas/GovernanceControlDetectionUpdateState"
+ $ref: '#/components/schemas/GovernanceControlDetectionUpdateState'
type: object
GovernanceControlDetectionUpdateData:
description: The data of a governance control detection update request.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceControlDetectionUpdateAttributes"
+ $ref: '#/components/schemas/GovernanceControlDetectionUpdateAttributes'
type:
- $ref: "#/components/schemas/GovernanceControlDetectionResourceType"
+ $ref: '#/components/schemas/GovernanceControlDetectionResourceType'
required:
- type
type: object
@@ -46631,7 +46692,7 @@ components:
description: A request to update a governance control detection.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlDetectionUpdateData"
+ $ref: '#/components/schemas/GovernanceControlDetectionUpdateData'
required:
- data
type: object
@@ -46648,13 +46709,13 @@ components:
GovernanceControlDetectionsDataArray:
description: An array of governance control detection resources.
items:
- $ref: "#/components/schemas/GovernanceControlDetectionData"
+ $ref: '#/components/schemas/GovernanceControlDetectionData'
type: array
GovernanceControlDetectionsResponse:
description: A list of governance control detections.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlDetectionsDataArray"
+ $ref: '#/components/schemas/GovernanceControlDetectionsDataArray'
required:
- data
type: object
@@ -46688,7 +46749,7 @@ components:
type: string
type: array
supported_parameters:
- $ref: "#/components/schemas/GovernanceControlParameterDefinitionArray"
+ $ref: '#/components/schemas/GovernanceControlParameterDefinitionArray'
title:
description: A short, human-readable name for the mitigation.
example: "Revoke Unused API Keys"
@@ -46704,7 +46765,7 @@ components:
GovernanceControlMitigationDefinitionArray:
description: The mitigations available for a control.
items:
- $ref: "#/components/schemas/GovernanceControlMitigationDefinition"
+ $ref: '#/components/schemas/GovernanceControlMitigationDefinition'
type: array
GovernanceControlParameterDefinition:
description: The definition of a configurable parameter on a control or mitigation.
@@ -46729,7 +46790,7 @@ components:
example: false
type: boolean
supported_values:
- $ref: "#/components/schemas/GovernanceControlSupportedValueArray"
+ $ref: '#/components/schemas/GovernanceControlSupportedValueArray'
type:
description: The type of the parameter, such as `integer`, `string`, `boolean`, `enum`, or `pattern_list`.
example: "integer"
@@ -46746,7 +46807,7 @@ components:
GovernanceControlParameterDefinitionArray:
description: An array of parameter definitions.
items:
- $ref: "#/components/schemas/GovernanceControlParameterDefinition"
+ $ref: '#/components/schemas/GovernanceControlParameterDefinition'
type: array
GovernanceControlParametersMap:
additionalProperties: {}
@@ -46764,7 +46825,7 @@ components:
description: A single governance control.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlData"
+ $ref: '#/components/schemas/GovernanceControlData'
required:
- data
type: object
@@ -46786,7 +46847,7 @@ components:
GovernanceControlSupportedValueArray:
description: The supported values for an enumerated parameter. `null` when the parameter is not an enumerated type.
items:
- $ref: "#/components/schemas/GovernanceControlSupportedValue"
+ $ref: '#/components/schemas/GovernanceControlSupportedValue'
nullable: true
type: array
GovernanceControlUpdateAttributes:
@@ -46807,9 +46868,9 @@ components:
description: The data of a governance control update request.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceControlUpdateAttributes"
+ $ref: '#/components/schemas/GovernanceControlUpdateAttributes'
type:
- $ref: "#/components/schemas/GovernanceControlResourceType"
+ $ref: '#/components/schemas/GovernanceControlResourceType'
required:
- type
type: object
@@ -46817,20 +46878,20 @@ components:
description: A request to update a governance control.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlUpdateData"
+ $ref: '#/components/schemas/GovernanceControlUpdateData'
required:
- data
type: object
GovernanceControlsDataArray:
description: An array of governance control resources.
items:
- $ref: "#/components/schemas/GovernanceControlData"
+ $ref: '#/components/schemas/GovernanceControlData'
type: array
GovernanceControlsResponse:
description: A list of governance controls.
properties:
data:
- $ref: "#/components/schemas/GovernanceControlsDataArray"
+ $ref: '#/components/schemas/GovernanceControlsDataArray'
required:
- data
type: object
@@ -46919,7 +46980,7 @@ components:
description: An audit log query used to compute an insight value.
properties:
compute:
- $ref: "#/components/schemas/GovernanceInsightAuditCompute"
+ $ref: '#/components/schemas/GovernanceInsightAuditCompute'
indexes:
description: The audit log indexes the query runs against.
example:
@@ -46946,13 +47007,13 @@ components:
description: A governance insight resource.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceInsightAttributes"
+ $ref: '#/components/schemas/GovernanceInsightAttributes'
id:
description: The unique identifier of the insight.
example: "498ee21f-8037-48b8-a961-a488692902f4"
type: string
type:
- $ref: "#/components/schemas/GovernanceInsightResourceType"
+ $ref: '#/components/schemas/GovernanceInsightResourceType'
required:
- id
- type
@@ -47032,9 +47093,9 @@ components:
description: A percentage query that computes an insight value as a ratio of two metric queries.
properties:
denominator_query:
- $ref: "#/components/schemas/GovernanceInsightMetricQuery"
+ $ref: '#/components/schemas/GovernanceInsightMetricQuery'
numerator_query:
- $ref: "#/components/schemas/GovernanceInsightMetricQuery"
+ $ref: '#/components/schemas/GovernanceInsightMetricQuery'
required:
- numerator_query
- denominator_query
@@ -47056,7 +47117,7 @@ components:
format: int64
type: integer
directionality:
- $ref: "#/components/schemas/GovernanceInsightDirectionality"
+ $ref: '#/components/schemas/GovernanceInsightDirectionality'
effective_time_window_days:
description: The number of days the insight value is computed over.
example: 30
@@ -47092,13 +47153,13 @@ components:
GovernanceInsightsDataArray:
description: An array of governance insight resources.
items:
- $ref: "#/components/schemas/GovernanceInsightData"
+ $ref: '#/components/schemas/GovernanceInsightData'
type: array
GovernanceInsightsResponse:
description: A list of governance insights.
properties:
data:
- $ref: "#/components/schemas/GovernanceInsightsDataArray"
+ $ref: '#/components/schemas/GovernanceInsightsDataArray'
required:
- data
type: object
@@ -47106,7 +47167,7 @@ components:
description: A request to mitigate a set of governance detections.
properties:
data:
- $ref: "#/components/schemas/GovernanceMitigationRequestData"
+ $ref: '#/components/schemas/GovernanceMitigationRequestData'
required:
- data
type: object
@@ -47140,9 +47201,9 @@ components:
description: The data of a governance mitigation request.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceMitigationRequestAttributes"
+ $ref: '#/components/schemas/GovernanceMitigationRequestAttributes'
type:
- $ref: "#/components/schemas/GovernanceControlDetectionResourceType"
+ $ref: '#/components/schemas/GovernanceControlDetectionResourceType'
required:
- type
type: object
@@ -47160,13 +47221,13 @@ components:
description: A governance notification settings resource.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceNotificationSettingsAttributes"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsAttributes'
id:
description: The unique identifier of the organization the notification settings apply to.
example: "11111111-2222-3333-4444-555555555555"
type: string
type:
- $ref: "#/components/schemas/GovernanceNotificationSettingsResourceType"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsResourceType'
required:
- id
- type
@@ -47184,7 +47245,7 @@ components:
description: The organization-wide governance notification settings.
properties:
data:
- $ref: "#/components/schemas/GovernanceNotificationSettingsData"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsData'
required:
- data
type: object
@@ -47200,9 +47261,9 @@ components:
description: The data of a governance notification settings update request.
properties:
attributes:
- $ref: "#/components/schemas/GovernanceNotificationSettingsUpdateAttributes"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsUpdateAttributes'
type:
- $ref: "#/components/schemas/GovernanceNotificationSettingsResourceType"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsResourceType'
required:
- type
type: object
@@ -47210,7 +47271,7 @@ components:
description: A request to update the organization-wide governance notification settings.
properties:
data:
- $ref: "#/components/schemas/GovernanceNotificationSettingsUpdateData"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsUpdateData'
required:
- data
type: object
@@ -47222,7 +47283,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/GreyNoiseAPIKeyType"
+ $ref: '#/components/schemas/GreyNoiseAPIKeyType'
required:
- type
- api_key
@@ -47242,25 +47303,25 @@ components:
description: The `GreyNoiseAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/GreyNoiseAPIKeyType"
+ $ref: '#/components/schemas/GreyNoiseAPIKeyType'
required:
- type
type: object
GreyNoiseCredentials:
description: The definition of the `GreyNoiseCredentials` object.
oneOf:
- - $ref: "#/components/schemas/GreyNoiseAPIKey"
+ - $ref: '#/components/schemas/GreyNoiseAPIKey'
GreyNoiseCredentialsUpdate:
description: The definition of the `GreyNoiseCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/GreyNoiseAPIKeyUpdate"
+ - $ref: '#/components/schemas/GreyNoiseAPIKeyUpdate'
GreyNoiseIntegration:
description: The definition of the `GreyNoiseIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/GreyNoiseCredentials"
+ $ref: '#/components/schemas/GreyNoiseCredentials'
type:
- $ref: "#/components/schemas/GreyNoiseIntegrationType"
+ $ref: '#/components/schemas/GreyNoiseIntegrationType'
required:
- type
- credentials
@@ -47277,9 +47338,9 @@ components:
description: The definition of the `GreyNoiseIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/GreyNoiseCredentialsUpdate"
+ $ref: '#/components/schemas/GreyNoiseCredentialsUpdate'
type:
- $ref: "#/components/schemas/GreyNoiseIntegrationType"
+ $ref: '#/components/schemas/GreyNoiseIntegrationType'
required:
- type
type: object
@@ -47291,7 +47352,7 @@ components:
example: env
type: string
type:
- $ref: "#/components/schemas/ScalarColumnTypeGroup"
+ $ref: '#/components/schemas/ScalarColumnTypeGroup'
values:
description: The array of tag values for each group found for the results of the formulas or queries.
example: [["production"], ["staging"]]
@@ -47319,7 +47380,7 @@ components:
example: "metric-error-rate"
type: string
trigger_action:
- $ref: "#/components/schemas/GuardrailTriggerAction"
+ $ref: '#/components/schemas/GuardrailTriggerAction'
triggered_by:
description: The signal or system that triggered the action.
example: "guardrail_monitor"
@@ -47337,7 +47398,7 @@ components:
example: "metric-error-rate"
type: string
trigger_action:
- $ref: "#/components/schemas/GuardrailTriggerAction"
+ $ref: '#/components/schemas/GuardrailTriggerAction'
required:
- metric_id
- trigger_action
@@ -47370,7 +47431,7 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/HTTPCIAppError"
+ $ref: '#/components/schemas/HTTPCIAppError'
type: array
type: object
HTTPCDGatesNotFoundResponse:
@@ -47379,7 +47440,7 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/HTTPCIAppError"
+ $ref: '#/components/schemas/HTTPCIAppError'
type: array
type: object
HTTPCDRulesNotFoundResponse:
@@ -47388,7 +47449,7 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/HTTPCIAppError"
+ $ref: '#/components/schemas/HTTPCIAppError'
type: array
type: object
HTTPCIAppError:
@@ -47413,17 +47474,17 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/HTTPCIAppError"
+ $ref: '#/components/schemas/HTTPCIAppError'
type: array
type: object
HTTPCredentials:
description: The definition of `HTTPCredentials` object.
oneOf:
- - $ref: "#/components/schemas/HTTPTokenAuth"
+ - $ref: '#/components/schemas/HTTPTokenAuth'
HTTPCredentialsUpdate:
description: The definition of `HTTPCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/HTTPTokenAuthUpdate"
+ - $ref: '#/components/schemas/HTTPTokenAuthUpdate'
HTTPHeader:
description: The definition of `HTTPHeader` object.
properties:
@@ -47466,9 +47527,9 @@ components:
example: http://datadoghq.com
type: string
credentials:
- $ref: "#/components/schemas/HTTPCredentials"
+ $ref: '#/components/schemas/HTTPCredentials'
type:
- $ref: "#/components/schemas/HTTPIntegrationType"
+ $ref: '#/components/schemas/HTTPIntegrationType'
required:
- type
- base_url
@@ -47490,16 +47551,16 @@ components:
example: http://datadoghq.com
type: string
credentials:
- $ref: "#/components/schemas/HTTPCredentialsUpdate"
+ $ref: '#/components/schemas/HTTPCredentialsUpdate'
type:
- $ref: "#/components/schemas/HTTPIntegrationType"
+ $ref: '#/components/schemas/HTTPIntegrationType'
required:
- type
type: object
HTTPLog:
description: Structured log message.
items:
- $ref: "#/components/schemas/HTTPLogItem"
+ $ref: '#/components/schemas/HTTPLogItem'
type: array
HTTPLogError:
description: List of errors.
@@ -47523,7 +47584,7 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/HTTPLogError"
+ $ref: '#/components/schemas/HTTPLogError'
type: array
type: object
HTTPLogItem:
@@ -47572,7 +47633,7 @@ components:
pattern: ^[A-Za-z][A-Za-z\\d]*$
type: string
type:
- $ref: "#/components/schemas/TokenType"
+ $ref: '#/components/schemas/TokenType'
value:
description: The `HTTPToken` `value`.
example: Some Token Value
@@ -47586,23 +47647,23 @@ components:
description: The definition of `HTTPTokenAuth` object.
properties:
body:
- $ref: "#/components/schemas/HTTPBody"
+ $ref: '#/components/schemas/HTTPBody'
headers:
description: The `HTTPTokenAuth` `headers`.
items:
- $ref: "#/components/schemas/HTTPHeader"
+ $ref: '#/components/schemas/HTTPHeader'
type: array
tokens:
description: The `HTTPTokenAuth` `tokens`.
items:
- $ref: "#/components/schemas/HTTPToken"
+ $ref: '#/components/schemas/HTTPToken'
type: array
type:
- $ref: "#/components/schemas/HTTPTokenAuthType"
+ $ref: '#/components/schemas/HTTPTokenAuthType'
url_parameters:
description: The `HTTPTokenAuth` `url_parameters`.
items:
- $ref: "#/components/schemas/UrlParam"
+ $ref: '#/components/schemas/UrlParam'
type: array
required:
- type
@@ -47619,23 +47680,23 @@ components:
description: The definition of `HTTPTokenAuthUpdate` object.
properties:
body:
- $ref: "#/components/schemas/HTTPBody"
+ $ref: '#/components/schemas/HTTPBody'
headers:
description: The `HTTPTokenAuthUpdate` `headers`.
items:
- $ref: "#/components/schemas/HTTPHeaderUpdate"
+ $ref: '#/components/schemas/HTTPHeaderUpdate'
type: array
tokens:
description: The `HTTPTokenAuthUpdate` `tokens`.
items:
- $ref: "#/components/schemas/HTTPTokenUpdate"
+ $ref: '#/components/schemas/HTTPTokenUpdate'
type: array
type:
- $ref: "#/components/schemas/HTTPTokenAuthType"
+ $ref: '#/components/schemas/HTTPTokenAuthType'
url_parameters:
description: The `HTTPTokenAuthUpdate` `url_parameters`.
items:
- $ref: "#/components/schemas/UrlParamUpdate"
+ $ref: '#/components/schemas/UrlParamUpdate'
type: array
required:
- type
@@ -47652,7 +47713,7 @@ components:
pattern: ^[A-Za-z][A-Za-z\\d]*$
type: string
type:
- $ref: "#/components/schemas/TokenType"
+ $ref: '#/components/schemas/TokenType'
value:
description: The `HTTPToken` `value`.
example: Some Token Value
@@ -47666,7 +47727,7 @@ components:
description: Attributes for a HAMR organization connection request.
properties:
hamr_status:
- $ref: "#/components/schemas/HamrOrgConnectionStatus"
+ $ref: '#/components/schemas/HamrOrgConnectionStatus'
is_primary:
description: |-
Indicates whether this organization is the primary organization in the HAMR relationship.
@@ -47701,7 +47762,7 @@ components:
description: Attributes of a HAMR organization connection response.
properties:
hamr_status:
- $ref: "#/components/schemas/HamrOrgConnectionStatus"
+ $ref: '#/components/schemas/HamrOrgConnectionStatus'
is_primary:
description: |-
Indicates whether this organization is the primary organization in the HAMR relationship.
@@ -47741,13 +47802,13 @@ components:
description: Data object for a HAMR organization connection request.
properties:
attributes:
- $ref: "#/components/schemas/HamrOrgConnectionAttributesRequest"
+ $ref: '#/components/schemas/HamrOrgConnectionAttributesRequest'
id:
description: The organization UUID for this HAMR connection. Must match the authenticated organization's UUID.
example: "550e8400-e29b-41d4-a716-446655440000"
type: string
type:
- $ref: "#/components/schemas/HamrOrgConnectionType"
+ $ref: '#/components/schemas/HamrOrgConnectionType'
required:
- id
- type
@@ -47757,13 +47818,13 @@ components:
description: Data object for a HAMR organization connection response.
properties:
attributes:
- $ref: "#/components/schemas/HamrOrgConnectionAttributesResponse"
+ $ref: '#/components/schemas/HamrOrgConnectionAttributesResponse'
id:
description: The organization UUID for this HAMR connection.
example: "550e8400-e29b-41d4-a716-446655440000"
type: string
type:
- $ref: "#/components/schemas/HamrOrgConnectionType"
+ $ref: '#/components/schemas/HamrOrgConnectionType'
required:
- id
- type
@@ -47773,7 +47834,7 @@ components:
description: Request payload for creating or updating a HAMR organization connection.
properties:
data:
- $ref: "#/components/schemas/HamrOrgConnectionDataRequest"
+ $ref: '#/components/schemas/HamrOrgConnectionDataRequest'
required:
- data
type: object
@@ -47781,7 +47842,7 @@ components:
description: Response payload for a HAMR organization connection.
properties:
data:
- $ref: "#/components/schemas/HamrOrgConnectionDataResponse"
+ $ref: '#/components/schemas/HamrOrgConnectionDataResponse'
required:
- data
type: object
@@ -47839,23 +47900,23 @@ components:
description: Job options.
properties:
anomalyDetectionOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions'
detectionMethod:
- $ref: "#/components/schemas/SecurityMonitoringRuleDetectionMethod"
+ $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
evaluationWindow:
- $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow"
+ $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
impossibleTravelOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions'
keepAlive:
- $ref: "#/components/schemas/SecurityMonitoringRuleKeepAlive"
+ $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive'
maxSignalDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleMaxSignalDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration'
newValueOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions'
sequenceDetectionOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions'
thirdPartyRuleOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleThirdPartyOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions'
type: object
HistoricalJobQuery:
description: Query for selecting logs analyzed by the historical job.
@@ -47864,7 +47925,7 @@ components:
description: Additional filters appended to the query at evaluation time.
type: string
aggregation:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
correlatedByFields:
description: Fields used to correlate results across queries in sequence detection rules.
items:
@@ -47881,7 +47942,7 @@ components:
description: Custom query extension used to refine the base query.
type: string
dataSource:
- $ref: "#/components/schemas/SecurityMonitoringStandardDataSource"
+ $ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
datasetIds:
description: IDs of reference datasets used by this query.
items:
@@ -47935,7 +47996,7 @@ components:
description: Historical job response.
properties:
data:
- $ref: "#/components/schemas/HistoricalJobResponseData"
+ $ref: '#/components/schemas/HistoricalJobResponseData'
type: object
HistoricalJobResponseAttributes:
description: Historical job attributes.
@@ -47953,7 +48014,7 @@ components:
description: ID of the rule used to create the job (if it is created from a rule).
type: string
jobDefinition:
- $ref: "#/components/schemas/JobDefinition"
+ $ref: '#/components/schemas/JobDefinition'
jobName:
description: Job name.
type: string
@@ -47975,12 +48036,12 @@ components:
description: Historical job response data.
properties:
attributes:
- $ref: "#/components/schemas/HistoricalJobResponseAttributes"
+ $ref: '#/components/schemas/HistoricalJobResponseAttributes'
id:
description: ID of the job.
type: string
type:
- $ref: "#/components/schemas/HistoricalJobDataType"
+ $ref: '#/components/schemas/HistoricalJobDataType'
type: object
HistoricalMetricsConfigurationAttributes:
description: Attributes of a historical metrics configuration.
@@ -48000,7 +48061,7 @@ components:
example: dd.test.metric
type: string
type:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationType"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationType'
required:
- id
- type
@@ -48009,7 +48070,7 @@ components:
description: Request body for enabling historical metrics ingestion for a metric.
properties:
data:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationCreateData"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationCreateData'
required:
- data
type: object
@@ -48018,19 +48079,19 @@ components:
A historical metrics configuration resource object. Existence of this resource means historical metrics ingestion is enabled for the metric; there is no separate enabled attribute.
properties:
attributes:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationAttributes"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationAttributes'
id:
description: The metric name, used as the resource ID.
example: dd.test.metric
type: string
type:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationType"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationType'
type: object
HistoricalMetricsConfigurationResponse:
description: Response containing a historical metrics configuration.
properties:
data:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationData"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationData'
readOnly: true
type: object
HistoricalMetricsConfigurationType:
@@ -48046,12 +48107,12 @@ components:
description: Hourly usage for a product family for an org.
properties:
attributes:
- $ref: "#/components/schemas/HourlyUsageAttributes"
+ $ref: '#/components/schemas/HourlyUsageAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/UsageTimeSeriesType"
+ $ref: '#/components/schemas/UsageTimeSeriesType'
type: object
HourlyUsageAttributes:
description: Attributes of hourly usage for a product family for an org for a time period.
@@ -48065,7 +48126,7 @@ components:
measurements:
description: List of the measured usage values for the product family for the org for the time period.
items:
- $ref: "#/components/schemas/HourlyUsageMeasurement"
+ $ref: '#/components/schemas/HourlyUsageMeasurement'
type: array
org_name:
description: The organization name.
@@ -48100,7 +48161,7 @@ components:
description: The object containing document metadata.
properties:
pagination:
- $ref: "#/components/schemas/HourlyUsagePagination"
+ $ref: '#/components/schemas/HourlyUsagePagination'
type: object
HourlyUsagePagination:
description: The metadata for the current pagination.
@@ -48116,10 +48177,10 @@ components:
data:
description: Response containing hourly usage.
items:
- $ref: "#/components/schemas/HourlyUsage"
+ $ref: '#/components/schemas/HourlyUsage'
type: array
meta:
- $ref: "#/components/schemas/HourlyUsageMetadata"
+ $ref: '#/components/schemas/HourlyUsageMetadata'
type: object
HourlyUsageType:
description: Usage type that is being measured.
@@ -48147,7 +48208,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/IL2CPPMappingFileFormDataType"
+ $ref: '#/components/schemas/IL2CPPMappingFileFormDataType'
required:
- type
- build_id
@@ -48156,7 +48217,7 @@ components:
description: Multipart form data for uploading IL2CPP mapping files for Unity crash symbolication.
properties:
event:
- $ref: "#/components/schemas/IL2CPPMappingFileEvent"
+ $ref: '#/components/schemas/IL2CPPMappingFileEvent'
il2cpp_mapping_file:
description: The IL2CPP mapping file.
example: il2cpp_data.dat
@@ -48204,13 +48265,13 @@ components:
description: IL2CPP mapping file data object.
properties:
attributes:
- $ref: "#/components/schemas/IL2CPPSourcemapAttributes"
+ $ref: '#/components/schemas/IL2CPPSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "8"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -48246,13 +48307,13 @@ components:
description: iOS dSYM source map data object.
properties:
attributes:
- $ref: "#/components/schemas/IOSSourcemapAttributes"
+ $ref: '#/components/schemas/IOSSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "11"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -48262,7 +48323,7 @@ components:
description: Metadata for an iOS dSYM file upload, sent as a JSON-encoded `event` field.
properties:
type:
- $ref: "#/components/schemas/IOSSymbolsFormDataType"
+ $ref: '#/components/schemas/IOSSymbolsFormDataType'
uuids:
description: Comma-separated list of dSYM UUIDs (min 1 character).
example: A1B2C3D4-E5F6-7890-ABCD-EF1234567890
@@ -48276,7 +48337,7 @@ components:
description: Multipart form data for uploading dSYM files for iOS crash symbolication.
properties:
event:
- $ref: "#/components/schemas/IOSSymbolsEvent"
+ $ref: '#/components/schemas/IOSSymbolsEvent'
symbols_archive:
description: The dSYM archive file (.zip).
example: MyApp.dSYM.zip
@@ -48303,19 +48364,19 @@ components:
entries:
description: Array of entries in the IP allowlist.
items:
- $ref: "#/components/schemas/IPAllowlistEntry"
+ $ref: '#/components/schemas/IPAllowlistEntry'
type: array
type: object
IPAllowlistData:
description: IP allowlist data.
properties:
attributes:
- $ref: "#/components/schemas/IPAllowlistAttributes"
+ $ref: '#/components/schemas/IPAllowlistAttributes'
id:
description: The unique identifier of the org.
type: string
type:
- $ref: "#/components/schemas/IPAllowlistType"
+ $ref: '#/components/schemas/IPAllowlistType'
required:
- type
type: object
@@ -48323,7 +48384,7 @@ components:
description: IP allowlist entry object.
properties:
data:
- $ref: "#/components/schemas/IPAllowlistEntryData"
+ $ref: '#/components/schemas/IPAllowlistEntryData'
required:
- data
type: object
@@ -48351,12 +48412,12 @@ components:
description: Data of the IP allowlist entry object.
properties:
attributes:
- $ref: "#/components/schemas/IPAllowlistEntryAttributes"
+ $ref: '#/components/schemas/IPAllowlistEntryAttributes'
id:
description: The unique identifier of the IP allowlist entry.
type: string
type:
- $ref: "#/components/schemas/IPAllowlistEntryType"
+ $ref: '#/components/schemas/IPAllowlistEntryType'
required:
- type
type: object
@@ -48373,7 +48434,7 @@ components:
description: Response containing information about the IP allowlist.
properties:
data:
- $ref: "#/components/schemas/IPAllowlistData"
+ $ref: '#/components/schemas/IPAllowlistData'
type: object
IPAllowlistType:
default: ip_allowlist
@@ -48388,7 +48449,7 @@ components:
description: Update the IP allowlist.
properties:
data:
- $ref: "#/components/schemas/IPAllowlistData"
+ $ref: '#/components/schemas/IPAllowlistData'
required:
- data
type: object
@@ -48420,13 +48481,13 @@ components:
description: Data object representing an organization identity provider.
properties:
attributes:
- $ref: "#/components/schemas/IdentityProviderAttributes"
+ $ref: '#/components/schemas/IdentityProviderAttributes'
id:
description: The unique identifier of the identity provider.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/IdentityProviderType"
+ $ref: '#/components/schemas/IdentityProviderType'
required:
- id
- type
@@ -48435,13 +48496,13 @@ components:
IdentityProviderDataList:
description: List of organization identity provider data objects.
items:
- $ref: "#/components/schemas/IdentityProviderData"
+ $ref: '#/components/schemas/IdentityProviderData'
type: array
IdentityProviderResponse:
description: Response containing a single organization identity provider.
properties:
data:
- $ref: "#/components/schemas/IdentityProviderData"
+ $ref: '#/components/schemas/IdentityProviderData'
required:
- data
type: object
@@ -48467,13 +48528,13 @@ components:
description: Data object for updating an organization identity provider.
properties:
attributes:
- $ref: "#/components/schemas/IdentityProviderUpdateAttributes"
+ $ref: '#/components/schemas/IdentityProviderUpdateAttributes'
id:
description: The unique identifier of the identity provider to update.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/IdentityProviderType"
+ $ref: '#/components/schemas/IdentityProviderType'
required:
- id
- type
@@ -48483,7 +48544,7 @@ components:
description: Request body for updating an organization identity provider.
properties:
data:
- $ref: "#/components/schemas/IdentityProviderUpdateData"
+ $ref: '#/components/schemas/IdentityProviderUpdateData'
required:
- data
type: object
@@ -48491,7 +48552,7 @@ components:
description: Response containing a list of identity providers for an organization.
properties:
data:
- $ref: "#/components/schemas/IdentityProviderDataList"
+ $ref: '#/components/schemas/IdentityProviderDataList'
required:
- data
type: object
@@ -48527,14 +48588,14 @@ components:
description: AI postmortem data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentAIPostmortemDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentAIPostmortemDataAttributesResponse'
id:
description: The incident identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentAIPostmortemResponseType"
+ $ref: '#/components/schemas/IncidentAIPostmortemResponseType'
required:
- id
- type
@@ -48544,7 +48605,7 @@ components:
description: Response with an AI-generated incident postmortem.
properties:
data:
- $ref: "#/components/schemas/IncidentAIPostmortemDataResponse"
+ $ref: '#/components/schemas/IncidentAIPostmortemDataResponse'
required:
- data
type: object
@@ -48571,7 +48632,7 @@ components:
tagValues:
description: "Incident tags and values used to filter matching incidents."
items:
- $ref: "#/components/schemas/IncidentTagValue"
+ $ref: '#/components/schemas/IncidentTagValue'
type: array
type: object
IncidentConfigurationDataAttributesRequest:
@@ -48636,9 +48697,9 @@ components:
description: Incident configuration data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentConfigurationDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentConfigurationDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentConfigurationType"
+ $ref: '#/components/schemas/IncidentConfigurationType'
required:
- type
type: object
@@ -48646,16 +48707,16 @@ components:
description: Incident configuration data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentConfigurationDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentConfigurationDataAttributesResponse'
id:
description: The incident configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentConfigurationRelationships"
+ $ref: '#/components/schemas/IncidentConfigurationRelationships'
type:
- $ref: "#/components/schemas/IncidentConfigurationType"
+ $ref: '#/components/schemas/IncidentConfigurationType'
required:
- id
- type
@@ -48685,14 +48746,14 @@ components:
description: Incident configuration data in a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentConfigurationPatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentConfigurationPatchDataAttributesRequest'
id:
description: The incident configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentConfigurationType"
+ $ref: '#/components/schemas/IncidentConfigurationType'
required:
- id
- type
@@ -48701,7 +48762,7 @@ components:
description: Request payload for patching an incident configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentConfigurationPatchDataRequest"
+ $ref: '#/components/schemas/IncidentConfigurationPatchDataRequest'
required:
- data
type: object
@@ -48709,15 +48770,15 @@ components:
description: Relationships for an incident configuration.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentConfigurationRequest:
description: Request payload for creating an incident configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentConfigurationDataRequest"
+ $ref: '#/components/schemas/IncidentConfigurationDataRequest'
required:
- data
type: object
@@ -48725,11 +48786,11 @@ components:
description: Response with an incident configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentConfigurationDataResponse"
+ $ref: '#/components/schemas/IncidentConfigurationDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -48756,7 +48817,7 @@ components:
type: boolean
fields:
additionalProperties:
- $ref: "#/components/schemas/IncidentFieldAttributes"
+ $ref: '#/components/schemas/IncidentFieldAttributes'
description: A condensed view of the user-defined fields for which to create initial selections.
example: {"severity": {"type": "dropdown", "value": "SEV-5"}}
type: object
@@ -48767,7 +48828,7 @@ components:
initial_cells:
description: An array of initial timeline cells to be placed at the beginning of the incident timeline.
items:
- $ref: "#/components/schemas/IncidentTimelineCellCreateAttributes"
+ $ref: '#/components/schemas/IncidentTimelineCellCreateAttributes'
type: array
is_test:
description: A flag indicating whether the incident is a test incident.
@@ -48777,7 +48838,7 @@ components:
description: Notification handles that will be notified of the incident at creation.
example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}]
items:
- $ref: "#/components/schemas/IncidentNotificationHandle"
+ $ref: '#/components/schemas/IncidentNotificationHandle'
type: array
title:
description: The title of the incident, which summarizes what happened.
@@ -48791,11 +48852,11 @@ components:
description: Incident data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentCreateAttributes"
+ $ref: '#/components/schemas/IncidentCreateAttributes'
relationships:
- $ref: "#/components/schemas/IncidentCreateRelationships"
+ $ref: '#/components/schemas/IncidentCreateRelationships'
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- type
- attributes
@@ -48808,7 +48869,7 @@ components:
example: A critical incident affecting production systems.
type: string
role:
- $ref: "#/components/schemas/IncidentPageRoleReference"
+ $ref: '#/components/schemas/IncidentPageRoleReference'
services:
description: List of affected services.
example:
@@ -48824,7 +48885,7 @@ components:
type: string
type: array
target:
- $ref: "#/components/schemas/IncidentPageTarget"
+ $ref: '#/components/schemas/IncidentPageTarget'
title:
description: The title of the page.
example: Production outage - SEV-1
@@ -48834,9 +48895,9 @@ components:
description: On-call page data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentCreateOnCallPageDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentCreateOnCallPageDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentCreatePageFromIncidentType"
+ $ref: '#/components/schemas/IncidentCreatePageFromIncidentType'
required:
- type
- attributes
@@ -48845,7 +48906,7 @@ components:
description: Request payload for creating an on-call page from an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentCreateOnCallPageDataRequest"
+ $ref: '#/components/schemas/IncidentCreateOnCallPageDataRequest'
required:
- data
type: object
@@ -48861,7 +48922,7 @@ components:
example: "12345"
type: string
role:
- $ref: "#/components/schemas/IncidentPageRoleReference"
+ $ref: '#/components/schemas/IncidentPageRoleReference'
services:
description: List of affected services.
example:
@@ -48878,7 +48939,7 @@ components:
type: string
type: array
target:
- $ref: "#/components/schemas/IncidentPageTarget"
+ $ref: '#/components/schemas/IncidentPageTarget'
title:
description: The title of the page.
example: Production outage - SEV-1
@@ -48888,9 +48949,9 @@ components:
description: Page data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentCreatePageFromIncidentDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentCreatePageFromIncidentDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentCreatePageFromIncidentType"
+ $ref: '#/components/schemas/IncidentCreatePageFromIncidentType'
required:
- type
- attributes
@@ -48899,7 +48960,7 @@ components:
description: Request payload for creating a page from an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentCreatePageFromIncidentDataRequest"
+ $ref: '#/components/schemas/IncidentCreatePageFromIncidentDataRequest'
required:
- data
type: object
@@ -48915,7 +48976,7 @@ components:
description: The relationships the incident will have with other resources once created.
properties:
commander_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
required:
- commander_user
type: object
@@ -48923,7 +48984,7 @@ components:
description: Create request for an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentCreateData"
+ $ref: '#/components/schemas/IncidentCreateData'
required:
- data
type: object
@@ -48934,28 +48995,28 @@ components:
description: "The type of incident that triggers the workflow."
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentCreatedTriggerWrapper:
description: "Schema for an incident declared trigger."
properties:
incidentCreatedTrigger:
- $ref: "#/components/schemas/IncidentCreatedTrigger"
+ $ref: '#/components/schemas/IncidentCreatedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentCreatedTrigger
type: object
IncidentFieldAttributes:
description: Dynamic fields for which selections can be made, with field names as keys.
oneOf:
- - $ref: "#/components/schemas/IncidentFieldAttributesSingleValue"
- - $ref: "#/components/schemas/IncidentFieldAttributesMultipleValue"
+ - $ref: '#/components/schemas/IncidentFieldAttributesSingleValue'
+ - $ref: '#/components/schemas/IncidentFieldAttributesMultipleValue'
IncidentFieldAttributesMultipleValue:
description: A field with potentially multiple values selected.
properties:
type:
- $ref: "#/components/schemas/IncidentFieldAttributesValueType"
+ $ref: '#/components/schemas/IncidentFieldAttributesValueType'
value:
description: The multiple values selected for this field.
example: ["1.0", "1.1"]
@@ -48970,7 +49031,7 @@ components:
description: A field with a single value selected.
properties:
type:
- $ref: "#/components/schemas/IncidentFieldAttributesSingleValueType"
+ $ref: '#/components/schemas/IncidentFieldAttributesSingleValueType'
value:
description: The single value selected for this field.
example: "SEV-1"
@@ -49069,11 +49130,11 @@ components:
description: Google Chat configuration data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationDataAttributesRequest'
relationships:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationType'
required:
- type
- attributes
@@ -49083,16 +49144,16 @@ components:
description: Google Chat configuration data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationDataAttributesResponse'
id:
description: The configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationRelationships"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationRelationships'
type:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationType'
required:
- id
- type
@@ -49122,14 +49183,14 @@ components:
description: Google Chat configuration data in a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationPatchDataAttributesRequest'
id:
description: The configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationType'
required:
- id
- type
@@ -49138,7 +49199,7 @@ components:
description: Request payload for patching a Google Chat configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchDataRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationPatchDataRequest'
required:
- data
type: object
@@ -49146,17 +49207,17 @@ components:
description: Relationships for a Google Chat configuration.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentGoogleChatConfigurationRelationshipsRequest:
description: Relationships for a Google Chat configuration create request.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
required:
- incident_type
type: object
@@ -49164,7 +49225,7 @@ components:
description: Request payload for creating a Google Chat configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationDataRequest'
required:
- data
type: object
@@ -49172,11 +49233,11 @@ components:
description: Response with a Google Chat configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationDataResponse"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49235,11 +49296,11 @@ components:
description: Google Meet configuration data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesRequest'
relationships:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationType'
required:
- type
- attributes
@@ -49249,16 +49310,16 @@ components:
description: Google Meet configuration data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationDataAttributesResponse'
id:
description: The configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRelationships"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationRelationships'
type:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationType'
required:
- id
- type
@@ -49280,14 +49341,14 @@ components:
description: Google Meet configuration data in a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationPatchDataAttributesRequest'
id:
description: The configuration identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationType"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationType'
required:
- id
- type
@@ -49296,7 +49357,7 @@ components:
description: Request payload for patching a Google Meet configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchDataRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationPatchDataRequest'
required:
- data
type: object
@@ -49304,17 +49365,17 @@ components:
description: Relationships for a Google Meet configuration.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentGoogleMeetConfigurationRelationshipsRequest:
description: Relationships for a Google Meet configuration create request.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
required:
- incident_type
type: object
@@ -49322,7 +49383,7 @@ components:
description: Request payload for creating a Google Meet configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationDataRequest'
required:
- data
type: object
@@ -49330,11 +49391,11 @@ components:
description: Response with a Google Meet configuration.
properties:
data:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationDataResponse"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49356,7 +49417,7 @@ components:
severity:
description: Severity levels associated with the handle
items:
- $ref: "#/components/schemas/IncidentHandleAttributesFieldsSeverity"
+ $ref: '#/components/schemas/IncidentHandleAttributesFieldsSeverity'
type: array
type: object
IncidentHandleAttributesFieldsSeverity:
@@ -49367,7 +49428,7 @@ components:
description: Incident handle attributes for requests
properties:
fields:
- $ref: "#/components/schemas/IncidentHandleAttributesFields"
+ $ref: '#/components/schemas/IncidentHandleAttributesFields'
name:
description: The handle name
example: "@incident-sev-1"
@@ -49384,7 +49445,7 @@ components:
format: date-time
type: string
fields:
- $ref: "#/components/schemas/IncidentHandleAttributesFields"
+ $ref: '#/components/schemas/IncidentHandleAttributesFields'
modified_at:
description: Timestamp when the handle was last modified
example: "2026-01-13T17:15:52.726905Z"
@@ -49404,15 +49465,15 @@ components:
description: Data object representing an incident handle in a create or update request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentHandleAttributesRequest"
+ $ref: '#/components/schemas/IncidentHandleAttributesRequest'
id:
description: The ID of the incident handle (required for PUT requests)
example: "b2494081-cdf0-4205-b366-4e1dd4fdf0bf"
type: string
relationships:
- $ref: "#/components/schemas/IncidentHandleRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentHandleRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentHandleType"
+ $ref: '#/components/schemas/IncidentHandleType'
required:
- type
- attributes
@@ -49421,15 +49482,15 @@ components:
description: Data object representing an incident handle in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentHandleAttributesResponse"
+ $ref: '#/components/schemas/IncidentHandleAttributesResponse'
id:
description: The ID of the incident handle
example: "12ceee6d-a7c0-4407-bc54-30e54140d7f0"
type: string
relationships:
- $ref: "#/components/schemas/IncidentHandleRelationships"
+ $ref: '#/components/schemas/IncidentHandleRelationships'
type:
- $ref: "#/components/schemas/IncidentHandleType"
+ $ref: '#/components/schemas/IncidentHandleType'
required:
- id
- type
@@ -49438,18 +49499,18 @@ components:
IncidentHandleIncludedItemResponse:
description: A single included resource item in an incident handle response, which can be a user or an incident type.
oneOf:
- - $ref: "#/components/schemas/IncidentUserData"
- - $ref: "#/components/schemas/IncidentTypeObject"
+ - $ref: '#/components/schemas/IncidentUserData'
+ - $ref: '#/components/schemas/IncidentTypeObject'
IncidentHandleIncludedResponse:
description: Included related resources
items:
- $ref: "#/components/schemas/IncidentHandleIncludedItemResponse"
+ $ref: '#/components/schemas/IncidentHandleIncludedItemResponse'
type: array
IncidentHandleRelationship:
description: A single relationship object for an incident handle, wrapping the related resource data.
properties:
data:
- $ref: "#/components/schemas/IncidentHandleRelationshipData"
+ $ref: '#/components/schemas/IncidentHandleRelationshipData'
required:
- data
type: object
@@ -49473,13 +49534,13 @@ components:
nullable: true
properties:
commander_user:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
created_by_user:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
incident_type:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
last_modified_by_user:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
required:
- incident_type
- created_by_user
@@ -49490,9 +49551,9 @@ components:
nullable: true
properties:
commander_user:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
incident_type:
- $ref: "#/components/schemas/IncidentHandleRelationship"
+ $ref: '#/components/schemas/IncidentHandleRelationship'
required:
- incident_type
type: object
@@ -49500,7 +49561,7 @@ components:
description: Request payload for creating or updating a global incident handle.
properties:
data:
- $ref: "#/components/schemas/IncidentHandleDataRequest"
+ $ref: '#/components/schemas/IncidentHandleDataRequest'
required:
- data
type: object
@@ -49508,9 +49569,9 @@ components:
description: Response payload for a single incident handle, including the handle data and related resources.
properties:
data:
- $ref: "#/components/schemas/IncidentHandleDataResponse"
+ $ref: '#/components/schemas/IncidentHandleDataResponse'
included:
- $ref: "#/components/schemas/IncidentHandleIncludedResponse"
+ $ref: '#/components/schemas/IncidentHandleIncludedResponse'
required:
- data
type: object
@@ -49533,14 +49594,14 @@ components:
id: "12ceee6d-a7c0-4407-bc54-30e54140d7f0"
type: incident_handles
included:
- $ref: "#/components/schemas/IncidentHandleIncludedResponse"
+ $ref: '#/components/schemas/IncidentHandleIncludedResponse'
required:
- data
type: object
IncidentHandlesResponseData:
description: Array of incident handle data objects returned in a list response.
items:
- $ref: "#/components/schemas/IncidentHandleDataResponse"
+ $ref: '#/components/schemas/IncidentHandleDataResponse'
type: array
IncidentImpactAttributes:
description: The incident impact's attributes.
@@ -49562,7 +49623,7 @@ components:
nullable: true
type: string
fields:
- $ref: "#/components/schemas/IncidentImpactFieldsObject"
+ $ref: '#/components/schemas/IncidentImpactFieldsObject'
impact_type:
description: The type of impact.
example: "customer"
@@ -49596,7 +49657,7 @@ components:
nullable: true
type: string
fields:
- $ref: "#/components/schemas/IncidentImpactFieldsObject"
+ $ref: '#/components/schemas/IncidentImpactFieldsObject'
start_at:
description: Timestamp when the impact started.
example: "2025-08-28T13:17:00Z"
@@ -49610,9 +49671,9 @@ components:
description: Incident impact data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImpactCreateAttributes"
+ $ref: '#/components/schemas/IncidentImpactCreateAttributes'
type:
- $ref: "#/components/schemas/IncidentImpactType"
+ $ref: '#/components/schemas/IncidentImpactType'
required:
- type
- attributes
@@ -49621,7 +49682,7 @@ components:
description: Create request for an incident impact.
properties:
data:
- $ref: "#/components/schemas/IncidentImpactCreateData"
+ $ref: '#/components/schemas/IncidentImpactCreateData'
required:
- data
type: object
@@ -49629,20 +49690,20 @@ components:
description: "Trigger a workflow when an impact is created for an incident."
properties:
executionLimit:
- $ref: "#/components/schemas/ExecutionLimit"
+ $ref: '#/components/schemas/ExecutionLimit'
incidentType:
description: "The type of incident that triggers the workflow."
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentImpactCreatedTriggerWrapper:
description: "Schema for an incident impact created trigger."
properties:
incidentImpactCreatedTrigger:
- $ref: "#/components/schemas/IncidentImpactCreatedTrigger"
+ $ref: '#/components/schemas/IncidentImpactCreatedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentImpactCreatedTrigger
type: object
@@ -49675,10 +49736,10 @@ components:
field_choices:
description: The choices for dropdown or multiselect fields.
items:
- $ref: "#/components/schemas/IncidentImpactFieldChoice"
+ $ref: '#/components/schemas/IncidentImpactFieldChoice'
type: array
field_type:
- $ref: "#/components/schemas/IncidentImpactFieldValueType"
+ $ref: '#/components/schemas/IncidentImpactFieldValueType'
name:
description: The normalized name of the impact field (used as identifier).
example: customer_impact_scope
@@ -49703,10 +49764,10 @@ components:
field_choices:
description: The choices for dropdown or multiselect fields.
items:
- $ref: "#/components/schemas/IncidentImpactFieldChoice"
+ $ref: '#/components/schemas/IncidentImpactFieldChoice'
type: array
field_type:
- $ref: "#/components/schemas/IncidentImpactFieldValueType"
+ $ref: '#/components/schemas/IncidentImpactFieldValueType'
name:
description: The normalized name of the impact field.
example: customer_impact_scope
@@ -49725,11 +49786,11 @@ components:
description: Impact field data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImpactFieldDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentImpactFieldDataAttributesRequest'
relationships:
- $ref: "#/components/schemas/IncidentImpactFieldRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentImpactFieldRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentImpactFieldType"
+ $ref: '#/components/schemas/IncidentImpactFieldType'
required:
- type
- attributes
@@ -49739,16 +49800,16 @@ components:
description: Impact field data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImpactFieldDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldDataAttributesResponse'
id:
description: The impact field identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentImpactFieldRelationships"
+ $ref: '#/components/schemas/IncidentImpactFieldRelationships'
type:
- $ref: "#/components/schemas/IncidentImpactFieldType"
+ $ref: '#/components/schemas/IncidentImpactFieldType'
required:
- id
- type
@@ -49758,17 +49819,17 @@ components:
description: Relationships for an impact field.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentImpactFieldRelationshipsRequest:
description: Relationships for an impact field create request.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
required:
- incident_type
type: object
@@ -49776,7 +49837,7 @@ components:
description: Request payload for creating an impact field.
properties:
data:
- $ref: "#/components/schemas/IncidentImpactFieldDataRequest"
+ $ref: '#/components/schemas/IncidentImpactFieldDataRequest'
required:
- data
type: object
@@ -49784,11 +49845,11 @@ components:
description: Response with a single impact field.
properties:
data:
- $ref: "#/components/schemas/IncidentImpactFieldDataResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49833,12 +49894,12 @@ components:
data:
description: List of impact fields.
items:
- $ref: "#/components/schemas/IncidentImpactFieldDataResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldDataResponse'
type: array
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49858,7 +49919,7 @@ components:
nullable: true
type: string
fields:
- $ref: "#/components/schemas/IncidentImpactFieldsObject"
+ $ref: '#/components/schemas/IncidentImpactFieldsObject'
start_at:
description: Timestamp when the impact started.
example: "2025-08-28T13:17:00Z"
@@ -49869,9 +49930,9 @@ components:
description: Incident impact data for a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImpactPatchAttributes"
+ $ref: '#/components/schemas/IncidentImpactPatchAttributes'
type:
- $ref: "#/components/schemas/IncidentImpactType"
+ $ref: '#/components/schemas/IncidentImpactType'
required:
- type
type: object
@@ -49879,7 +49940,7 @@ components:
description: Patch request for an incident impact.
properties:
data:
- $ref: "#/components/schemas/IncidentImpactPatchData"
+ $ref: '#/components/schemas/IncidentImpactPatchData'
required:
- data
type: object
@@ -49898,21 +49959,21 @@ components:
description: The incident impact's resource relationships.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident:
- $ref: "#/components/schemas/RelationshipToIncident"
+ $ref: '#/components/schemas/RelationshipToIncident'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentImpactResponse:
description: Response with an incident impact.
properties:
data:
- $ref: "#/components/schemas/IncidentImpactResponseData"
+ $ref: '#/components/schemas/IncidentImpactResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49922,15 +49983,15 @@ components:
description: Incident impact data from a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImpactAttributes"
+ $ref: '#/components/schemas/IncidentImpactAttributes'
id:
description: The incident impact's ID.
example: "00000000-0000-0000-1234-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentImpactRelationships"
+ $ref: '#/components/schemas/IncidentImpactRelationships'
type:
- $ref: "#/components/schemas/IncidentImpactType"
+ $ref: '#/components/schemas/IncidentImpactType'
required:
- id
- type
@@ -49948,20 +50009,20 @@ components:
description: "Trigger a workflow when an impact is updated for an incident."
properties:
executionLimit:
- $ref: "#/components/schemas/ExecutionLimit"
+ $ref: '#/components/schemas/ExecutionLimit'
incidentType:
description: "The type of incident that triggers the workflow."
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentImpactUpdatedTriggerWrapper:
description: "Schema for an incident impact updated trigger."
properties:
incidentImpactUpdatedTrigger:
- $ref: "#/components/schemas/IncidentImpactUpdatedTrigger"
+ $ref: '#/components/schemas/IncidentImpactUpdatedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentImpactUpdatedTrigger
type: object
@@ -49971,12 +50032,12 @@ components:
data:
description: An array of incident impacts.
items:
- $ref: "#/components/schemas/IncidentImpactResponseData"
+ $ref: '#/components/schemas/IncidentImpactResponseData'
type: array
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -49993,8 +50054,8 @@ components:
IncidentImportFieldAttributes:
description: Dynamic fields for which selections can be made, with field names as keys.
oneOf:
- - $ref: "#/components/schemas/IncidentImportFieldAttributesSingleValue"
- - $ref: "#/components/schemas/IncidentImportFieldAttributesMultipleValue"
+ - $ref: '#/components/schemas/IncidentImportFieldAttributesSingleValue'
+ - $ref: '#/components/schemas/IncidentImportFieldAttributesMultipleValue'
IncidentImportFieldAttributesMultipleValue:
additionalProperties: false
description: A field with potentially multiple values selected.
@@ -50038,15 +50099,15 @@ components:
description: The relationships for an incident import request.
properties:
commander_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
declared_by_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
type: object
IncidentImportRequest:
description: Import request for an incident. Used to import historical incidents from external systems.
properties:
data:
- $ref: "#/components/schemas/IncidentImportRequestData"
+ $ref: '#/components/schemas/IncidentImportRequestData'
required:
- data
type: object
@@ -50065,7 +50126,7 @@ components:
type: string
fields:
additionalProperties:
- $ref: "#/components/schemas/IncidentImportFieldAttributes"
+ $ref: '#/components/schemas/IncidentImportFieldAttributes'
description: A condensed view of the user-defined fields for which to create initial selections.
example: {"severity": {"value": "SEV-5"}, "state": {"value": "active"}}
type: object
@@ -50084,7 +50145,7 @@ components:
maxLength: 1024
type: string
visibility:
- $ref: "#/components/schemas/IncidentImportVisibility"
+ $ref: '#/components/schemas/IncidentImportVisibility'
required:
- title
type: object
@@ -50092,11 +50153,11 @@ components:
description: Incident data for an import request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImportRequestAttributes"
+ $ref: '#/components/schemas/IncidentImportRequestAttributes'
relationships:
- $ref: "#/components/schemas/IncidentImportRelationships"
+ $ref: '#/components/schemas/IncidentImportRelationships'
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- type
- attributes
@@ -50105,11 +50166,11 @@ components:
description: Response with an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentImportResponseData"
+ $ref: '#/components/schemas/IncidentImportResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentImportResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentImportResponseIncludedItem'
readOnly: true
type: array
required:
@@ -50176,7 +50237,7 @@ components:
type: string
fields:
additionalProperties:
- $ref: "#/components/schemas/IncidentFieldAttributes"
+ $ref: '#/components/schemas/IncidentFieldAttributes'
description: A condensed view of the user-defined fields attached to incidents.
example: {"severity": {"type": "dropdown", "value": "SEV-5"}}
type: object
@@ -50198,11 +50259,11 @@ components:
readOnly: true
type: string
non_datadog_creator:
- $ref: "#/components/schemas/IncidentNonDatadogCreator"
+ $ref: '#/components/schemas/IncidentNonDatadogCreator'
notification_handles:
description: Notification handles that are notified of the incident during update.
items:
- $ref: "#/components/schemas/IncidentNotificationHandle"
+ $ref: '#/components/schemas/IncidentNotificationHandle'
nullable: true
type: array
public_id:
@@ -50216,7 +50277,7 @@ components:
nullable: true
type: string
severity:
- $ref: "#/components/schemas/IncidentSeverity"
+ $ref: '#/components/schemas/IncidentSeverity'
state:
description: The state of the incident.
nullable: true
@@ -50236,15 +50297,15 @@ components:
description: Incident data from an import response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentImportResponseAttributes"
+ $ref: '#/components/schemas/IncidentImportResponseAttributes'
id:
description: The incident's ID.
example: "00000000-0000-0000-1234-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentImportResponseRelationships"
+ $ref: '#/components/schemas/IncidentImportResponseRelationships'
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- id
- type
@@ -50252,31 +50313,31 @@ components:
IncidentImportResponseIncludedItem:
description: An object related to an incident that is included in the response.
oneOf:
- - $ref: "#/components/schemas/IncidentUserData"
- - $ref: "#/components/schemas/IncidentTypeObject"
+ - $ref: '#/components/schemas/IncidentUserData'
+ - $ref: '#/components/schemas/IncidentTypeObject'
IncidentImportResponseRelationships:
description: The incident's relationships from an import response.
properties:
attachments:
- $ref: "#/components/schemas/RelationshipToIncidentAttachment"
+ $ref: '#/components/schemas/RelationshipToIncidentAttachment'
commander_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
declared_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
impacts:
- $ref: "#/components/schemas/RelationshipToIncidentImpacts"
+ $ref: '#/components/schemas/RelationshipToIncidentImpacts'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
integrations:
- $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas"
+ $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
responders:
- $ref: "#/components/schemas/RelationshipToIncidentResponders"
+ $ref: '#/components/schemas/RelationshipToIncidentResponders'
user_defined_fields:
- $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFields"
+ $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
type: object
IncidentImportVisibility:
default: organization
@@ -50311,7 +50372,7 @@ components:
maximum: 100
type: integer
metadata:
- $ref: "#/components/schemas/IncidentIntegrationMetadataMetadata"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataMetadata'
modified:
description: Timestamp when the incident todo was last modified.
format: date-time
@@ -50333,9 +50394,9 @@ components:
description: Incident integration metadata data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes'
type:
- $ref: "#/components/schemas/IncidentIntegrationMetadataType"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataType'
required:
- type
- attributes
@@ -50344,7 +50405,7 @@ components:
description: Create request for an incident integration metadata.
properties:
data:
- $ref: "#/components/schemas/IncidentIntegrationMetadataCreateData"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataCreateData'
required:
- data
type: object
@@ -50354,32 +50415,32 @@ components:
data:
description: An array of incident integration metadata.
items:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponseData"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponseData'
type: array
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem'
readOnly: true
type: array
meta:
- $ref: "#/components/schemas/IncidentResponseMeta"
+ $ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
IncidentIntegrationMetadataMetadata:
description: Incident integration metadata's metadata attribute.
oneOf:
- - $ref: "#/components/schemas/SlackIntegrationMetadata"
- - $ref: "#/components/schemas/JiraIntegrationMetadata"
- - $ref: "#/components/schemas/MSTeamsIntegrationMetadata"
+ - $ref: '#/components/schemas/SlackIntegrationMetadata'
+ - $ref: '#/components/schemas/JiraIntegrationMetadata'
+ - $ref: '#/components/schemas/MSTeamsIntegrationMetadata'
IncidentIntegrationMetadataPatchData:
description: Incident integration metadata data for a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes'
type:
- $ref: "#/components/schemas/IncidentIntegrationMetadataType"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataType'
required:
- type
- attributes
@@ -50388,7 +50449,7 @@ components:
description: Patch request for an incident integration metadata.
properties:
data:
- $ref: "#/components/schemas/IncidentIntegrationMetadataPatchData"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataPatchData'
required:
- data
type: object
@@ -50396,11 +50457,11 @@ components:
description: Response with an incident integration metadata.
properties:
data:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponseData"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponseIncludedItem'
readOnly: true
type: array
required:
@@ -50410,15 +50471,15 @@ components:
description: Incident integration metadata from a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentIntegrationMetadataAttributes"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataAttributes'
id:
description: The incident integration metadata's ID.
example: "00000000-0000-0000-1234-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentIntegrationRelationships"
+ $ref: '#/components/schemas/IncidentIntegrationRelationships'
type:
- $ref: "#/components/schemas/IncidentIntegrationMetadataType"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataType'
required:
- id
- type
@@ -50426,7 +50487,7 @@ components:
IncidentIntegrationMetadataResponseIncludedItem:
description: An object related to an incident integration metadata that is included in the response.
oneOf:
- - $ref: "#/components/schemas/User"
+ - $ref: '#/components/schemas/User'
IncidentIntegrationMetadataType:
default: incident_integrations
description: Integration metadata resource type.
@@ -50440,9 +50501,9 @@ components:
description: The incident's integration relationships from a response.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentNonDatadogCreator:
description: Incident's non Datadog creator.
@@ -50471,11 +50532,11 @@ components:
description: Response with a notification rule.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationRuleResponseData"
+ $ref: '#/components/schemas/IncidentNotificationRuleResponseData'
included:
description: Related objects that are included in the response.
items:
- $ref: "#/components/schemas/IncidentNotificationRuleIncludedItems"
+ $ref: '#/components/schemas/IncidentNotificationRuleIncludedItems'
type: array
required:
- data
@@ -50486,15 +50547,15 @@ components:
data:
description: The `NotificationRuleArray` `data`.
items:
- $ref: "#/components/schemas/IncidentNotificationRuleResponseData"
+ $ref: '#/components/schemas/IncidentNotificationRuleResponseData'
type: array
included:
description: Related objects that are included in the response.
items:
- $ref: "#/components/schemas/IncidentNotificationRuleIncludedItems"
+ $ref: '#/components/schemas/IncidentNotificationRuleIncludedItems'
type: array
meta:
- $ref: "#/components/schemas/IncidentNotificationRuleArrayMeta"
+ $ref: '#/components/schemas/IncidentNotificationRuleArrayMeta'
required:
- data
type: object
@@ -50502,7 +50563,7 @@ components:
description: Response metadata.
properties:
pagination:
- $ref: "#/components/schemas/IncidentNotificationRuleArrayMetaPage"
+ $ref: '#/components/schemas/IncidentNotificationRuleArrayMetaPage'
type: object
IncidentNotificationRuleArrayMetaPage:
description: Pagination metadata.
@@ -50527,7 +50588,7 @@ components:
description: The notification rule's attributes.
properties:
conditions:
- $ref: "#/components/schemas/IncidentNotificationRuleConditions"
+ $ref: '#/components/schemas/IncidentNotificationRuleConditions'
created:
description: Timestamp when the notification rule was created.
example: "2025-01-15T10:30:00Z"
@@ -50539,7 +50600,7 @@ components:
example: true
type: boolean
handles:
- $ref: "#/components/schemas/IncidentNotificationRuleHandles"
+ $ref: '#/components/schemas/IncidentNotificationRuleHandles'
modified:
description: Timestamp when the notification rule was last modified.
example: "2025-01-15T14:45:00Z"
@@ -50547,13 +50608,13 @@ components:
readOnly: true
type: string
renotify_on:
- $ref: "#/components/schemas/IncidentNotificationRuleRenotifyOn"
+ $ref: '#/components/schemas/IncidentNotificationRuleRenotifyOn'
trigger:
description: The trigger event for this notification rule.
example: "incident_created_trigger"
type: string
visibility:
- $ref: "#/components/schemas/IncidentNotificationRuleAttributesVisibility"
+ $ref: '#/components/schemas/IncidentNotificationRuleAttributesVisibility'
required:
- conditions
- handles
@@ -50576,7 +50637,7 @@ components:
description: The conditions that trigger this notification rule.
example: [{"field": "severity", "values": ["SEV-1", "SEV-2"]}]
items:
- $ref: "#/components/schemas/IncidentNotificationRuleConditionsItems"
+ $ref: '#/components/schemas/IncidentNotificationRuleConditionsItems'
type: array
IncidentNotificationRuleConditionsItems:
description: A condition that must be met to trigger the notification rule.
@@ -50600,22 +50661,22 @@ components:
description: The attributes for creating a notification rule.
properties:
conditions:
- $ref: "#/components/schemas/IncidentNotificationRuleConditions"
+ $ref: '#/components/schemas/IncidentNotificationRuleConditions'
enabled:
default: false
description: Whether the notification rule is enabled.
example: true
type: boolean
handles:
- $ref: "#/components/schemas/IncidentNotificationRuleHandles"
+ $ref: '#/components/schemas/IncidentNotificationRuleHandles'
renotify_on:
- $ref: "#/components/schemas/IncidentNotificationRuleRenotifyOn"
+ $ref: '#/components/schemas/IncidentNotificationRuleRenotifyOn'
trigger:
description: The trigger event for this notification rule.
example: "incident_created_trigger"
type: string
visibility:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributesVisibility"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributesVisibility'
required:
- conditions
- handles
@@ -50634,11 +50695,11 @@ components:
description: Notification rule data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributes'
relationships:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateDataRelationships"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateDataRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationRuleType"
+ $ref: '#/components/schemas/IncidentNotificationRuleType'
required:
- type
- attributes
@@ -50647,9 +50708,9 @@ components:
description: The definition of `NotificationRuleCreateDataRelationships` object.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
notification_template:
- $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplate"
+ $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplate'
type: object
IncidentNotificationRuleHandles:
description: The notification handles (targets) for this rule.
@@ -50661,20 +50722,20 @@ components:
IncidentNotificationRuleIncludedItems:
description: Objects related to a notification rule.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/IncidentTypeObject"
- - $ref: "#/components/schemas/IncidentNotificationTemplateObject"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/IncidentTypeObject'
+ - $ref: '#/components/schemas/IncidentNotificationTemplateObject'
IncidentNotificationRuleRelationships:
description: The notification rule's resource relationships.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
notification_template:
- $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplate"
+ $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplate'
type: object
IncidentNotificationRuleRenotifyOn:
description: List of incident fields that trigger re-notification when changed.
@@ -50687,16 +50748,16 @@ components:
description: Notification rule data from a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationRuleAttributes"
+ $ref: '#/components/schemas/IncidentNotificationRuleAttributes'
id:
description: The unique identifier of the notification rule.
example: "00000000-0000-0000-0000-000000000001"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentNotificationRuleRelationships"
+ $ref: '#/components/schemas/IncidentNotificationRuleRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationRuleType"
+ $ref: '#/components/schemas/IncidentNotificationRuleType'
required:
- id
- type
@@ -50713,16 +50774,16 @@ components:
description: Notification rule data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateAttributes'
id:
description: The unique identifier of the notification rule.
example: "00000000-0000-0000-0000-000000000001"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentNotificationRuleCreateDataRelationships"
+ $ref: '#/components/schemas/IncidentNotificationRuleCreateDataRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationRuleType"
+ $ref: '#/components/schemas/IncidentNotificationRuleType'
required:
- id
- type
@@ -50732,11 +50793,11 @@ components:
description: Response with a notification template.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationTemplateResponseData"
+ $ref: '#/components/schemas/IncidentNotificationTemplateResponseData'
included:
description: Related objects that are included in the response.
items:
- $ref: "#/components/schemas/IncidentNotificationTemplateIncludedItems"
+ $ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems'
type: array
required:
- data
@@ -50747,15 +50808,15 @@ components:
data:
description: The `NotificationTemplateArray` `data`.
items:
- $ref: "#/components/schemas/IncidentNotificationTemplateResponseData"
+ $ref: '#/components/schemas/IncidentNotificationTemplateResponseData'
type: array
included:
description: Related objects that are included in the response.
items:
- $ref: "#/components/schemas/IncidentNotificationTemplateIncludedItems"
+ $ref: '#/components/schemas/IncidentNotificationTemplateIncludedItems'
type: array
meta:
- $ref: "#/components/schemas/IncidentNotificationTemplateArrayMeta"
+ $ref: '#/components/schemas/IncidentNotificationTemplateArrayMeta'
required:
- data
type: object
@@ -50763,7 +50824,7 @@ components:
description: Response metadata.
properties:
page:
- $ref: "#/components/schemas/IncidentNotificationTemplateArrayMetaPage"
+ $ref: '#/components/schemas/IncidentNotificationTemplateArrayMetaPage'
type: object
IncidentNotificationTemplateArrayMetaPage:
description: Pagination metadata.
@@ -50847,11 +50908,11 @@ components:
description: Notification template data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationTemplateCreateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationTemplateCreateAttributes'
relationships:
- $ref: "#/components/schemas/IncidentNotificationTemplateCreateDataRelationships"
+ $ref: '#/components/schemas/IncidentNotificationTemplateCreateDataRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationTemplateType"
+ $ref: '#/components/schemas/IncidentNotificationTemplateType'
required:
- type
- attributes
@@ -50860,27 +50921,27 @@ components:
description: The definition of `NotificationTemplateCreateDataRelationships` object.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
type: object
IncidentNotificationTemplateIncludedItems:
description: Objects related to a notification template.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/IncidentTypeObject"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/IncidentTypeObject'
IncidentNotificationTemplateObject:
description: A notification template object for inclusion in other resources.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationTemplateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationTemplateAttributes'
id:
description: The unique identifier of the notification template.
example: "00000000-0000-0000-0000-000000000001"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentNotificationTemplateRelationships"
+ $ref: '#/components/schemas/IncidentNotificationTemplateRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationTemplateType"
+ $ref: '#/components/schemas/IncidentNotificationTemplateType'
required:
- id
- type
@@ -50889,26 +50950,26 @@ components:
description: The notification template's resource relationships.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentNotificationTemplateResponseData:
description: Notification template data from a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationTemplateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationTemplateAttributes'
id:
description: The unique identifier of the notification template.
example: "00000000-0000-0000-0000-000000000001"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentNotificationTemplateRelationships"
+ $ref: '#/components/schemas/IncidentNotificationTemplateRelationships'
type:
- $ref: "#/components/schemas/IncidentNotificationTemplateType"
+ $ref: '#/components/schemas/IncidentNotificationTemplateType'
required:
- id
- type
@@ -50945,14 +51006,14 @@ components:
description: Notification template data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentNotificationTemplateUpdateAttributes"
+ $ref: '#/components/schemas/IncidentNotificationTemplateUpdateAttributes'
id:
description: The unique identifier of the notification template.
example: "00000000-0000-0000-0000-000000000001"
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentNotificationTemplateType"
+ $ref: '#/components/schemas/IncidentNotificationTemplateType'
required:
- id
- type
@@ -50965,7 +51026,7 @@ components:
example: PAGE-12345
type: string
page_target:
- $ref: "#/components/schemas/IncidentOnCallPageTarget"
+ $ref: '#/components/schemas/IncidentOnCallPageTarget'
team_id:
description: The team ID associated with the page (deprecated, use page_target instead).
example: team-abc-123
@@ -50975,13 +51036,13 @@ components:
description: On-call page data in a link request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentOnCallPageDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentOnCallPageDataAttributesRequest'
id:
description: The ID of the on-call page to link.
example: PAGE-12345
type: string
type:
- $ref: "#/components/schemas/IncidentOnCallPageType"
+ $ref: '#/components/schemas/IncidentOnCallPageType'
required:
- id
- type
@@ -50990,7 +51051,7 @@ components:
description: Request payload for linking an on-call page to an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentOnCallPageDataRequest"
+ $ref: '#/components/schemas/IncidentOnCallPageDataRequest'
required:
- data
type: object
@@ -51031,7 +51092,7 @@ components:
format: date-time
type: string
settings:
- $ref: "#/components/schemas/IncidentOrgSettingsMeta"
+ $ref: '#/components/schemas/IncidentOrgSettingsMeta'
required:
- created
- modified
@@ -51041,16 +51102,16 @@ components:
description: Incident org settings data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentOrgSettingsDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentOrgSettingsDataAttributesResponse'
id:
description: The org settings identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentOrgSettingsRelationships"
+ $ref: '#/components/schemas/IncidentOrgSettingsRelationships'
type:
- $ref: "#/components/schemas/IncidentOrgSettingsType"
+ $ref: '#/components/schemas/IncidentOrgSettingsType'
required:
- id
- type
@@ -51062,7 +51123,7 @@ components:
data:
description: List of incident org settings resources.
items:
- $ref: "#/components/schemas/IncidentOrgSettingsDataResponse"
+ $ref: '#/components/schemas/IncidentOrgSettingsDataResponse'
type: array
required:
- data
@@ -51080,13 +51141,13 @@ components:
description: Relationships for an incident org settings resource.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
type: object
IncidentOrgSettingsResponse:
description: Response with a single incident org settings resource.
properties:
data:
- $ref: "#/components/schemas/IncidentOrgSettingsDataResponse"
+ $ref: '#/components/schemas/IncidentOrgSettingsDataResponse'
required:
- data
type: object
@@ -51107,7 +51168,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentPageRoleType"
+ $ref: '#/components/schemas/IncidentPageRoleType'
required:
- type
- id
@@ -51130,7 +51191,7 @@ components:
example: my-team-handle
type: string
type:
- $ref: "#/components/schemas/IncidentPageTargetType"
+ $ref: '#/components/schemas/IncidentPageTargetType'
required:
- type
- identifier
@@ -51156,7 +51217,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentPageUUIDType"
+ $ref: '#/components/schemas/IncidentPageUUIDType'
required:
- id
- type
@@ -51165,7 +51226,7 @@ components:
description: Response with a page UUID.
properties:
data:
- $ref: "#/components/schemas/IncidentPageUUIDDataResponse"
+ $ref: '#/components/schemas/IncidentPageUUIDDataResponse'
required:
- data
type: object
@@ -51190,20 +51251,20 @@ components:
description: "Trigger a workflow when a postmortem is updated for an incident."
properties:
executionLimit:
- $ref: "#/components/schemas/ExecutionLimit"
+ $ref: '#/components/schemas/ExecutionLimit'
incidentType:
description: "The type of incident that triggers the workflow."
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentPostmortemUpdatedTriggerWrapper:
description: "Schema for an incident postmortem updated trigger."
properties:
incidentPostmortemUpdatedTrigger:
- $ref: "#/components/schemas/IncidentPostmortemUpdatedTrigger"
+ $ref: '#/components/schemas/IncidentPostmortemUpdatedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentPostmortemUpdatedTrigger
type: object
@@ -51224,7 +51285,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentResourceType"
+ $ref: '#/components/schemas/IncidentResourceType'
required:
- type
- id
@@ -51241,20 +51302,20 @@ components:
description: "Trigger a workflow when a responder is created for an incident."
properties:
executionLimit:
- $ref: "#/components/schemas/ExecutionLimit"
+ $ref: '#/components/schemas/ExecutionLimit'
incidentType:
description: "The type of incident that triggers the workflow."
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentResponderCreatedTriggerWrapper:
description: "Schema for an incident responder created trigger."
properties:
incidentResponderCreatedTrigger:
- $ref: "#/components/schemas/IncidentResponderCreatedTrigger"
+ $ref: '#/components/schemas/IncidentResponderCreatedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentResponderCreatedTrigger
type: object
@@ -51305,9 +51366,9 @@ components:
description: Incident responder data in a create request.
properties:
relationships:
- $ref: "#/components/schemas/IncidentResponderRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentResponderRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentResponderType"
+ $ref: '#/components/schemas/IncidentResponderType'
required:
- type
- relationships
@@ -51316,16 +51377,16 @@ components:
description: Incident responder data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentResponderDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentResponderDataAttributesResponse'
id:
description: The responder identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentResponderRelationships"
+ $ref: '#/components/schemas/IncidentResponderRelationships'
type:
- $ref: "#/components/schemas/IncidentResponderType"
+ $ref: '#/components/schemas/IncidentResponderType'
required:
- id
- type
@@ -51335,19 +51396,19 @@ components:
description: Relationships for an incident responder.
properties:
created_by:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
last_modified_by:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
role_assignments:
- $ref: "#/components/schemas/IncidentResponderRoleAssignmentsRelationship"
+ $ref: '#/components/schemas/IncidentResponderRoleAssignmentsRelationship'
user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
type: object
IncidentResponderRelationshipsRequest:
description: Relationships for creating an incident responder.
properties:
user:
- $ref: "#/components/schemas/IncidentResponderUserRelationship"
+ $ref: '#/components/schemas/IncidentResponderUserRelationship'
required:
- user
type: object
@@ -51355,7 +51416,7 @@ components:
description: Request payload for creating an incident responder.
properties:
data:
- $ref: "#/components/schemas/IncidentResponderDataRequest"
+ $ref: '#/components/schemas/IncidentResponderDataRequest'
required:
- data
type: object
@@ -51363,11 +51424,11 @@ components:
description: Response with a single incident responder.
properties:
data:
- $ref: "#/components/schemas/IncidentResponderDataResponse"
+ $ref: '#/components/schemas/IncidentResponderDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -51395,7 +51456,7 @@ components:
data:
description: List of role assignment relationship data.
items:
- $ref: "#/components/schemas/IncidentResponderRoleAssignmentRelationshipData"
+ $ref: '#/components/schemas/IncidentResponderRoleAssignmentRelationshipData'
type: array
type: object
IncidentResponderType:
@@ -51410,7 +51471,7 @@ components:
description: Relationship to a user for a responder create request.
properties:
data:
- $ref: "#/components/schemas/IncidentResponderUserRelationshipData"
+ $ref: '#/components/schemas/IncidentResponderUserRelationshipData'
required:
- data
type: object
@@ -51436,12 +51497,12 @@ components:
data:
description: List of incident responders.
items:
- $ref: "#/components/schemas/IncidentResponderDataResponse"
+ $ref: '#/components/schemas/IncidentResponderDataResponse'
type: array
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -51459,11 +51520,11 @@ components:
description: Response with an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentResponseData"
+ $ref: '#/components/schemas/IncidentResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentResponseIncludedItem'
readOnly: true
type: array
required:
@@ -51521,7 +51582,7 @@ components:
readOnly: true
type: string
declared_by:
- $ref: "#/components/schemas/IncidentNonDatadogCreator"
+ $ref: '#/components/schemas/IncidentNonDatadogCreator'
declared_by_uuid:
description: UUID of the user who declared the incident.
nullable: true
@@ -51533,7 +51594,7 @@ components:
type: string
fields:
additionalProperties:
- $ref: "#/components/schemas/IncidentFieldAttributes"
+ $ref: '#/components/schemas/IncidentFieldAttributes'
description: A condensed view of the user-defined fields attached to incidents.
example: {"severity": {"type": "dropdown", "value": "SEV-5"}}
type: object
@@ -51551,12 +51612,12 @@ components:
readOnly: true
type: string
non_datadog_creator:
- $ref: "#/components/schemas/IncidentNonDatadogCreator"
+ $ref: '#/components/schemas/IncidentNonDatadogCreator'
notification_handles:
description: Notification handles that will be notified of the incident during update.
example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}]
items:
- $ref: "#/components/schemas/IncidentNotificationHandle"
+ $ref: '#/components/schemas/IncidentNotificationHandle'
nullable: true
type: array
public_id:
@@ -51571,7 +51632,7 @@ components:
nullable: true
type: string
severity:
- $ref: "#/components/schemas/IncidentSeverity"
+ $ref: '#/components/schemas/IncidentSeverity'
state:
description: The state incident.
nullable: true
@@ -51616,15 +51677,15 @@ components:
description: Incident data from a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentResponseAttributes"
+ $ref: '#/components/schemas/IncidentResponseAttributes'
id:
description: The incident's ID.
example: "00000000-0000-0000-1234-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentResponseRelationships"
+ $ref: '#/components/schemas/IncidentResponseRelationships'
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- id
- type
@@ -51632,13 +51693,13 @@ components:
IncidentResponseIncludedItem:
description: An object related to an incident that is included in the response.
oneOf:
- - $ref: "#/components/schemas/IncidentUserData"
- - $ref: "#/components/schemas/AttachmentData"
+ - $ref: '#/components/schemas/IncidentUserData'
+ - $ref: '#/components/schemas/AttachmentData'
IncidentResponseMeta:
description: The metadata object containing pagination metadata.
properties:
pagination:
- $ref: "#/components/schemas/IncidentResponseMetaPagination"
+ $ref: '#/components/schemas/IncidentResponseMetaPagination'
readOnly: true
type: object
IncidentResponseMetaPagination:
@@ -51664,23 +51725,23 @@ components:
description: The incident's relationships from a response.
properties:
attachments:
- $ref: "#/components/schemas/RelationshipToIncidentAttachment"
+ $ref: '#/components/schemas/RelationshipToIncidentAttachment'
commander_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
declared_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
impacts:
- $ref: "#/components/schemas/RelationshipToIncidentImpacts"
+ $ref: '#/components/schemas/RelationshipToIncidentImpacts'
integrations:
- $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas"
+ $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
responders:
- $ref: "#/components/schemas/RelationshipToIncidentResponders"
+ $ref: '#/components/schemas/RelationshipToIncidentResponders'
user_defined_fields:
- $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFields"
+ $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFields'
type: object
IncidentRuleCondition:
description: A condition for an incident rule.
@@ -51705,7 +51766,7 @@ components:
description: Attributes for creating an incident rule.
properties:
condition:
- $ref: "#/components/schemas/IncidentRuleQueryCondition"
+ $ref: '#/components/schemas/IncidentRuleQueryCondition'
condition_table_type:
description: "The condition table type. 1 = raw query."
example: 1
@@ -51714,14 +51775,14 @@ components:
conditions:
description: List of field-based conditions.
items:
- $ref: "#/components/schemas/IncidentRuleCondition"
+ $ref: '#/components/schemas/IncidentRuleCondition'
type: array
enabled:
description: Whether the rule is enabled.
example: true
type: boolean
execution_type:
- $ref: "#/components/schemas/IncidentRuleExecutionType"
+ $ref: '#/components/schemas/IncidentRuleExecutionType'
incident_type_uuid:
description: The UUID of the incident type this rule applies to.
example: 00000000-0000-0000-0000-000000000000
@@ -51733,13 +51794,13 @@ components:
example: false
type: boolean
task_id:
- $ref: "#/components/schemas/IncidentRuleTaskIDType"
+ $ref: '#/components/schemas/IncidentRuleTaskIDType'
task_payload:
description: The JSON-encoded payload for the task.
example: "{}"
type: string
trigger:
- $ref: "#/components/schemas/IncidentRuleTriggerType"
+ $ref: '#/components/schemas/IncidentRuleTriggerType'
required:
- execution_type
- condition_table_type
@@ -51752,7 +51813,7 @@ components:
description: Attributes of an incident rule in a response.
properties:
condition:
- $ref: "#/components/schemas/IncidentRuleQueryCondition"
+ $ref: '#/components/schemas/IncidentRuleQueryCondition'
condition_table_type:
description: The condition table type.
example: 1
@@ -51761,7 +51822,7 @@ components:
conditions:
description: List of field-based conditions.
items:
- $ref: "#/components/schemas/IncidentRuleCondition"
+ $ref: '#/components/schemas/IncidentRuleCondition'
type: array
created:
description: Timestamp when the rule was created.
@@ -51832,9 +51893,9 @@ components:
description: Incident rule data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentRuleDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentRuleDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentRuleType"
+ $ref: '#/components/schemas/IncidentRuleType'
required:
- type
- attributes
@@ -51843,14 +51904,14 @@ components:
description: Incident rule data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentRuleDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentRuleDataAttributesResponse'
id:
description: The rule identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentRuleResponseType"
+ $ref: '#/components/schemas/IncidentRuleResponseType'
required:
- id
- type
@@ -51871,11 +51932,11 @@ components:
description: Attributes for patching an incident rule. All fields are optional.
properties:
condition:
- $ref: "#/components/schemas/IncidentRuleQueryCondition"
+ $ref: '#/components/schemas/IncidentRuleQueryCondition'
conditions:
description: List of field-based conditions.
items:
- $ref: "#/components/schemas/IncidentRuleCondition"
+ $ref: '#/components/schemas/IncidentRuleCondition'
type: array
enabled:
description: Whether the rule is enabled.
@@ -51886,20 +51947,20 @@ components:
example: "{}"
type: string
trigger:
- $ref: "#/components/schemas/IncidentRuleTriggerType"
+ $ref: '#/components/schemas/IncidentRuleTriggerType'
type: object
IncidentRulePatchDataRequest:
description: Incident rule data in a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentRulePatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentRulePatchDataAttributesRequest'
id:
description: The rule identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentRuleType"
+ $ref: '#/components/schemas/IncidentRuleType'
required:
- id
- type
@@ -51908,7 +51969,7 @@ components:
description: Request payload for patching an incident rule.
properties:
data:
- $ref: "#/components/schemas/IncidentRulePatchDataRequest"
+ $ref: '#/components/schemas/IncidentRulePatchDataRequest'
required:
- data
type: object
@@ -51930,7 +51991,7 @@ components:
description: Request payload for creating an incident rule.
properties:
data:
- $ref: "#/components/schemas/IncidentRuleDataRequest"
+ $ref: '#/components/schemas/IncidentRuleDataRequest'
required:
- data
type: object
@@ -51938,7 +51999,7 @@ components:
description: Response with a single incident rule.
properties:
data:
- $ref: "#/components/schemas/IncidentRuleDataResponse"
+ $ref: '#/components/schemas/IncidentRuleDataResponse'
required:
- data
type: object
@@ -52006,7 +52067,7 @@ components:
data:
description: List of incident rules.
items:
- $ref: "#/components/schemas/IncidentRuleDataResponse"
+ $ref: '#/components/schemas/IncidentRuleDataResponse'
type: array
required:
- data
@@ -52015,22 +52076,22 @@ components:
description: "Trigger a workflow when an incident is declared or updated."
properties:
executionLimit:
- $ref: "#/components/schemas/ExecutionLimit"
+ $ref: '#/components/schemas/ExecutionLimit'
incidentType:
description: "The type of incident that triggers the workflow."
type: string
serialExecution:
- $ref: "#/components/schemas/SerialExecution"
+ $ref: '#/components/schemas/SerialExecution'
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
type: object
IncidentSavedTriggerWrapper:
description: "Schema for an incident declared or updated trigger."
properties:
incidentSavedTrigger:
- $ref: "#/components/schemas/IncidentSavedTrigger"
+ $ref: '#/components/schemas/IncidentSavedTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentSavedTrigger
type: object
@@ -52046,7 +52107,7 @@ components:
minLength: 1
type: string
tagCondition:
- $ref: "#/components/schemas/IncidentCondition"
+ $ref: '#/components/schemas/IncidentCondition'
required:
- rrule
type: object
@@ -52054,9 +52115,9 @@ components:
description: "Schema for an incident schedule trigger."
properties:
incidentScheduleTrigger:
- $ref: "#/components/schemas/IncidentScheduleTrigger"
+ $ref: '#/components/schemas/IncidentScheduleTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentScheduleTrigger
type: object
@@ -52064,15 +52125,15 @@ components:
description: Response with incidents and facets.
properties:
data:
- $ref: "#/components/schemas/IncidentSearchResponseData"
+ $ref: '#/components/schemas/IncidentSearchResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentResponseIncludedItem'
readOnly: true
type: array
meta:
- $ref: "#/components/schemas/IncidentSearchResponseMeta"
+ $ref: '#/components/schemas/IncidentSearchResponseMeta'
required:
- data
type: object
@@ -52080,11 +52141,11 @@ components:
description: Attributes returned by an incident search.
properties:
facets:
- $ref: "#/components/schemas/IncidentSearchResponseFacetsData"
+ $ref: '#/components/schemas/IncidentSearchResponseFacetsData'
incidents:
description: Incidents returned by the search.
items:
- $ref: "#/components/schemas/IncidentSearchResponseIncidentsData"
+ $ref: '#/components/schemas/IncidentSearchResponseIncidentsData'
type: array
total:
description: Number of incidents returned by the search.
@@ -52101,9 +52162,9 @@ components:
description: Data returned by an incident search.
properties:
attributes:
- $ref: "#/components/schemas/IncidentSearchResponseAttributes"
+ $ref: '#/components/schemas/IncidentSearchResponseAttributes'
type:
- $ref: "#/components/schemas/IncidentSearchResultsType"
+ $ref: '#/components/schemas/IncidentSearchResultsType'
type: object
IncidentSearchResponseFacetCount:
description: Count of the facet value appearing in search results.
@@ -52117,64 +52178,64 @@ components:
commander:
description: Facet data for incident commander users.
items:
- $ref: "#/components/schemas/IncidentSearchResponseUserFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
type: array
created_by:
description: Facet data for incident creator users.
items:
- $ref: "#/components/schemas/IncidentSearchResponseUserFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
type: array
fields:
description: Facet data for incident property fields.
items:
- $ref: "#/components/schemas/IncidentSearchResponsePropertyFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponsePropertyFieldFacetData'
type: array
impact:
description: Facet data for incident impact attributes.
items:
- $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
type: array
last_modified_by:
description: Facet data for incident last modified by users.
items:
- $ref: "#/components/schemas/IncidentSearchResponseUserFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
type: array
postmortem:
description: Facet data for incident postmortem existence.
items:
- $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
type: array
responder:
description: Facet data for incident responder users.
items:
- $ref: "#/components/schemas/IncidentSearchResponseUserFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
type: array
severity:
description: Facet data for incident severity attributes.
items:
- $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
type: array
state:
description: Facet data for incident state attributes.
items:
- $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
type: array
time_to_repair:
description: Facet data for incident time to repair metrics.
items:
- $ref: "#/components/schemas/IncidentSearchResponseNumericFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData'
type: array
time_to_resolve:
description: Facet data for incident time to resolve metrics.
items:
- $ref: "#/components/schemas/IncidentSearchResponseNumericFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData'
type: array
type: object
IncidentSearchResponseFieldFacetData:
description: Facet value and number of occurrences for a property field of an incident.
properties:
count:
- $ref: "#/components/schemas/IncidentSearchResponseFacetCount"
+ $ref: '#/components/schemas/IncidentSearchResponseFacetCount'
name:
description: The facet value appearing in search results.
example: SEV-2
@@ -52184,7 +52245,7 @@ components:
description: Incident returned by the search.
properties:
data:
- $ref: "#/components/schemas/IncidentResponseData"
+ $ref: '#/components/schemas/IncidentResponseData'
required:
- data
type: object
@@ -52192,14 +52253,14 @@ components:
description: The metadata object containing pagination metadata.
properties:
pagination:
- $ref: "#/components/schemas/IncidentResponseMetaPagination"
+ $ref: '#/components/schemas/IncidentResponseMetaPagination'
readOnly: true
type: object
IncidentSearchResponseNumericFacetData:
description: Facet data numeric attributes of an incident.
properties:
aggregates:
- $ref: "#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates"
+ $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates'
name:
description: Name of the incident property field.
example: time_to_repair
@@ -52228,11 +52289,11 @@ components:
description: Facet data for the incident property fields.
properties:
aggregates:
- $ref: "#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates"
+ $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates'
facets:
description: Facet data for the property field of an incident.
items:
- $ref: "#/components/schemas/IncidentSearchResponseFieldFacetData"
+ $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
type: array
name:
description: Name of the incident property field.
@@ -52246,7 +52307,7 @@ components:
description: Facet data for user attributes of an incident.
properties:
count:
- $ref: "#/components/schemas/IncidentSearchResponseFacetCount"
+ $ref: '#/components/schemas/IncidentSearchResponseFacetCount'
email:
description: Email of the user.
example: datadog.user@example.com
@@ -52310,9 +52371,9 @@ components:
description: ServiceNow record data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentServiceNowRecordDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentServiceNowRecordDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentServiceNowRecordPromptType"
+ $ref: '#/components/schemas/IncidentServiceNowRecordPromptType'
required:
- type
- attributes
@@ -52329,7 +52390,7 @@ components:
description: Request payload for creating a ServiceNow record for an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentServiceNowRecordDataRequest"
+ $ref: '#/components/schemas/IncidentServiceNowRecordDataRequest'
required:
- data
type: object
@@ -52374,7 +52435,7 @@ components:
IncidentTimelineCellCreateAttributes:
description: The timeline cell's attributes for a create request.
oneOf:
- - $ref: "#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes"
+ - $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributes'
IncidentTimelineCellMarkdownContentType:
default: markdown
description: Type of the Markdown timeline cell.
@@ -52388,9 +52449,9 @@ components:
description: Timeline cell data for Markdown timeline cells for a create request.
properties:
cell_type:
- $ref: "#/components/schemas/IncidentTimelineCellMarkdownContentType"
+ $ref: '#/components/schemas/IncidentTimelineCellMarkdownContentType'
content:
- $ref: "#/components/schemas/IncidentTimelineCellMarkdownCreateAttributesContent"
+ $ref: '#/components/schemas/IncidentTimelineCellMarkdownCreateAttributesContent'
important:
default: false
description: A flag indicating whether the timeline cell is important and should be highlighted.
@@ -52413,7 +52474,7 @@ components:
description: Attributes for creating a timestamp override.
properties:
timestamp_type:
- $ref: "#/components/schemas/IncidentTimestampType"
+ $ref: '#/components/schemas/IncidentTimestampType'
timestamp_value:
description: The overridden timestamp value.
example: "2024-01-01T10:00:00.000Z"
@@ -52447,7 +52508,7 @@ components:
format: date-time
type: string
timestamp_type:
- $ref: "#/components/schemas/IncidentTimestampType"
+ $ref: '#/components/schemas/IncidentTimestampType'
timestamp_value:
description: The overridden timestamp value.
example: "2024-01-01T10:00:00.000Z"
@@ -52464,9 +52525,9 @@ components:
description: Timestamp override data in a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTimestampOverrideDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverrideDataAttributesRequest'
type:
- $ref: "#/components/schemas/IncidentTimestampOverrideType"
+ $ref: '#/components/schemas/IncidentTimestampOverrideType'
required:
- type
- attributes
@@ -52475,16 +52536,16 @@ components:
description: Timestamp override data in a response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTimestampOverrideDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverrideDataAttributesResponse'
id:
description: The timestamp override identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentTimestampOverrideRelationships"
+ $ref: '#/components/schemas/IncidentTimestampOverrideRelationships'
type:
- $ref: "#/components/schemas/IncidentTimestampOverrideType"
+ $ref: '#/components/schemas/IncidentTimestampOverrideType'
required:
- id
- type
@@ -52505,14 +52566,14 @@ components:
description: Timestamp override data in a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTimestampOverridePatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverridePatchDataAttributesRequest'
id:
description: The timestamp override identifier.
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentTimestampOverrideType"
+ $ref: '#/components/schemas/IncidentTimestampOverrideType'
required:
- id
- type
@@ -52521,7 +52582,7 @@ components:
description: Request payload for patching a timestamp override.
properties:
data:
- $ref: "#/components/schemas/IncidentTimestampOverridePatchDataRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverridePatchDataRequest'
required:
- data
type: object
@@ -52529,15 +52590,15 @@ components:
description: Relationships for a timestamp override.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentTimestampOverrideRequest:
description: Request payload for creating a timestamp override.
properties:
data:
- $ref: "#/components/schemas/IncidentTimestampOverrideDataRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverrideDataRequest'
required:
- data
type: object
@@ -52545,11 +52606,11 @@ components:
description: Response with a single timestamp override.
properties:
data:
- $ref: "#/components/schemas/IncidentTimestampOverrideDataResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverrideDataResponse'
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -52569,12 +52630,12 @@ components:
data:
description: List of timestamp overrides.
items:
- $ref: "#/components/schemas/IncidentTimestampOverrideDataResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverrideDataResponse'
type: array
included:
description: Included related resources.
items:
- $ref: "#/components/schemas/IncidentUserData"
+ $ref: '#/components/schemas/IncidentUserData'
readOnly: true
type: array
required:
@@ -52608,7 +52669,7 @@ components:
example: Slackbot
type: string
source:
- $ref: "#/components/schemas/IncidentTodoAnonymousAssigneeSource"
+ $ref: '#/components/schemas/IncidentTodoAnonymousAssigneeSource'
required:
- id
- icon
@@ -52630,14 +52691,14 @@ components:
description: A todo assignee.
example: "@test.user@test.com"
oneOf:
- - $ref: "#/components/schemas/IncidentTodoAssigneeHandle"
- - $ref: "#/components/schemas/IncidentTodoAnonymousAssignee"
+ - $ref: '#/components/schemas/IncidentTodoAssigneeHandle'
+ - $ref: '#/components/schemas/IncidentTodoAnonymousAssignee'
IncidentTodoAssigneeArray:
description: Array of todo assignees.
example:
- "@test.user@test.com"
items:
- $ref: "#/components/schemas/IncidentTodoAssignee"
+ $ref: '#/components/schemas/IncidentTodoAssignee'
type: array
IncidentTodoAssigneeHandle:
description: Assignee's @-handle.
@@ -52647,7 +52708,7 @@ components:
description: Incident todo's attributes.
properties:
assignees:
- $ref: "#/components/schemas/IncidentTodoAssigneeArray"
+ $ref: '#/components/schemas/IncidentTodoAssigneeArray'
completed:
description: Timestamp when the todo was completed.
example: "2023-03-06T22:00:00.000000+00:00"
@@ -52684,9 +52745,9 @@ components:
description: Incident todo data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTodoAttributes"
+ $ref: '#/components/schemas/IncidentTodoAttributes'
type:
- $ref: "#/components/schemas/IncidentTodoType"
+ $ref: '#/components/schemas/IncidentTodoType'
required:
- type
- attributes
@@ -52695,7 +52756,7 @@ components:
description: Create request for an incident todo.
properties:
data:
- $ref: "#/components/schemas/IncidentTodoCreateData"
+ $ref: '#/components/schemas/IncidentTodoCreateData'
required:
- data
type: object
@@ -52705,16 +52766,16 @@ components:
data:
description: An array of incident todos.
items:
- $ref: "#/components/schemas/IncidentTodoResponseData"
+ $ref: '#/components/schemas/IncidentTodoResponseData'
type: array
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentTodoResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentTodoResponseIncludedItem'
readOnly: true
type: array
meta:
- $ref: "#/components/schemas/IncidentResponseMeta"
+ $ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
@@ -52722,9 +52783,9 @@ components:
description: Incident todo data for a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTodoAttributes"
+ $ref: '#/components/schemas/IncidentTodoAttributes'
type:
- $ref: "#/components/schemas/IncidentTodoType"
+ $ref: '#/components/schemas/IncidentTodoType'
required:
- type
- attributes
@@ -52733,7 +52794,7 @@ components:
description: Patch request for an incident todo.
properties:
data:
- $ref: "#/components/schemas/IncidentTodoPatchData"
+ $ref: '#/components/schemas/IncidentTodoPatchData'
required:
- data
type: object
@@ -52741,19 +52802,19 @@ components:
description: The incident's relationships from a response.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentTodoResponse:
description: Response with an incident todo.
properties:
data:
- $ref: "#/components/schemas/IncidentTodoResponseData"
+ $ref: '#/components/schemas/IncidentTodoResponseData'
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentTodoResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentTodoResponseIncludedItem'
readOnly: true
type: array
required:
@@ -52763,15 +52824,15 @@ components:
description: Incident todo response data.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTodoAttributes"
+ $ref: '#/components/schemas/IncidentTodoAttributes'
id:
description: The incident todo's ID.
example: "00000000-0000-0000-1234-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentTodoRelationships"
+ $ref: '#/components/schemas/IncidentTodoRelationships'
type:
- $ref: "#/components/schemas/IncidentTodoType"
+ $ref: '#/components/schemas/IncidentTodoType'
required:
- id
- type
@@ -52779,7 +52840,7 @@ components:
IncidentTodoResponseIncludedItem:
description: An object related to an incident todo that is included in the response.
oneOf:
- - $ref: "#/components/schemas/User"
+ - $ref: '#/components/schemas/User'
IncidentTodoType:
default: incident_todos
description: Todo resource type.
@@ -52793,7 +52854,7 @@ components:
description: "Trigger a workflow from an incident. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
version:
description: "Version of the incident manual trigger."
type: string
@@ -52802,9 +52863,9 @@ components:
description: "Schema for an incident-based trigger."
properties:
incidentTrigger:
- $ref: "#/components/schemas/IncidentTrigger"
+ $ref: '#/components/schemas/IncidentTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- incidentTrigger
type: object
@@ -52899,7 +52960,7 @@ components:
example: false
type: boolean
slug_source:
- $ref: "#/components/schemas/IncidentTypeSlugSource"
+ $ref: '#/components/schemas/IncidentTypeSlugSource'
test_incidents:
default: true
description: Whether incidents of this type are treated as test incidents.
@@ -52910,9 +52971,9 @@ components:
description: Incident type data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTypeAttributes"
+ $ref: '#/components/schemas/IncidentTypeAttributes'
type:
- $ref: "#/components/schemas/IncidentTypeType"
+ $ref: '#/components/schemas/IncidentTypeType'
required:
- type
- attributes
@@ -52921,7 +52982,7 @@ components:
description: Create request for an incident type.
properties:
data:
- $ref: "#/components/schemas/IncidentTypeCreateData"
+ $ref: '#/components/schemas/IncidentTypeCreateData'
required:
- data
type: object
@@ -52931,7 +52992,7 @@ components:
data:
description: An array of incident type objects.
items:
- $ref: "#/components/schemas/IncidentTypeObject"
+ $ref: '#/components/schemas/IncidentTypeObject'
type: array
required:
- data
@@ -52940,15 +53001,15 @@ components:
description: Incident type response data.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTypeAttributes"
+ $ref: '#/components/schemas/IncidentTypeAttributes'
id:
description: The incident type's ID.
example: "00000000-0000-0000-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentTypeRelationships"
+ $ref: '#/components/schemas/IncidentTypeRelationships'
type:
- $ref: "#/components/schemas/IncidentTypeType"
+ $ref: '#/components/schemas/IncidentTypeType'
required:
- id
- type
@@ -52957,13 +53018,13 @@ components:
description: Incident type data for a patch request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentTypeUpdateAttributes"
+ $ref: '#/components/schemas/IncidentTypeUpdateAttributes'
id:
description: The incident type's ID.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentTypeType"
+ $ref: '#/components/schemas/IncidentTypeType'
required:
- id
- type
@@ -52973,7 +53034,7 @@ components:
description: Patch request for an incident type.
properties:
data:
- $ref: "#/components/schemas/IncidentTypePatchData"
+ $ref: '#/components/schemas/IncidentTypePatchData'
required:
- data
type: object
@@ -52982,21 +53043,21 @@ components:
description: The incident type's resource relationships.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
google_meet_configuration:
- $ref: "#/components/schemas/GoogleMeetConfigurationReference"
+ $ref: '#/components/schemas/GoogleMeetConfigurationReference'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
microsoft_teams_configuration:
- $ref: "#/components/schemas/MicrosoftTeamsConfigurationReference"
+ $ref: '#/components/schemas/MicrosoftTeamsConfigurationReference'
zoom_configuration:
- $ref: "#/components/schemas/ZoomConfigurationReference"
+ $ref: '#/components/schemas/ZoomConfigurationReference'
type: object
IncidentTypeResponse:
description: Incident type response data.
properties:
data:
- $ref: "#/components/schemas/IncidentTypeObject"
+ $ref: '#/components/schemas/IncidentTypeObject'
required:
- data
type: object
@@ -53025,7 +53086,7 @@ components:
description: Incident type's attributes for updates.
properties:
configuration:
- $ref: "#/components/schemas/IncidentTypeConfiguration"
+ $ref: '#/components/schemas/IncidentTypeConfiguration'
createdAt:
description: Timestamp when the incident type was created.
format: date-time
@@ -53092,7 +53153,7 @@ components:
type: string
fields:
additionalProperties:
- $ref: "#/components/schemas/IncidentFieldAttributes"
+ $ref: '#/components/schemas/IncidentFieldAttributes'
description: A condensed view of the user-defined fields for which to update selections.
example: {"severity": {"type": "dropdown", "value": "SEV-5"}}
type: object
@@ -53100,7 +53161,7 @@ components:
description: Notification handles that will be notified of the incident during update.
example: [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}]
items:
- $ref: "#/components/schemas/IncidentNotificationHandle"
+ $ref: '#/components/schemas/IncidentNotificationHandle'
type: array
title:
description: The title of the incident, which summarizes what happened.
@@ -53111,15 +53172,15 @@ components:
description: Incident data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUpdateAttributes"
+ $ref: '#/components/schemas/IncidentUpdateAttributes'
id:
description: The incident's ID.
example: "00000000-0000-0000-4567-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentUpdateRelationships"
+ $ref: '#/components/schemas/IncidentUpdateRelationships'
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- id
- type
@@ -53128,17 +53189,17 @@ components:
description: The incident's relationships for an update request.
properties:
commander_user:
- $ref: "#/components/schemas/NullableRelationshipToUser"
+ $ref: '#/components/schemas/NullableRelationshipToUser'
integrations:
- $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadatas"
+ $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadatas'
postmortem:
- $ref: "#/components/schemas/RelationshipToIncidentPostmortem"
+ $ref: '#/components/schemas/RelationshipToIncidentPostmortem'
type: object
IncidentUpdateRequest:
description: Update request for an incident.
properties:
data:
- $ref: "#/components/schemas/IncidentUpdateData"
+ $ref: '#/components/schemas/IncidentUpdateData'
required:
- data
type: object
@@ -53166,20 +53227,20 @@ components:
description: User object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserAttributes"
+ $ref: '#/components/schemas/IncidentUserAttributes'
id:
description: ID of the user.
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
type: object
IncidentUserDefinedFieldAttributesCreateRequest:
description: Attributes for creating an incident user-defined field.
properties:
category:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCategory"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCategory'
collected:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCollected"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCollected'
default_value:
description: The default value for the field. Must be one of the valid values when valid_values is set.
example: "critical"
@@ -53208,11 +53269,11 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/IncidentUserDefinedFieldFieldType"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldFieldType'
valid_values:
description: The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
items:
- $ref: "#/components/schemas/IncidentUserDefinedFieldValidValue"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldValidValue'
type: array
required:
- name
@@ -53222,9 +53283,9 @@ components:
description: Attributes of an incident user-defined field.
properties:
category:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCategory"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCategory'
collected:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCollected"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCollected'
created:
description: Timestamp when the field was created.
example: "2026-03-18T08:40:05.185406Z"
@@ -53248,7 +53309,7 @@ components:
example: "Root Cause"
type: string
metadata:
- $ref: "#/components/schemas/IncidentUserDefinedFieldMetadata"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldMetadata'
modified:
description: Timestamp when the field was last modified.
example: "2026-03-18T08:40:05.185406Z"
@@ -53290,7 +53351,7 @@ components:
valid_values:
description: The list of allowed values for dropdown, multiselect, and autocomplete fields.
items:
- $ref: "#/components/schemas/IncidentUserDefinedFieldValidValue"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldValidValue'
nullable: true
type: array
required:
@@ -53314,9 +53375,9 @@ components:
description: Attributes for updating an incident user-defined field. All fields are optional.
properties:
category:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCategory"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCategory'
collected:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCollected"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCollected'
default_value:
description: The default value for the field. Must be one of the valid values when valid_values is set.
example: "critical"
@@ -53339,7 +53400,7 @@ components:
valid_values:
description: The list of allowed values for dropdown and multiselect fields. Limited to 1000 values.
items:
- $ref: "#/components/schemas/IncidentUserDefinedFieldValidValue"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldValidValue'
nullable: true
type: array
type: object
@@ -53373,11 +53434,11 @@ components:
description: Data for creating an incident user-defined field.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedFieldAttributesCreateRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldAttributesCreateRequest'
relationships:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCreateRelationships"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCreateRelationships'
type:
- $ref: "#/components/schemas/IncidentUserDefinedFieldType"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldType'
required:
- type
- attributes
@@ -53387,7 +53448,7 @@ components:
description: Relationships for creating an incident user-defined field.
properties:
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
required:
- incident_type
type: object
@@ -53395,7 +53456,7 @@ components:
description: Request body for creating an incident user-defined field.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCreateData"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCreateData'
required:
- data
type: object
@@ -53442,10 +53503,10 @@ components:
data:
description: An array of user-defined field objects.
items:
- $ref: "#/components/schemas/IncidentUserDefinedFieldResponseData"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldResponseData'
type: array
meta:
- $ref: "#/components/schemas/IncidentUserDefinedFieldListMeta"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldListMeta'
required:
- data
- meta
@@ -53490,11 +53551,11 @@ components:
description: Relationships of an incident user-defined field.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/RelationshipToIncidentType"
+ $ref: '#/components/schemas/RelationshipToIncidentType'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
required:
- created_by_user
- last_modified_by_user
@@ -53504,7 +53565,7 @@ components:
description: Response containing a single incident user-defined field.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedFieldResponseData"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldResponseData'
required:
- data
type: object
@@ -53512,15 +53573,15 @@ components:
description: Data object for an incident user-defined field response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedFieldAttributesResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldAttributesResponse'
id:
description: The unique identifier of the user-defined field.
example: "00000000-0000-0000-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/IncidentUserDefinedFieldRelationships"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldRelationships'
type:
- $ref: "#/components/schemas/IncidentUserDefinedFieldType"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldType'
required:
- id
- type
@@ -53539,13 +53600,13 @@ components:
description: Data for updating an incident user-defined field.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedFieldAttributesUpdateRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldAttributesUpdateRequest'
id:
description: The unique identifier of the user-defined field to update.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentUserDefinedFieldType"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldType'
required:
- id
- type
@@ -53555,7 +53616,7 @@ components:
description: Request body for updating an incident user-defined field.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedFieldUpdateData"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldUpdateData'
required:
- data
type: object
@@ -53595,7 +53656,7 @@ components:
example: "Tech Lead"
type: string
policy:
- $ref: "#/components/schemas/IncidentUserDefinedRolePolicy"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePolicy'
required:
- name
type: object
@@ -53622,7 +53683,7 @@ components:
example: "Tech Lead"
type: string
policy:
- $ref: "#/components/schemas/IncidentUserDefinedRolePolicy"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePolicy'
required:
- name
- policy
@@ -53633,11 +53694,11 @@ components:
description: Data for creating an incident user-defined role.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedRoleDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleDataAttributesRequest'
relationships:
- $ref: "#/components/schemas/IncidentUserDefinedRoleRelationshipsRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleRelationshipsRequest'
type:
- $ref: "#/components/schemas/IncidentUserDefinedRoleType"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleType'
required:
- type
- attributes
@@ -53647,16 +53708,16 @@ components:
description: Data for an incident user-defined role response.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedRoleDataAttributesResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleDataAttributesResponse'
id:
description: The ID of the user-defined role.
example: "00000000-0000-0000-0000-000000000002"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/IncidentUserDefinedRoleRelationshipsResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleRelationshipsResponse'
type:
- $ref: "#/components/schemas/IncidentUserDefinedRoleType"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleType'
required:
- id
- type
@@ -53666,7 +53727,7 @@ components:
description: Relationship to an incident type for a user-defined role.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationshipData"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationshipData'
required:
- data
type: object
@@ -53689,12 +53750,12 @@ components:
IncidentUserDefinedRoleIncludedItem:
description: A single included resource in a user-defined role response.
oneOf:
- - $ref: "#/components/schemas/IncidentUserData"
- - $ref: "#/components/schemas/IncidentTypeObject"
+ - $ref: '#/components/schemas/IncidentUserData'
+ - $ref: '#/components/schemas/IncidentTypeObject'
IncidentUserDefinedRoleIncludedResponse:
description: Included resources for an incident user-defined role response.
items:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedItem"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncludedItem'
type: array
IncidentUserDefinedRolePatchDataAttributesRequest:
description: Attributes for updating an incident user-defined role.
@@ -53709,20 +53770,20 @@ components:
example: "Tech Lead"
type: string
policy:
- $ref: "#/components/schemas/IncidentUserDefinedRolePolicy"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePolicy'
type: object
IncidentUserDefinedRolePatchDataRequest:
description: Data for updating an incident user-defined role.
properties:
attributes:
- $ref: "#/components/schemas/IncidentUserDefinedRolePatchDataAttributesRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePatchDataAttributesRequest'
id:
description: The ID of the user-defined role to update.
example: "00000000-0000-0000-0000-000000000002"
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentUserDefinedRoleType"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleType'
required:
- id
- type
@@ -53731,7 +53792,7 @@ components:
description: Request for updating an incident user-defined role.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedRolePatchDataRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePatchDataRequest'
required:
- data
type: object
@@ -53749,7 +53810,7 @@ components:
description: Relationships for creating a user-defined role.
properties:
incident_type:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship'
required:
- incident_type
type: object
@@ -53757,17 +53818,17 @@ components:
description: Relationships of a user-defined role response.
properties:
created_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
incident_type:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncidentTypeRelationship'
last_modified_by_user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
IncidentUserDefinedRoleRequest:
description: Request for creating an incident user-defined role.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedRoleDataRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleDataRequest'
required:
- data
type: object
@@ -53775,9 +53836,9 @@ components:
description: Response with a single incident user-defined role.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedRoleDataResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleDataResponse'
included:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncludedResponse'
required:
- data
type: object
@@ -53792,15 +53853,15 @@ components:
IncidentUserDefinedRolesDataResponse:
description: List of incident user-defined role data objects.
items:
- $ref: "#/components/schemas/IncidentUserDefinedRoleDataResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleDataResponse'
type: array
IncidentUserDefinedRolesResponse:
description: Response with a list of incident user-defined roles.
properties:
data:
- $ref: "#/components/schemas/IncidentUserDefinedRolesDataResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRolesDataResponse'
included:
- $ref: "#/components/schemas/IncidentUserDefinedRoleIncludedResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleIncludedResponse'
required:
- data
type: object
@@ -53813,16 +53874,16 @@ components:
"type": "users"}}, "integrations": {"data": [{"id": "00000000-0000-0000-4444-000000000000", "type": "incident_integrations"}, {"id": "00000000-0000-0000-5555-000000000000", "type": "incident_integrations"}]}, "last_modified_by_user": {"data": {"id": "00000000-0000-0000-cccc-000000000000", "type": "users"}}}, "type": "incidents"}, {"attributes": {"created": "2020-04-21T15:34:08.627205+00:00", "creation_idempotency_key": null, "customer_impact_duration": 0, "customer_impact_end": null, "customer_impact_scope": null, "customer_impact_start": null, "customer_impacted": false, "detected": "2020-04-14T00:00:00+00:00", "incident_type_uuid": "00000000-0000-0000-0000-000000000002", "modified": "2020-09-17T14:16:58.696424+00:00", "public_id": 2, "resolved": null, "severity": "SEV-5", "time_to_detect": 0, "time_to_internal_response": 0, "time_to_repair": 0, "time_to_resolve": 0, "title": "Example Incident 2"}, "id": "00000000-1111-0000-0000-000000000000", "relationships": {"attachments": {
"data": [{"id": "00000000-9999-0000-0000-000000000000", "type": "incident_attachments"}]}, "commander_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}, "created_by_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}, "integrations": {"data": [{"id": "00000000-0000-0000-0001-000000000000", "type": "incident_integrations"}, {"id": "00000000-0000-0000-0002-000000000000", "type": "incident_integrations"}]}, "last_modified_by_user": {"data": {"id": "00000000-aaaa-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}]
items:
- $ref: "#/components/schemas/IncidentResponseData"
+ $ref: '#/components/schemas/IncidentResponseData'
type: array
included:
description: Included related resources that the user requested.
items:
- $ref: "#/components/schemas/IncidentResponseIncludedItem"
+ $ref: '#/components/schemas/IncidentResponseIncludedItem'
readOnly: true
type: array
meta:
- $ref: "#/components/schemas/IncidentResponseMeta"
+ $ref: '#/components/schemas/IncidentResponseMeta'
required:
- data
type: object
@@ -53847,7 +53908,7 @@ components:
parameters:
description: The `InputSchema` `parameters`.
items:
- $ref: "#/components/schemas/InputSchemaParameters"
+ $ref: '#/components/schemas/InputSchemaParameters'
type: array
type: object
InputSchemaParameters:
@@ -53872,7 +53933,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/InputSchemaParametersType"
+ $ref: '#/components/schemas/InputSchemaParametersType'
required:
- name
- type
@@ -53913,15 +53974,15 @@ components:
description: Integration resource object.
properties:
attributes:
- $ref: "#/components/schemas/IntegrationAttributes"
+ $ref: '#/components/schemas/IntegrationAttributes'
id:
description: The unique identifier of the integration.
example: "calico"
type: string
links:
- $ref: "#/components/schemas/IntegrationLinks"
+ $ref: '#/components/schemas/IntegrationLinks'
type:
- $ref: "#/components/schemas/IntegrationType"
+ $ref: '#/components/schemas/IntegrationType'
required:
- type
- id
@@ -53931,7 +53992,7 @@ components:
description: Username and password authentication.
properties:
auth_type:
- $ref: "#/components/schemas/IntegrationAccountBasicAuthType"
+ $ref: '#/components/schemas/IntegrationAccountBasicAuthType'
password:
description: Secret password or private key.
example: your-password
@@ -53950,7 +54011,7 @@ components:
description: The basic authentication method and username configured on the account.
properties:
auth_type:
- $ref: "#/components/schemas/IntegrationAccountBasicAuthType"
+ $ref: '#/components/schemas/IntegrationAccountBasicAuthType'
username:
description: Non-secret username or public identifier for the credential pair.
example: datadog
@@ -53972,7 +54033,7 @@ components:
description: Username and password authentication. Only the fields provided are changed; omit `password` to keep the stored one.
properties:
auth_type:
- $ref: "#/components/schemas/IntegrationAccountBasicAuthType"
+ $ref: '#/components/schemas/IntegrationAccountBasicAuthType'
password:
description: Secret password or private key.
example: your-password
@@ -54001,7 +54062,7 @@ components:
description: Read-only collection status of a dataflow.
properties:
health:
- $ref: "#/components/schemas/IntegrationAccountDataflowHealth"
+ $ref: '#/components/schemas/IntegrationAccountDataflowHealth'
message:
description: Human-readable detail, populated when the dataflow is not healthy.
example: ""
@@ -54067,13 +54128,13 @@ components:
field_mappings:
description: List of mappings between incident fields and case fields.
items:
- $ref: "#/components/schemas/IntegrationIncidentFieldMappingsItems"
+ $ref: '#/components/schemas/IntegrationIncidentFieldMappingsItems'
type: array
incident_type:
description: Incident type.
type: string
severity_config:
- $ref: "#/components/schemas/IntegrationIncidentSeverityConfig"
+ $ref: '#/components/schemas/IntegrationIncidentSeverityConfig'
type: object
IntegrationIncidentFieldMappingsItems:
description: Mapping between an incident user-defined field and a case field.
@@ -54098,14 +54159,14 @@ components:
description: Jira integration settings.
properties:
auto_creation:
- $ref: "#/components/schemas/IntegrationJiraAutoCreation"
+ $ref: '#/components/schemas/IntegrationJiraAutoCreation'
enabled:
description: Whether Jira integration is enabled.
type: boolean
metadata:
- $ref: "#/components/schemas/IntegrationJiraMetadata"
+ $ref: '#/components/schemas/IntegrationJiraMetadata'
sync:
- $ref: "#/components/schemas/IntegrationJiraSync"
+ $ref: '#/components/schemas/IntegrationJiraSync'
type: object
IntegrationJiraAutoCreation:
description: Auto-creation settings for Jira issues from cases.
@@ -54134,7 +54195,7 @@ components:
description: Whether Jira field synchronization is enabled.
type: boolean
properties:
- $ref: "#/components/schemas/IntegrationJiraSyncProperties"
+ $ref: '#/components/schemas/IntegrationJiraSyncProperties'
type: object
IntegrationJiraSyncDueDate:
description: Due date synchronization configuration for Jira integration.
@@ -54150,24 +54211,24 @@ components:
description: Field synchronization properties for Jira integration.
properties:
assignee:
- $ref: "#/components/schemas/SyncProperty"
+ $ref: '#/components/schemas/SyncProperty'
comments:
- $ref: "#/components/schemas/SyncProperty"
+ $ref: '#/components/schemas/SyncProperty'
custom_fields:
additionalProperties:
- $ref: "#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties"
+ $ref: '#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties'
description: Map of custom field identifiers to their sync configurations.
type: object
description:
- $ref: "#/components/schemas/SyncProperty"
+ $ref: '#/components/schemas/SyncProperty'
due_date:
- $ref: "#/components/schemas/IntegrationJiraSyncDueDate"
+ $ref: '#/components/schemas/IntegrationJiraSyncDueDate'
priority:
- $ref: "#/components/schemas/SyncPropertyWithMapping"
+ $ref: '#/components/schemas/SyncPropertyWithMapping'
status:
- $ref: "#/components/schemas/SyncPropertyWithMapping"
+ $ref: '#/components/schemas/SyncPropertyWithMapping'
title:
- $ref: "#/components/schemas/SyncProperty"
+ $ref: '#/components/schemas/SyncProperty'
type: object
IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties:
description: Synchronization configuration for a Jira custom field.
@@ -54176,7 +54237,7 @@ components:
description: The type of synchronization to apply for this custom field.
type: string
value:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
type: object
IntegrationLinks:
description: Links for the integration resource.
@@ -54214,7 +54275,7 @@ components:
escalation_queries:
description: List of escalation queries for routing cases to on-call responders.
items:
- $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItems"
+ $ref: '#/components/schemas/IntegrationOnCallEscalationQueriesItems'
type: array
type: object
IntegrationOnCallEscalationQueriesItems:
@@ -54230,7 +54291,7 @@ components:
description: The query used to match cases for escalation.
type: string
target:
- $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget"
+ $ref: '#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget'
type: object
IntegrationOnCallEscalationQueriesItemsTarget:
description: The target recipient for an On-Call escalation query.
@@ -54252,7 +54313,7 @@ components:
description: Assignment group.
type: string
auto_creation:
- $ref: "#/components/schemas/IntegrationServiceNowAutoCreation"
+ $ref: '#/components/schemas/IntegrationServiceNowAutoCreation'
enabled:
description: Whether ServiceNow integration is enabled.
type: boolean
@@ -54260,7 +54321,7 @@ components:
description: ServiceNow instance name.
type: string
sync_config:
- $ref: "#/components/schemas/IntegrationServiceNowSyncConfig"
+ $ref: '#/components/schemas/IntegrationServiceNowSyncConfig'
type: object
IntegrationServiceNowAutoCreation:
description: Auto-creation settings for ServiceNow incidents from cases.
@@ -54276,17 +54337,17 @@ components:
description: Whether ServiceNow synchronization is enabled.
type: boolean
properties:
- $ref: "#/components/schemas/IntegrationServiceNowSyncConfig139772721534496"
+ $ref: '#/components/schemas/IntegrationServiceNowSyncConfig139772721534496'
type: object
IntegrationServiceNowSyncConfig139772721534496:
description: Field-level synchronization properties for ServiceNow integration.
properties:
comments:
- $ref: "#/components/schemas/SyncProperty"
+ $ref: '#/components/schemas/SyncProperty'
priority:
- $ref: "#/components/schemas/IntegrationServiceNowSyncConfigPriority"
+ $ref: '#/components/schemas/IntegrationServiceNowSyncConfigPriority'
status:
- $ref: "#/components/schemas/SyncPropertyWithMapping"
+ $ref: '#/components/schemas/SyncPropertyWithMapping'
type: object
IntegrationServiceNowSyncConfigPriority:
description: Priority synchronization configuration for ServiceNow integration.
@@ -54346,7 +54407,7 @@ components:
example: if0
type: string
status:
- $ref: "#/components/schemas/InterfaceAttributesStatus"
+ $ref: '#/components/schemas/InterfaceAttributesStatus'
type: object
InterfaceAttributesStatus:
description: The interface status
@@ -54394,7 +54455,7 @@ components:
description: Response for the list indicators of compromise endpoint.
properties:
data:
- $ref: "#/components/schemas/IoCExplorerListResponseData"
+ $ref: '#/components/schemas/IoCExplorerListResponseData'
type: object
IoCExplorerListResponseAttributes:
description: Attributes of the IoC Explorer list response.
@@ -54402,18 +54463,18 @@ components:
data:
description: List of indicators of compromise.
items:
- $ref: "#/components/schemas/IoCIndicator"
+ $ref: '#/components/schemas/IoCIndicator'
type: array
metadata:
- $ref: "#/components/schemas/IoCExplorerListResponseMetadata"
+ $ref: '#/components/schemas/IoCExplorerListResponseMetadata'
paging:
- $ref: "#/components/schemas/IoCExplorerListResponsePaging"
+ $ref: '#/components/schemas/IoCExplorerListResponsePaging'
type: object
IoCExplorerListResponseData:
description: IoC Explorer list response data object.
properties:
attributes:
- $ref: "#/components/schemas/IoCExplorerListResponseAttributes"
+ $ref: '#/components/schemas/IoCExplorerListResponseAttributes'
id:
description: Unique identifier for the response.
type: string
@@ -54454,14 +54515,14 @@ components:
description: An indicator of compromise with threat intelligence data.
properties:
as_geo:
- $ref: "#/components/schemas/IoCGeoLocation"
+ $ref: '#/components/schemas/IoCGeoLocation'
as_type:
description: Autonomous system type.
type: string
benign_sources:
description: Threat intelligence sources that flagged this indicator as benign.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
categories:
@@ -54491,21 +54552,21 @@ components:
format: int64
type: integer
m_as_type:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_persistence:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_signal:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_sources:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
malicious_sources:
description: Threat intelligence sources that flagged this indicator as malicious.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
max_trust_score:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
score:
description: Threat score for the indicator (0-100).
format: double
@@ -54521,7 +54582,7 @@ components:
suspicious_sources:
description: Threat intelligence sources that flagged this indicator as suspicious.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
tags:
@@ -54530,7 +54591,7 @@ components:
type: string
type: array
triage_state:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
triaged_at:
description: Timestamp when the indicator was last triaged.
format: date-time
@@ -54550,7 +54611,7 @@ components:
description: Autonomous system CIDR block.
type: string
as_geo:
- $ref: "#/components/schemas/IoCGeoLocation"
+ $ref: '#/components/schemas/IoCGeoLocation'
as_number:
description: Autonomous system number.
type: string
@@ -54563,7 +54624,7 @@ components:
benign_sources:
description: Threat intelligence sources that flagged this indicator as benign.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
categories:
@@ -54608,21 +54669,21 @@ components:
type: string
type: array
m_as_type:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_persistence:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_signal:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
m_sources:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
malicious_sources:
description: Threat intelligence sources that flagged this indicator as malicious.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
max_trust_score:
- $ref: "#/components/schemas/IoCScoreEffect"
+ $ref: '#/components/schemas/IoCScoreEffect'
score:
description: Threat score for the indicator (0-100).
format: double
@@ -54639,7 +54700,7 @@ components:
signal_severity:
description: Breakdown of security signals by severity.
items:
- $ref: "#/components/schemas/IoCSignalSeverityCount"
+ $ref: '#/components/schemas/IoCSignalSeverityCount'
type: array
signal_tier:
description: Signal tier level.
@@ -54648,7 +54709,7 @@ components:
suspicious_sources:
description: Threat intelligence sources that flagged this indicator as suspicious.
items:
- $ref: "#/components/schemas/IoCSource"
+ $ref: '#/components/schemas/IoCSource'
nullable: true
type: array
tags:
@@ -54659,10 +54720,10 @@ components:
triage_history:
description: Full triage history timeline. Returned only when `include_triage_history` is true.
items:
- $ref: "#/components/schemas/IoCTriageEvent"
+ $ref: '#/components/schemas/IoCTriageEvent'
type: array
triage_state:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
triaged_at:
description: Timestamp when the indicator was last triaged.
format: date-time
@@ -54712,7 +54773,7 @@ components:
description: A single entry in an indicator's triage history timeline.
properties:
triage_state:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
triaged_at:
description: Timestamp when this triage action occurred.
format: date-time
@@ -54735,7 +54796,7 @@ components:
description: Request body for creating or updating an indicator triage state.
properties:
data:
- $ref: "#/components/schemas/IoCTriageWriteRequestData"
+ $ref: '#/components/schemas/IoCTriageWriteRequestData'
required:
- data
type: object
@@ -54747,7 +54808,7 @@ components:
example: "192.0.2.1"
type: string
triage_state:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
required:
- indicator
- triage_state
@@ -54756,7 +54817,7 @@ components:
description: Data object for the triage write request.
properties:
attributes:
- $ref: "#/components/schemas/IoCTriageWriteRequestAttributes"
+ $ref: '#/components/schemas/IoCTriageWriteRequestAttributes'
type:
default: ioc_triage_state
description: Triage state resource type.
@@ -54770,7 +54831,7 @@ components:
description: Response for the create indicator triage state endpoint.
properties:
data:
- $ref: "#/components/schemas/IoCTriageWriteResponseData"
+ $ref: '#/components/schemas/IoCTriageWriteResponseData'
type: object
IoCTriageWriteResponseAttributes:
description: Attributes of a created or updated triage state.
@@ -54783,7 +54844,7 @@ components:
description: The indicator value that was triaged.
type: string
triage_state:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
triaged_at:
description: Timestamp when the triage state was set.
format: date-time
@@ -54796,7 +54857,7 @@ components:
description: Data object of the triage write response.
properties:
attributes:
- $ref: "#/components/schemas/IoCTriageWriteResponseAttributes"
+ $ref: '#/components/schemas/IoCTriageWriteResponseAttributes'
id:
description: Unique identifier for the triage state record.
type: string
@@ -54809,15 +54870,15 @@ components:
description: The issue matching the request.
properties:
attributes:
- $ref: "#/components/schemas/IssueAttributes"
+ $ref: '#/components/schemas/IssueAttributes'
id:
description: Issue identifier.
example: "c1726a66-1f64-11ee-b338-da7ad0900002"
type: string
relationships:
- $ref: "#/components/schemas/IssueRelationships"
+ $ref: '#/components/schemas/IssueRelationships'
type:
- $ref: "#/components/schemas/IssueType"
+ $ref: '#/components/schemas/IssueType'
required:
- id
- type
@@ -54827,7 +54888,7 @@ components:
description: Relationship between the issue and assignee.
properties:
data:
- $ref: "#/components/schemas/IssueUserReference"
+ $ref: '#/components/schemas/IssueUserReference'
required:
- data
type: object
@@ -54867,7 +54928,7 @@ components:
description: Array of programming languages associated with the issue.
example: ["PYTHON", "GO"]
items:
- $ref: "#/components/schemas/IssueLanguage"
+ $ref: '#/components/schemas/IssueLanguage'
type: array
last_seen:
description: Timestamp of the last seen error in milliseconds since the Unix epoch.
@@ -54879,29 +54940,29 @@ components:
example: "b6199f80"
type: string
platform:
- $ref: "#/components/schemas/IssuePlatform"
+ $ref: '#/components/schemas/IssuePlatform'
regression:
- $ref: "#/components/schemas/IssueRegression"
+ $ref: '#/components/schemas/IssueRegression'
service:
description: Service name.
example: "email-api-py"
type: string
state:
- $ref: "#/components/schemas/IssueState"
+ $ref: '#/components/schemas/IssueState'
type: object
IssueCase:
description: The case attached to the issue.
properties:
attributes:
- $ref: "#/components/schemas/IssueCaseAttributes"
+ $ref: '#/components/schemas/IssueCaseAttributes'
id:
description: Case identifier.
example: "2841440d-e780-4fe2-96cd-6a8c1d194da5"
type: string
relationships:
- $ref: "#/components/schemas/IssueCaseRelationships"
+ $ref: '#/components/schemas/IssueCaseRelationships'
type:
- $ref: "#/components/schemas/IssueCaseResourceType"
+ $ref: '#/components/schemas/IssueCaseResourceType'
required:
- id
- type
@@ -54939,25 +55000,25 @@ components:
insights:
description: Insights of the case.
items:
- $ref: "#/components/schemas/IssueCaseInsight"
+ $ref: '#/components/schemas/IssueCaseInsight'
type: array
jira_issue:
- $ref: "#/components/schemas/IssueCaseJiraIssue"
+ $ref: '#/components/schemas/IssueCaseJiraIssue'
key:
description: Key of the case.
example: "ET-123"
type: string
linear_issue:
- $ref: "#/components/schemas/IssueCaseLinearIssue"
+ $ref: '#/components/schemas/IssueCaseLinearIssue'
modified_at:
description: Timestamp of when the case was last modified.
example: "2025-01-01T00:00:00Z"
format: date-time
type: string
priority:
- $ref: "#/components/schemas/CasePriority"
+ $ref: '#/components/schemas/CasePriority'
status:
- $ref: "#/components/schemas/CaseStatus"
+ $ref: '#/components/schemas/CaseStatus'
title:
description: Title of the case.
example: "Error: HTTP error"
@@ -54991,7 +55052,7 @@ components:
example: ""
type: string
result:
- $ref: "#/components/schemas/IssueCaseJiraIssueResult"
+ $ref: '#/components/schemas/IssueCaseJiraIssueResult'
status:
description: Creation status of the Jira issue.
example: "COMPLETED"
@@ -55033,7 +55094,7 @@ components:
example: ""
type: string
result:
- $ref: "#/components/schemas/IssueCaseLinearIssueResult"
+ $ref: '#/components/schemas/IssueCaseLinearIssueResult'
status:
description: Creation status of the Linear issue.
example: "COMPLETED"
@@ -55071,7 +55132,7 @@ components:
example: "2841440d-e780-4fe2-96cd-6a8c1d194da5"
type: string
type:
- $ref: "#/components/schemas/IssueCaseResourceType"
+ $ref: '#/components/schemas/IssueCaseResourceType'
required:
- id
- type
@@ -55080,7 +55141,7 @@ components:
description: Relationship between the issue and case.
properties:
data:
- $ref: "#/components/schemas/IssueCaseReference"
+ $ref: '#/components/schemas/IssueCaseReference'
required:
- data
type: object
@@ -55088,13 +55149,13 @@ components:
description: Resources related to a case.
properties:
assignee:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
created_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
modified_by:
- $ref: "#/components/schemas/NullableUserRelationship"
+ $ref: '#/components/schemas/NullableUserRelationship'
project:
- $ref: "#/components/schemas/ProjectRelationship"
+ $ref: '#/components/schemas/ProjectRelationship'
type: object
IssueCaseResourceType:
description: Type of the object.
@@ -55106,9 +55167,9 @@ components:
IssueIncluded:
description: An array of related resources, returned when the `include` query parameter is used.
oneOf:
- - $ref: "#/components/schemas/IssueCase"
- - $ref: "#/components/schemas/IssueUser"
- - $ref: "#/components/schemas/IssueTeam"
+ - $ref: '#/components/schemas/IssueCase'
+ - $ref: '#/components/schemas/IssueUser'
+ - $ref: '#/components/schemas/IssueTeam'
IssueLanguage:
description: Programming language associated with the issue.
enum:
@@ -55199,7 +55260,7 @@ components:
example: "c1726a66-1f64-11ee-b338-da7ad0900002"
type: string
type:
- $ref: "#/components/schemas/IssueType"
+ $ref: '#/components/schemas/IssueType'
required:
- id
- type
@@ -55229,21 +55290,21 @@ components:
description: Relationship between the issue and an assignee, case and/or teams.
properties:
assignee:
- $ref: "#/components/schemas/IssueAssigneeRelationship"
+ $ref: '#/components/schemas/IssueAssigneeRelationship'
case:
- $ref: "#/components/schemas/IssueCaseRelationship"
+ $ref: '#/components/schemas/IssueCaseRelationship'
team_owners:
- $ref: "#/components/schemas/IssueTeamOwnersRelationship"
+ $ref: '#/components/schemas/IssueTeamOwnersRelationship'
type: object
IssueResponse:
description: Response containing error tracking issue data.
properties:
data:
- $ref: "#/components/schemas/Issue"
+ $ref: '#/components/schemas/Issue'
included:
description: Array of resources related to the issue.
items:
- $ref: "#/components/schemas/IssueIncluded"
+ $ref: '#/components/schemas/IssueIncluded'
type: array
type: object
IssueState:
@@ -55266,13 +55327,13 @@ components:
description: A team that owns an issue.
properties:
attributes:
- $ref: "#/components/schemas/IssueTeamAttributes"
+ $ref: '#/components/schemas/IssueTeamAttributes'
id:
description: Team identifier.
example: "221b0179-6447-4d03-91c3-3ca98bf60e8a"
type: string
type:
- $ref: "#/components/schemas/IssueTeamType"
+ $ref: '#/components/schemas/IssueTeamType'
required:
- id
- type
@@ -55300,7 +55361,7 @@ components:
data:
description: Array of teams that are owners of the issue.
items:
- $ref: "#/components/schemas/IssueTeamReference"
+ $ref: '#/components/schemas/IssueTeamReference'
type: array
required:
- data
@@ -55313,7 +55374,7 @@ components:
example: "221b0179-6447-4d03-91c3-3ca98bf60e8a"
type: string
type:
- $ref: "#/components/schemas/IssueTeamType"
+ $ref: '#/components/schemas/IssueTeamType'
required:
- id
- type
@@ -55336,7 +55397,7 @@ components:
description: Update issue assignee request payload.
properties:
data:
- $ref: "#/components/schemas/IssueUpdateAssigneeRequestData"
+ $ref: '#/components/schemas/IssueUpdateAssigneeRequestData'
required:
- data
type: object
@@ -55348,7 +55409,7 @@ components:
example: "87cb11a0-278c-440a-99fe-701223c80296"
type: string
type:
- $ref: "#/components/schemas/IssueUpdateAssigneeRequestDataType"
+ $ref: '#/components/schemas/IssueUpdateAssigneeRequestDataType'
required:
- id
- type
@@ -55364,7 +55425,7 @@ components:
description: Update issue state request payload.
properties:
data:
- $ref: "#/components/schemas/IssueUpdateStateRequestData"
+ $ref: '#/components/schemas/IssueUpdateStateRequestData'
required:
- data
type: object
@@ -55372,13 +55433,13 @@ components:
description: Update issue state request.
properties:
attributes:
- $ref: "#/components/schemas/IssueUpdateStateRequestDataAttributes"
+ $ref: '#/components/schemas/IssueUpdateStateRequestDataAttributes'
id:
description: Issue identifier.
example: "c1726a66-1f64-11ee-b338-da7ad0900002"
type: string
type:
- $ref: "#/components/schemas/IssueUpdateStateRequestDataType"
+ $ref: '#/components/schemas/IssueUpdateStateRequestDataType'
required:
- id
- type
@@ -55388,7 +55449,7 @@ components:
description: Object describing an issue state update request.
properties:
state:
- $ref: "#/components/schemas/IssueState"
+ $ref: '#/components/schemas/IssueState'
required:
- state
type: object
@@ -55403,13 +55464,13 @@ components:
description: The user to whom the issue is assigned.
properties:
attributes:
- $ref: "#/components/schemas/IssueUserAttributes"
+ $ref: '#/components/schemas/IssueUserAttributes'
id:
description: User identifier.
example: "87cb11a0-278c-440a-99fe-701223c80296"
type: string
type:
- $ref: "#/components/schemas/IssueUserType"
+ $ref: '#/components/schemas/IssueUserType'
required:
- id
- type
@@ -55439,7 +55500,7 @@ components:
example: "87cb11a0-278c-440a-99fe-701223c80296"
type: string
type:
- $ref: "#/components/schemas/IssueUserType"
+ $ref: '#/components/schemas/IssueUserType'
required:
- id
- type
@@ -55455,7 +55516,7 @@ components:
description: Search issues request payload.
properties:
data:
- $ref: "#/components/schemas/IssuesSearchRequestData"
+ $ref: '#/components/schemas/IssuesSearchRequestData'
required:
- data
type: object
@@ -55463,9 +55524,9 @@ components:
description: Search issues request.
properties:
attributes:
- $ref: "#/components/schemas/IssuesSearchRequestDataAttributes"
+ $ref: '#/components/schemas/IssuesSearchRequestDataAttributes'
type:
- $ref: "#/components/schemas/IssuesSearchRequestDataType"
+ $ref: '#/components/schemas/IssuesSearchRequestDataType'
required:
- type
- attributes
@@ -55488,9 +55549,9 @@ components:
format: int64
type: integer
order_by:
- $ref: "#/components/schemas/IssuesSearchRequestDataAttributesOrderBy"
+ $ref: '#/components/schemas/IssuesSearchRequestDataAttributesOrderBy'
persona:
- $ref: "#/components/schemas/IssuesSearchRequestDataAttributesPersona"
+ $ref: '#/components/schemas/IssuesSearchRequestDataAttributesPersona'
query:
description: Search query following the event search syntax.
example: "service:orders-* AND @language:go"
@@ -55501,7 +55562,7 @@ components:
- "OPEN"
- "ACKNOWLEDGED"
items:
- $ref: "#/components/schemas/IssueState"
+ $ref: '#/components/schemas/IssueState'
maxItems: 20
type: array
team_ids:
@@ -55519,7 +55580,7 @@ components:
format: int64
type: integer
track:
- $ref: "#/components/schemas/IssuesSearchRequestDataAttributesTrack"
+ $ref: '#/components/schemas/IssuesSearchRequestDataAttributesTrack'
required:
- query
- from
@@ -55571,27 +55632,27 @@ components:
data:
description: Array of results matching the search query.
items:
- $ref: "#/components/schemas/IssuesSearchResult"
+ $ref: '#/components/schemas/IssuesSearchResult'
type: array
included:
description: Array of resources related to the search results.
items:
- $ref: "#/components/schemas/IssuesSearchResultIncluded"
+ $ref: '#/components/schemas/IssuesSearchResultIncluded'
type: array
type: object
IssuesSearchResult:
description: Result matching the search query.
properties:
attributes:
- $ref: "#/components/schemas/IssuesSearchResultAttributes"
+ $ref: '#/components/schemas/IssuesSearchResultAttributes'
id:
description: Search result identifier (matches the nested issue's identifier).
example: "c1726a66-1f64-11ee-b338-da7ad0900002"
type: string
relationships:
- $ref: "#/components/schemas/IssuesSearchResultRelationships"
+ $ref: '#/components/schemas/IssuesSearchResultRelationships'
type:
- $ref: "#/components/schemas/IssuesSearchResultType"
+ $ref: '#/components/schemas/IssuesSearchResultType'
required:
- id
- type
@@ -55619,15 +55680,15 @@ components:
IssuesSearchResultIncluded:
description: An array of related resources, returned when the `include` query parameter is used.
oneOf:
- - $ref: "#/components/schemas/Issue"
- - $ref: "#/components/schemas/IssueCase"
- - $ref: "#/components/schemas/IssueUser"
- - $ref: "#/components/schemas/IssueTeam"
+ - $ref: '#/components/schemas/Issue'
+ - $ref: '#/components/schemas/IssueCase'
+ - $ref: '#/components/schemas/IssueUser'
+ - $ref: '#/components/schemas/IssueTeam'
IssuesSearchResultIssueRelationship:
description: Relationship between the search result and the corresponding issue.
properties:
data:
- $ref: "#/components/schemas/IssueReference"
+ $ref: '#/components/schemas/IssueReference'
required:
- data
type: object
@@ -55635,7 +55696,7 @@ components:
description: Relationships between the search result and other resources.
properties:
issue:
- $ref: "#/components/schemas/IssuesSearchResultIssueRelationship"
+ $ref: '#/components/schemas/IssuesSearchResultIssueRelationship'
type: object
IssuesSearchResultType:
description: Type of the object.
@@ -55648,7 +55709,7 @@ components:
description: A single datastore item with its content and metadata.
properties:
data:
- $ref: "#/components/schemas/ItemApiPayloadData"
+ $ref: '#/components/schemas/ItemApiPayloadData'
type: object
ItemApiPayloadArray:
description: A collection of datastore items with pagination and schema metadata.
@@ -55656,7 +55717,7 @@ components:
data:
description: An array of datastore items with their content and metadata.
items:
- $ref: "#/components/schemas/ItemApiPayloadData"
+ $ref: '#/components/schemas/ItemApiPayloadData'
maxItems: 100
type: array
meta:
@@ -55669,12 +55730,12 @@ components:
description: Core data and metadata for a single datastore item.
properties:
attributes:
- $ref: "#/components/schemas/ItemApiPayloadDataAttributes"
+ $ref: '#/components/schemas/ItemApiPayloadDataAttributes'
id:
description: The unique identifier of the datastore.
type: string
type:
- $ref: "#/components/schemas/DatastoreItemsDataType"
+ $ref: '#/components/schemas/DatastoreItemsDataType'
required:
- type
type: object
@@ -55694,7 +55755,7 @@ components:
format: int64
type: integer
primary_column_name:
- $ref: "#/components/schemas/DatastoreAttributesPrimaryColumnName"
+ $ref: '#/components/schemas/DatastoreAttributesPrimaryColumnName'
signature:
description: A unique signature identifying this item version.
type: string
@@ -55702,7 +55763,7 @@ components:
description: The unique identifier of the datastore containing this item.
type: string
value:
- $ref: "#/components/schemas/ItemApiPayloadDataAttributesValue"
+ $ref: '#/components/schemas/ItemApiPayloadDataAttributesValue'
type: object
ItemApiPayloadDataAttributesValue:
additionalProperties: {}
@@ -55712,9 +55773,9 @@ components:
description: Additional metadata about a collection of datastore items, including pagination and schema information.
properties:
page:
- $ref: "#/components/schemas/ItemApiPayloadMetaPage"
+ $ref: '#/components/schemas/ItemApiPayloadMetaPage'
schema:
- $ref: "#/components/schemas/ItemApiPayloadMetaSchema"
+ $ref: '#/components/schemas/ItemApiPayloadMetaSchema'
type: object
ItemApiPayloadMetaPage:
description: Pagination information for a collection of datastore items.
@@ -55737,7 +55798,7 @@ components:
fields:
description: An array describing the columns available in this datastore.
items:
- $ref: "#/components/schemas/ItemApiPayloadMetaSchemaField"
+ $ref: '#/components/schemas/ItemApiPayloadMetaSchemaField'
type: array
primary_key:
description: The name of the primary key column for this datastore.
@@ -55770,7 +55831,7 @@ components:
description: Non-standard meta-information about the error
type: object
source:
- $ref: "#/components/schemas/JSONAPIErrorItemSource"
+ $ref: '#/components/schemas/JSONAPIErrorItemSource'
status:
description: Status code of the response.
example: "400"
@@ -55802,7 +55863,7 @@ components:
errors:
description: A list of errors.
items:
- $ref: "#/components/schemas/JSONAPIErrorItem"
+ $ref: '#/components/schemas/JSONAPIErrorItem'
type: array
required:
- errors
@@ -55844,7 +55905,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/JSSourceMapFormDataType"
+ $ref: '#/components/schemas/JSSourceMapFormDataType'
version:
description: Version of the service (1-200 characters).
example: "1.2.3"
@@ -55861,7 +55922,7 @@ components:
description: Multipart form data for uploading JavaScript source maps for browser RUM applications.
properties:
event:
- $ref: "#/components/schemas/JSSourceMapEvent"
+ $ref: '#/components/schemas/JSSourceMapEvent'
minified_file:
description: The minified JavaScript file.
example: main.min.js
@@ -55951,13 +56012,13 @@ components:
description: JavaScript source map data object.
properties:
attributes:
- $ref: "#/components/schemas/JSSourcemapAttributes"
+ $ref: '#/components/schemas/JSSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "5"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -55981,7 +56042,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/JVMMappingFileFormDataType"
+ $ref: '#/components/schemas/JVMMappingFileFormDataType'
variant:
description: Build variant (max 200 characters).
example: release
@@ -56002,7 +56063,7 @@ components:
description: Multipart form data for uploading ProGuard or R8 mapping files for Android crash deobfuscation.
properties:
event:
- $ref: "#/components/schemas/JVMMappingFileEvent"
+ $ref: '#/components/schemas/JVMMappingFileEvent'
jvm_mapping_file:
description: The ProGuard/R8 mapping file.
example: mapping.txt
@@ -56070,13 +56131,13 @@ components:
description: JVM (ProGuard/R8) mapping file data object.
properties:
attributes:
- $ref: "#/components/schemas/JVMSourcemapAttributes"
+ $ref: '#/components/schemas/JVMSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "9"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -56106,13 +56167,13 @@ components:
description: Data object for a Jira account
properties:
attributes:
- $ref: "#/components/schemas/JiraAccountAttributes"
+ $ref: '#/components/schemas/JiraAccountAttributes'
id:
description: Unique identifier for the Jira account
example: "account-1"
type: string
type:
- $ref: "#/components/schemas/JiraAccountType"
+ $ref: '#/components/schemas/JiraAccountType'
required:
- id
- type
@@ -56122,7 +56183,7 @@ components:
description: Relationship to a Jira account
properties:
data:
- $ref: "#/components/schemas/JiraAccountData"
+ $ref: '#/components/schemas/JiraAccountData'
required:
- data
type: object
@@ -56137,7 +56198,7 @@ components:
JiraAccountsData:
description: Array of Jira account data objects
items:
- $ref: "#/components/schemas/JiraAccountData"
+ $ref: '#/components/schemas/JiraAccountData'
type: array
JiraAccountsMeta:
description: Metadata for Jira accounts response
@@ -56159,7 +56220,7 @@ components:
id: "account-1"
type: jira-account
meta:
- $ref: "#/components/schemas/JiraAccountsMeta"
+ $ref: '#/components/schemas/JiraAccountsMeta'
required:
- data
type: object
@@ -56170,7 +56231,7 @@ components:
description: Array of Jira issues in this integration metadata.
example: []
items:
- $ref: "#/components/schemas/JiraIntegrationMetadataIssuesItem"
+ $ref: '#/components/schemas/JiraIntegrationMetadataIssuesItem'
type: array
required:
- issues
@@ -56207,9 +56268,9 @@ components:
nullable: true
properties:
result:
- $ref: "#/components/schemas/JiraIssueResult"
+ $ref: '#/components/schemas/JiraIssueResult'
status:
- $ref: "#/components/schemas/Case3rdPartyTicketStatus"
+ $ref: '#/components/schemas/Case3rdPartyTicketStatus'
readOnly: true
type: object
JiraIssueCreateAttributes:
@@ -56241,9 +56302,9 @@ components:
description: Jira issue creation data
properties:
attributes:
- $ref: "#/components/schemas/JiraIssueCreateAttributes"
+ $ref: '#/components/schemas/JiraIssueCreateAttributes'
type:
- $ref: "#/components/schemas/JiraIssueResourceType"
+ $ref: '#/components/schemas/JiraIssueResourceType'
required:
- type
- attributes
@@ -56252,7 +56313,7 @@ components:
description: Jira issue creation request
properties:
data:
- $ref: "#/components/schemas/JiraIssueCreateData"
+ $ref: '#/components/schemas/JiraIssueCreateData'
required:
- data
type: object
@@ -56270,9 +56331,9 @@ components:
description: Jira issue link data
properties:
attributes:
- $ref: "#/components/schemas/JiraIssueLinkAttributes"
+ $ref: '#/components/schemas/JiraIssueLinkAttributes'
type:
- $ref: "#/components/schemas/JiraIssueResourceType"
+ $ref: '#/components/schemas/JiraIssueResourceType'
required:
- type
- attributes
@@ -56281,7 +56342,7 @@ components:
description: Jira issue link request
properties:
data:
- $ref: "#/components/schemas/JiraIssueLinkData"
+ $ref: '#/components/schemas/JiraIssueLinkData'
required:
- data
type: object
@@ -56313,7 +56374,7 @@ components:
description: Request to create a Jira issue template
properties:
data:
- $ref: "#/components/schemas/JiraIssueTemplateCreateRequestData"
+ $ref: '#/components/schemas/JiraIssueTemplateCreateRequestData'
type: object
JiraIssueTemplateCreateRequestAttributes:
description: Attributes for creating a Jira issue template
@@ -56331,7 +56392,7 @@ components:
example: "12730"
type: string
jira-account:
- $ref: "#/components/schemas/JiraIssueTemplateCreateRequestAttributesJiraAccount"
+ $ref: '#/components/schemas/JiraIssueTemplateCreateRequestAttributesJiraAccount'
name:
description: The name of the issue template
example: "test-template"
@@ -56356,24 +56417,24 @@ components:
description: Data object for creating a Jira issue template
properties:
attributes:
- $ref: "#/components/schemas/JiraIssueTemplateCreateRequestAttributes"
+ $ref: '#/components/schemas/JiraIssueTemplateCreateRequestAttributes'
type:
- $ref: "#/components/schemas/JiraIssueTemplateType"
+ $ref: '#/components/schemas/JiraIssueTemplateType'
type: object
JiraIssueTemplateData:
description: Data object for a Jira issue template
properties:
attributes:
- $ref: "#/components/schemas/JiraIssueTemplateDataAttributes"
+ $ref: '#/components/schemas/JiraIssueTemplateDataAttributes'
id:
description: Unique identifier for the Jira issue template
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/JiraIssueTemplateDataRelationships"
+ $ref: '#/components/schemas/JiraIssueTemplateDataRelationships'
type:
- $ref: "#/components/schemas/JiraIssueTemplateType"
+ $ref: '#/components/schemas/JiraIssueTemplateType'
required:
- id
- type
@@ -56412,7 +56473,7 @@ components:
description: Relationships of a Jira issue template
properties:
jira-account:
- $ref: "#/components/schemas/JiraAccountRelationship"
+ $ref: '#/components/schemas/JiraAccountRelationship'
required:
- jira-account
type: object
@@ -56420,9 +56481,9 @@ components:
description: Response containing a single Jira issue template
properties:
data:
- $ref: "#/components/schemas/JiraIssueTemplateData"
+ $ref: '#/components/schemas/JiraIssueTemplateData'
included:
- $ref: "#/components/schemas/JiraAccountsData"
+ $ref: '#/components/schemas/JiraAccountsData'
required:
- data
type: object
@@ -56438,7 +56499,7 @@ components:
description: Request to update a Jira issue template
properties:
data:
- $ref: "#/components/schemas/JiraIssueTemplateUpdateRequestData"
+ $ref: '#/components/schemas/JiraIssueTemplateUpdateRequestData'
required:
- data
type: object
@@ -56462,9 +56523,9 @@ components:
description: Data object for updating a Jira issue template
properties:
attributes:
- $ref: "#/components/schemas/JiraIssueTemplateUpdateRequestAttributes"
+ $ref: '#/components/schemas/JiraIssueTemplateUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/JiraIssueTemplateType"
+ $ref: '#/components/schemas/JiraIssueTemplateType'
required:
- type
- attributes
@@ -56472,7 +56533,7 @@ components:
JiraIssueTemplatesData:
description: Array of Jira issue template data objects
items:
- $ref: "#/components/schemas/JiraIssueTemplateData"
+ $ref: '#/components/schemas/JiraIssueTemplateData'
type: array
JiraIssueTemplatesResponse:
description: Response containing Jira issue templates
@@ -56491,7 +56552,7 @@ components:
id: "65b3341b-0680-47f9-a6d4-134db45c603e"
type: jira-issue-template
included:
- $ref: "#/components/schemas/JiraAccountsData"
+ $ref: '#/components/schemas/JiraAccountsData'
required:
- data
type: object
@@ -56508,7 +56569,7 @@ components:
description: Run a historical job response.
properties:
data:
- $ref: "#/components/schemas/JobCreateResponseData"
+ $ref: '#/components/schemas/JobCreateResponseData'
type: object
JobCreateResponseData:
description: The definition of `JobCreateResponseData` object.
@@ -56517,7 +56578,7 @@ components:
description: ID of the created job.
type: string
type:
- $ref: "#/components/schemas/HistoricalJobDataType"
+ $ref: '#/components/schemas/HistoricalJobDataType'
type: object
JobDefinition:
description: Definition of a historical job.
@@ -56525,12 +56586,12 @@ components:
calculatedFields:
description: Calculated fields.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases used for generating job results. Up to 10 cases are allowed.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
maxItems: 10
type: array
from:
@@ -56559,17 +56620,17 @@ components:
example: Excessive number of failed attempts.
type: string
options:
- $ref: "#/components/schemas/HistoricalJobOptions"
+ $ref: '#/components/schemas/HistoricalJobOptions'
queries:
description: Queries for selecting logs analyzed by the job. Up to 10 queries are allowed.
items:
- $ref: "#/components/schemas/HistoricalJobQuery"
+ $ref: '#/components/schemas/HistoricalJobQuery'
maxItems: 10
type: array
referenceTables:
description: Reference tables used in the queries.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
tags:
description: Tags for generated signals.
@@ -56581,7 +56642,7 @@ components:
description: Cases for generating results from third-party detection method. Only available for third-party detection method. Up to 10 cases are allowed.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
maxItems: 10
type: array
to:
@@ -56646,7 +56707,7 @@ components:
description: A JSON Patch operation as per RFC 6902.
properties:
op:
- $ref: "#/components/schemas/JsonPatchOperationOp"
+ $ref: '#/components/schemas/JsonPatchOperationOp'
path:
description: A JSON Pointer path (e.g., "/name", "/value/secure").
example: "/name"
@@ -56694,14 +56755,14 @@ components:
description: Schema that defines the structure of a Kind object in the Software Catalog.
properties:
attributes:
- $ref: "#/components/schemas/KindAttributes"
+ $ref: '#/components/schemas/KindAttributes'
id:
description: A read-only globally unique identifier for the entity generated by Datadog. User supplied values are ignored.
example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
minLength: 1
type: string
meta:
- $ref: "#/components/schemas/KindMetadata"
+ $ref: '#/components/schemas/KindMetadata'
type:
description: Kind.
type: string
@@ -56742,7 +56803,7 @@ components:
KindResponseData:
description: List of kind responses.
items:
- $ref: "#/components/schemas/KindData"
+ $ref: '#/components/schemas/KindData'
type: array
KindResponseMeta:
description: Kind response metadata.
@@ -56758,7 +56819,7 @@ components:
annotations:
description: List of annotations for this interaction.
items:
- $ref: "#/components/schemas/LLMObsAnnotationItem"
+ $ref: '#/components/schemas/LLMObsAnnotationItem'
type: array
can_annotate:
description: Whether the current caller can annotate this interaction.
@@ -56774,7 +56835,7 @@ components:
format: date-time
type: string
display_block:
- $ref: "#/components/schemas/LLMObsContentBlocks"
+ $ref: '#/components/schemas/LLMObsContentBlocks'
id:
description: Unique identifier of the interaction.
example: "interaction-456"
@@ -56793,7 +56854,7 @@ components:
example: "My Annotation Queue"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnyInteractionType"
+ $ref: '#/components/schemas/LLMObsAnyInteractionType'
required:
- id
- type
@@ -56809,11 +56870,11 @@ components:
description: Attributes containing an annotated interaction and its related events.
properties:
annotated_interaction:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionItem"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionItem'
events:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionEvents"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionEvents'
interaction_type:
- $ref: "#/components/schemas/LLMObsAnyInteractionType"
+ $ref: '#/components/schemas/LLMObsAnyInteractionType'
next_cursor:
description: Cursor to retrieve the next page of events. Absent when there are no more events.
example: "eyJzdGFydCI6MTAwfQ=="
@@ -56827,13 +56888,13 @@ components:
description: Data object for a single annotated interaction.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionDataAttributesResponse'
id:
description: Unique identifier of the interaction.
example: "interaction-456"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsType"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsType'
required:
- id
- type
@@ -56843,7 +56904,7 @@ components:
description: An event associated with an annotated interaction.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionEventAttributes"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionEventAttributes'
id:
description: Unique identifier of the event.
example: "span-7a1b2c3d"
@@ -56873,18 +56934,18 @@ components:
LLMObsAnnotatedInteractionEvents:
description: Page of events associated with the annotated interaction.
items:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionEvent"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionEvent'
type: array
LLMObsAnnotatedInteractionItem:
description: An interaction with its associated annotations.
oneOf:
- - $ref: "#/components/schemas/LLMObsTraceAnnotatedInteractionItem"
- - $ref: "#/components/schemas/LLMObsDisplayBlockAnnotatedInteractionItem"
+ - $ref: '#/components/schemas/LLMObsTraceAnnotatedInteractionItem'
+ - $ref: '#/components/schemas/LLMObsDisplayBlockAnnotatedInteractionItem'
LLMObsAnnotatedInteractionResponse:
description: Response containing a single annotated interaction and its related events.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionDataResponse'
required:
- data
type: object
@@ -56894,7 +56955,7 @@ components:
annotated_interactions:
description: List of annotated interactions across all queues for the requested content IDs.
items:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionByTraceItem"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionByTraceItem'
type: array
total_count:
description: Total number of annotated interactions matching the query.
@@ -56910,13 +56971,13 @@ components:
description: Data object for the cross-queue annotated interactions response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsByTraceDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsByTraceDataAttributesResponse'
id:
description: Opaque identifier for the response object.
example: "trace-query"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsByTraceType"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsByTraceType'
required:
- id
- type
@@ -56926,7 +56987,7 @@ components:
description: Response containing annotated interactions across all queues for the requested content IDs.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsByTraceDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsByTraceDataResponse'
required:
- data
type: object
@@ -56950,7 +57011,7 @@ components:
id: "interaction-456"
type: trace
items:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionItem"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionItem'
type: array
required:
- annotated_interactions
@@ -56959,13 +57020,13 @@ components:
description: Data object for annotated interactions.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsDataAttributesResponse'
id:
description: The annotation queue ID.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsType"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsType'
required:
- id
- type
@@ -56975,7 +57036,7 @@ components:
description: Response containing the annotated interactions for an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsDataResponse'
required:
- data
type: object
@@ -57005,7 +57066,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
code:
- $ref: "#/components/schemas/LLMObsAnnotationErrorCode"
+ $ref: '#/components/schemas/LLMObsAnnotationErrorCode'
error:
description: Error message.
example: "interaction not found"
@@ -57099,7 +57160,7 @@ components:
- label_schema_id: "abc-123"
value: "good"
items:
- $ref: "#/components/schemas/LLMObsAnnotationLabelValueResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationLabelValueResponse'
type: array
modified_at:
description: Timestamp when the annotation was last modified.
@@ -57129,7 +57190,7 @@ components:
- `text`: any non-empty string.
properties:
assessment:
- $ref: "#/components/schemas/LLMObsAnnotationAssessment"
+ $ref: '#/components/schemas/LLMObsAnnotationAssessment'
label_schema_id:
description: ID of the label schema this value corresponds to.
example: "abc-123"
@@ -57139,7 +57200,7 @@ components:
example: "The response was accurate and well-structured."
type: string
value:
- $ref: "#/components/schemas/LLMObsAnnotationLabelValueValue"
+ $ref: '#/components/schemas/LLMObsAnnotationLabelValueValue'
required:
- label_schema_id
- value
@@ -57153,7 +57214,7 @@ components:
has since changed.
properties:
assessment:
- $ref: "#/components/schemas/LLMObsAnnotationAssessment"
+ $ref: '#/components/schemas/LLMObsAnnotationAssessment'
label_schema_id:
description: ID of the label schema this value corresponds to.
example: "abc-123"
@@ -57167,9 +57228,9 @@ components:
example: "The response was accurate and well-structured."
type: string
type:
- $ref: "#/components/schemas/LLMObsLabelSchemaType"
+ $ref: '#/components/schemas/LLMObsLabelSchemaType'
value:
- $ref: "#/components/schemas/LLMObsAnnotationLabelValueValue"
+ $ref: '#/components/schemas/LLMObsAnnotationLabelValueValue'
required:
- label_schema_id
- value
@@ -57183,15 +57244,15 @@ components:
description: The value for this label. Must comply with the label schema type constraints.
example: 0.0
oneOf:
- - $ref: "#/components/schemas/AnyValueNumber"
- - $ref: "#/components/schemas/AnyValueString"
- - $ref: "#/components/schemas/LLMObsAnnotationLabelValueStringArray"
- - $ref: "#/components/schemas/AnyValueBoolean"
+ - $ref: '#/components/schemas/AnyValueNumber'
+ - $ref: '#/components/schemas/AnyValueString'
+ - $ref: '#/components/schemas/LLMObsAnnotationLabelValueStringArray'
+ - $ref: '#/components/schemas/AnyValueBoolean'
LLMObsAnnotationQueueDataAttributesRequest:
description: Attributes for creating an Agent Observability annotation queue.
properties:
annotation_schema:
- $ref: "#/components/schemas/LLMObsAnnotationSchema"
+ $ref: '#/components/schemas/LLMObsAnnotationSchema'
description:
description: Description of the annotation queue.
example: "Queue for annotating customer support traces"
@@ -57227,7 +57288,7 @@ components:
description: Attributes of an Agent Observability annotation queue.
properties:
annotation_schema:
- $ref: "#/components/schemas/LLMObsAnnotationSchema"
+ $ref: '#/components/schemas/LLMObsAnnotationSchema'
can_manage_access:
description: Whether the current caller can manage access for the annotation queue.
example: true
@@ -57301,9 +57362,9 @@ components:
description: Data object for creating an Agent Observability annotation queue.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueType'
required:
- type
- attributes
@@ -57312,13 +57373,13 @@ components:
description: Data object for an Agent Observability annotation queue.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueDataAttributesResponse'
id:
description: Unique identifier of the annotation queue.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueType'
required:
- id
- type
@@ -57327,13 +57388,13 @@ components:
LLMObsAnnotationQueueInteractionItem:
description: A single interaction to add to an annotation queue.
oneOf:
- - $ref: "#/components/schemas/LLMObsTraceInteractionItem"
- - $ref: "#/components/schemas/LLMObsDisplayBlockInteractionItem"
+ - $ref: '#/components/schemas/LLMObsTraceInteractionItem'
+ - $ref: '#/components/schemas/LLMObsDisplayBlockInteractionItem'
LLMObsAnnotationQueueInteractionResponseItem:
description: A single interaction result.
oneOf:
- - $ref: "#/components/schemas/LLMObsTraceInteractionResponseItem"
- - $ref: "#/components/schemas/LLMObsDisplayBlockInteractionResponseItem"
+ - $ref: '#/components/schemas/LLMObsTraceInteractionResponseItem'
+ - $ref: '#/components/schemas/LLMObsDisplayBlockInteractionResponseItem'
LLMObsAnnotationQueueInteractionsDataAttributesRequest:
description: Attributes for adding interactions to an annotation queue.
properties:
@@ -57343,7 +57404,7 @@ components:
- content_id: trace-abc-123
type: trace
items:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionItem"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionItem'
minItems: 1
type: array
required:
@@ -57360,7 +57421,7 @@ components:
id: "00000000-0000-0000-0000-000000000000"
type: trace
items:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionResponseItem"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionResponseItem'
type: array
required:
- interactions
@@ -57369,9 +57430,9 @@ components:
description: Data object for adding interactions to an annotation queue.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsType'
required:
- type
- attributes
@@ -57380,13 +57441,13 @@ components:
description: Data object for the interaction addition response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsDataAttributesResponse'
id:
description: The queue ID the interactions were added to.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsType'
required:
- id
- type
@@ -57396,7 +57457,7 @@ components:
description: Request to add interactions to an Agent Observability annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsDataRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsDataRequest'
required:
- data
type: object
@@ -57404,7 +57465,7 @@ components:
description: Response containing the result of adding interactions to an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsDataResponse'
required:
- data
type: object
@@ -57420,7 +57481,7 @@ components:
description: Attributes of an annotation queue label schema.
properties:
annotation_schema:
- $ref: "#/components/schemas/LLMObsAnnotationSchema"
+ $ref: '#/components/schemas/LLMObsAnnotationSchema'
required:
- annotation_schema
type: object
@@ -57428,13 +57489,13 @@ components:
description: Data object for an annotation queue label schema.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaAttributes"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaAttributes'
id:
description: Unique identifier of the annotation queue.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueType'
required:
- id
- type
@@ -57444,7 +57505,7 @@ components:
description: Response containing the label schema of an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaData"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaData'
required:
- data
type: object
@@ -57452,7 +57513,7 @@ components:
description: Attributes for updating an annotation queue label schema.
properties:
annotation_schema:
- $ref: "#/components/schemas/LLMObsAnnotationSchema"
+ $ref: '#/components/schemas/LLMObsAnnotationSchema'
required:
- annotation_schema
type: object
@@ -57460,9 +57521,9 @@ components:
description: Data object for updating an annotation queue label schema.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateAttributes"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateAttributes'
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueType'
required:
- type
- attributes
@@ -57471,7 +57532,7 @@ components:
description: Request to update the label schema of an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateData"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateData'
required:
- data
type: object
@@ -57479,7 +57540,7 @@ components:
description: Request to create an Agent Observability annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueDataRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueDataRequest'
required:
- data
type: object
@@ -57487,7 +57548,7 @@ components:
description: Response containing a single Agent Observability annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueDataResponse'
required:
- data
type: object
@@ -57503,7 +57564,7 @@ components:
description: Attributes for updating an Agent Observability annotation queue. All fields are optional.
properties:
annotation_schema:
- $ref: "#/components/schemas/LLMObsAnnotationSchema"
+ $ref: '#/components/schemas/LLMObsAnnotationSchema'
description:
description: Updated description of the annotation queue.
example: "Updated description"
@@ -57532,9 +57593,9 @@ components:
description: Data object for updating an Agent Observability annotation queue.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationQueueUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueUpdateDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueType'
required:
- type
- attributes
@@ -57543,7 +57604,7 @@ components:
description: Request to update an Agent Observability annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationQueueUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueUpdateDataRequest'
required:
- data
type: object
@@ -57553,7 +57614,7 @@ components:
data:
description: List of annotation queues.
items:
- $ref: "#/components/schemas/LLMObsAnnotationQueueDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueDataResponse'
type: array
required:
- data
@@ -57564,7 +57625,7 @@ components:
label_schemas:
description: List of label schema definitions.
items:
- $ref: "#/components/schemas/LLMObsLabelSchema"
+ $ref: '#/components/schemas/LLMObsLabelSchema'
type: array
required:
- label_schemas
@@ -57575,7 +57636,7 @@ components:
annotations:
description: List of annotations to create or update. Must contain at least one item.
items:
- $ref: "#/components/schemas/LLMObsUpsertAnnotationItem"
+ $ref: '#/components/schemas/LLMObsUpsertAnnotationItem'
minItems: 1
type: array
required:
@@ -57587,12 +57648,12 @@ components:
annotations:
description: Successfully created or updated annotations.
items:
- $ref: "#/components/schemas/LLMObsAnnotationItemResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationItemResponse'
type: array
errors:
description: Partial errors for annotations that could not be processed.
items:
- $ref: "#/components/schemas/LLMObsAnnotationError"
+ $ref: '#/components/schemas/LLMObsAnnotationError'
type: array
required:
- annotations
@@ -57601,9 +57662,9 @@ components:
description: Data object for creating or updating annotations.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationsType"
+ $ref: '#/components/schemas/LLMObsAnnotationsType'
required:
- type
- attributes
@@ -57612,13 +57673,13 @@ components:
description: Data object for the annotations response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsAnnotationsDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationsDataAttributesResponse'
id:
description: The annotation queue ID.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotationsType"
+ $ref: '#/components/schemas/LLMObsAnnotationsType'
required:
- id
- type
@@ -57628,7 +57689,7 @@ components:
description: Request to create or update annotations on interactions in an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationsDataRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationsDataRequest'
required:
- data
type: object
@@ -57636,7 +57697,7 @@ components:
description: Response containing the created or updated annotations.
properties:
data:
- $ref: "#/components/schemas/LLMObsAnnotationsDataResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationsDataResponse'
required:
- data
type: object
@@ -57667,7 +57728,7 @@ components:
description: Anthropic-specific metadata for an inference request.
properties:
effort:
- $ref: "#/components/schemas/LLMObsAnthropicEffort"
+ $ref: '#/components/schemas/LLMObsAnthropicEffort'
thinking:
$ref: "#/components/schemas/LLMObsAnthropicThinkingConfig"
nullable: true
@@ -57682,7 +57743,7 @@ components:
nullable: true
type: integer
type:
- $ref: "#/components/schemas/LLMObsAnthropicThinkingType"
+ $ref: '#/components/schemas/LLMObsAnthropicThinkingType'
required:
- type
type: object
@@ -57766,13 +57827,13 @@ components:
format: int64
type: integer
interactionType:
- $ref: "#/components/schemas/LLMObsContentBlockLLMObsTraceInteractionType"
+ $ref: '#/components/schemas/LLMObsContentBlockLLMObsTraceInteractionType'
label:
description: Optional label rendered alongside the block.
example: "Triage Instructions"
type: string
level:
- $ref: "#/components/schemas/LLMObsContentBlockHeaderLevel"
+ $ref: '#/components/schemas/LLMObsContentBlockHeaderLevel'
tileDef:
description: |-
Tile definition for a `widget` block. Required for `widget`. The
@@ -57787,13 +57848,13 @@ components:
type: line
viz: timeseries
timeFrame:
- $ref: "#/components/schemas/LLMObsContentBlockTimeFrame"
+ $ref: '#/components/schemas/LLMObsContentBlockTimeFrame'
traceId:
description: Trace identifier. Required for `llmobs_trace` blocks.
example: "69fcc2bb0000000003113989d83069ba"
type: string
type:
- $ref: "#/components/schemas/LLMObsContentBlockType"
+ $ref: '#/components/schemas/LLMObsContentBlockType'
url:
description: URL of the image. Required for `image` blocks.
example: "https://example.com/image.png"
@@ -57871,16 +57932,16 @@ components:
List of content blocks that make up a `display_block` interaction.
Must contain at least one block.
items:
- $ref: "#/components/schemas/LLMObsContentBlock"
+ $ref: '#/components/schemas/LLMObsContentBlock'
minItems: 1
type: array
LLMObsCreatePromptData:
description: Data object for creating an Agent Observability prompt.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsCreatePromptDataAttributes"
+ $ref: '#/components/schemas/LLMObsCreatePromptDataAttributes'
type:
- $ref: "#/components/schemas/LLMObsPromptType"
+ $ref: '#/components/schemas/LLMObsPromptType'
required:
- type
- attributes
@@ -57903,7 +57964,7 @@ components:
description: >-
Optional labels to attach to the first version. Do not use this attribute for new integrations.
items:
- $ref: "#/components/schemas/LLMObsPromptVersionLabel"
+ $ref: '#/components/schemas/LLMObsPromptVersionLabel'
type: array
prompt_id:
description: Customer-provided identifier for the new prompt.
@@ -57911,7 +57972,7 @@ components:
minLength: 1
type: string
template:
- $ref: "#/components/schemas/LLMObsPromptTemplate"
+ $ref: '#/components/schemas/LLMObsPromptTemplate'
title:
description: Optional title of the prompt.
type: string
@@ -57926,7 +57987,7 @@ components:
description: Request to create an Agent Observability prompt.
properties:
data:
- $ref: "#/components/schemas/LLMObsCreatePromptData"
+ $ref: '#/components/schemas/LLMObsCreatePromptData'
required:
- data
type: object
@@ -57934,9 +57995,9 @@ components:
description: Data object for creating an Agent Observability prompt version.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsCreatePromptVersionDataAttributes"
+ $ref: '#/components/schemas/LLMObsCreatePromptVersionDataAttributes'
type:
- $ref: "#/components/schemas/LLMObsPromptVersionType"
+ $ref: '#/components/schemas/LLMObsPromptVersionType'
required:
- type
- attributes
@@ -57958,10 +58019,10 @@ components:
deprecated: true
description: Optional labels to attach to this version. Do not use this attribute for new integrations.
items:
- $ref: "#/components/schemas/LLMObsPromptVersionLabel"
+ $ref: '#/components/schemas/LLMObsPromptVersionLabel'
type: array
template:
- $ref: "#/components/schemas/LLMObsPromptTemplate"
+ $ref: '#/components/schemas/LLMObsPromptTemplate'
user_version:
description: Optional user-supplied version identifier for this version.
type: string
@@ -57972,7 +58033,7 @@ components:
description: Request to create a new version of an Agent Observability prompt.
properties:
data:
- $ref: "#/components/schemas/LLMObsCreatePromptVersionData"
+ $ref: '#/components/schemas/LLMObsCreatePromptVersionData'
required:
- data
type: object
@@ -58028,19 +58089,19 @@ components:
format: date-time
type: string
created_by:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigUser"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigUser'
eval_name:
description: Name of the custom evaluator.
example: "my-custom-evaluator"
type: string
last_updated_by:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigUser"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigUser'
llm_judge_config:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigLLMJudgeConfig"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigLLMJudgeConfig'
llm_provider:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigLLMProvider"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigLLMProvider'
target:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigTarget"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigTarget'
updated_at:
description: Timestamp when the evaluator configuration was last updated.
example: "2024-01-15T10:30:00Z"
@@ -58067,13 +58128,13 @@ components:
description: Data object for a custom Agent Observability evaluator configuration.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigAttributes"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigAttributes'
id:
description: Unique name identifier of the evaluator configuration.
example: "my-custom-evaluator"
type: string
type:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigType"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigType'
required:
- id
- type
@@ -58147,14 +58208,14 @@ components:
description: LLM judge configuration for a custom evaluator.
properties:
assessment_criteria:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigAssessmentCriteria"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigAssessmentCriteria'
context_query:
description: Query used to extract additional context for the evaluation.
example: "@input.context"
nullable: true
type: string
inference_params:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigInferenceParams"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigInferenceParams'
last_used_library_prompt_template_name:
description: Name of the last library prompt template used.
example: "sentiment-analysis-v1"
@@ -58171,11 +58232,11 @@ components:
nullable: true
type: object
parsing_type:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigParsingType"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigParsingType'
prompt_template:
description: List of messages forming the LLM judge prompt template.
items:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigPromptMessage"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigPromptMessage'
type: array
target_query:
description: Query used to extract the target value to evaluate.
@@ -58193,19 +58254,19 @@ components:
description: LLM provider configuration for a custom evaluator.
properties:
bedrock:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigBedrockOptions"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigBedrockOptions'
integration_account_id:
description: Integration account identifier.
example: "my-account-id"
type: string
integration_provider:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigIntegrationProvider"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigIntegrationProvider'
model_name:
description: Name of the LLM model.
example: "gpt-4o"
type: string
vertex_ai:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigVertexAIOptions"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigVertexAIOptions'
type: object
LLMObsCustomEvalConfigListResponse:
description: Response containing a list of custom Agent Observability evaluator configurations.
@@ -58213,7 +58274,7 @@ components:
data:
description: List of custom evaluator configuration data objects.
items:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigData"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigData'
type: array
required:
- data
@@ -58238,7 +58299,7 @@ components:
example: "text"
type: string
value:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigPromptContentValue"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigPromptContentValue'
required:
- type
- value
@@ -58251,9 +58312,9 @@ components:
example: "What is the sentiment of this review?"
type: string
tool_call:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigPromptToolCall"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigPromptToolCall'
tool_call_result:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigPromptToolResult"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigPromptToolResult'
type: object
LLMObsCustomEvalConfigPromptMessage:
description: A message in the prompt template for a custom LLM judge evaluator.
@@ -58265,7 +58326,7 @@ components:
contents:
description: Multi-part content blocks for the message.
items:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigPromptContent"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigPromptContent'
type: array
role:
description: Role of the message author.
@@ -58318,7 +58379,7 @@ components:
description: Response containing a custom Agent Observability evaluator configuration.
properties:
data:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigData"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigData'
required:
- data
type: object
@@ -58383,11 +58444,11 @@ components:
example: "my-custom-evaluator"
type: string
llm_judge_config:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigLLMJudgeConfig"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigLLMJudgeConfig'
llm_provider:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigLLMProvider"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigLLMProvider'
target:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigTarget"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigTarget'
required:
- target
type: object
@@ -58395,13 +58456,13 @@ components:
description: Data object for creating or updating a custom Agent Observability evaluator configuration.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigUpdateAttributes"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigUpdateAttributes'
id:
description: Name of the evaluator. If provided, must match the eval_name path parameter.
example: "my-custom-evaluator"
type: string
type:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigType"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigType'
required:
- type
- attributes
@@ -58410,7 +58471,7 @@ components:
description: Request to create or update a custom Agent Observability evaluator configuration.
properties:
data:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigUpdateData"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigUpdateData'
required:
- data
type: object
@@ -58442,25 +58503,25 @@ components:
example: true
type: boolean
delete_records:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateDeleteRecords"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateDeleteRecords'
insert_records:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateInsertRecords"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateInsertRecords'
tags:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagsList"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagsList'
update_records:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateUpdateRecords"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateUpdateRecords'
type: object
LLMObsDatasetBatchUpdateDataRequest:
description: Data object for batch-updating records in an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateDataAttributesRequest'
id:
description: Unique identifier of the dataset.
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- id
- type
@@ -58476,34 +58537,34 @@ components:
description: A record to insert as part of a batch update on an Agent Observability dataset.
properties:
expected_output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
id:
description: Optional user-provided identifier for the record. If omitted, the server generates an identifier.
example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c"
type: string
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
metadata:
additionalProperties: {}
description: Arbitrary metadata associated with the record.
type: object
tag_operations:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagOperations"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagOperations'
tags:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagsList"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagsList'
required:
- input
type: object
LLMObsDatasetBatchUpdateInsertRecords:
description: Records to insert.
items:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateInsertRecord"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateInsertRecord'
type: array
LLMObsDatasetBatchUpdateRequest:
description: Request to batch-insert, update, and delete records in an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateDataRequest'
required:
- data
type: object
@@ -58511,26 +58572,26 @@ components:
description: A record update payload as part of a batch update on an Agent Observability dataset.
properties:
expected_output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
id:
description: Unique identifier of the record to update.
example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c"
type: string
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
metadata:
additionalProperties: {}
description: Updated metadata associated with the record.
type: object
tag_operations:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagOperations"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagOperations'
required:
- id
type: object
LLMObsDatasetBatchUpdateUpdateRecords:
description: Records to update by ID.
items:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateUpdateRecord"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateUpdateRecord'
type: array
LLMObsDatasetCloneDataAttributesRequest:
description: Attributes for cloning an Agent Observability dataset.
@@ -58550,13 +58611,13 @@ components:
description: Data object for cloning an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetCloneDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetCloneDataAttributesRequest'
id:
description: Identifier of the source dataset to clone.
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- id
- type
@@ -58566,7 +58627,7 @@ components:
description: Request to clone an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetCloneDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetCloneDataRequest'
required:
- data
type: object
@@ -58631,9 +58692,9 @@ components:
description: Data object for creating an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- type
- attributes
@@ -58642,13 +58703,13 @@ components:
description: Data object for an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDataAttributesResponse'
id:
description: Unique identifier of the dataset.
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- id
- type
@@ -58658,13 +58719,13 @@ components:
description: Data object for an Agent Observability dataset draft state.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateDataAttributes"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateDataAttributes'
id:
description: Unique identifier of the dataset draft state. Matches the dataset ID.
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateType"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateType'
required:
- id
- type
@@ -58679,7 +58740,7 @@ components:
format: date-time
type: string
user:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateUser"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateUser'
required:
- user
- drafting_since
@@ -58688,7 +58749,7 @@ components:
description: Response containing the draft state of an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateData"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateData'
required:
- data
type: object
@@ -58748,13 +58809,13 @@ components:
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
expected_output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
id:
description: Unique identifier of the record.
example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c"
type: string
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
metadata:
additionalProperties: {}
description: Arbitrary metadata associated with the record.
@@ -58778,9 +58839,9 @@ components:
description: A single record to append to an Agent Observability dataset.
properties:
expected_output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
metadata:
additionalProperties: {}
description: Arbitrary metadata associated with the record.
@@ -58792,11 +58853,11 @@ components:
description: Explicit tag operations for updating records. Operations are applied in order, Remove then Add then Set. `set` is the final override; if specified, the result of `remove` and `add` is discarded.
properties:
add:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagsList"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagsList'
remove:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagsList"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagsList'
set:
- $ref: "#/components/schemas/LLMObsDatasetRecordTagsList"
+ $ref: '#/components/schemas/LLMObsDatasetRecordTagsList'
type: object
LLMObsDatasetRecordTagsList:
description: List of tag strings.
@@ -58808,13 +58869,13 @@ components:
description: A record update payload for an Agent Observability dataset.
properties:
expected_output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
id:
description: Unique identifier of the record to update.
example: "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c"
type: string
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
metadata:
additionalProperties: {}
description: Updated metadata associated with the record.
@@ -58831,7 +58892,7 @@ components:
records:
description: List of records to append to the dataset.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordItem"
+ $ref: '#/components/schemas/LLMObsDatasetRecordItem'
type: array
required:
- records
@@ -58840,9 +58901,9 @@ components:
description: Data object for appending records to an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetRecordsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsRecordType"
+ $ref: '#/components/schemas/LLMObsRecordType'
required:
- type
- attributes
@@ -58853,10 +58914,10 @@ components:
data:
description: List of dataset records.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordDataResponse'
type: array
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -58866,7 +58927,7 @@ components:
records:
description: List of affected dataset records.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordDataResponse'
type: array
required:
- records
@@ -58877,7 +58938,7 @@ components:
data:
description: List of affected dataset records.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordsMutationData"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsMutationData'
type: array
required:
- data
@@ -58886,7 +58947,7 @@ components:
description: Request to append records to an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetRecordsDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsDataRequest'
required:
- data
type: object
@@ -58896,7 +58957,7 @@ components:
records:
description: List of records to update.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordUpdateItem"
+ $ref: '#/components/schemas/LLMObsDatasetRecordUpdateItem'
type: array
required:
- records
@@ -58905,9 +58966,9 @@ components:
description: Data object for updating records in an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsRecordType"
+ $ref: '#/components/schemas/LLMObsRecordType'
required:
- type
- attributes
@@ -58916,7 +58977,7 @@ components:
description: Request to update records in an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateDataRequest'
required:
- data
type: object
@@ -58932,7 +58993,7 @@ components:
description: Request to create an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetDataRequest'
required:
- data
type: object
@@ -58940,7 +59001,7 @@ components:
description: Response containing a single Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDataResponse'
required:
- data
type: object
@@ -58960,13 +59021,13 @@ components:
description: Data object for restoring an Agent Observability dataset to a previous version.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetRestoreVersionDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRestoreVersionDataAttributesRequest'
id:
description: Unique identifier of the dataset to restore.
example: "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- id
- type
@@ -58976,7 +59037,7 @@ components:
description: Request to restore an Agent Observability dataset to a previous version.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetRestoreVersionDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRestoreVersionDataRequest'
required:
- data
type: object
@@ -59006,9 +59067,9 @@ components:
description: Data object for updating an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDatasetUpdateDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- type
- attributes
@@ -59017,7 +59078,7 @@ components:
description: Request to partially update an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsDatasetUpdateDataRequest'
required:
- data
type: object
@@ -59025,13 +59086,13 @@ components:
description: Data object for an Agent Observability dataset version.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDatasetVersionDataAttributes"
+ $ref: '#/components/schemas/LLMObsDatasetVersionDataAttributes'
id:
description: Unique identifier of the dataset version.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsDatasetVersionType"
+ $ref: '#/components/schemas/LLMObsDatasetVersionType'
required:
- id
- type
@@ -59073,14 +59134,14 @@ components:
description: Response containing the active versions of an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDatasetVersionsResponseData"
+ $ref: '#/components/schemas/LLMObsDatasetVersionsResponseData'
required:
- data
type: object
LLMObsDatasetVersionsResponseData:
description: List of dataset versions.
items:
- $ref: "#/components/schemas/LLMObsDatasetVersionData"
+ $ref: '#/components/schemas/LLMObsDatasetVersionData'
type: array
LLMObsDatasetsResponse:
description: Response containing a list of Agent Observability datasets.
@@ -59088,10 +59149,10 @@ components:
data:
description: List of datasets.
items:
- $ref: "#/components/schemas/LLMObsDatasetDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDataResponse'
type: array
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -59130,9 +59191,9 @@ components:
description: Data object for deleting interactions from an annotation queue.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsType"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsType'
required:
- type
- attributes
@@ -59141,7 +59202,7 @@ components:
description: Request to delete interactions from an Agent Observability annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsDataRequest'
required:
- data
type: object
@@ -59173,7 +59234,7 @@ components:
errors:
description: Errors for annotations that could not be deleted.
items:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationError"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationError'
type: array
required:
- annotation_ids
@@ -59183,9 +59244,9 @@ components:
description: Data object for deleting annotations.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsAnnotationsType"
+ $ref: '#/components/schemas/LLMObsAnnotationsType'
required:
- type
- attributes
@@ -59194,13 +59255,13 @@ components:
description: Data object for the annotation deletion response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsDataAttributesResponse'
id:
description: The annotation queue ID.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsAnnotationsType"
+ $ref: '#/components/schemas/LLMObsAnnotationsType'
required:
- id
- type
@@ -59210,7 +59271,7 @@ components:
description: Request to delete annotations from an annotation queue.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsDataRequest'
required:
- data
type: object
@@ -59220,7 +59281,7 @@ components:
response if any annotations could not be deleted.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsDataResponse"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsDataResponse'
required:
- data
type: object
@@ -59242,9 +59303,9 @@ components:
description: Data object for deleting records from an Agent Observability dataset.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsRecordType"
+ $ref: '#/components/schemas/LLMObsRecordType'
required:
- type
- attributes
@@ -59253,7 +59314,7 @@ components:
description: Request to delete records from an Agent Observability dataset.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsDataRequest'
required:
- data
type: object
@@ -59275,9 +59336,9 @@ components:
description: Data object for deleting Agent Observability datasets.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteDatasetsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsDatasetType"
+ $ref: '#/components/schemas/LLMObsDatasetType'
required:
- type
- attributes
@@ -59286,7 +59347,7 @@ components:
description: Request to delete one or more Agent Observability datasets.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteDatasetsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetsDataRequest'
required:
- data
type: object
@@ -59308,9 +59369,9 @@ components:
description: Data object for deleting Agent Observability experiments.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteExperimentsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteExperimentsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentType"
+ $ref: '#/components/schemas/LLMObsExperimentType'
required:
- type
- attributes
@@ -59319,7 +59380,7 @@ components:
description: Request to delete one or more Agent Observability experiments.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteExperimentsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteExperimentsDataRequest'
required:
- data
type: object
@@ -59341,9 +59402,9 @@ components:
description: Data object for deleting Agent Observability projects.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeleteProjectsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsDeleteProjectsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsProjectType"
+ $ref: '#/components/schemas/LLMObsProjectType'
required:
- type
- attributes
@@ -59352,7 +59413,7 @@ components:
description: Request to delete one or more Agent Observability projects.
properties:
data:
- $ref: "#/components/schemas/LLMObsDeleteProjectsDataRequest"
+ $ref: '#/components/schemas/LLMObsDeleteProjectsDataRequest'
required:
- data
type: object
@@ -59360,13 +59421,13 @@ components:
description: Data object confirming that an Agent Observability prompt was deleted.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsDeletedPromptDataAttributes"
+ $ref: '#/components/schemas/LLMObsDeletedPromptDataAttributes'
id:
description: Unique identifier of the deleted prompt.
example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: string
type:
- $ref: "#/components/schemas/LLMObsPromptType"
+ $ref: '#/components/schemas/LLMObsPromptType'
required:
- id
- type
@@ -59399,7 +59460,7 @@ components:
type: prompt-templates
properties:
data:
- $ref: "#/components/schemas/LLMObsDeletedPromptData"
+ $ref: '#/components/schemas/LLMObsDeletedPromptData'
required:
- data
type: object
@@ -59409,7 +59470,7 @@ components:
annotations:
description: List of annotations for this interaction.
items:
- $ref: "#/components/schemas/LLMObsAnnotationItem"
+ $ref: '#/components/schemas/LLMObsAnnotationItem'
type: array
can_annotate:
description: Whether the current caller can annotate this interaction.
@@ -59420,13 +59481,13 @@ components:
example: "9a87f3e2b1d4c5a6f8b3e2d1c4a7b5f6e3d2a1c4b7e5f8a3d6c2e1b4a7d5f8c2"
type: string
display_block:
- $ref: "#/components/schemas/LLMObsContentBlocks"
+ $ref: '#/components/schemas/LLMObsContentBlocks'
id:
description: Unique identifier of the interaction.
example: "interaction-456"
type: string
type:
- $ref: "#/components/schemas/LLMObsDisplayBlockInteractionType"
+ $ref: '#/components/schemas/LLMObsDisplayBlockInteractionType'
required:
- id
- type
@@ -59442,9 +59503,9 @@ components:
from the block list.
properties:
display_block:
- $ref: "#/components/schemas/LLMObsContentBlocks"
+ $ref: '#/components/schemas/LLMObsContentBlocks'
type:
- $ref: "#/components/schemas/LLMObsDisplayBlockInteractionType"
+ $ref: '#/components/schemas/LLMObsDisplayBlockInteractionType'
required:
- type
- display_block
@@ -59461,13 +59522,13 @@ components:
example: "9a87f3e2b1d4c5a6f8b3e2d1c4a7b5f6e3d2a1c4b7e5f8a3d6c2e1b4a7d5f8c2"
type: string
display_block:
- $ref: "#/components/schemas/LLMObsContentBlocks"
+ $ref: '#/components/schemas/LLMObsContentBlocks'
id:
description: Unique identifier of the interaction.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/LLMObsDisplayBlockInteractionType"
+ $ref: '#/components/schemas/LLMObsDisplayBlockInteractionType'
required:
- id
- type
@@ -59547,7 +59608,7 @@ components:
nullable: true
type: object
author:
- $ref: "#/components/schemas/LLMObsExperimentUser"
+ $ref: '#/components/schemas/LLMObsExperimentUser'
config:
additionalProperties: {}
description: Configuration parameters for the experiment.
@@ -59614,7 +59675,7 @@ components:
maximum: 2147483647
type: integer
status:
- $ref: "#/components/schemas/LLMObsExperimentStatus"
+ $ref: '#/components/schemas/LLMObsExperimentStatus'
updated_at:
description: Timestamp when the experiment was last updated.
example: "2024-01-15T10:30:00Z"
@@ -59634,9 +59695,9 @@ components:
description: Data object for creating an Agent Observability experiment.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentType"
+ $ref: '#/components/schemas/LLMObsExperimentType'
required:
- type
- attributes
@@ -59645,13 +59706,13 @@ components:
description: Data object for an Agent Observability experiment.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsExperimentDataAttributesResponse'
id:
description: Unique identifier of the experiment.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentType"
+ $ref: '#/components/schemas/LLMObsExperimentType'
required:
- id
- type
@@ -59661,7 +59722,7 @@ components:
description: An evaluation metric event associated with an experiment span.
properties:
assessment:
- $ref: "#/components/schemas/LLMObsMetricAssessment"
+ $ref: '#/components/schemas/LLMObsMetricAssessment'
boolean_value:
description: Boolean value. Present when `metric_type` is `boolean`.
nullable: true
@@ -59697,7 +59758,7 @@ components:
example: "custom"
type: string
metric_type:
- $ref: "#/components/schemas/LLMObsMetricScoreType"
+ $ref: '#/components/schemas/LLMObsMetricScoreType'
reasoning:
description: Human-readable reasoning for the metric value.
nullable: true
@@ -59732,21 +59793,21 @@ components:
metrics:
description: List of metrics to push for the experiment.
items:
- $ref: "#/components/schemas/LLMObsExperimentMetric"
+ $ref: '#/components/schemas/LLMObsExperimentMetric'
type: array
spans:
description: List of spans to push for the experiment.
items:
- $ref: "#/components/schemas/LLMObsExperimentSpan"
+ $ref: '#/components/schemas/LLMObsExperimentSpan'
type: array
type: object
LLMObsExperimentEventsDataRequest:
description: Data object for pushing experiment events.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentEventsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentEventsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsEventType"
+ $ref: '#/components/schemas/LLMObsEventType'
required:
- type
- attributes
@@ -59755,7 +59816,7 @@ components:
description: Request to push spans and metrics for an Agent Observability experiment.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentEventsDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentEventsDataRequest'
required:
- data
type: object
@@ -59773,12 +59834,12 @@ components:
spans:
description: Experiment spans, each enriched with their associated evaluation metrics.
items:
- $ref: "#/components/schemas/LLMObsExperimentSpanWithEvals"
+ $ref: '#/components/schemas/LLMObsExperimentSpanWithEvals'
type: array
summary_metrics:
description: Experiment-level summary evaluation metrics (not tied to individual spans).
items:
- $ref: "#/components/schemas/LLMObsExperimentEvalMetricEvent"
+ $ref: '#/components/schemas/LLMObsExperimentEvalMetricEvent'
type: array
required:
- spans
@@ -59788,13 +59849,13 @@ components:
description: JSON:API data object for an experiment events response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentEventsV2DataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsExperimentEventsV2DataAttributesResponse'
id:
description: Identifier for this events resource.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentEventsType"
+ $ref: '#/components/schemas/LLMObsExperimentEventsType'
required:
- id
- type
@@ -59804,9 +59865,9 @@ components:
description: Response for listing experiment events (v2/v3). Returns spans and summary metrics in a single resource.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentEventsV2DataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentEventsV2DataResponse'
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -59814,7 +59875,7 @@ components:
description: A metric associated with an Agent Observability experiment span.
properties:
assessment:
- $ref: "#/components/schemas/LLMObsMetricAssessment"
+ $ref: '#/components/schemas/LLMObsMetricAssessment'
boolean_value:
description: Boolean value. Used when `metric_type` is `boolean`.
type: boolean
@@ -59822,7 +59883,7 @@ components:
description: Categorical value. Used when `metric_type` is `categorical`.
type: string
error:
- $ref: "#/components/schemas/LLMObsExperimentMetricError"
+ $ref: '#/components/schemas/LLMObsExperimentMetricError'
json_value:
additionalProperties: {}
description: JSON value. Used when `metric_type` is `json`.
@@ -59836,7 +59897,7 @@ components:
description: Arbitrary metadata associated with the metric.
type: object
metric_type:
- $ref: "#/components/schemas/LLMObsMetricScoreType"
+ $ref: '#/components/schemas/LLMObsMetricScoreType'
reasoning:
description: Human-readable reasoning for the metric value.
type: string
@@ -59876,7 +59937,7 @@ components:
description: Request to create an Agent Observability experiment.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentDataRequest'
required:
- data
type: object
@@ -59884,7 +59945,7 @@ components:
description: Response containing a single Agent Observability experiment.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentDataResponse'
required:
- data
type: object
@@ -59929,7 +59990,7 @@ components:
format: int64
type: integer
meta:
- $ref: "#/components/schemas/LLMObsExperimentSpanMeta"
+ $ref: '#/components/schemas/LLMObsExperimentSpanMeta'
name:
description: Name of the span.
example: "llm_call"
@@ -59948,7 +60009,7 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/LLMObsExperimentSpanStatus"
+ $ref: '#/components/schemas/LLMObsExperimentSpanStatus'
tags:
description: List of tags associated with the span.
items:
@@ -59973,13 +60034,13 @@ components:
description: JSON:API data item wrapping a single experiment span with evaluations.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentSpanWithEvals"
+ $ref: '#/components/schemas/LLMObsExperimentSpanWithEvals'
id:
description: Unique identifier of the span.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentSpanType"
+ $ref: '#/components/schemas/LLMObsExperimentSpanType'
required:
- id
- type
@@ -60005,15 +60066,15 @@ components:
description: Metadata associated with an experiment span.
properties:
error:
- $ref: "#/components/schemas/LLMObsExperimentSpanError"
+ $ref: '#/components/schemas/LLMObsExperimentSpanError'
expected_output:
additionalProperties: {}
description: Expected output for the span, used for evaluation.
type: object
input:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
output:
- $ref: "#/components/schemas/AnyValue"
+ $ref: '#/components/schemas/AnyValue'
type: object
LLMObsExperimentSpanStatus:
description: Status of the span.
@@ -60048,14 +60109,14 @@ components:
eval_metrics:
description: Evaluation metrics associated with this span.
items:
- $ref: "#/components/schemas/LLMObsExperimentEvalMetricEvent"
+ $ref: '#/components/schemas/LLMObsExperimentEvalMetricEvent'
type: array
id:
description: Unique identifier of the span.
example: "00000000-0000-0000-0000-000000000001"
type: string
meta:
- $ref: "#/components/schemas/LLMObsExperimentSpanMeta"
+ $ref: '#/components/schemas/LLMObsExperimentSpanMeta'
metrics:
additionalProperties:
format: double
@@ -60079,7 +60140,7 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/LLMObsExperimentSpanStatus"
+ $ref: '#/components/schemas/LLMObsExperimentSpanStatus'
tags:
description: Tags associated with the span.
items:
@@ -60097,7 +60158,7 @@ components:
data:
description: List of experiment spans with their evaluation metrics.
items:
- $ref: "#/components/schemas/LLMObsExperimentSpanDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentSpanDataResponse'
type: array
required:
- data
@@ -60145,15 +60206,15 @@ components:
description: Updated name of the experiment.
type: string
status:
- $ref: "#/components/schemas/LLMObsExperimentStatus"
+ $ref: '#/components/schemas/LLMObsExperimentStatus'
type: object
LLMObsExperimentUpdateDataRequest:
description: Data object for updating an Agent Observability experiment.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentUpdateDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentType"
+ $ref: '#/components/schemas/LLMObsExperimentType'
required:
- type
- attributes
@@ -60162,7 +60223,7 @@ components:
description: Request to partially update an Agent Observability experiment.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentUpdateDataRequest'
required:
- data
type: object
@@ -60196,7 +60257,7 @@ components:
compute:
description: List of metric computations to perform.
items:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsCompute"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsCompute'
minItems: 1
type: array
dataset_version:
@@ -60207,7 +60268,7 @@ components:
group_by:
description: Fields to group results by.
items:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsGroupBy"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsGroupBy'
type: array
indexes:
description: Data indexes to query. At least one is required.
@@ -60225,9 +60286,9 @@ components:
nullable: true
type: integer
search:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsSearch"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsSearch'
time:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsTimeRange"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsTimeRange'
required:
- compute
- indexes
@@ -60251,7 +60312,7 @@ components:
description: Attributes for an analytics request.
properties:
aggregate:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsAggregate"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsAggregate'
required:
- aggregate
type: object
@@ -60264,7 +60325,7 @@ components:
format: int64
type: integer
result:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsResult"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsResult'
required:
- hit_count
- result
@@ -60273,9 +60334,9 @@ components:
description: Data object for an analytics request.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- type
- attributes
@@ -60284,13 +60345,13 @@ components:
description: JSON:API data object for an analytics response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsDataAttributesResponse'
id:
description: Server-generated identifier for this analytics result.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- id
- type
@@ -60310,7 +60371,7 @@ components:
description: Request to run an analytics aggregation over Agent Observability experimentation data.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsDataRequest'
required:
- data
type: object
@@ -60318,7 +60379,7 @@ components:
description: Response to an analytics query.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsDataResponse'
required:
- data
type: object
@@ -60328,7 +60389,7 @@ components:
values:
description: List of result buckets.
items:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsValue"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsValue'
type: array
required:
- values
@@ -60460,13 +60521,13 @@ components:
description: Attributes for an experimentation search request.
properties:
content_preview:
- $ref: "#/components/schemas/LLMObsExperimentationContentPreview"
+ $ref: '#/components/schemas/LLMObsExperimentationContentPreview'
filter:
- $ref: "#/components/schemas/LLMObsExperimentationFilter"
+ $ref: '#/components/schemas/LLMObsExperimentationFilter'
include:
- $ref: "#/components/schemas/LLMObsExperimentationInclude"
+ $ref: '#/components/schemas/LLMObsExperimentationInclude'
page:
- $ref: "#/components/schemas/LLMObsExperimentationCursorPage"
+ $ref: '#/components/schemas/LLMObsExperimentationCursorPage'
required:
- filter
type: object
@@ -60474,9 +60535,9 @@ components:
description: Data object for an experimentation search request.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationSearchDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- type
- attributes
@@ -60485,13 +60546,13 @@ components:
description: JSON:API data object for an experimentation search response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationSearchResults"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchResults'
id:
description: Server-generated identifier for this search result.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- id
- type
@@ -60501,7 +60562,7 @@ components:
description: Request to search across Agent Observability experimentation entities using cursor-based pagination.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationSearchDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchDataRequest'
required:
- data
type: object
@@ -60509,9 +60570,9 @@ components:
description: Response to a cursor-based experimentation search. Returns `200 OK` when all results fit in one page; `206 Partial Content` when a next-page cursor is available.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationSearchDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchDataResponse'
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -60521,31 +60582,31 @@ components:
dataset_records:
description: Matching dataset records. Present when `dataset_records` is included in `filter.scope`.
items:
- $ref: "#/components/schemas/LLMObsDatasetRecordDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordDataResponse'
nullable: true
type: array
datasets:
description: Matching datasets. Present when `datasets` is included in `filter.scope`.
items:
- $ref: "#/components/schemas/LLMObsDatasetDataResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDataResponse'
nullable: true
type: array
experiment_runs:
description: Matching experiment runs. Present when `experiment_runs` is included in `filter.scope`.
items:
- $ref: "#/components/schemas/LLMObsExperimentRunDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentRunDataResponse'
nullable: true
type: array
experiments:
description: Matching experiments. Present when `experiments` is included in `filter.scope`.
items:
- $ref: "#/components/schemas/LLMObsExperimentDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsExperimentDataAttributesResponse'
nullable: true
type: array
projects:
description: Matching projects. Present when `projects` is included in `filter.scope`.
items:
- $ref: "#/components/schemas/LLMObsProjectDataResponse"
+ $ref: '#/components/schemas/LLMObsProjectDataResponse'
nullable: true
type: array
type: object
@@ -60553,17 +60614,17 @@ components:
description: Attributes for an experimentation simple search request.
properties:
content_preview:
- $ref: "#/components/schemas/LLMObsExperimentationContentPreview"
+ $ref: '#/components/schemas/LLMObsExperimentationContentPreview'
filter:
- $ref: "#/components/schemas/LLMObsExperimentationFilter"
+ $ref: '#/components/schemas/LLMObsExperimentationFilter'
include:
- $ref: "#/components/schemas/LLMObsExperimentationInclude"
+ $ref: '#/components/schemas/LLMObsExperimentationInclude'
page:
- $ref: "#/components/schemas/LLMObsExperimentationNumberPage"
+ $ref: '#/components/schemas/LLMObsExperimentationNumberPage'
sort:
description: Sort order for results.
items:
- $ref: "#/components/schemas/LLMObsExperimentationSortField"
+ $ref: '#/components/schemas/LLMObsExperimentationSortField'
type: array
required:
- filter
@@ -60572,9 +60633,9 @@ components:
description: Data object for an experimentation simple search request.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- type
- attributes
@@ -60583,13 +60644,13 @@ components:
description: JSON:API data object for a simple search response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsExperimentationSearchResults"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchResults'
id:
description: Server-generated identifier for this search result.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsExperimentationType"
+ $ref: '#/components/schemas/LLMObsExperimentationType'
required:
- id
- type
@@ -60599,7 +60660,7 @@ components:
description: Pagination metadata for a simple search response.
properties:
page:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchMetaPage"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchMetaPage'
type: object
LLMObsExperimentationSimpleSearchMetaPage:
description: Page metadata.
@@ -60633,7 +60694,7 @@ components:
description: Request to search across Agent Observability experimentation entities using offset-based pagination.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchDataRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchDataRequest'
required:
- data
type: object
@@ -60641,9 +60702,9 @@ components:
description: Response to an offset-based experimentation simple search.
properties:
data:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchDataResponse'
meta:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchMeta"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchMeta'
required:
- data
type: object
@@ -60651,7 +60712,7 @@ components:
description: A field and direction to sort results by.
properties:
direction:
- $ref: "#/components/schemas/LLMObsExperimentationSortFieldDirection"
+ $ref: '#/components/schemas/LLMObsExperimentationSortFieldDirection'
field:
description: The field name to sort on.
example: "created_at"
@@ -60683,10 +60744,10 @@ components:
data:
description: List of experiments.
items:
- $ref: "#/components/schemas/LLMObsExperimentDataResponse"
+ $ref: '#/components/schemas/LLMObsExperimentDataResponse'
type: array
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -60718,7 +60779,7 @@ components:
example: "text"
type: string
value:
- $ref: "#/components/schemas/LLMObsInferenceContentValue"
+ $ref: '#/components/schemas/LLMObsInferenceContentValue'
required:
- type
- value
@@ -60726,7 +60787,7 @@ components:
LLMObsInferenceContentList:
description: List of structured content blocks in a message.
items:
- $ref: "#/components/schemas/LLMObsInferenceContent"
+ $ref: '#/components/schemas/LLMObsInferenceContent'
type: array
LLMObsInferenceContentValue:
description: The typed value of a message content block.
@@ -60736,9 +60797,9 @@ components:
example: "Hello, how can I help you?"
type: string
tool_call:
- $ref: "#/components/schemas/LLMObsInferenceToolCall"
+ $ref: '#/components/schemas/LLMObsInferenceToolCall'
tool_call_result:
- $ref: "#/components/schemas/LLMObsInferenceToolResult"
+ $ref: '#/components/schemas/LLMObsInferenceToolResult'
type: object
LLMObsInferenceErrorResponse:
description: Error details returned when an inference provider returns an error.
@@ -60787,7 +60848,7 @@ components:
example: "What is the capital of France?"
type: string
contents:
- $ref: "#/components/schemas/LLMObsInferenceContentList"
+ $ref: '#/components/schemas/LLMObsInferenceContentList'
id:
description: Unique identifier for the message.
example: "msg_001"
@@ -60797,14 +60858,14 @@ components:
example: "user"
type: string
tool_calls:
- $ref: "#/components/schemas/LLMObsInferenceToolCallsList"
+ $ref: '#/components/schemas/LLMObsInferenceToolCallsList'
tool_results:
- $ref: "#/components/schemas/LLMObsInferenceToolResultsList"
+ $ref: '#/components/schemas/LLMObsInferenceToolResultsList'
type: object
LLMObsInferenceMessagesList:
description: List of messages in an inference conversation.
items:
- $ref: "#/components/schemas/LLMObsInferenceMessage"
+ $ref: '#/components/schemas/LLMObsInferenceMessage'
type: array
LLMObsInferenceRunResult:
description: The output of a completed LLM inference call.
@@ -60823,7 +60884,7 @@ components:
example: "stop"
type: string
inference_codes:
- $ref: "#/components/schemas/LLMObsIntegrationInferenceCodesResponse"
+ $ref: '#/components/schemas/LLMObsIntegrationInferenceCodesResponse'
input_tokens:
description: Number of input tokens consumed.
example: 15
@@ -60843,7 +60904,7 @@ components:
format: int64
type: integer
tools:
- $ref: "#/components/schemas/LLMObsInferenceToolsList"
+ $ref: '#/components/schemas/LLMObsInferenceToolsList'
total_tokens:
description: Total tokens used (input plus output).
example: 25
@@ -60864,7 +60925,7 @@ components:
description: A tool definition available to the model during inference.
properties:
function:
- $ref: "#/components/schemas/LLMObsInferenceFunction"
+ $ref: '#/components/schemas/LLMObsInferenceFunction'
type:
description: The type of tool.
example: "function"
@@ -60898,7 +60959,7 @@ components:
LLMObsInferenceToolCallsList:
description: List of tool calls in a message.
items:
- $ref: "#/components/schemas/LLMObsInferenceToolCall"
+ $ref: '#/components/schemas/LLMObsInferenceToolCall'
type: array
LLMObsInferenceToolResult:
description: The result returned by a tool call during LLM inference.
@@ -60923,12 +60984,12 @@ components:
LLMObsInferenceToolResultsList:
description: List of tool results in a message.
items:
- $ref: "#/components/schemas/LLMObsInferenceToolResult"
+ $ref: '#/components/schemas/LLMObsInferenceToolResult'
type: array
LLMObsInferenceToolsList:
description: List of tools available to the model.
items:
- $ref: "#/components/schemas/LLMObsInferenceTool"
+ $ref: '#/components/schemas/LLMObsInferenceTool'
type: array
LLMObsIntegrationAccount:
description: A configured account for an LLM provider integration.
@@ -60946,7 +61007,7 @@ components:
example: "us-east-1"
type: string
azure_openai_metadata:
- $ref: "#/components/schemas/LLMObsAzureOpenAIMetadata"
+ $ref: '#/components/schemas/LLMObsAzureOpenAIMetadata'
id:
description: Unique identifier for the integration account.
example: "account-abc123"
@@ -60956,7 +61017,7 @@ components:
example: openai
type: string
vertex_ai_metadata:
- $ref: "#/components/schemas/LLMObsVertexAIMetadata"
+ $ref: '#/components/schemas/LLMObsVertexAIMetadata'
required:
- id
- account_id
@@ -60966,7 +61027,7 @@ components:
LLMObsIntegrationInferenceCodesResponse:
description: List of generated code snippets for the inference configuration.
items:
- $ref: "#/components/schemas/LLMObsInferenceCode"
+ $ref: '#/components/schemas/LLMObsInferenceCode'
type: array
LLMObsIntegrationInferenceRequest:
description: Parameters for an LLM inference request.
@@ -61004,7 +61065,7 @@ components:
nullable: true
type: integer
messages:
- $ref: "#/components/schemas/LLMObsInferenceMessagesList"
+ $ref: '#/components/schemas/LLMObsInferenceMessagesList'
model_id:
description: The model identifier to use for inference.
example: "gpt-4o"
@@ -61025,7 +61086,7 @@ components:
nullable: true
type: number
tools:
- $ref: "#/components/schemas/LLMObsInferenceToolsList"
+ $ref: '#/components/schemas/LLMObsInferenceToolsList'
top_k:
description: Top-K sampling parameter.
example: 50
@@ -61058,7 +61119,7 @@ components:
$ref: "#/components/schemas/LLMObsBedrockMetadata"
nullable: true
error_response:
- $ref: "#/components/schemas/LLMObsInferenceErrorResponse"
+ $ref: '#/components/schemas/LLMObsInferenceErrorResponse'
frequency_penalty:
description: Frequency penalty that was applied.
example: 0.0
@@ -61083,7 +61144,7 @@ components:
nullable: true
type: integer
messages:
- $ref: "#/components/schemas/LLMObsInferenceMessagesList"
+ $ref: '#/components/schemas/LLMObsInferenceMessagesList'
model_id:
description: The model identifier used for inference.
example: "gpt-4o"
@@ -61098,7 +61159,7 @@ components:
nullable: true
type: number
response:
- $ref: "#/components/schemas/LLMObsInferenceRunResult"
+ $ref: '#/components/schemas/LLMObsInferenceRunResult'
temperature:
description: Sampling temperature that was used.
example: 0.7
@@ -61106,7 +61167,7 @@ components:
nullable: true
type: number
tools:
- $ref: "#/components/schemas/LLMObsInferenceToolsList"
+ $ref: '#/components/schemas/LLMObsInferenceToolsList'
top_k:
description: Top-K sampling parameter that was used.
example: 50
@@ -61167,7 +61228,7 @@ components:
example: "OpenAI"
type: string
region_prefix_overrides:
- $ref: "#/components/schemas/LLMObsIntegrationModelRegionPrefixOverrides"
+ $ref: '#/components/schemas/LLMObsIntegrationModelRegionPrefixOverrides'
required:
- id
- model_id
@@ -61266,7 +61327,7 @@ components:
example: "quality"
type: string
type:
- $ref: "#/components/schemas/LLMObsLabelSchemaType"
+ $ref: '#/components/schemas/LLMObsLabelSchemaType'
values:
description: Allowed values for categorical-type labels. Must contain at least one non-empty, unique value.
example:
@@ -61323,9 +61384,9 @@ components:
description: OpenAI-specific metadata for an inference request.
properties:
reasoning_effort:
- $ref: "#/components/schemas/LLMObsOpenAIReasoningEffort"
+ $ref: '#/components/schemas/LLMObsOpenAIReasoningEffort'
reasoning_summary:
- $ref: "#/components/schemas/LLMObsOpenAIReasoningSummary"
+ $ref: '#/components/schemas/LLMObsOpenAIReasoningSummary'
type: object
LLMObsOpenAIReasoningEffort:
description: The reasoning effort level for OpenAI models that support it.
@@ -61473,18 +61534,18 @@ components:
LLMObsPatternsClusteredPointRefsList:
description: List of clustered points attached to a topic.
items:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointRef"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointRef'
type: array
LLMObsPatternsClusteredPointsList:
description: List of clustered points.
items:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPoint"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPoint'
type: array
LLMObsPatternsClusteredPointsResponse:
description: Response containing the clustered points of an Agent Observability topic.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointsResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointsResponseData'
required:
- data
type: object
@@ -61497,7 +61558,7 @@ components:
nullable: true
type: string
points:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointsList"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointsList'
topic_id:
description: Identifier of the topic the points belong to.
example: "5c1fae90-2b6d-4e3a-9f12-7a0c4d8e6b21"
@@ -61511,13 +61572,13 @@ components:
description: Data object of an Agent Observability patterns clustered points response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointsResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointsResponseAttributes'
id:
description: Identifier of the topic the points belong to.
example: "5c1fae90-2b6d-4e3a-9f12-7a0c4d8e6b21"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointsType"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointsType'
required:
- id
- type
@@ -61683,13 +61744,13 @@ components:
LLMObsPatternsConfigItemsList:
description: List of patterns configurations.
items:
- $ref: "#/components/schemas/LLMObsPatternsConfigItem"
+ $ref: '#/components/schemas/LLMObsPatternsConfigItem'
type: array
LLMObsPatternsConfigResponse:
description: Response containing a single Agent Observability patterns configuration.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsConfigResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsConfigResponseData'
required:
- data
type: object
@@ -61697,13 +61758,13 @@ components:
description: Data object of an Agent Observability patterns configuration.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsConfigAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsConfigAttributes'
id:
description: Unique identifier of the configuration.
example: "a7c8d9e0-1234-5678-9abc-def012345678"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsConfigType"
+ $ref: '#/components/schemas/LLMObsPatternsConfigType'
required:
- id
- type
@@ -61758,7 +61819,7 @@ components:
description: Request to create or update an Agent Observability patterns configuration.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsConfigUpsertRequestData"
+ $ref: '#/components/schemas/LLMObsPatternsConfigUpsertRequestData'
required:
- data
type: object
@@ -61825,9 +61886,9 @@ components:
description: Data object for creating or updating an Agent Observability patterns configuration.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsConfigUpsertRequestAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsConfigUpsertRequestAttributes'
type:
- $ref: "#/components/schemas/LLMObsPatternsConfigType"
+ $ref: '#/components/schemas/LLMObsPatternsConfigType'
required:
- type
- attributes
@@ -61844,7 +61905,7 @@ components:
description: Response containing a list of Agent Observability patterns configurations.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsConfigsResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsConfigsResponseData'
required:
- data
type: object
@@ -61852,7 +61913,7 @@ components:
description: Attributes of a list of Agent Observability patterns configurations.
properties:
configs:
- $ref: "#/components/schemas/LLMObsPatternsConfigItemsList"
+ $ref: '#/components/schemas/LLMObsPatternsConfigItemsList'
required:
- configs
type: object
@@ -61860,13 +61921,13 @@ components:
description: Data object of a list of Agent Observability patterns configurations.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsConfigsResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsConfigsResponseAttributes'
id:
description: Identifier of the list response.
example: "1000000001"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsConfigsListType"
+ $ref: '#/components/schemas/LLMObsPatternsConfigsListType'
required:
- id
- type
@@ -61875,7 +61936,7 @@ components:
LLMObsPatternsProgressList:
description: List of step-by-step progress entries for a patterns run.
items:
- $ref: "#/components/schemas/LLMObsPatternsActivityProgress"
+ $ref: '#/components/schemas/LLMObsPatternsActivityProgress'
type: array
LLMObsPatternsRequestType:
description: Resource type for triggering an Agent Observability patterns run.
@@ -61889,7 +61950,7 @@ components:
description: Response containing the status of an Agent Observability patterns run.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsRunStatusResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsRunStatusResponseData'
required:
- data
type: object
@@ -61902,7 +61963,7 @@ components:
format: date-time
type: string
progress:
- $ref: "#/components/schemas/LLMObsPatternsProgressList"
+ $ref: '#/components/schemas/LLMObsPatternsProgressList'
status:
description: Overall status of the run.
example: running
@@ -61921,13 +61982,13 @@ components:
description: Data object of an Agent Observability patterns run status response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsRunStatusResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsRunStatusResponseAttributes'
id:
description: The ID of the patterns run.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsRunStatusType"
+ $ref: '#/components/schemas/LLMObsPatternsRunStatusType'
required:
- id
- type
@@ -61951,7 +62012,7 @@ components:
nullable: true
type: string
config_snapshot:
- $ref: "#/components/schemas/LLMObsPatternsConfigSnapshot"
+ $ref: '#/components/schemas/LLMObsPatternsConfigSnapshot'
created_at:
description: Timestamp when the run was created.
example: "2024-01-15T10:30:00Z"
@@ -61973,7 +62034,7 @@ components:
LLMObsPatternsRunsList:
description: List of patterns runs.
items:
- $ref: "#/components/schemas/LLMObsPatternsRunSummary"
+ $ref: '#/components/schemas/LLMObsPatternsRunSummary'
type: array
LLMObsPatternsRunsListType:
description: Resource type of a list of Agent Observability patterns runs.
@@ -61987,7 +62048,7 @@ components:
description: Response containing the completed runs of an Agent Observability patterns configuration.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsRunsResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsRunsResponseData'
required:
- data
type: object
@@ -61995,7 +62056,7 @@ components:
description: Attributes of an Agent Observability patterns runs response.
properties:
runs:
- $ref: "#/components/schemas/LLMObsPatternsRunsList"
+ $ref: '#/components/schemas/LLMObsPatternsRunsList'
required:
- runs
type: object
@@ -62003,13 +62064,13 @@ components:
description: Data object of an Agent Observability patterns runs response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsRunsResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsRunsResponseAttributes'
id:
description: Identifier of the configuration the runs belong to.
example: "a7c8d9e0-1234-5678-9abc-def012345678"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsRunsListType"
+ $ref: '#/components/schemas/LLMObsPatternsRunsListType'
required:
- id
- type
@@ -62080,7 +62141,7 @@ components:
clustered points attached to leaf topics.
properties:
cluster_points:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointRefsList"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointRefsList'
created_at:
description: Timestamp when the topic was created.
example: "2024-01-15T10:30:00Z"
@@ -62140,13 +62201,13 @@ components:
LLMObsPatternsTopicsList:
description: List of discovered topics.
items:
- $ref: "#/components/schemas/LLMObsPatternsTopic"
+ $ref: '#/components/schemas/LLMObsPatternsTopic'
type: array
LLMObsPatternsTopicsResponse:
description: Response containing the topics discovered by an Agent Observability patterns run.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsTopicsResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsResponseData'
required:
- data
type: object
@@ -62164,7 +62225,7 @@ components:
example: "a7c8d9e0-1234-5678-9abc-def012345678"
type: string
config_snapshot:
- $ref: "#/components/schemas/LLMObsPatternsConfigSnapshot"
+ $ref: '#/components/schemas/LLMObsPatternsConfigSnapshot'
created_at:
description: Timestamp when the run was created.
example: "2024-01-15T10:30:00Z"
@@ -62179,7 +62240,7 @@ components:
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
topics:
- $ref: "#/components/schemas/LLMObsPatternsTopicsList"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsList'
required:
- run_id
- config_id
@@ -62191,13 +62252,13 @@ components:
description: Data object of an Agent Observability patterns topics response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsTopicsResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsResponseAttributes'
id:
description: Identifier of the run the topics belong to.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsTopicsType"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsType'
required:
- id
- type
@@ -62214,7 +62275,7 @@ components:
LLMObsPatternsTopicsWithClusteredPointsList:
description: List of discovered topics with their clustered points.
items:
- $ref: "#/components/schemas/LLMObsPatternsTopicWithClusteredPoints"
+ $ref: '#/components/schemas/LLMObsPatternsTopicWithClusteredPoints'
type: array
LLMObsPatternsTopicsWithClusteredPointsResponse:
description: |-
@@ -62222,7 +62283,7 @@ components:
discovered by an Agent Observability patterns run.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponseData'
required:
- data
type: object
@@ -62240,7 +62301,7 @@ components:
example: "a7c8d9e0-1234-5678-9abc-def012345678"
type: string
config_snapshot:
- $ref: "#/components/schemas/LLMObsPatternsConfigSnapshot"
+ $ref: '#/components/schemas/LLMObsPatternsConfigSnapshot'
created_at:
description: Timestamp when the run was created.
example: "2024-01-15T10:30:00Z"
@@ -62255,7 +62316,7 @@ components:
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
topics:
- $ref: "#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsList"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsList'
required:
- run_id
- config_id
@@ -62267,13 +62328,13 @@ components:
description: Data object of an Agent Observability patterns topics-with-clustered-points response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponseAttributes'
id:
description: Identifier of the run the topics belong to.
example: "3fd6b5e0-8910-4b1c-a7d0-5b84de329012"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsType"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsType'
required:
- id
- type
@@ -62291,7 +62352,7 @@ components:
description: Request to trigger an Agent Observability patterns run.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsTriggerRequestData"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerRequestData'
required:
- data
type: object
@@ -62309,9 +62370,9 @@ components:
description: Data object for triggering an Agent Observability patterns run.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsTriggerRequestAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerRequestAttributes'
type:
- $ref: "#/components/schemas/LLMObsPatternsRequestType"
+ $ref: '#/components/schemas/LLMObsPatternsRequestType'
required:
- type
- attributes
@@ -62320,7 +62381,7 @@ components:
description: Response after triggering an Agent Observability patterns run.
properties:
data:
- $ref: "#/components/schemas/LLMObsPatternsTriggerResponseData"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerResponseData'
required:
- data
type: object
@@ -62348,13 +62409,13 @@ components:
description: Data object of an Agent Observability patterns trigger response.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPatternsTriggerResponseAttributes"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerResponseAttributes'
id:
description: The ID of the patterns configuration that was run.
example: "a7c8d9e0-1234-5678-9abc-def012345678"
type: string
type:
- $ref: "#/components/schemas/LLMObsPatternsTriggerResponseType"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerResponseType'
required:
- id
- type
@@ -62413,9 +62474,9 @@ components:
description: Data object for creating an Agent Observability project.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsProjectDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsProjectDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsProjectType"
+ $ref: '#/components/schemas/LLMObsProjectType'
required:
- type
- attributes
@@ -62424,13 +62485,13 @@ components:
description: Data object for an Agent Observability project.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsProjectDataAttributesResponse"
+ $ref: '#/components/schemas/LLMObsProjectDataAttributesResponse'
id:
description: Unique identifier of the project.
example: "a33671aa-24fd-4dcd-9b33-a8ec7dde7751"
type: string
type:
- $ref: "#/components/schemas/LLMObsProjectType"
+ $ref: '#/components/schemas/LLMObsProjectType'
required:
- id
- type
@@ -62440,7 +62501,7 @@ components:
description: Request to create an Agent Observability project.
properties:
data:
- $ref: "#/components/schemas/LLMObsProjectDataRequest"
+ $ref: '#/components/schemas/LLMObsProjectDataRequest'
required:
- data
type: object
@@ -62448,7 +62509,7 @@ components:
description: Response containing a single Agent Observability project.
properties:
data:
- $ref: "#/components/schemas/LLMObsProjectDataResponse"
+ $ref: '#/components/schemas/LLMObsProjectDataResponse'
required:
- data
type: object
@@ -62474,9 +62535,9 @@ components:
description: Data object for updating an Agent Observability project.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsProjectUpdateDataAttributesRequest"
+ $ref: '#/components/schemas/LLMObsProjectUpdateDataAttributesRequest'
type:
- $ref: "#/components/schemas/LLMObsProjectType"
+ $ref: '#/components/schemas/LLMObsProjectType'
required:
- type
- attributes
@@ -62485,7 +62546,7 @@ components:
description: Request to partially update an Agent Observability project.
properties:
data:
- $ref: "#/components/schemas/LLMObsProjectUpdateDataRequest"
+ $ref: '#/components/schemas/LLMObsProjectUpdateDataRequest'
required:
- data
type: object
@@ -62495,10 +62556,10 @@ components:
data:
description: List of projects.
items:
- $ref: "#/components/schemas/LLMObsProjectDataResponse"
+ $ref: '#/components/schemas/LLMObsProjectDataResponse'
type: array
meta:
- $ref: "#/components/schemas/LLMObsCursorMeta"
+ $ref: '#/components/schemas/LLMObsCursorMeta'
required:
- data
type: object
@@ -62520,7 +62581,7 @@ components:
LLMObsPromptChatTemplate:
description: A chat prompt template.
items:
- $ref: "#/components/schemas/LLMObsPromptChatMessage"
+ $ref: '#/components/schemas/LLMObsPromptChatMessage'
minItems: 1
type: array
x-generate-alias-as-model: true
@@ -62528,13 +62589,13 @@ components:
description: Data object for an Agent Observability prompt.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPromptDataAttributes"
+ $ref: '#/components/schemas/LLMObsPromptDataAttributes'
id:
description: Unique identifier of the prompt.
example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: string
type:
- $ref: "#/components/schemas/LLMObsPromptType"
+ $ref: '#/components/schemas/LLMObsPromptType'
required:
- id
- type
@@ -62558,7 +62619,7 @@ components:
datasets:
description: Datasets observed in runs associated with this prompt.
items:
- $ref: "#/components/schemas/LLMObsPromptDataset"
+ $ref: '#/components/schemas/LLMObsPromptDataset'
type: array
description:
description: Description of the prompt.
@@ -62596,7 +62657,7 @@ components:
example: "customer-support-assistant"
type: string
source:
- $ref: "#/components/schemas/LLMObsPromptResponseSource"
+ $ref: '#/components/schemas/LLMObsPromptResponseSource'
tags:
description: Tags observed on runs of this prompt.
items:
@@ -62644,7 +62705,7 @@ components:
type: prompt-templates
properties:
data:
- $ref: "#/components/schemas/LLMObsPromptData"
+ $ref: '#/components/schemas/LLMObsPromptData'
required:
- data
type: object
@@ -62662,13 +62723,13 @@ components:
description: Data object for a flattened Agent Observability prompt version returned for SDK consumption.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPromptSDKDataAttributes"
+ $ref: '#/components/schemas/LLMObsPromptSDKDataAttributes'
id:
description: Unique identifier of the prompt.
example: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: string
type:
- $ref: "#/components/schemas/LLMObsPromptType"
+ $ref: '#/components/schemas/LLMObsPromptType'
required:
- id
- type
@@ -62682,7 +62743,7 @@ components:
description: >-
Chat template for this prompt version, as a list of role and content messages. Omitted for text templates.
items:
- $ref: "#/components/schemas/LLMObsPromptChatMessage"
+ $ref: '#/components/schemas/LLMObsPromptChatMessage'
type: array
labels:
deprecated: true
@@ -62724,7 +62785,7 @@ components:
type: prompt-templates
properties:
data:
- $ref: "#/components/schemas/LLMObsPromptSDKData"
+ $ref: '#/components/schemas/LLMObsPromptSDKData'
required:
- data
type: object
@@ -62732,8 +62793,8 @@ components:
description: A text template or a list of chat messages.
example: "You are a helpful assistant for {{audience}}."
oneOf:
- - $ref: "#/components/schemas/LLMObsPromptTextTemplate"
- - $ref: "#/components/schemas/LLMObsPromptChatTemplate"
+ - $ref: '#/components/schemas/LLMObsPromptTextTemplate'
+ - $ref: '#/components/schemas/LLMObsPromptChatTemplate'
LLMObsPromptTextTemplate:
description: A text prompt template.
minLength: 1
@@ -62751,13 +62812,13 @@ components:
description: Data object for a specific version of an Agent Observability prompt.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPromptVersionDataAttributes"
+ $ref: '#/components/schemas/LLMObsPromptVersionDataAttributes'
id:
description: Unique identifier of the prompt version.
example: "d83ab666-61cc-5545-a83b-2424bb85467b"
type: string
type:
- $ref: "#/components/schemas/LLMObsPromptVersionType"
+ $ref: '#/components/schemas/LLMObsPromptVersionType'
required:
- id
- type
@@ -62776,7 +62837,7 @@ components:
datasets:
description: Datasets observed in runs associated with this prompt version.
items:
- $ref: "#/components/schemas/LLMObsPromptDataset"
+ $ref: '#/components/schemas/LLMObsPromptDataset'
type: array
description:
description: Description of this version.
@@ -62813,7 +62874,7 @@ components:
type: string
type: array
template:
- $ref: "#/components/schemas/LLMObsPromptTemplate"
+ $ref: '#/components/schemas/LLMObsPromptTemplate'
user_version:
description: User-supplied identifier for this version.
type: string
@@ -62846,13 +62907,13 @@ components:
description: Data object for a prompt version returned in a list.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsPromptVersionListDataAttributes"
+ $ref: '#/components/schemas/LLMObsPromptVersionListDataAttributes'
id:
description: Unique identifier of the prompt version.
example: "d83ab666-61cc-5545-a83b-2424bb85467b"
type: string
type:
- $ref: "#/components/schemas/LLMObsPromptVersionType"
+ $ref: '#/components/schemas/LLMObsPromptVersionType'
required:
- id
- type
@@ -62871,7 +62932,7 @@ components:
datasets:
description: Datasets observed in runs associated with this prompt version.
items:
- $ref: "#/components/schemas/LLMObsPromptDataset"
+ $ref: '#/components/schemas/LLMObsPromptDataset'
type: array
description:
description: Description of this version.
@@ -62946,7 +63007,7 @@ components:
type: prompt-template-versions
properties:
data:
- $ref: "#/components/schemas/LLMObsPromptVersionData"
+ $ref: '#/components/schemas/LLMObsPromptVersionData'
required:
- data
type: object
@@ -62986,7 +63047,7 @@ components:
data:
description: Prompt versions ordered from newest to oldest.
items:
- $ref: "#/components/schemas/LLMObsPromptVersionListData"
+ $ref: '#/components/schemas/LLMObsPromptVersionListData'
type: array
required:
- data
@@ -63012,7 +63073,7 @@ components:
data:
description: List of Agent Observability prompts.
items:
- $ref: "#/components/schemas/LLMObsPromptData"
+ $ref: '#/components/schemas/LLMObsPromptData'
type: array
required:
- data
@@ -63029,7 +63090,7 @@ components:
description: Request body for searching Agent Observability spans.
properties:
data:
- $ref: "#/components/schemas/LLMObsSearchSpansRequestData"
+ $ref: '#/components/schemas/LLMObsSearchSpansRequestData'
required:
- data
type: object
@@ -63037,11 +63098,11 @@ components:
description: Attributes of an Agent Observability spans search request.
properties:
filter:
- $ref: "#/components/schemas/LLMObsSpanFilter"
+ $ref: '#/components/schemas/LLMObsSpanFilter'
options:
- $ref: "#/components/schemas/LLMObsSpanSearchOptions"
+ $ref: '#/components/schemas/LLMObsSpanSearchOptions'
page:
- $ref: "#/components/schemas/LLMObsSpanPageQuery"
+ $ref: '#/components/schemas/LLMObsSpanPageQuery'
sort:
description: Sort order for the results. Use `-` prefix for descending order.
example: "-start_ns"
@@ -63051,9 +63112,9 @@ components:
description: Data object for an Agent Observability spans search request.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsSearchSpansRequestAttributes"
+ $ref: '#/components/schemas/LLMObsSearchSpansRequestAttributes'
type:
- $ref: "#/components/schemas/LLMObsSearchSpansRequestType"
+ $ref: '#/components/schemas/LLMObsSearchSpansRequestType'
required:
- type
- attributes
@@ -63076,11 +63137,11 @@ components:
type: number
evaluation:
additionalProperties:
- $ref: "#/components/schemas/LLMObsSpanEvaluationMetric"
+ $ref: '#/components/schemas/LLMObsSpanEvaluationMetric'
description: Evaluation metrics keyed by evaluator name.
type: object
input:
- $ref: "#/components/schemas/LLMObsSpanIO"
+ $ref: '#/components/schemas/LLMObsSpanIO'
intent:
description: Detected intent of the span.
type: string
@@ -63111,7 +63172,7 @@ components:
example: "llm_call"
type: string
output:
- $ref: "#/components/schemas/LLMObsSpanIO"
+ $ref: '#/components/schemas/LLMObsSpanIO'
parent_id:
description: Identifier of the parent span, if any.
type: string
@@ -63140,7 +63201,7 @@ components:
tool_definitions:
description: Tool definitions available to the span.
items:
- $ref: "#/components/schemas/LLMObsSpanToolDefinition"
+ $ref: '#/components/schemas/LLMObsSpanToolDefinition'
type: array
trace_id:
description: Trace identifier this span belongs to.
@@ -63160,13 +63221,13 @@ components:
description: A single Agent Observability span.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsSpanAttributes"
+ $ref: '#/components/schemas/LLMObsSpanAttributes'
id:
description: Unique identifier of the span.
example: "abc123def456"
type: string
type:
- $ref: "#/components/schemas/LLMObsSpanType"
+ $ref: '#/components/schemas/LLMObsSpanType'
required:
- id
- type
@@ -63245,7 +63306,7 @@ components:
messages:
description: List of messages in the input or output.
items:
- $ref: "#/components/schemas/LLMObsSpanMessage"
+ $ref: '#/components/schemas/LLMObsSpanMessage'
type: array
value:
description: Plain-text value of the input or output.
@@ -63266,12 +63327,12 @@ components:
tool_calls:
description: Tool calls made in this message.
items:
- $ref: "#/components/schemas/LLMObsSpanToolCall"
+ $ref: '#/components/schemas/LLMObsSpanToolCall'
type: array
tool_results:
description: Tool results returned in this message.
items:
- $ref: "#/components/schemas/LLMObsSpanToolResult"
+ $ref: '#/components/schemas/LLMObsSpanToolResult'
type: array
type: object
LLMObsSpanPageQuery:
@@ -63364,12 +63425,12 @@ components:
data:
description: List of spans matching the query.
items:
- $ref: "#/components/schemas/LLMObsSpanData"
+ $ref: '#/components/schemas/LLMObsSpanData'
type: array
links:
- $ref: "#/components/schemas/LLMObsSpansResponseLinks"
+ $ref: '#/components/schemas/LLMObsSpansResponseLinks'
meta:
- $ref: "#/components/schemas/LLMObsSpansResponseMeta"
+ $ref: '#/components/schemas/LLMObsSpansResponseMeta'
required:
- data
- meta
@@ -63391,7 +63452,7 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/LLMObsSpansResponsePage"
+ $ref: '#/components/schemas/LLMObsSpansResponsePage'
request_id:
description: Unique identifier for the request.
example: "req-abc123"
@@ -63420,7 +63481,7 @@ components:
annotations:
description: List of annotations for this interaction.
items:
- $ref: "#/components/schemas/LLMObsAnnotationItem"
+ $ref: '#/components/schemas/LLMObsAnnotationItem'
type: array
can_annotate:
description: Whether the current caller can annotate this interaction.
@@ -63445,7 +63506,7 @@ components:
format: date-time
type: string
type:
- $ref: "#/components/schemas/LLMObsTraceInteractionType"
+ $ref: '#/components/schemas/LLMObsTraceInteractionType'
required:
- id
- type
@@ -63463,7 +63524,7 @@ components:
example: "trace-abc-123"
type: string
type:
- $ref: "#/components/schemas/LLMObsTraceInteractionType"
+ $ref: '#/components/schemas/LLMObsTraceInteractionType'
required:
- type
- content_id
@@ -63494,7 +63555,7 @@ components:
format: date-time
type: string
type:
- $ref: "#/components/schemas/LLMObsTraceInteractionType"
+ $ref: '#/components/schemas/LLMObsTraceInteractionType'
required:
- id
- type
@@ -63519,9 +63580,9 @@ components:
description: Data object for updating an Agent Observability prompt.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsUpdatePromptDataAttributes"
+ $ref: '#/components/schemas/LLMObsUpdatePromptDataAttributes'
type:
- $ref: "#/components/schemas/LLMObsPromptType"
+ $ref: '#/components/schemas/LLMObsPromptType'
required:
- type
- attributes
@@ -63543,7 +63604,7 @@ components:
description: Request to update an Agent Observability prompt's metadata.
properties:
data:
- $ref: "#/components/schemas/LLMObsUpdatePromptData"
+ $ref: '#/components/schemas/LLMObsUpdatePromptData'
required:
- data
type: object
@@ -63551,9 +63612,9 @@ components:
description: Data object for updating an Agent Observability prompt version.
properties:
attributes:
- $ref: "#/components/schemas/LLMObsUpdatePromptVersionDataAttributes"
+ $ref: '#/components/schemas/LLMObsUpdatePromptVersionDataAttributes'
type:
- $ref: "#/components/schemas/LLMObsPromptVersionType"
+ $ref: '#/components/schemas/LLMObsPromptVersionType'
required:
- type
- attributes
@@ -63577,14 +63638,14 @@ components:
deprecated: true
description: Optional new labels for this version. Do not use this attribute for new integrations.
items:
- $ref: "#/components/schemas/LLMObsPromptVersionLabel"
+ $ref: '#/components/schemas/LLMObsPromptVersionLabel'
type: array
type: object
LLMObsUpdatePromptVersionRequest:
description: Request to update an Agent Observability prompt version's metadata or feature-flag environments.
properties:
data:
- $ref: "#/components/schemas/LLMObsUpdatePromptVersionData"
+ $ref: '#/components/schemas/LLMObsUpdatePromptVersionData'
required:
- data
type: object
@@ -63607,7 +63668,7 @@ components:
- label_schema_id: "ef56gh78"
value: "positive"
items:
- $ref: "#/components/schemas/LLMObsAnnotationLabelValue"
+ $ref: '#/components/schemas/LLMObsAnnotationLabelValue'
minItems: 1
type: array
required:
@@ -63679,7 +63740,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/LaunchDarklyAPIKeyType"
+ $ref: '#/components/schemas/LaunchDarklyAPIKeyType'
required:
- type
- api_token
@@ -63699,25 +63760,25 @@ components:
description: The `LaunchDarklyAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/LaunchDarklyAPIKeyType"
+ $ref: '#/components/schemas/LaunchDarklyAPIKeyType'
required:
- type
type: object
LaunchDarklyCredentials:
description: The definition of the `LaunchDarklyCredentials` object.
oneOf:
- - $ref: "#/components/schemas/LaunchDarklyAPIKey"
+ - $ref: '#/components/schemas/LaunchDarklyAPIKey'
LaunchDarklyCredentialsUpdate:
description: The definition of the `LaunchDarklyCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/LaunchDarklyAPIKeyUpdate"
+ - $ref: '#/components/schemas/LaunchDarklyAPIKeyUpdate'
LaunchDarklyIntegration:
description: The definition of the `LaunchDarklyIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/LaunchDarklyCredentials"
+ $ref: '#/components/schemas/LaunchDarklyCredentials'
type:
- $ref: "#/components/schemas/LaunchDarklyIntegrationType"
+ $ref: '#/components/schemas/LaunchDarklyIntegrationType'
required:
- type
- credentials
@@ -63734,9 +63795,9 @@ components:
description: The definition of the `LaunchDarklyIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/LaunchDarklyCredentialsUpdate"
+ $ref: '#/components/schemas/LaunchDarklyCredentialsUpdate'
type:
- $ref: "#/components/schemas/LaunchDarklyIntegrationType"
+ $ref: '#/components/schemas/LaunchDarklyIntegrationType'
required:
- type
type: object
@@ -63744,14 +63805,14 @@ components:
description: Encapsulates a layer resource, holding attributes like rotation details, plus relationships to the members covering that layer.
properties:
attributes:
- $ref: "#/components/schemas/LayerAttributes"
+ $ref: '#/components/schemas/LayerAttributes'
id:
description: A unique identifier for this layer.
type: string
relationships:
- $ref: "#/components/schemas/LayerRelationships"
+ $ref: '#/components/schemas/LayerRelationships'
type:
- $ref: "#/components/schemas/LayerType"
+ $ref: '#/components/schemas/LayerType'
required:
- type
type: object
@@ -63767,7 +63828,7 @@ components:
format: date-time
type: string
interval:
- $ref: "#/components/schemas/LayerAttributesInterval"
+ $ref: '#/components/schemas/LayerAttributesInterval'
name:
description: The name of this layer.
example: Weekend Layer
@@ -63775,7 +63836,7 @@ components:
restrictions:
description: An optional list of time restrictions for when this layer is in effect.
items:
- $ref: "#/components/schemas/TimeRestriction"
+ $ref: '#/components/schemas/TimeRestriction'
type: array
rotation_start:
description: The date/time when the rotation starts (ISO 8601).
@@ -63806,7 +63867,7 @@ components:
description: Holds references to objects related to the Layer entity, such as its members.
properties:
members:
- $ref: "#/components/schemas/LayerRelationshipsMembers"
+ $ref: '#/components/schemas/LayerRelationshipsMembers'
type: object
LayerRelationshipsMembers:
description: Holds an array of references to the members of a Layer, each containing member IDs.
@@ -63814,7 +63875,7 @@ components:
data:
description: The list of members who belong to this layer.
items:
- $ref: "#/components/schemas/LayerRelationshipsMembersDataItems"
+ $ref: '#/components/schemas/LayerRelationshipsMembersDataItems'
type: array
type: object
LayerRelationshipsMembersDataItems:
@@ -63827,7 +63888,7 @@ components:
example: "00000000-0000-0000-0000-000000000002"
type: string
type:
- $ref: "#/components/schemas/LayerRelationshipsMembersDataItemsType"
+ $ref: '#/components/schemas/LayerRelationshipsMembersDataItemsType'
required:
- type
- id
@@ -63856,13 +63917,13 @@ components:
description: The definition of LeakedKey object.
properties:
attributes:
- $ref: "#/components/schemas/LeakedKeyAttributes"
+ $ref: '#/components/schemas/LeakedKeyAttributes'
id:
description: The LeakedKey id.
example: "id"
type: string
type:
- $ref: "#/components/schemas/LeakedKeyType"
+ $ref: '#/components/schemas/LeakedKeyType'
required:
- attributes
- id
@@ -63917,7 +63978,7 @@ components:
The top-level response object returned by the licenses list endpoint, containing the array of supported SPDX licenses.
properties:
data:
- $ref: "#/components/schemas/LicensesListResponseData"
+ $ref: '#/components/schemas/LicensesListResponseData'
required:
- data
type: object
@@ -63925,13 +63986,13 @@ components:
description: The data object in a licenses list response, containing the list of SPDX licenses.
properties:
attributes:
- $ref: "#/components/schemas/LicensesListResponseDataAttributes"
+ $ref: '#/components/schemas/LicensesListResponseDataAttributes'
id:
description: The unique identifier for this licenses list response.
example: 0190a3d4-1234-7000-8000-000000000000
type: string
type:
- $ref: "#/components/schemas/LicensesListResponseDataType"
+ $ref: '#/components/schemas/LicensesListResponseDataType'
required:
- id
- type
@@ -63941,14 +64002,14 @@ components:
description: The attributes of the licenses list response, containing the array of SPDX licenses.
properties:
licenses:
- $ref: "#/components/schemas/LicensesListResponseDataAttributesLicenses"
+ $ref: '#/components/schemas/LicensesListResponseDataAttributesLicenses'
required:
- licenses
type: object
LicensesListResponseDataAttributesLicenses:
description: The list of SPDX licenses returned by the API.
items:
- $ref: "#/components/schemas/LicensesListResponseDataAttributesLicensesItems"
+ $ref: '#/components/schemas/LicensesListResponseDataAttributesLicensesItems'
type: array
LicensesListResponseDataAttributesLicensesItems:
description: An SPDX license entry returned by the licenses list endpoint.
@@ -64022,18 +64083,18 @@ components:
data:
description: List of API items.
items:
- $ref: "#/components/schemas/ListAPIsResponseData"
+ $ref: '#/components/schemas/ListAPIsResponseData'
type: array
meta:
- $ref: "#/components/schemas/ListAPIsResponseMeta"
+ $ref: '#/components/schemas/ListAPIsResponseMeta'
type: object
ListAPIsResponseData:
description: Data envelope for `ListAPIsResponse`.
properties:
attributes:
- $ref: "#/components/schemas/ListAPIsResponseDataAttributes"
+ $ref: '#/components/schemas/ListAPIsResponseDataAttributes'
id:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
type: object
ListAPIsResponseDataAttributes:
description: Attributes for `ListAPIsResponseData`.
@@ -64047,7 +64108,7 @@ components:
description: Metadata for `ListAPIsResponse`.
properties:
pagination:
- $ref: "#/components/schemas/ListAPIsResponseMetaPagination"
+ $ref: '#/components/schemas/ListAPIsResponseMetaPagination'
type: object
ListAPIsResponseMetaPagination:
description: Pagination metadata information for `ListAPIsResponse`.
@@ -64086,10 +64147,10 @@ components:
data:
description: An array of app key registrations.
items:
- $ref: "#/components/schemas/AppKeyRegistrationData"
+ $ref: '#/components/schemas/AppKeyRegistrationData'
type: array
meta:
- $ref: "#/components/schemas/ListAppKeyRegistrationsResponseMeta"
+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponseMeta'
type: object
ListAppKeyRegistrationsResponseMeta:
description: The definition of `ListAppKeyRegistrationsResponseMeta` object.
@@ -64111,10 +64172,10 @@ components:
data:
description: The list of app versions.
items:
- $ref: "#/components/schemas/AppVersion"
+ $ref: '#/components/schemas/AppVersion'
type: array
meta:
- $ref: "#/components/schemas/ListAppsResponseMeta"
+ $ref: '#/components/schemas/ListAppsResponseMeta'
type: object
ListApplicationKeysResponse:
description: Response for a list of application keys.
@@ -64122,15 +64183,15 @@ components:
data:
description: Array of application keys.
items:
- $ref: "#/components/schemas/PartialApplicationKey"
+ $ref: '#/components/schemas/PartialApplicationKey'
type: array
included:
description: Array of objects related to the application key.
items:
- $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem"
+ $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
type: array
meta:
- $ref: "#/components/schemas/ApplicationKeyResponseMeta"
+ $ref: '#/components/schemas/ApplicationKeyResponseMeta'
type: object
ListAppsResponse:
description: A paginated list of apps matching the specified filters and sorting.
@@ -64138,32 +64199,32 @@ components:
data:
description: An array of app definitions.
items:
- $ref: "#/components/schemas/ListAppsResponseDataItems"
+ $ref: '#/components/schemas/ListAppsResponseDataItems'
type: array
included:
description: Data on the version of the app that was published.
items:
- $ref: "#/components/schemas/Deployment"
+ $ref: '#/components/schemas/Deployment'
type: array
meta:
- $ref: "#/components/schemas/ListAppsResponseMeta"
+ $ref: '#/components/schemas/ListAppsResponseMeta'
type: object
ListAppsResponseDataItems:
description: An app definition object. This contains only basic information about the app such as ID, name, and tags.
properties:
attributes:
- $ref: "#/components/schemas/ListAppsResponseDataItemsAttributes"
+ $ref: '#/components/schemas/ListAppsResponseDataItemsAttributes'
id:
description: The ID of the app.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
meta:
- $ref: "#/components/schemas/AppMeta"
+ $ref: '#/components/schemas/AppMeta'
relationships:
- $ref: "#/components/schemas/ListAppsResponseDataItemsRelationships"
+ $ref: '#/components/schemas/ListAppsResponseDataItemsRelationships'
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -64198,13 +64259,13 @@ components:
description: The app's publication information.
properties:
deployment:
- $ref: "#/components/schemas/DeploymentRelationship"
+ $ref: '#/components/schemas/DeploymentRelationship'
type: object
ListAppsResponseMeta:
description: Pagination metadata.
properties:
page:
- $ref: "#/components/schemas/ListAppsResponseMetaPage"
+ $ref: '#/components/schemas/ListAppsResponseMetaPage'
type: object
ListAppsResponseMetaPage:
description: Information on the total number of apps, to be used for pagination.
@@ -64224,12 +64285,12 @@ components:
data:
description: List of assets SBOMs.
items:
- $ref: "#/components/schemas/SBOM"
+ $ref: '#/components/schemas/SBOM'
type: array
links:
- $ref: "#/components/schemas/Links"
+ $ref: '#/components/schemas/Links'
meta:
- $ref: "#/components/schemas/Metadata"
+ $ref: '#/components/schemas/Metadata'
required:
- data
type: object
@@ -64239,16 +64300,16 @@ components:
data:
description: An array of blueprint metadata.
items:
- $ref: "#/components/schemas/BlueprintMetadataData"
+ $ref: '#/components/schemas/BlueprintMetadataData'
type: array
type: object
ListCampaignsResponse:
description: Response containing a list of campaigns.
properties:
data:
- $ref: "#/components/schemas/ListCampaignsResponseData"
+ $ref: '#/components/schemas/ListCampaignsResponseData'
meta:
- $ref: "#/components/schemas/PaginatedResponseMeta"
+ $ref: '#/components/schemas/PaginatedResponseMeta'
required:
- data
- meta
@@ -64256,7 +64317,7 @@ components:
ListCampaignsResponseData:
description: Array of campaigns.
items:
- $ref: "#/components/schemas/CampaignResponseData"
+ $ref: '#/components/schemas/CampaignResponseData'
type: array
ListConnectionsResponse:
description: Response containing the list of all data source connections configured for an entity.
@@ -64294,18 +64355,18 @@ components:
type: list_connections_response
properties:
data:
- $ref: "#/components/schemas/ListConnectionsResponseData"
+ $ref: '#/components/schemas/ListConnectionsResponseData'
type: object
ListConnectionsResponseData:
description: The data object containing the resource type and attributes for the list connections response.
properties:
attributes:
- $ref: "#/components/schemas/ListConnectionsResponseDataAttributes"
+ $ref: '#/components/schemas/ListConnectionsResponseDataAttributes'
id:
description: Unique identifier for the list connections response resource.
type: string
type:
- $ref: "#/components/schemas/ListConnectionsResponseDataType"
+ $ref: '#/components/schemas/ListConnectionsResponseDataType'
required:
- type
type: object
@@ -64315,7 +64376,7 @@ components:
connections:
description: The list of data source connections configured for the entity.
items:
- $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems"
+ $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems'
type: array
type: object
ListConnectionsResponseDataAttributesConnectionsItems:
@@ -64331,13 +64392,13 @@ components:
fields:
description: List of custom attribute fields imported from the data source.
items:
- $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems"
+ $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems'
type: array
id:
description: Unique identifier of the connection.
type: string
join:
- $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin"
+ $ref: '#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin'
metadata:
additionalProperties:
type: string
@@ -64379,12 +64440,12 @@ components:
data:
description: Dashboard usage records, one per dashboard in the caller's organization.
items:
- $ref: "#/components/schemas/DashboardUsage"
+ $ref: '#/components/schemas/DashboardUsage'
type: array
links:
- $ref: "#/components/schemas/ListDashboardsUsageResponseLinks"
+ $ref: '#/components/schemas/ListDashboardsUsageResponseLinks'
meta:
- $ref: "#/components/schemas/ListDashboardsUsageResponseMeta"
+ $ref: '#/components/schemas/ListDashboardsUsageResponseMeta'
required:
- data
- meta
@@ -64417,19 +64478,19 @@ components:
description: Pagination metadata for a list of dashboard usage records.
properties:
page:
- $ref: "#/components/schemas/PaginationMetaPage"
+ $ref: '#/components/schemas/PaginationMetaPage'
type: object
ListDeploymentRuleResponseData:
description: Data for a list of deployment rules.
properties:
attributes:
- $ref: "#/components/schemas/ListDeploymentRulesResponseDataAttributes"
+ $ref: '#/components/schemas/ListDeploymentRulesResponseDataAttributes'
id:
description: Unique identifier of the deployment rule.
example: "1111-2222-3333-4444-555566667777"
type: string
type:
- $ref: "#/components/schemas/ListDeploymentRulesDataType"
+ $ref: '#/components/schemas/ListDeploymentRulesDataType'
required:
- type
- attributes
@@ -64449,7 +64510,7 @@ components:
rules:
description: The list of deployment rules.
items:
- $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes"
+ $ref: '#/components/schemas/DeploymentRuleResponseDataAttributes'
type: array
type: object
ListDevicesResponse:
@@ -64458,16 +64519,16 @@ components:
data:
description: The list devices response data.
items:
- $ref: "#/components/schemas/DevicesListData"
+ $ref: '#/components/schemas/DevicesListData'
type: array
meta:
- $ref: "#/components/schemas/ListDevicesResponseMetadata"
+ $ref: '#/components/schemas/ListDevicesResponseMetadata'
type: object
ListDevicesResponseMetadata:
description: Object describing meta attributes of response.
properties:
page:
- $ref: "#/components/schemas/ListDevicesResponseMetadataPage"
+ $ref: '#/components/schemas/ListDevicesResponseMetadataPage'
type: object
ListDevicesResponseMetadataPage:
description: Pagination object.
@@ -64484,41 +64545,41 @@ components:
data:
description: An array of downtimes.
items:
- $ref: "#/components/schemas/DowntimeResponseData"
+ $ref: '#/components/schemas/DowntimeResponseData'
type: array
included:
description: Array of objects related to the downtimes.
items:
- $ref: "#/components/schemas/DowntimeResponseIncludedItem"
+ $ref: '#/components/schemas/DowntimeResponseIncludedItem'
type: array
meta:
- $ref: "#/components/schemas/DowntimeMeta"
+ $ref: '#/components/schemas/DowntimeMeta'
type: object
ListEntityCatalogResponse:
description: List entity response.
properties:
data:
- $ref: "#/components/schemas/EntityResponseData"
+ $ref: '#/components/schemas/EntityResponseData'
included:
- $ref: "#/components/schemas/ListEntityCatalogResponseIncluded"
+ $ref: '#/components/schemas/ListEntityCatalogResponseIncluded'
links:
- $ref: "#/components/schemas/ListEntityCatalogResponseLinks"
+ $ref: '#/components/schemas/ListEntityCatalogResponseLinks'
meta:
- $ref: "#/components/schemas/EntityResponseMeta"
+ $ref: '#/components/schemas/EntityResponseMeta'
type: object
ListEntityCatalogResponseIncluded:
description: List entity response included.
items:
- $ref: "#/components/schemas/ListEntityCatalogResponseIncludedItem"
+ $ref: '#/components/schemas/ListEntityCatalogResponseIncludedItem'
type: array
ListEntityCatalogResponseIncludedItem:
description: List entity response included item.
oneOf:
- - $ref: "#/components/schemas/EntityResponseIncludedSchema"
- - $ref: "#/components/schemas/EntityResponseIncludedRawSchema"
- - $ref: "#/components/schemas/EntityResponseIncludedRelatedEntity"
- - $ref: "#/components/schemas/EntityResponseIncludedOncall"
- - $ref: "#/components/schemas/EntityResponseIncludedIncident"
+ - $ref: '#/components/schemas/EntityResponseIncludedSchema'
+ - $ref: '#/components/schemas/EntityResponseIncludedRawSchema'
+ - $ref: '#/components/schemas/EntityResponseIncludedRelatedEntity'
+ - $ref: '#/components/schemas/EntityResponseIncludedOncall'
+ - $ref: '#/components/schemas/EntityResponseIncludedIncident'
ListEntityCatalogResponseLinks:
description: List entity response links.
properties:
@@ -64538,10 +64599,10 @@ components:
data:
description: List of environments.
items:
- $ref: "#/components/schemas/Environment"
+ $ref: '#/components/schemas/Environment'
type: array
meta:
- $ref: "#/components/schemas/EnvironmentsPaginationMeta"
+ $ref: '#/components/schemas/EnvironmentsPaginationMeta'
required:
- data
type: object
@@ -64596,7 +64657,7 @@ components:
Resources:
description: List of groups matching the request criteria.
items:
- $ref: "#/components/schemas/ListExternalUserGroupResponseResourcesItems"
+ $ref: '#/components/schemas/ListExternalUserGroupResponseResourcesItems'
type: array
itemsPerPage:
description: Number of groups returned per page.
@@ -64643,10 +64704,10 @@ components:
members:
description: A list of members belonging to the team.
items:
- $ref: "#/components/schemas/ListExternalUserGroupResponseResourcesItemsMembersItems"
+ $ref: '#/components/schemas/ListExternalUserGroupResponseResourcesItemsMembersItems'
type: array
meta:
- $ref: "#/components/schemas/ExternalUserGroupMeta"
+ $ref: '#/components/schemas/ExternalUserGroupMeta'
schemas:
description: Group JSON Schemas.
example:
@@ -64729,7 +64790,7 @@ components:
Resources:
description: List of users matching the request criteria.
items:
- $ref: "#/components/schemas/ListExternalUsersResponseResourcesItems"
+ $ref: '#/components/schemas/ListExternalUsersResponseResourcesItems'
type: array
itemsPerPage:
description: Number of users returned per page.
@@ -64767,19 +64828,19 @@ components:
emails:
description: Email addresses for the user.
items:
- $ref: "#/components/schemas/ExternalUserEmailType"
+ $ref: '#/components/schemas/ExternalUserEmailType'
type: array
id:
description: The identifier of the resource. Not required when creating a user.
type: string
meta:
- $ref: "#/components/schemas/ExternalUserMeta"
+ $ref: '#/components/schemas/ExternalUserMeta'
name:
- $ref: "#/components/schemas/ExternalUserNameType"
+ $ref: '#/components/schemas/ExternalUserNameType'
roles:
description: Datadog roles assigned to the user. Provide the role UUID in `value` when provisioning or updating roles through SCIM.
items:
- $ref: "#/components/schemas/ExternalUserRole"
+ $ref: '#/components/schemas/ExternalUserRole'
maxItems: 50
type: array
schemas:
@@ -64803,24 +64864,24 @@ components:
data:
description: List of feature flags.
items:
- $ref: "#/components/schemas/FeatureFlagListItem"
+ $ref: '#/components/schemas/FeatureFlagListItem'
type: array
meta:
- $ref: "#/components/schemas/FeatureFlagsPaginationMeta"
+ $ref: '#/components/schemas/FeatureFlagsPaginationMeta'
required:
- data
type: object
ListFindingsData:
description: Array of findings.
items:
- $ref: "#/components/schemas/Finding"
+ $ref: '#/components/schemas/Finding'
type: array
ListFindingsMeta:
additionalProperties: false
description: Metadata for pagination.
properties:
page:
- $ref: "#/components/schemas/ListFindingsPage"
+ $ref: '#/components/schemas/ListFindingsPage'
snapshot_timestamp:
description: The point in time corresponding to the listed findings.
example: 1678721573794
@@ -64856,7 +64917,7 @@ components:
id: "abc-123-xyz"
type: finding
meta:
- $ref: "#/components/schemas/ListFindingsMeta"
+ $ref: '#/components/schemas/ListFindingsMeta'
required:
- data
- meta
@@ -64867,10 +64928,10 @@ components:
data:
description: Array containing the list of historical jobs.
items:
- $ref: "#/components/schemas/HistoricalJobResponseData"
+ $ref: '#/components/schemas/HistoricalJobResponseData'
type: array
meta:
- $ref: "#/components/schemas/HistoricalJobListMeta"
+ $ref: '#/components/schemas/HistoricalJobListMeta'
type: object
ListIntegrationsResponse:
description: Response containing information about multiple integrations.
@@ -64878,7 +64939,7 @@ components:
data:
description: Array of integration objects.
items:
- $ref: "#/components/schemas/Integration"
+ $ref: '#/components/schemas/Integration'
type: array
required:
- data
@@ -64887,13 +64948,13 @@ components:
description: Response for listing interface tags.
properties:
data:
- $ref: "#/components/schemas/ListInterfaceTagsResponseData"
+ $ref: '#/components/schemas/ListInterfaceTagsResponseData'
type: object
ListInterfaceTagsResponseData:
description: Response data for listing interface tags.
properties:
attributes:
- $ref: "#/components/schemas/ListTagsResponseDataAttributes"
+ $ref: '#/components/schemas/ListTagsResponseDataAttributes'
id:
description: The interface ID
example: example:1.2.3.4:1
@@ -64908,12 +64969,12 @@ components:
data:
description: List of investigations.
items:
- $ref: "#/components/schemas/ListInvestigationsResponseData"
+ $ref: '#/components/schemas/ListInvestigationsResponseData'
type: array
links:
- $ref: "#/components/schemas/ListInvestigationsResponseLinks"
+ $ref: '#/components/schemas/ListInvestigationsResponseLinks'
meta:
- $ref: "#/components/schemas/ListInvestigationsResponseMeta"
+ $ref: '#/components/schemas/ListInvestigationsResponseMeta'
required:
- data
- meta
@@ -64923,13 +64984,13 @@ components:
description: Data for an investigation list item.
properties:
attributes:
- $ref: "#/components/schemas/ListInvestigationsResponseDataAttributes"
+ $ref: '#/components/schemas/ListInvestigationsResponseDataAttributes'
id:
description: The unique identifier of the investigation.
example: "a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
type: string
type:
- $ref: "#/components/schemas/InvestigationType"
+ $ref: '#/components/schemas/InvestigationType'
required:
- id
- type
@@ -64982,7 +65043,7 @@ components:
description: Metadata for the list investigations response.
properties:
page:
- $ref: "#/components/schemas/ListInvestigationsResponseMetaPage"
+ $ref: '#/components/schemas/ListInvestigationsResponseMetaPage'
required:
- page
type: object
@@ -65013,9 +65074,9 @@ components:
description: List kind response.
properties:
data:
- $ref: "#/components/schemas/KindResponseData"
+ $ref: '#/components/schemas/KindResponseData'
meta:
- $ref: "#/components/schemas/KindResponseMeta"
+ $ref: '#/components/schemas/KindResponseMeta'
type: object
ListNotificationChannelsResponse:
description: Response type for listing notification channels for a user
@@ -65023,7 +65084,7 @@ components:
data:
description: Array of notification channel data objects.
items:
- $ref: "#/components/schemas/NotificationChannelData"
+ $ref: '#/components/schemas/NotificationChannelData'
type: array
type: object
ListOnCallNotificationRulesResponse:
@@ -65032,11 +65093,11 @@ components:
data:
description: Array of notification rule data objects.
items:
- $ref: "#/components/schemas/OnCallNotificationRuleData"
+ $ref: '#/components/schemas/OnCallNotificationRuleData'
type: array
included:
items:
- $ref: "#/components/schemas/OnCallNotificationRulesIncluded"
+ $ref: '#/components/schemas/OnCallNotificationRulesIncluded'
type: array
type: object
ListPersonalAccessTokensResponse:
@@ -65045,10 +65106,10 @@ components:
data:
description: Array of access tokens. Includes both personal and service access tokens.
items:
- $ref: "#/components/schemas/AccessTokenListItem"
+ $ref: '#/components/schemas/AccessTokenListItem'
type: array
meta:
- $ref: "#/components/schemas/PersonalAccessTokenResponseMeta"
+ $ref: '#/components/schemas/PersonalAccessTokenResponseMeta'
type: object
ListPipelinesResponse:
description: Represents the response payload containing a list of pipelines and associated metadata.
@@ -65056,10 +65117,10 @@ components:
data:
description: The `schema` `data`.
items:
- $ref: "#/components/schemas/ObservabilityPipelineData"
+ $ref: '#/components/schemas/ObservabilityPipelineData'
type: array
meta:
- $ref: "#/components/schemas/ListPipelinesResponseMeta"
+ $ref: '#/components/schemas/ListPipelinesResponseMeta'
required:
- data
type: object
@@ -65078,34 +65139,34 @@ components:
data:
description: List of powerpack definitions.
items:
- $ref: "#/components/schemas/PowerpackData"
+ $ref: '#/components/schemas/PowerpackData'
type: array
included:
description: Array of objects related to the users.
items:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
links:
- $ref: "#/components/schemas/PowerpackResponseLinks"
+ $ref: '#/components/schemas/PowerpackResponseLinks'
meta:
- $ref: "#/components/schemas/PowerpacksResponseMeta"
+ $ref: '#/components/schemas/PowerpacksResponseMeta'
type: object
ListRelationCatalogResponse:
description: List entity relation response.
properties:
data:
- $ref: "#/components/schemas/RelationResponseData"
+ $ref: '#/components/schemas/RelationResponseData'
included:
- $ref: "#/components/schemas/ListRelationCatalogResponseIncluded"
+ $ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
links:
- $ref: "#/components/schemas/ListRelationCatalogResponseLinks"
+ $ref: '#/components/schemas/ListRelationCatalogResponseLinks'
meta:
- $ref: "#/components/schemas/RelationResponseMeta"
+ $ref: '#/components/schemas/RelationResponseMeta'
type: object
ListRelationCatalogResponseIncluded:
description: List relation response included entities.
items:
- $ref: "#/components/schemas/EntityData"
+ $ref: '#/components/schemas/EntityData'
type: array
ListRelationCatalogResponseLinks:
description: List relation response links.
@@ -65143,12 +65204,12 @@ components:
data:
description: The rows.
items:
- $ref: "#/components/schemas/TableRowResourceData"
+ $ref: '#/components/schemas/TableRowResourceData'
type: array
links:
- $ref: "#/components/schemas/ListRowsResponseLinks"
+ $ref: '#/components/schemas/ListRowsResponseLinks'
meta:
- $ref: "#/components/schemas/ListRowsResponseMeta"
+ $ref: '#/components/schemas/ListRowsResponseMeta'
required:
- data
- links
@@ -65176,7 +65237,7 @@ components:
description: Contains pagination details, including the continuation token for fetching additional rows.
properties:
page:
- $ref: "#/components/schemas/ListRowsResponseMetaPage"
+ $ref: '#/components/schemas/ListRowsResponseMetaPage'
type: object
ListRowsResponseMetaPage:
description: Contains the continuation token for navigating to the next page of rows.
@@ -65190,26 +65251,26 @@ components:
description: Scorecard rules response.
properties:
data:
- $ref: "#/components/schemas/ListRulesResponseData"
+ $ref: '#/components/schemas/ListRulesResponseData'
links:
- $ref: "#/components/schemas/ListRulesResponseLinks"
+ $ref: '#/components/schemas/ListRulesResponseLinks'
type: object
ListRulesResponseData:
description: Array of rule details.
items:
- $ref: "#/components/schemas/ListRulesResponseDataItem"
+ $ref: '#/components/schemas/ListRulesResponseDataItem'
type: array
ListRulesResponseDataItem:
description: Rule details.
properties:
attributes:
- $ref: "#/components/schemas/RuleAttributes"
+ $ref: '#/components/schemas/RuleAttributes'
id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
relationships:
- $ref: "#/components/schemas/RelationshipToRule"
+ $ref: '#/components/schemas/RelationshipToRule'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
ListRulesResponseLinks:
description: Links attributes.
@@ -65253,7 +65314,7 @@ components:
Resources:
description: List of resource types supported by this SCIM service provider.
items:
- $ref: "#/components/schemas/SCIMResourceType"
+ $ref: '#/components/schemas/SCIMResourceType'
type: array
itemsPerPage:
description: Number of resource types returned per page.
@@ -65307,7 +65368,7 @@ components:
Resources:
description: List of schemas supported by this SCIM service provider.
items:
- $ref: "#/components/schemas/SCIMSchema"
+ $ref: '#/components/schemas/SCIMSchema'
type: array
itemsPerPage:
description: Number of schemas returned per page.
@@ -65362,25 +65423,25 @@ components:
data:
description: Array of score objects.
items:
- $ref: "#/components/schemas/ScorecardScoreData"
+ $ref: '#/components/schemas/ScorecardScoreData'
type: array
links:
- $ref: "#/components/schemas/ListRulesResponseLinks"
+ $ref: '#/components/schemas/ListRulesResponseLinks'
meta:
- $ref: "#/components/schemas/ListScorecardScoresMeta"
+ $ref: '#/components/schemas/ListScorecardScoresMeta'
type: object
ListScorecardsResponse:
description: Response containing a list of scorecards.
properties:
data:
- $ref: "#/components/schemas/ListScorecardsResponseData"
+ $ref: '#/components/schemas/ListScorecardsResponseData'
required:
- data
type: object
ListScorecardsResponseData:
description: Array of scorecards.
items:
- $ref: "#/components/schemas/ScorecardListResponseData"
+ $ref: '#/components/schemas/ScorecardListResponseData'
type: array
ListSecurityFindingsResponse:
description: The expected response schema when listing security findings.
@@ -65388,12 +65449,12 @@ components:
data:
description: Array of security findings matching the search query.
items:
- $ref: "#/components/schemas/SecurityFindingsData"
+ $ref: '#/components/schemas/SecurityFindingsData'
type: array
links:
- $ref: "#/components/schemas/SecurityFindingsLinks"
+ $ref: '#/components/schemas/SecurityFindingsLinks'
meta:
- $ref: "#/components/schemas/SecurityFindingsMeta"
+ $ref: '#/components/schemas/SecurityFindingsMeta'
type: object
ListServiceAccessTokensResponse:
description: Response for a list of access tokens.
@@ -65401,10 +65462,10 @@ components:
data:
description: Array of access tokens.
items:
- $ref: "#/components/schemas/ServiceAccessToken"
+ $ref: '#/components/schemas/ServiceAccessToken'
type: array
meta:
- $ref: "#/components/schemas/ServiceAccessTokenResponseMeta"
+ $ref: '#/components/schemas/ServiceAccessTokenResponseMeta'
type: object
ListSharedDashboardsResponse:
description: Response containing shared dashboards for a dashboard.
@@ -65412,12 +65473,12 @@ components:
data:
description: Shared dashboards for the dashboard.
items:
- $ref: "#/components/schemas/SharedDashboardResponse"
+ $ref: '#/components/schemas/SharedDashboardResponse'
type: array
included:
description: Users and dashboards related to the shared dashboards.
items:
- $ref: "#/components/schemas/SharedDashboardIncluded"
+ $ref: '#/components/schemas/SharedDashboardIncluded'
type: array
required:
- data
@@ -65427,9 +65488,9 @@ components:
description: Response containing a paginated list of source maps.
properties:
data:
- $ref: "#/components/schemas/SourcemapsData"
+ $ref: '#/components/schemas/SourcemapsData'
meta:
- $ref: "#/components/schemas/SourcemapsListMeta"
+ $ref: '#/components/schemas/SourcemapsListMeta'
required:
- data
type: object
@@ -65437,13 +65498,13 @@ components:
description: List tags response.
properties:
data:
- $ref: "#/components/schemas/ListTagsResponseData"
+ $ref: '#/components/schemas/ListTagsResponseData'
type: object
ListTagsResponseData:
description: The list tags response data.
properties:
attributes:
- $ref: "#/components/schemas/ListTagsResponseDataAttributes"
+ $ref: '#/components/schemas/ListTagsResponseDataAttributes'
id:
description: The device ID
example: example:1.2.3.4
@@ -65491,12 +65552,12 @@ components:
data:
description: List of vulnerabilities.
items:
- $ref: "#/components/schemas/Vulnerability"
+ $ref: '#/components/schemas/Vulnerability'
type: array
links:
- $ref: "#/components/schemas/Links"
+ $ref: '#/components/schemas/Links'
meta:
- $ref: "#/components/schemas/Metadata"
+ $ref: '#/components/schemas/Metadata'
required:
- data
type: object
@@ -65506,12 +65567,12 @@ components:
data:
description: List of vulnerable assets.
items:
- $ref: "#/components/schemas/Asset"
+ $ref: '#/components/schemas/Asset'
type: array
links:
- $ref: "#/components/schemas/Links"
+ $ref: '#/components/schemas/Links'
meta:
- $ref: "#/components/schemas/Metadata"
+ $ref: '#/components/schemas/Metadata'
required:
- data
type: object
@@ -65521,16 +65582,16 @@ components:
data:
description: A list of workflows.
items:
- $ref: "#/components/schemas/WorkflowListItem"
+ $ref: '#/components/schemas/WorkflowListItem'
type: array
meta:
- $ref: "#/components/schemas/ListWorkflowsResponseMeta"
+ $ref: '#/components/schemas/ListWorkflowsResponseMeta'
type: object
ListWorkflowsResponseMeta:
description: Metadata for a List Workflows response.
properties:
page:
- $ref: "#/components/schemas/ListWorkflowsResponseMetaPage"
+ $ref: '#/components/schemas/ListWorkflowsResponseMetaPage'
type: object
ListWorkflowsResponseMetaPage:
description: Pagination metadata for a List Workflows response.
@@ -65548,13 +65609,13 @@ components:
description: Object description of a log after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/LogAttributes"
+ $ref: '#/components/schemas/LogAttributes'
id:
description: Unique ID of the Log.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/LogType"
+ $ref: '#/components/schemas/LogType'
type: object
LogAttributes:
description: JSON object containing all log attributes and their associated values.
@@ -65621,16 +65682,16 @@ components:
type: object
computes:
additionalProperties:
- $ref: "#/components/schemas/LogsAggregateBucketValue"
+ $ref: '#/components/schemas/LogsAggregateBucketValue'
description: A map of the metric name -> value for regular compute or list of values for a timeseries
type: object
type: object
LogsAggregateBucketValue:
description: A bucket value, can be either a timeseries or a single value
oneOf:
- - $ref: "#/components/schemas/LogsAggregateBucketValueSingleString"
- - $ref: "#/components/schemas/LogsAggregateBucketValueSingleNumber"
- - $ref: "#/components/schemas/LogsAggregateBucketValueTimeseries"
+ - $ref: '#/components/schemas/LogsAggregateBucketValueSingleString'
+ - $ref: '#/components/schemas/LogsAggregateBucketValueSingleNumber'
+ - $ref: '#/components/schemas/LogsAggregateBucketValueTimeseries'
LogsAggregateBucketValueSingleNumber:
description: A single number value
format: double
@@ -65641,7 +65702,7 @@ components:
LogsAggregateBucketValueTimeseries:
description: A timeseries array
items:
- $ref: "#/components/schemas/LogsAggregateBucketValueTimeseriesPoint"
+ $ref: '#/components/schemas/LogsAggregateBucketValueTimeseriesPoint'
type: array
x-generate-alias-as-model: true
LogsAggregateBucketValueTimeseriesPoint:
@@ -65663,19 +65724,19 @@ components:
compute:
description: The list of metrics or timeseries to compute for the retrieved buckets.
items:
- $ref: "#/components/schemas/LogsCompute"
+ $ref: '#/components/schemas/LogsCompute'
type: array
filter:
- $ref: "#/components/schemas/LogsQueryFilter"
+ $ref: '#/components/schemas/LogsQueryFilter'
group_by:
description: The rules for the group by
items:
- $ref: "#/components/schemas/LogsGroupBy"
+ $ref: '#/components/schemas/LogsGroupBy'
type: array
options:
- $ref: "#/components/schemas/LogsQueryOptions"
+ $ref: '#/components/schemas/LogsQueryOptions'
page:
- $ref: "#/components/schemas/LogsAggregateRequestPage"
+ $ref: '#/components/schemas/LogsAggregateRequestPage'
type: object
LogsAggregateRequestPage:
description: Paging settings
@@ -65690,9 +65751,9 @@ components:
description: The response object for the logs aggregate API endpoint
properties:
data:
- $ref: "#/components/schemas/LogsAggregateResponseData"
+ $ref: '#/components/schemas/LogsAggregateResponseData'
meta:
- $ref: "#/components/schemas/LogsResponseMetadata"
+ $ref: '#/components/schemas/LogsResponseMetadata'
type: object
LogsAggregateResponseData:
description: The query results
@@ -65700,7 +65761,7 @@ components:
buckets:
description: The list of matching buckets, one item per bucket
items:
- $ref: "#/components/schemas/LogsAggregateBucket"
+ $ref: '#/components/schemas/LogsAggregateBucket'
type: array
type: object
LogsAggregateResponseStatus:
@@ -65714,15 +65775,15 @@ components:
example: {"aggregation": "count", "order": "asc"}
properties:
aggregation:
- $ref: "#/components/schemas/LogsAggregationFunction"
+ $ref: '#/components/schemas/LogsAggregationFunction'
metric:
description: The metric to sort by (only used for `type=measure`)
example: "@duration"
type: string
order:
- $ref: "#/components/schemas/LogsSortOrder"
+ $ref: '#/components/schemas/LogsSortOrder'
type:
- $ref: "#/components/schemas/LogsAggregateSortType"
+ $ref: '#/components/schemas/LogsAggregateSortType'
type: object
LogsAggregateSortType:
default: "alphabetical"
@@ -65740,15 +65801,15 @@ components:
description: The logs archive.
properties:
data:
- $ref: "#/components/schemas/LogsArchiveDefinition"
+ $ref: '#/components/schemas/LogsArchiveDefinition'
type: object
LogsArchiveAttributes:
description: The attributes associated with the archive.
properties:
compression_method:
- $ref: "#/components/schemas/LogsArchiveAttributesCompressionMethod"
+ $ref: '#/components/schemas/LogsArchiveAttributesCompressionMethod'
destination:
- $ref: "#/components/schemas/LogsArchiveDestination"
+ $ref: '#/components/schemas/LogsArchiveDestination'
include_tags:
default: false
description: |-
@@ -65792,7 +65853,7 @@ components:
type: string
type: array
state:
- $ref: "#/components/schemas/LogsArchiveState"
+ $ref: '#/components/schemas/LogsArchiveState'
required:
- name
- query
@@ -65813,15 +65874,15 @@ components:
description: The logs archive.
properties:
data:
- $ref: "#/components/schemas/LogsArchiveCreateRequestDefinition"
+ $ref: '#/components/schemas/LogsArchiveCreateRequestDefinition'
type: object
LogsArchiveCreateRequestAttributes:
description: The attributes associated with the archive.
properties:
compression_method:
- $ref: "#/components/schemas/LogsArchiveAttributesCompressionMethod"
+ $ref: '#/components/schemas/LogsArchiveAttributesCompressionMethod'
destination:
- $ref: "#/components/schemas/LogsArchiveCreateRequestDestination"
+ $ref: '#/components/schemas/LogsArchiveCreateRequestDestination'
include_tags:
default: false
description: |-
@@ -65873,7 +65934,7 @@ components:
description: The definition of an archive.
properties:
attributes:
- $ref: "#/components/schemas/LogsArchiveCreateRequestAttributes"
+ $ref: '#/components/schemas/LogsArchiveCreateRequestAttributes'
type:
default: archives
description: The type of the resource. The value should always be archives.
@@ -65885,14 +65946,14 @@ components:
LogsArchiveCreateRequestDestination:
description: An archive's destination.
oneOf:
- - $ref: "#/components/schemas/LogsArchiveDestinationAzure"
- - $ref: "#/components/schemas/LogsArchiveDestinationGCS"
- - $ref: "#/components/schemas/LogsArchiveDestinationS3"
+ - $ref: '#/components/schemas/LogsArchiveDestinationAzure'
+ - $ref: '#/components/schemas/LogsArchiveDestinationGCS'
+ - $ref: '#/components/schemas/LogsArchiveDestinationS3'
LogsArchiveDefinition:
description: The definition of an archive.
properties:
attributes:
- $ref: "#/components/schemas/LogsArchiveAttributes"
+ $ref: '#/components/schemas/LogsArchiveAttributes'
id:
description: The archive ID.
example: a2zcMylnM4OCHpYusxIi3g
@@ -65911,9 +65972,9 @@ components:
description: An archive's destination.
nullable: true
oneOf:
- - $ref: "#/components/schemas/LogsArchiveDestinationAzure"
- - $ref: "#/components/schemas/LogsArchiveDestinationGCS"
- - $ref: "#/components/schemas/LogsArchiveDestinationS3"
+ - $ref: '#/components/schemas/LogsArchiveDestinationAzure'
+ - $ref: '#/components/schemas/LogsArchiveDestinationGCS'
+ - $ref: '#/components/schemas/LogsArchiveDestinationS3'
type: object
LogsArchiveDestinationAzure:
description: The Azure archive destination.
@@ -65923,7 +65984,7 @@ components:
example: container-name
type: string
integration:
- $ref: "#/components/schemas/LogsArchiveIntegrationAzure"
+ $ref: '#/components/schemas/LogsArchiveIntegrationAzure'
path:
description: The archive path.
type: string
@@ -65935,7 +65996,7 @@ components:
example: account-name
type: string
type:
- $ref: "#/components/schemas/LogsArchiveDestinationAzureType"
+ $ref: '#/components/schemas/LogsArchiveDestinationAzureType'
required:
- storage_account
- container
@@ -65959,12 +66020,12 @@ components:
example: bucket-name
type: string
integration:
- $ref: "#/components/schemas/LogsArchiveIntegrationGCS"
+ $ref: '#/components/schemas/LogsArchiveIntegrationGCS'
path:
description: The archive path.
type: string
type:
- $ref: "#/components/schemas/LogsArchiveDestinationGCSType"
+ $ref: '#/components/schemas/LogsArchiveDestinationGCSType'
required:
- bucket
- integration
@@ -65987,16 +66048,16 @@ components:
example: bucket-name
type: string
encryption:
- $ref: "#/components/schemas/LogsArchiveEncryptionS3"
+ $ref: '#/components/schemas/LogsArchiveEncryptionS3'
integration:
- $ref: "#/components/schemas/LogsArchiveIntegrationS3"
+ $ref: '#/components/schemas/LogsArchiveIntegrationS3'
path:
description: The archive path.
type: string
storage_class:
- $ref: "#/components/schemas/LogsArchiveStorageClassS3Type"
+ $ref: '#/components/schemas/LogsArchiveStorageClassS3Type'
type:
- $ref: "#/components/schemas/LogsArchiveDestinationS3Type"
+ $ref: '#/components/schemas/LogsArchiveDestinationS3Type'
required:
- bucket
- integration
@@ -66019,7 +66080,7 @@ components:
example: arn:aws:kms:us-east-1:012345678901:key/DatadogIntegrationRoleKms
type: string
type:
- $ref: "#/components/schemas/LogsArchiveEncryptionS3Type"
+ $ref: '#/components/schemas/LogsArchiveEncryptionS3Type'
required:
- type
type: object
@@ -66068,8 +66129,8 @@ components:
description: >-
The S3 Archive's integration destination. You must provide one of the following: `access_key_id` alone, or both `account_id` and `role_name` together.
oneOf:
- - $ref: "#/components/schemas/LogsArchiveIntegrationS3AccessKey"
- - $ref: "#/components/schemas/LogsArchiveIntegrationS3Role"
+ - $ref: '#/components/schemas/LogsArchiveIntegrationS3AccessKey'
+ - $ref: '#/components/schemas/LogsArchiveIntegrationS3Role'
LogsArchiveIntegrationS3AccessKey:
description: The S3 Archive's integration destination using an access key.
properties:
@@ -66099,7 +66160,7 @@ components:
description: A ordered list of archive IDs.
properties:
data:
- $ref: "#/components/schemas/LogsArchiveOrderDefinition"
+ $ref: '#/components/schemas/LogsArchiveOrderDefinition'
type: object
LogsArchiveOrderAttributes:
description: The attributes associated with the archive order.
@@ -66120,9 +66181,9 @@ components:
description: The definition of an archive order.
properties:
attributes:
- $ref: "#/components/schemas/LogsArchiveOrderAttributes"
+ $ref: '#/components/schemas/LogsArchiveOrderAttributes'
type:
- $ref: "#/components/schemas/LogsArchiveOrderDefinitionType"
+ $ref: '#/components/schemas/LogsArchiveOrderDefinitionType'
required:
- type
- attributes
@@ -66173,14 +66234,14 @@ components:
data:
description: A list of archives.
items:
- $ref: "#/components/schemas/LogsArchiveDefinition"
+ $ref: '#/components/schemas/LogsArchiveDefinition'
type: array
type: object
LogsCompute:
description: A compute rule to compute metrics or timeseries
properties:
aggregation:
- $ref: "#/components/schemas/LogsAggregationFunction"
+ $ref: '#/components/schemas/LogsAggregationFunction'
interval:
description: |-
The time buckets' size (only used for type=timeseries)
@@ -66192,7 +66253,7 @@ components:
example: "@duration"
type: string
type:
- $ref: "#/components/schemas/LogsComputeType"
+ $ref: '#/components/schemas/LogsComputeType'
required:
- aggregation
type: object
@@ -66210,7 +66271,7 @@ components:
example: "host"
type: string
histogram:
- $ref: "#/components/schemas/LogsGroupByHistogram"
+ $ref: '#/components/schemas/LogsGroupByHistogram'
limit:
default: 10
description: |-
@@ -66219,11 +66280,11 @@ components:
format: int64
type: integer
missing:
- $ref: "#/components/schemas/LogsGroupByMissing"
+ $ref: '#/components/schemas/LogsGroupByMissing'
sort:
- $ref: "#/components/schemas/LogsAggregateSort"
+ $ref: '#/components/schemas/LogsAggregateSort'
total:
- $ref: "#/components/schemas/LogsGroupByTotal"
+ $ref: '#/components/schemas/LogsGroupByTotal'
required:
- facet
type: object
@@ -66259,8 +66320,8 @@ components:
LogsGroupByMissing:
description: The value to use for logs that don't have the facet used to group by
oneOf:
- - $ref: "#/components/schemas/LogsGroupByMissingString"
- - $ref: "#/components/schemas/LogsGroupByMissingNumber"
+ - $ref: '#/components/schemas/LogsGroupByMissingString'
+ - $ref: '#/components/schemas/LogsGroupByMissingNumber'
LogsGroupByMissingNumber:
description: The missing value to use if there is a number valued facet.
format: double
@@ -66273,9 +66334,9 @@ components:
description: |-
A resulting object to put the given computes in over all the matching records.
oneOf:
- - $ref: "#/components/schemas/LogsGroupByTotalBoolean"
- - $ref: "#/components/schemas/LogsGroupByTotalString"
- - $ref: "#/components/schemas/LogsGroupByTotalNumber"
+ - $ref: '#/components/schemas/LogsGroupByTotalBoolean'
+ - $ref: '#/components/schemas/LogsGroupByTotalString'
+ - $ref: '#/components/schemas/LogsGroupByTotalNumber'
LogsGroupByTotalBoolean:
description: If set to true, creates an additional bucket labeled "$facet_total"
type: boolean
@@ -66290,13 +66351,13 @@ components:
description: The request for a logs list.
properties:
filter:
- $ref: "#/components/schemas/LogsQueryFilter"
+ $ref: '#/components/schemas/LogsQueryFilter'
options:
- $ref: "#/components/schemas/LogsQueryOptions"
+ $ref: '#/components/schemas/LogsQueryOptions'
page:
- $ref: "#/components/schemas/LogsListRequestPage"
+ $ref: '#/components/schemas/LogsListRequestPage'
sort:
- $ref: "#/components/schemas/LogsSort"
+ $ref: '#/components/schemas/LogsSort'
type: object
LogsListRequestPage:
description: Paging attributes for listing logs.
@@ -66320,12 +66381,12 @@ components:
data:
description: Array of logs matching the request.
items:
- $ref: "#/components/schemas/Log"
+ $ref: '#/components/schemas/Log'
type: array
links:
- $ref: "#/components/schemas/LogsListResponseLinks"
+ $ref: '#/components/schemas/LogsListResponseLinks'
meta:
- $ref: "#/components/schemas/LogsResponseMetadata"
+ $ref: '#/components/schemas/LogsResponseMetadata'
type: object
LogsListResponseLinks:
description: Links attributes.
@@ -66341,9 +66402,9 @@ components:
description: The compute rule to compute the log-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/LogsMetricComputeAggregationType"
+ $ref: '#/components/schemas/LogsMetricComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles'
path:
description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: "@duration"
@@ -66367,13 +66428,13 @@ components:
description: The object describing the Datadog log-based metric to create.
properties:
compute:
- $ref: "#/components/schemas/LogsMetricCompute"
+ $ref: '#/components/schemas/LogsMetricCompute'
filter:
- $ref: "#/components/schemas/LogsMetricFilter"
+ $ref: '#/components/schemas/LogsMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/LogsMetricGroupBy"
+ $ref: '#/components/schemas/LogsMetricGroupBy'
type: array
required:
- compute
@@ -66382,11 +66443,11 @@ components:
description: The new log-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/LogsMetricCreateAttributes"
+ $ref: '#/components/schemas/LogsMetricCreateAttributes'
id:
- $ref: "#/components/schemas/LogsMetricID"
+ $ref: '#/components/schemas/LogsMetricID'
type:
- $ref: "#/components/schemas/LogsMetricType"
+ $ref: '#/components/schemas/LogsMetricType'
required:
- id
- type
@@ -66396,7 +66457,7 @@ components:
description: The new log-based metric body.
properties:
data:
- $ref: "#/components/schemas/LogsMetricCreateData"
+ $ref: '#/components/schemas/LogsMetricCreateData'
required:
- data
type: object
@@ -66431,28 +66492,28 @@ components:
description: The log-based metric object.
properties:
data:
- $ref: "#/components/schemas/LogsMetricResponseData"
+ $ref: '#/components/schemas/LogsMetricResponseData'
type: object
LogsMetricResponseAttributes:
description: The object describing a Datadog log-based metric.
properties:
compute:
- $ref: "#/components/schemas/LogsMetricResponseCompute"
+ $ref: '#/components/schemas/LogsMetricResponseCompute'
filter:
- $ref: "#/components/schemas/LogsMetricResponseFilter"
+ $ref: '#/components/schemas/LogsMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/LogsMetricResponseGroupBy"
+ $ref: '#/components/schemas/LogsMetricResponseGroupBy'
type: array
type: object
LogsMetricResponseCompute:
description: The compute rule to compute the log-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/LogsMetricResponseComputeAggregationType"
+ $ref: '#/components/schemas/LogsMetricResponseComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles'
path:
description: The path to the value the log-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: "@duration"
@@ -66468,11 +66529,11 @@ components:
description: The log-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/LogsMetricResponseAttributes"
+ $ref: '#/components/schemas/LogsMetricResponseAttributes'
id:
- $ref: "#/components/schemas/LogsMetricID"
+ $ref: '#/components/schemas/LogsMetricID'
type:
- $ref: "#/components/schemas/LogsMetricType"
+ $ref: '#/components/schemas/LogsMetricType'
type: object
LogsMetricResponseFilter:
description: The log-based metric filter. Logs matching this filter will be aggregated in this metric.
@@ -66506,28 +66567,28 @@ components:
description: The log-based metric properties that will be updated.
properties:
compute:
- $ref: "#/components/schemas/LogsMetricUpdateCompute"
+ $ref: '#/components/schemas/LogsMetricUpdateCompute'
filter:
- $ref: "#/components/schemas/LogsMetricFilter"
+ $ref: '#/components/schemas/LogsMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/LogsMetricGroupBy"
+ $ref: '#/components/schemas/LogsMetricGroupBy'
type: array
type: object
LogsMetricUpdateCompute:
description: The compute rule to compute the log-based metric.
properties:
include_percentiles:
- $ref: "#/components/schemas/LogsMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/LogsMetricComputeIncludePercentiles'
type: object
LogsMetricUpdateData:
description: The new log-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/LogsMetricUpdateAttributes"
+ $ref: '#/components/schemas/LogsMetricUpdateAttributes'
type:
- $ref: "#/components/schemas/LogsMetricType"
+ $ref: '#/components/schemas/LogsMetricType'
required:
- type
- attributes
@@ -66536,7 +66597,7 @@ components:
description: The new log-based metric body.
properties:
data:
- $ref: "#/components/schemas/LogsMetricUpdateData"
+ $ref: '#/components/schemas/LogsMetricUpdateData'
required:
- data
type: object
@@ -66546,7 +66607,7 @@ components:
data:
description: A list of log-based metric objects.
items:
- $ref: "#/components/schemas/LogsMetricResponseData"
+ $ref: '#/components/schemas/LogsMetricResponseData'
type: array
type: object
LogsQueryFilter:
@@ -66571,7 +66632,7 @@ components:
example: "service:web* AND @http.status_code:[200 TO 299]"
type: string
storage_tier:
- $ref: "#/components/schemas/LogsStorageTier"
+ $ref: '#/components/schemas/LogsStorageTier'
to:
default: "now"
description: The maximum time for the requested logs, supports date math and regular timestamps (milliseconds).
@@ -66604,19 +66665,19 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/LogsResponseMetadataPage"
+ $ref: '#/components/schemas/LogsResponseMetadataPage'
request_id:
description: The identifier of the request
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/LogsAggregateResponseStatus"
+ $ref: '#/components/schemas/LogsAggregateResponseStatus'
warnings:
description: |-
A list of warnings (non fatal errors) encountered, partial results might be returned if
warnings are present in the response.
items:
- $ref: "#/components/schemas/LogsWarning"
+ $ref: '#/components/schemas/LogsWarning'
type: array
type: object
LogsResponseMetadataPage:
@@ -66707,25 +66768,25 @@ components:
description: Statistical distributions of long task metrics computed per view across sampled views.
properties:
fcp_blocking_time_ms:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
fcp_count:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
inp_overlap_blocking_time_ms:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
inp_overlap_count:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
lcp_blocking_time_ms:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
lcp_count:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
loading_time_blocking_time_ms:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
loading_time_count:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
total_blocking_time_ms:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
total_count:
- $ref: "#/components/schemas/LongTaskMetricStats"
+ $ref: '#/components/schemas/LongTaskMetricStats'
type: object
MSTeamsIntegrationMetadata:
description: Incident integration metadata for the Microsoft Teams integration.
@@ -66734,7 +66795,7 @@ components:
description: Array of Microsoft Teams in this integration metadata.
example: []
items:
- $ref: "#/components/schemas/MSTeamsIntegrationMetadataTeamsItem"
+ $ref: '#/components/schemas/MSTeamsIntegrationMetadataTeamsItem'
type: array
required:
- teams
@@ -66768,11 +66829,11 @@ components:
description: Response object for a single maintenance.
properties:
data:
- $ref: "#/components/schemas/MaintenanceData"
+ $ref: '#/components/schemas/MaintenanceData'
included:
description: The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
type: object
MaintenanceArray:
@@ -66781,15 +66842,15 @@ components:
data:
description: A list of maintenance data objects.
items:
- $ref: "#/components/schemas/MaintenanceData"
+ $ref: '#/components/schemas/MaintenanceData'
type: array
included:
description: The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
meta:
- $ref: "#/components/schemas/PaginationMeta"
+ $ref: '#/components/schemas/PaginationMeta'
required:
- data
type: object
@@ -66797,15 +66858,15 @@ components:
description: The data object for a maintenance.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceDataAttributes"
+ $ref: '#/components/schemas/MaintenanceDataAttributes'
id:
description: The ID of the maintenance.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/MaintenanceDataRelationships"
+ $ref: '#/components/schemas/MaintenanceDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataType'
required:
- type
type: object
@@ -66825,7 +66886,7 @@ components:
components_affected:
description: Components affected by the maintenance.
items:
- $ref: "#/components/schemas/MaintenanceDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/MaintenanceDataAttributesComponentsAffectedItems'
type: array
in_progress_description:
description: The description shown while the maintenance is in progress.
@@ -66857,7 +66918,7 @@ components:
updates:
description: Past updates made to the maintenance.
items:
- $ref: "#/components/schemas/MaintenanceDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItems'
type: array
type: object
MaintenanceDataAttributesComponentsAffectedItems:
@@ -66873,7 +66934,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -66895,7 +66956,7 @@ components:
components_affected:
description: The components affected at the time of the update.
items:
- $ref: "#/components/schemas/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems"
+ $ref: '#/components/schemas/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems'
type: array
created_at:
description: Timestamp of when the update was created.
@@ -66966,7 +67027,7 @@ components:
description: The Datadog user who created the maintenance.
properties:
data:
- $ref: "#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -66979,7 +67040,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -66988,7 +67049,7 @@ components:
description: The Datadog user who last modified the maintenance.
properties:
data:
- $ref: "#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -67001,7 +67062,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -67010,7 +67071,7 @@ components:
description: The status page the maintenance belongs to.
properties:
data:
- $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/MaintenanceDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -67023,7 +67084,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -67032,7 +67093,7 @@ components:
description: The template the maintenance was created from.
properties:
data:
- $ref: "#/components/schemas/MaintenanceDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/MaintenanceDataRelationshipsTemplateData'
required:
- data
type: object
@@ -67044,7 +67105,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
- id
@@ -67053,11 +67114,11 @@ components:
description: Response object for a single maintenance template.
properties:
data:
- $ref: "#/components/schemas/MaintenanceTemplateData"
+ $ref: '#/components/schemas/MaintenanceTemplateData'
included:
description: The included related resources of a maintenance template. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
type: object
MaintenanceTemplateArray:
@@ -67066,12 +67127,12 @@ components:
data:
description: A list of maintenance template data objects.
items:
- $ref: "#/components/schemas/MaintenanceTemplateData"
+ $ref: '#/components/schemas/MaintenanceTemplateData'
type: array
included:
description: The included related resources of a maintenance template. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/DegradationIncluded"
+ $ref: '#/components/schemas/DegradationIncluded'
type: array
required:
- data
@@ -67080,14 +67141,14 @@ components:
description: The data object for a maintenance template.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceTemplateDataAttributes"
+ $ref: '#/components/schemas/MaintenanceTemplateDataAttributes'
id:
description: The ID of the maintenance template.
type: string
relationships:
- $ref: "#/components/schemas/MaintenanceTemplateDataRelationships"
+ $ref: '#/components/schemas/MaintenanceTemplateDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
type: object
@@ -67140,7 +67201,7 @@ components:
description: The Datadog user who created the maintenance template.
properties:
data:
- $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/MaintenanceTemplateDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -67152,7 +67213,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -67161,7 +67222,7 @@ components:
description: The Datadog user who last modified the maintenance template.
properties:
data:
- $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/MaintenanceTemplateDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -67173,7 +67234,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -67182,7 +67243,7 @@ components:
description: The status page the maintenance template belongs to.
properties:
data:
- $ref: "#/components/schemas/MaintenanceTemplateDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/MaintenanceTemplateDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -67194,7 +67255,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -67203,22 +67264,22 @@ components:
description: Response object for a maintenance update.
properties:
data:
- $ref: "#/components/schemas/MaintenanceUpdateData"
+ $ref: '#/components/schemas/MaintenanceUpdateData'
type: object
MaintenanceUpdateData:
description: The data object for a maintenance update.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceUpdateDataAttributes"
+ $ref: '#/components/schemas/MaintenanceUpdateDataAttributes'
id:
description: The ID of the maintenance update.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationships"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceUpdateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceUpdateRequestDataType'
required:
- id
- type
@@ -67229,7 +67290,7 @@ components:
components_affected:
description: Components affected at the time of the update.
items:
- $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/CreateMaintenanceRequestDataAttributesComponentsAffectedItems'
type: array
created_at:
description: The date and time the update was created.
@@ -67250,7 +67311,7 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/MaintenanceUpdateDataAttributesStatus"
+ $ref: '#/components/schemas/MaintenanceUpdateDataAttributesStatus'
type: object
MaintenanceUpdateDataAttributesStatus:
description: The status of the maintenance update.
@@ -67269,17 +67330,17 @@ components:
description: Relationships of a maintenance update resource.
properties:
created_by_user:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationshipsUser"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationshipsUser'
last_modified_by_user:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationshipsUser"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationshipsUser'
maintenance:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationshipsMaintenance"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationshipsMaintenance'
type: object
MaintenanceUpdateDataRelationshipsMaintenance:
description: The parent maintenance of the update.
properties:
data:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationshipsMaintenanceData"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationshipsMaintenanceData'
required:
- data
type: object
@@ -67292,7 +67353,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataType'
required:
- type
- id
@@ -67301,7 +67362,7 @@ components:
description: A user relationship of a maintenance update.
properties:
data:
- $ref: "#/components/schemas/MaintenanceUpdateDataRelationshipsUserData"
+ $ref: '#/components/schemas/MaintenanceUpdateDataRelationshipsUserData'
required:
- data
type: object
@@ -67314,7 +67375,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -67323,13 +67384,13 @@ components:
description: A maintenance window that defines a scheduled time period during which case-related notifications and automation rules are suppressed. Each maintenance window applies to cases matching a specified query.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceWindowAttributes"
+ $ref: '#/components/schemas/MaintenanceWindowAttributes'
id:
description: The maintenance window's identifier.
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
type: string
type:
- $ref: "#/components/schemas/MaintenanceWindowResourceType"
+ $ref: '#/components/schemas/MaintenanceWindowResourceType'
required:
- id
- type
@@ -67374,9 +67435,9 @@ components:
description: Data object for creating a maintenance window.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceWindowCreateAttributes"
+ $ref: '#/components/schemas/MaintenanceWindowCreateAttributes'
type:
- $ref: "#/components/schemas/MaintenanceWindowResourceType"
+ $ref: '#/components/schemas/MaintenanceWindowResourceType'
required:
- type
- attributes
@@ -67412,7 +67473,7 @@ components:
description: Request payload for creating a maintenance window.
properties:
data:
- $ref: "#/components/schemas/MaintenanceWindowCreate"
+ $ref: '#/components/schemas/MaintenanceWindowCreate'
required:
- data
type: object
@@ -67429,7 +67490,7 @@ components:
description: Response containing a single maintenance window.
properties:
data:
- $ref: "#/components/schemas/MaintenanceWindow"
+ $ref: '#/components/schemas/MaintenanceWindow'
required:
- data
type: object
@@ -67437,9 +67498,9 @@ components:
description: Data object for updating a maintenance window.
properties:
attributes:
- $ref: "#/components/schemas/MaintenanceWindowUpdateAttributes"
+ $ref: '#/components/schemas/MaintenanceWindowUpdateAttributes'
type:
- $ref: "#/components/schemas/MaintenanceWindowResourceType"
+ $ref: '#/components/schemas/MaintenanceWindowResourceType'
required:
- type
type: object
@@ -67465,7 +67526,7 @@ components:
description: Request payload for updating a maintenance window.
properties:
data:
- $ref: "#/components/schemas/MaintenanceWindowUpdate"
+ $ref: '#/components/schemas/MaintenanceWindowUpdate'
required:
- data
type: object
@@ -67475,7 +67536,7 @@ components:
data:
description: List of maintenance windows.
items:
- $ref: "#/components/schemas/MaintenanceWindow"
+ $ref: '#/components/schemas/MaintenanceWindow'
type: array
required:
- data
@@ -67489,9 +67550,9 @@ components:
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/ManagedOrgsRelationships"
+ $ref: '#/components/schemas/ManagedOrgsRelationships'
type:
- $ref: "#/components/schemas/ManagedOrgsType"
+ $ref: '#/components/schemas/ManagedOrgsType'
required:
- id
- type
@@ -67501,7 +67562,7 @@ components:
description: Relationship to the current organization.
properties:
data:
- $ref: "#/components/schemas/OrgRelationshipData"
+ $ref: '#/components/schemas/OrgRelationshipData'
required:
- data
type: object
@@ -67511,7 +67572,7 @@ components:
data:
description: List of managed organization references.
items:
- $ref: "#/components/schemas/OrgRelationshipData"
+ $ref: '#/components/schemas/OrgRelationshipData'
type: array
required:
- data
@@ -67520,9 +67581,9 @@ components:
description: Relationships of the managed organizations resource.
properties:
current_org:
- $ref: "#/components/schemas/ManagedOrgsRelationshipToOrg"
+ $ref: '#/components/schemas/ManagedOrgsRelationshipToOrg'
managed_orgs:
- $ref: "#/components/schemas/ManagedOrgsRelationshipToOrgs"
+ $ref: '#/components/schemas/ManagedOrgsRelationshipToOrgs'
required:
- current_org
- managed_orgs
@@ -67531,11 +67592,11 @@ components:
description: Response containing the current organization and its managed organizations.
properties:
data:
- $ref: "#/components/schemas/ManagedOrgsData"
+ $ref: '#/components/schemas/ManagedOrgsData'
included:
description: Included organization resources.
items:
- $ref: "#/components/schemas/OrgData"
+ $ref: '#/components/schemas/OrgData'
type: array
required:
- data
@@ -67570,23 +67631,23 @@ components:
description: The data object for a maximum session duration update request.
properties:
attributes:
- $ref: "#/components/schemas/MaxSessionDurationUpdateAttributes"
+ $ref: '#/components/schemas/MaxSessionDurationUpdateAttributes'
type:
- $ref: "#/components/schemas/MaxSessionDurationType"
+ $ref: '#/components/schemas/MaxSessionDurationType'
required: [type, attributes]
type: object
MaxSessionDurationUpdateRequest:
description: A request to update the maximum session duration for an organization.
properties:
data:
- $ref: "#/components/schemas/MaxSessionDurationUpdateData"
+ $ref: '#/components/schemas/MaxSessionDurationUpdateData'
required: [data]
type: object
McpScanRequest:
description: The top-level request object for submitting an MCP SCA dependency scan.
properties:
data:
- $ref: "#/components/schemas/McpScanRequestData"
+ $ref: '#/components/schemas/McpScanRequestData'
required:
- data
type: object
@@ -67594,12 +67655,12 @@ components:
description: The data object in an MCP SCA scan request, containing the scan attributes and request type.
properties:
attributes:
- $ref: "#/components/schemas/McpScanRequestDataAttributes"
+ $ref: '#/components/schemas/McpScanRequestDataAttributes'
id:
description: An optional identifier for this scan request.
type: string
type:
- $ref: "#/components/schemas/McpScanRequestDataType"
+ $ref: '#/components/schemas/McpScanRequestDataType'
required:
- type
- attributes
@@ -67612,7 +67673,7 @@ components:
example: 0e9fc8de83eaabecd722e1cd0ed44fb489fe15fc
type: string
libraries:
- $ref: "#/components/schemas/McpScanRequestDataAttributesLibraries"
+ $ref: '#/components/schemas/McpScanRequestDataAttributesLibraries'
resource_name:
description: The name of the resource (typically the repository or project name) being scanned.
example: my-org/my-repo
@@ -67625,13 +67686,13 @@ components:
McpScanRequestDataAttributesLibraries:
description: The list of libraries to scan for vulnerabilities.
items:
- $ref: "#/components/schemas/McpScanRequestDataAttributesLibrariesItems"
+ $ref: '#/components/schemas/McpScanRequestDataAttributesLibrariesItems'
type: array
McpScanRequestDataAttributesLibrariesItems:
description: A library declaration to include in the dependency scan.
properties:
exclusions:
- $ref: "#/components/schemas/McpScanRequestDataAttributesLibrariesItemsExclusions"
+ $ref: '#/components/schemas/McpScanRequestDataAttributesLibrariesItemsExclusions'
is_dev:
description: Whether this library is a development-only dependency.
example: false
@@ -67649,7 +67710,7 @@ components:
example: pkg:nuget/Newtonsoft.Json@13.0.1
type: string
target_frameworks:
- $ref: "#/components/schemas/McpScanRequestDataAttributesLibrariesItemsTargetFrameworks"
+ $ref: '#/components/schemas/McpScanRequestDataAttributesLibrariesItemsTargetFrameworks'
required:
- purl
- is_dev
@@ -67681,7 +67742,7 @@ components:
description: The top-level response object returned when an MCP SCA dependency scan request has been accepted.
properties:
data:
- $ref: "#/components/schemas/McpScanRequestResponseData"
+ $ref: '#/components/schemas/McpScanRequestResponseData'
required:
- data
type: object
@@ -67689,13 +67750,13 @@ components:
description: The data object returned when a scan request has been accepted.
properties:
attributes:
- $ref: "#/components/schemas/McpScanRequestResponseDataAttributes"
+ $ref: '#/components/schemas/McpScanRequestResponseDataAttributes'
id:
description: The job identifier assigned to the scan.
example: 0190a3d4-1234-7000-8000-000000000000
type: string
type:
- $ref: "#/components/schemas/McpScanRequestResponseDataType"
+ $ref: '#/components/schemas/McpScanRequestResponseDataType'
required:
- id
- type
@@ -67729,7 +67790,7 @@ components:
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/MemberTeamType"
+ $ref: '#/components/schemas/MemberTeamType'
required:
- id
- type
@@ -67772,11 +67833,11 @@ components:
type: metrics
properties:
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
relationships:
- $ref: "#/components/schemas/MetricRelationships"
+ $ref: '#/components/schemas/MetricRelationships'
type:
- $ref: "#/components/schemas/MetricType"
+ $ref: '#/components/schemas/MetricType'
type: object
MetricActiveConfigurationType:
default: actively_queried_configurations
@@ -67791,11 +67852,11 @@ components:
description: Object for a single metric's indexed and ingested tags.
properties:
attributes:
- $ref: "#/components/schemas/MetricAllTagsAttributes"
+ $ref: '#/components/schemas/MetricAllTagsAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricType"
+ $ref: '#/components/schemas/MetricType'
type: object
MetricAllTagsAttributes:
description: Object containing the definition of a metric's indexed and ingested tags.
@@ -67819,7 +67880,7 @@ components:
description: Response object that includes a single metric's indexed and ingested tags.
properties:
data:
- $ref: "#/components/schemas/MetricAllTags"
+ $ref: '#/components/schemas/MetricAllTags'
readOnly: true
type: object
MetricAssetAttributes:
@@ -67843,9 +67904,9 @@ components:
description: An object of type `dashboard` that can be referenced in the `included` data.
properties:
id:
- $ref: "#/components/schemas/MetricDashboardID"
+ $ref: '#/components/schemas/MetricDashboardID'
type:
- $ref: "#/components/schemas/MetricDashboardType"
+ $ref: '#/components/schemas/MetricDashboardType'
type: object
MetricAssetDashboardRelationships:
description: An object containing the list of dashboards that can be referenced in the `included` data.
@@ -67853,16 +67914,16 @@ components:
data:
description: A list of dashboards that can be referenced in the `included` data.
items:
- $ref: "#/components/schemas/MetricAssetDashboardRelationship"
+ $ref: '#/components/schemas/MetricAssetDashboardRelationship'
type: array
type: object
MetricAssetMonitorRelationship:
description: An object of type `monitor` that can be referenced in the `included` data.
properties:
id:
- $ref: "#/components/schemas/MetricMonitorID"
+ $ref: '#/components/schemas/MetricMonitorID'
type:
- $ref: "#/components/schemas/MetricMonitorType"
+ $ref: '#/components/schemas/MetricMonitorType'
type: object
MetricAssetMonitorRelationships:
description: A object containing the list of monitors that can be referenced in the `included` data.
@@ -67870,16 +67931,16 @@ components:
data:
description: A list of monitors that can be referenced in the `included` data.
items:
- $ref: "#/components/schemas/MetricAssetMonitorRelationship"
+ $ref: '#/components/schemas/MetricAssetMonitorRelationship'
type: array
type: object
MetricAssetNotebookRelationship:
description: An object of type `notebook` that can be referenced in the `included` data.
properties:
id:
- $ref: "#/components/schemas/MetricNotebookID"
+ $ref: '#/components/schemas/MetricNotebookID'
type:
- $ref: "#/components/schemas/MetricNotebookType"
+ $ref: '#/components/schemas/MetricNotebookType'
type: object
MetricAssetNotebookRelationships:
description: An object containing the list of notebooks that can be referenced in the `included` data.
@@ -67887,18 +67948,18 @@ components:
data:
description: A list of notebooks that can be referenced in the `included` data.
items:
- $ref: "#/components/schemas/MetricAssetNotebookRelationship"
+ $ref: '#/components/schemas/MetricAssetNotebookRelationship'
type: array
type: object
MetricAssetResponseData:
description: Metric assets response data.
properties:
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
relationships:
- $ref: "#/components/schemas/MetricAssetResponseRelationships"
+ $ref: '#/components/schemas/MetricAssetResponseRelationships'
type:
- $ref: "#/components/schemas/MetricType"
+ $ref: '#/components/schemas/MetricType'
required:
- id
- type
@@ -67906,29 +67967,29 @@ components:
MetricAssetResponseIncluded:
description: List of included assets with full set of attributes.
oneOf:
- - $ref: "#/components/schemas/MetricDashboardAsset"
- - $ref: "#/components/schemas/MetricMonitorAsset"
- - $ref: "#/components/schemas/MetricNotebookAsset"
- - $ref: "#/components/schemas/MetricSLOAsset"
+ - $ref: '#/components/schemas/MetricDashboardAsset'
+ - $ref: '#/components/schemas/MetricMonitorAsset'
+ - $ref: '#/components/schemas/MetricNotebookAsset'
+ - $ref: '#/components/schemas/MetricSLOAsset'
MetricAssetResponseRelationships:
description: Relationships to assets related to the metric.
properties:
dashboards:
- $ref: "#/components/schemas/MetricAssetDashboardRelationships"
+ $ref: '#/components/schemas/MetricAssetDashboardRelationships'
monitors:
- $ref: "#/components/schemas/MetricAssetMonitorRelationships"
+ $ref: '#/components/schemas/MetricAssetMonitorRelationships'
notebooks:
- $ref: "#/components/schemas/MetricAssetNotebookRelationships"
+ $ref: '#/components/schemas/MetricAssetNotebookRelationships'
slos:
- $ref: "#/components/schemas/MetricAssetSLORelationships"
+ $ref: '#/components/schemas/MetricAssetSLORelationships'
type: object
MetricAssetSLORelationship:
description: An object of type `slos` that can be referenced in the `included` data.
properties:
id:
- $ref: "#/components/schemas/MetricSLOID"
+ $ref: '#/components/schemas/MetricSLOID'
type:
- $ref: "#/components/schemas/MetricSLOType"
+ $ref: '#/components/schemas/MetricSLOType'
type: object
MetricAssetSLORelationships:
description: An object containing a list of SLOs that can be referenced in the `included` data.
@@ -67936,18 +67997,18 @@ components:
data:
description: A list of SLOs that can be referenced in the `included` data.
items:
- $ref: "#/components/schemas/MetricAssetSLORelationship"
+ $ref: '#/components/schemas/MetricAssetSLORelationship'
type: array
type: object
MetricAssetsResponse:
description: Response object that includes related dashboards, monitors, notebooks, and SLOs.
properties:
data:
- $ref: "#/components/schemas/MetricAssetResponseData"
+ $ref: '#/components/schemas/MetricAssetResponseData'
included:
description: Array of objects related to the metric assets.
items:
- $ref: "#/components/schemas/MetricAssetResponseIncluded"
+ $ref: '#/components/schemas/MetricAssetResponseIncluded'
type: array
type: object
MetricBulkConfigureTagsType:
@@ -67963,11 +68024,11 @@ components:
description: Request object to bulk configure tags for metrics matching the given prefix.
properties:
attributes:
- $ref: "#/components/schemas/MetricBulkTagConfigCreateAttributes"
+ $ref: '#/components/schemas/MetricBulkTagConfigCreateAttributes'
id:
- $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix"
+ $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
type:
- $ref: "#/components/schemas/MetricBulkConfigureTagsType"
+ $ref: '#/components/schemas/MetricBulkConfigureTagsType'
required:
- id
- type
@@ -67976,7 +68037,7 @@ components:
description: Optional parameters for bulk creating metric tag configurations.
properties:
emails:
- $ref: "#/components/schemas/MetricBulkTagConfigEmailList"
+ $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
exclude_tags_mode:
description: |-
When set to true, the configuration will exclude the configured tags and include any other submitted tags.
@@ -68002,13 +68063,13 @@ components:
Defaults to true.
type: boolean
tags:
- $ref: "#/components/schemas/MetricBulkTagConfigTagNameList"
+ $ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
type: object
MetricBulkTagConfigCreateRequest:
description: Wrapper object for a single bulk tag configuration request.
properties:
data:
- $ref: "#/components/schemas/MetricBulkTagConfigCreate"
+ $ref: '#/components/schemas/MetricBulkTagConfigCreate'
required:
- data
type: object
@@ -68016,11 +68077,11 @@ components:
description: Request object to bulk delete all tag configurations for metrics matching the given prefix.
properties:
attributes:
- $ref: "#/components/schemas/MetricBulkTagConfigDeleteAttributes"
+ $ref: '#/components/schemas/MetricBulkTagConfigDeleteAttributes'
id:
- $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix"
+ $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
type:
- $ref: "#/components/schemas/MetricBulkConfigureTagsType"
+ $ref: '#/components/schemas/MetricBulkConfigureTagsType'
required:
- id
- type
@@ -68029,13 +68090,13 @@ components:
description: Optional parameters for bulk deleting metric tag configurations.
properties:
emails:
- $ref: "#/components/schemas/MetricBulkTagConfigEmailList"
+ $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
type: object
MetricBulkTagConfigDeleteRequest:
description: Wrapper object for a single bulk tag deletion request.
properties:
data:
- $ref: "#/components/schemas/MetricBulkTagConfigDelete"
+ $ref: '#/components/schemas/MetricBulkTagConfigDelete'
required:
- data
type: object
@@ -68054,7 +68115,7 @@ components:
description: Wrapper for a single bulk tag configuration status response.
properties:
data:
- $ref: "#/components/schemas/MetricBulkTagConfigStatus"
+ $ref: '#/components/schemas/MetricBulkTagConfigStatus'
type: object
MetricBulkTagConfigStatus:
description: |-
@@ -68062,11 +68123,11 @@ components:
It contains the fields from the original request for reference.
properties:
attributes:
- $ref: "#/components/schemas/MetricBulkTagConfigStatusAttributes"
+ $ref: '#/components/schemas/MetricBulkTagConfigStatusAttributes'
id:
- $ref: "#/components/schemas/MetricBulkTagConfigNamePrefix"
+ $ref: '#/components/schemas/MetricBulkTagConfigNamePrefix'
type:
- $ref: "#/components/schemas/MetricBulkConfigureTagsType"
+ $ref: '#/components/schemas/MetricBulkConfigureTagsType'
required:
- id
- type
@@ -68075,7 +68136,7 @@ components:
description: Optional attributes for the status of a bulk tag configuration request.
properties:
emails:
- $ref: "#/components/schemas/MetricBulkTagConfigEmailList"
+ $ref: '#/components/schemas/MetricBulkTagConfigEmailList'
exclude_tags_mode:
description: |-
When set to true, the configuration will exclude the configured tags and include any other submitted tags.
@@ -68086,7 +68147,7 @@ components:
example: "Accepted"
type: string
tags:
- $ref: "#/components/schemas/MetricBulkTagConfigTagNameList"
+ $ref: '#/components/schemas/MetricBulkTagConfigTagNameList'
type: object
MetricBulkTagConfigTagNameList:
description: A list of tag names to apply to the configuration.
@@ -68118,9 +68179,9 @@ components:
time: sum
properties:
space:
- $ref: "#/components/schemas/MetricCustomSpaceAggregation"
+ $ref: '#/components/schemas/MetricCustomSpaceAggregation'
time:
- $ref: "#/components/schemas/MetricCustomTimeAggregation"
+ $ref: '#/components/schemas/MetricCustomTimeAggregation'
required:
- time
- space
@@ -68134,7 +68195,7 @@ components:
- space: sum
time: count
items:
- $ref: "#/components/schemas/MetricCustomAggregation"
+ $ref: '#/components/schemas/MetricCustomAggregation'
type: array
MetricCustomSpaceAggregation:
description: A space aggregation for use in query.
@@ -68170,11 +68231,11 @@ components:
description: A dashboard object with title and popularity.
properties:
attributes:
- $ref: "#/components/schemas/MetricDashboardAttributes"
+ $ref: '#/components/schemas/MetricDashboardAttributes'
id:
- $ref: "#/components/schemas/MetricDashboardID"
+ $ref: '#/components/schemas/MetricDashboardID'
type:
- $ref: "#/components/schemas/MetricDashboardType"
+ $ref: '#/components/schemas/MetricDashboardType'
required:
- id
- type
@@ -68218,11 +68279,11 @@ components:
description: Object for a single metric's distinct volume.
properties:
attributes:
- $ref: "#/components/schemas/MetricDistinctVolumeAttributes"
+ $ref: '#/components/schemas/MetricDistinctVolumeAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricDistinctVolumeType"
+ $ref: '#/components/schemas/MetricDistinctVolumeType'
type: object
MetricDistinctVolumeAttributes:
description: Object containing the definition of a metric's distinct volume.
@@ -68246,17 +68307,17 @@ components:
description: Object for a metric cardinality estimate.
properties:
attributes:
- $ref: "#/components/schemas/MetricEstimateAttributes"
+ $ref: '#/components/schemas/MetricEstimateAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricEstimateResourceType"
+ $ref: '#/components/schemas/MetricEstimateResourceType'
type: object
MetricEstimateAttributes:
description: Object containing the definition of a metric estimate attribute.
properties:
estimate_type:
- $ref: "#/components/schemas/MetricEstimateType"
+ $ref: '#/components/schemas/MetricEstimateType'
estimated_at:
description: Timestamp when the cardinality estimate was requested.
example: "2022-04-27T09:48:37.463835Z"
@@ -68281,7 +68342,7 @@ components:
description: Response object that includes metric cardinality estimates.
properties:
data:
- $ref: "#/components/schemas/MetricEstimate"
+ $ref: '#/components/schemas/MetricEstimate'
type: object
MetricEstimateType:
default: count_or_gauge
@@ -68301,11 +68362,11 @@ components:
description: Object for a single metric's ingested and indexed volume.
properties:
attributes:
- $ref: "#/components/schemas/MetricIngestedIndexedVolumeAttributes"
+ $ref: '#/components/schemas/MetricIngestedIndexedVolumeAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricIngestedIndexedVolumeType"
+ $ref: '#/components/schemas/MetricIngestedIndexedVolumeType'
type: object
MetricIngestedIndexedVolumeAttributes:
description: Object containing the definition of a metric's ingested and indexed volume.
@@ -68362,7 +68423,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/MetricMetaPageType"
+ $ref: '#/components/schemas/MetricMetaPageType'
type: object
MetricMetaPageType:
default: cursor_limit
@@ -68377,17 +68438,17 @@ components:
description: Metadata for the metric.
properties:
origin:
- $ref: "#/components/schemas/MetricOrigin"
+ $ref: '#/components/schemas/MetricOrigin'
type: object
MetricMonitorAsset:
description: A monitor object with title.
properties:
attributes:
- $ref: "#/components/schemas/MetricAssetAttributes"
+ $ref: '#/components/schemas/MetricAssetAttributes'
id:
- $ref: "#/components/schemas/MetricMonitorID"
+ $ref: '#/components/schemas/MetricMonitorID'
type:
- $ref: "#/components/schemas/MetricMonitorType"
+ $ref: '#/components/schemas/MetricMonitorType'
required:
- id
- type
@@ -68412,11 +68473,11 @@ components:
description: A notebook object with title.
properties:
attributes:
- $ref: "#/components/schemas/MetricAssetAttributes"
+ $ref: '#/components/schemas/MetricAssetAttributes'
id:
- $ref: "#/components/schemas/MetricNotebookID"
+ $ref: '#/components/schemas/MetricNotebookID'
type:
- $ref: "#/components/schemas/MetricNotebookType"
+ $ref: '#/components/schemas/MetricNotebookType'
required:
- id
- type
@@ -68459,7 +68520,7 @@ components:
description: Response metadata object.
properties:
pagination:
- $ref: "#/components/schemas/MetricMetaPage"
+ $ref: '#/components/schemas/MetricMetaPage'
type: object
MetricPayload:
description: The metrics' payload.
@@ -68473,7 +68534,7 @@ components:
resources:
- {name: "dummyhost", type: "host"}
items:
- $ref: "#/components/schemas/MetricSeries"
+ $ref: '#/components/schemas/MetricSeries'
type: array
required:
- series
@@ -68497,7 +68558,7 @@ components:
description: Relationships for a metric.
properties:
metric_volumes:
- $ref: "#/components/schemas/MetricVolumesRelationship"
+ $ref: '#/components/schemas/MetricVolumesRelationship'
type: object
MetricResource:
description: Metric resource.
@@ -68514,11 +68575,11 @@ components:
description: A SLO object with title.
properties:
attributes:
- $ref: "#/components/schemas/MetricAssetAttributes"
+ $ref: '#/components/schemas/MetricAssetAttributes'
id:
- $ref: "#/components/schemas/MetricSLOID"
+ $ref: '#/components/schemas/MetricSLOID'
type:
- $ref: "#/components/schemas/MetricSLOType"
+ $ref: '#/components/schemas/MetricSLOType'
required:
- id
- type
@@ -68546,7 +68607,7 @@ components:
format: int64
type: integer
metadata:
- $ref: "#/components/schemas/MetricMetadata"
+ $ref: '#/components/schemas/MetricMetadata'
metric:
description: The name of the timeseries.
example: system.load.1
@@ -68556,12 +68617,12 @@ components:
example:
- {timestamp: 1575317847, value: 0.5}
items:
- $ref: "#/components/schemas/MetricPoint"
+ $ref: '#/components/schemas/MetricPoint'
type: array
resources:
description: A list of resources to associate with this metric.
items:
- $ref: "#/components/schemas/MetricResource"
+ $ref: '#/components/schemas/MetricResource'
type: array
source_type_name:
description: The source type name.
@@ -68575,7 +68636,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/MetricIntakeType"
+ $ref: '#/components/schemas/MetricIntakeType'
unit:
description: The unit of point value.
example: "second"
@@ -68593,30 +68654,30 @@ components:
- space: sum
time: count
items:
- $ref: "#/components/schemas/MetricCustomAggregation"
+ $ref: '#/components/schemas/MetricCustomAggregation'
type: array
MetricSuggestedTagsAndAggregations:
description: Object for a single metric's actively queried tags and aggregations.
properties:
attributes:
- $ref: "#/components/schemas/MetricSuggestedTagsAttributes"
+ $ref: '#/components/schemas/MetricSuggestedTagsAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricActiveConfigurationType"
+ $ref: '#/components/schemas/MetricActiveConfigurationType'
type: object
MetricSuggestedTagsAndAggregationsResponse:
description: Response object that includes a single metric's actively queried tags and aggregations.
properties:
data:
- $ref: "#/components/schemas/MetricSuggestedTagsAndAggregations"
+ $ref: '#/components/schemas/MetricSuggestedTagsAndAggregations'
readOnly: true
type: object
MetricSuggestedTagsAttributes:
description: Object containing the definition of a metric's actively queried tags and aggregations.
properties:
active_aggregations:
- $ref: "#/components/schemas/MetricSuggestedAggregations"
+ $ref: '#/components/schemas/MetricSuggestedAggregations'
active_tags:
description: List of tag keys that have been actively queried.
example: ["app", "datacenter"]
@@ -68628,7 +68689,7 @@ components:
MetricTagCardinalitiesData:
description: A list of tag cardinalities associated with the given metric.
items:
- $ref: "#/components/schemas/MetricTagCardinality"
+ $ref: '#/components/schemas/MetricTagCardinality'
type: array
MetricTagCardinalitiesMeta:
description: Response metadata object.
@@ -68644,9 +68705,9 @@ components:
Response object that includes an array of objects representing the cardinality details of a metric's tags.
properties:
data:
- $ref: "#/components/schemas/MetricTagCardinalitiesData"
+ $ref: '#/components/schemas/MetricTagCardinalitiesData'
meta:
- $ref: "#/components/schemas/MetricTagCardinalitiesMeta"
+ $ref: '#/components/schemas/MetricTagCardinalitiesMeta'
readOnly: true
type: object
MetricTagCardinality:
@@ -68658,7 +68719,7 @@ components:
type: tag_cardinality
properties:
attributes:
- $ref: "#/components/schemas/MetricTagCardinalityAttributes"
+ $ref: '#/components/schemas/MetricTagCardinalityAttributes'
id:
description: The name of the tag key.
type: string
@@ -68688,19 +68749,19 @@ components:
type: manage_tags
properties:
attributes:
- $ref: "#/components/schemas/MetricTagConfigurationAttributes"
+ $ref: '#/components/schemas/MetricTagConfigurationAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
relationships:
- $ref: "#/components/schemas/MetricRelationships"
+ $ref: '#/components/schemas/MetricRelationships'
type:
- $ref: "#/components/schemas/MetricTagConfigurationType"
+ $ref: '#/components/schemas/MetricTagConfigurationType'
type: object
MetricTagConfigurationAttributes:
description: Object containing the definition of a metric tag configuration attributes.
properties:
aggregations:
- $ref: "#/components/schemas/MetricCustomAggregations"
+ $ref: '#/components/schemas/MetricCustomAggregations'
created_at:
description: Timestamp when the tag configuration was created.
example: "2020-03-25T09:48:37.463835Z"
@@ -68719,7 +68780,7 @@ components:
example: true
type: boolean
metric_type:
- $ref: "#/components/schemas/MetricTagConfigurationMetricTypes"
+ $ref: '#/components/schemas/MetricTagConfigurationMetricTypes'
modified_at:
description: Timestamp when the tag configuration was last modified.
example: "2020-03-25T09:48:37.463835Z"
@@ -68737,7 +68798,7 @@ components:
description: Object containing the definition of a metric tag configuration to be created.
properties:
aggregations:
- $ref: "#/components/schemas/MetricCustomAggregations"
+ $ref: '#/components/schemas/MetricCustomAggregations'
exclude_tags_mode:
description: |-
When set to true, the configuration will exclude the configured tags and include any other submitted tags.
@@ -68751,7 +68812,7 @@ components:
example: true
type: boolean
metric_type:
- $ref: "#/components/schemas/MetricTagConfigurationMetricTypes"
+ $ref: '#/components/schemas/MetricTagConfigurationMetricTypes'
tags:
default: []
description: A list of tag keys that will be queryable for your metric.
@@ -68777,11 +68838,11 @@ components:
type: manage_tags
properties:
attributes:
- $ref: "#/components/schemas/MetricTagConfigurationCreateAttributes"
+ $ref: '#/components/schemas/MetricTagConfigurationCreateAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricTagConfigurationType"
+ $ref: '#/components/schemas/MetricTagConfigurationType'
required:
- id
- type
@@ -68790,7 +68851,7 @@ components:
description: Request object that includes the metric that you would like to configure tags for.
properties:
data:
- $ref: "#/components/schemas/MetricTagConfigurationCreateData"
+ $ref: '#/components/schemas/MetricTagConfigurationCreateData'
required:
- data
type: object
@@ -68824,7 +68885,7 @@ components:
description: Response object which includes a single metric's tag configuration.
properties:
data:
- $ref: "#/components/schemas/MetricTagConfiguration"
+ $ref: '#/components/schemas/MetricTagConfiguration'
readOnly: true
type: object
MetricTagConfigurationType:
@@ -68840,7 +68901,7 @@ components:
description: Object containing the definition of a metric tag configuration to be updated.
properties:
aggregations:
- $ref: "#/components/schemas/MetricCustomAggregations"
+ $ref: '#/components/schemas/MetricCustomAggregations'
exclude_tags_mode:
description: |-
When set to true, the configuration will exclude the configured tags and include any other submitted tags.
@@ -68874,11 +68935,11 @@ components:
type: manage_tags
properties:
attributes:
- $ref: "#/components/schemas/MetricTagConfigurationUpdateAttributes"
+ $ref: '#/components/schemas/MetricTagConfigurationUpdateAttributes'
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricTagConfigurationType"
+ $ref: '#/components/schemas/MetricTagConfigurationType'
required:
- id
- type
@@ -68887,7 +68948,7 @@ components:
description: Request object that includes the metric that you would like to edit the tag configuration on.
properties:
data:
- $ref: "#/components/schemas/MetricTagConfigurationUpdateData"
+ $ref: '#/components/schemas/MetricTagConfigurationUpdateData'
required:
- data
type: object
@@ -68903,27 +68964,27 @@ components:
MetricVolumes:
description: Possible response objects for a metric's volume.
oneOf:
- - $ref: "#/components/schemas/MetricDistinctVolume"
- - $ref: "#/components/schemas/MetricIngestedIndexedVolume"
+ - $ref: '#/components/schemas/MetricDistinctVolume'
+ - $ref: '#/components/schemas/MetricIngestedIndexedVolume'
MetricVolumesRelationship:
description: Relationship to a metric volume included in the response.
properties:
data:
- $ref: "#/components/schemas/MetricVolumesRelationshipData"
+ $ref: '#/components/schemas/MetricVolumesRelationshipData'
type: object
MetricVolumesRelationshipData:
description: Relationship data for a metric volume.
properties:
id:
- $ref: "#/components/schemas/MetricName"
+ $ref: '#/components/schemas/MetricName'
type:
- $ref: "#/components/schemas/MetricIngestedIndexedVolumeType"
+ $ref: '#/components/schemas/MetricIngestedIndexedVolumeType'
type: object
MetricVolumesResponse:
description: Response object which includes a single metric's volume.
properties:
data:
- $ref: "#/components/schemas/MetricVolumes"
+ $ref: '#/components/schemas/MetricVolumes'
readOnly: true
type: object
MetricsAggregator:
@@ -68954,25 +69015,25 @@ components:
MetricsAndMetricTagConfigurations:
description: Object for a metrics and metric tag configurations.
oneOf:
- - $ref: "#/components/schemas/Metric"
- - $ref: "#/components/schemas/MetricTagConfiguration"
+ - $ref: '#/components/schemas/Metric'
+ - $ref: '#/components/schemas/MetricTagConfiguration'
MetricsAndMetricTagConfigurationsResponse:
description: Response object that includes metrics and metric tag configurations.
properties:
data:
description: Array of metrics and metric tag configurations.
items:
- $ref: "#/components/schemas/MetricsAndMetricTagConfigurations"
+ $ref: '#/components/schemas/MetricsAndMetricTagConfigurations'
type: array
included:
description: Array of metric volume resources included when requested with `include=metric_volumes`.
items:
- $ref: "#/components/schemas/MetricIngestedIndexedVolume"
+ $ref: '#/components/schemas/MetricIngestedIndexedVolume'
type: array
links:
- $ref: "#/components/schemas/MetricsListResponseLinks"
+ $ref: '#/components/schemas/MetricsListResponseLinks'
meta:
- $ref: "#/components/schemas/MetricPaginationMeta"
+ $ref: '#/components/schemas/MetricPaginationMeta'
readOnly: true
type: object
MetricsDataSource:
@@ -69012,11 +69073,11 @@ components:
description: A query against Datadog custom metrics or Cloud Cost data sources.
properties:
aggregator:
- $ref: "#/components/schemas/MetricsAggregator"
+ $ref: '#/components/schemas/MetricsAggregator'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/MetricsDataSource"
+ $ref: '#/components/schemas/MetricsDataSource'
name:
description: The variable name for use in formulas.
type: string
@@ -69033,9 +69094,9 @@ components:
description: A query against Datadog custom metrics or Cloud Cost data sources.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/MetricsDataSource"
+ $ref: '#/components/schemas/MetricsDataSource'
name:
description: The variable name for use in formulas.
type: string
@@ -69054,7 +69115,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
client_id:
description: Azure AD client ID used for authentication.
example: "a1b2c3d4-5678-90ab-cdef-1234567890ab"
@@ -69091,7 +69152,7 @@ components:
example: "abcdef12-3456-7890-abcd-ef1234567890"
type: string
type:
- $ref: "#/components/schemas/MicrosoftSentinelDestinationType"
+ $ref: '#/components/schemas/MicrosoftSentinelDestinationType'
required:
- id
- type
@@ -69134,7 +69195,7 @@ components:
description: Channel data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseAttributes'
id:
description: The ID of the channel.
example: "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2"
@@ -69142,7 +69203,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/MicrosoftTeamsChannelInfoType"
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoType'
type: object
MicrosoftTeamsChannelInfoType:
default: ms-teams-channel-info
@@ -69158,7 +69219,7 @@ components:
nullable: true
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsConfigurationReferenceData"
+ $ref: '#/components/schemas/MicrosoftTeamsConfigurationReferenceData'
required:
- data
type: object
@@ -69182,7 +69243,7 @@ components:
description: Create tenant-based handle request.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestData"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestData'
required:
- data
type: object
@@ -69190,7 +69251,7 @@ components:
description: Create Workflows webhook handle request.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestData'
required:
- data
type: object
@@ -69198,7 +69259,7 @@ components:
description: Response with channel, team, and tenant ID information.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsChannelInfoResponseData"
+ $ref: '#/components/schemas/MicrosoftTeamsChannelInfoResponseData'
type: object
MicrosoftTeamsTenantBasedHandleAttributes:
description: Tenant-based handle attributes.
@@ -69267,7 +69328,7 @@ components:
description: Tenant-based handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseAttributes'
id:
description: The ID of the tenant-based handle.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -69275,7 +69336,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoType'
type: object
MicrosoftTeamsTenantBasedHandleInfoType:
default: ms-teams-tenant-based-handle-info
@@ -69319,9 +69380,9 @@ components:
description: Tenant-based handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleRequestAttributes'
type:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType'
required:
- type
- attributes
@@ -69330,7 +69391,7 @@ components:
description: Response of a tenant-based handle.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponseData"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponseData'
required:
- data
type: object
@@ -69338,7 +69399,7 @@ components:
description: Tenant-based handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes'
id:
description: The ID of the tenant-based handle.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -69346,7 +69407,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType'
type: object
MicrosoftTeamsTenantBasedHandleType:
default: tenant-based-handle
@@ -69364,7 +69425,7 @@ components:
description: An array of tenant-based handles.
example: [{"attributes": {"channelId": "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2", "channelName": "General", "name": "general-handle", "teamId": "00000000-0000-0000-0000-000000000000", "teamName": "Example Team", "tenantId": "00000000-0000-0000-0000-000000000001", "tenantName": "Company, Inc."}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "ms-teams-tenant-based-handle-info"}, {"attributes": {"channelId": "19:b41k24b14bn1nwffkernfkwrnfneubgk1@thread.tacv2", "channelName": "General2", "name": "general-handle-2", "teamId": "00000000-0000-0000-0000-000000000002", "teamName": "Example Team 2", "tenantId": "00000000-0000-0000-0000-000000000003", "tenantName": "Company, Inc."}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "ms-teams-tenant-based-handle-info"}]
items:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleInfoResponseData'
type: array
required:
- data
@@ -69373,7 +69434,7 @@ components:
description: Update tenant-based handle request.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequestData"
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequestData'
required:
- data
type: object
@@ -69381,9 +69442,9 @@ components:
description: Tenant-based handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleAttributes'
type:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleType'
required:
- type
- attributes
@@ -69392,7 +69453,7 @@ components:
description: Update Workflows webhook handle request.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData"
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequestData'
required:
- data
type: object
@@ -69400,9 +69461,9 @@ components:
description: Workflows Webhook handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleAttributes'
type:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
required:
- type
- attributes
@@ -69442,9 +69503,9 @@ components:
description: Workflows Webhook handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleRequestAttributes'
type:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
required:
- type
- attributes
@@ -69453,7 +69514,7 @@ components:
description: Response of a Workflows webhook handle.
properties:
data:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData'
required:
- data
type: object
@@ -69461,7 +69522,7 @@ components:
description: Workflows Webhook handle data from a response.
properties:
attributes:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookResponseAttributes'
id:
description: The ID of the Workflows webhook handle.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -69469,7 +69530,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleType'
type: object
MicrosoftTeamsWorkflowsWebhookHandleType:
default: workflows-webhook-handle
@@ -69487,7 +69548,7 @@ components:
description: An array of Workflows webhook handles.
example: [{"attributes": {"name": "general-handle"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "workflows-webhook-handle"}, {"attributes": {"name": "general-handle-2"}, "id": "596da4af-0563-4097-90ff-07230c3f9db4", "type": "workflows-webhook-handle"}]
items:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponseData'
type: array
required:
- data
@@ -69581,13 +69642,13 @@ components:
description: A facet keys JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabFacetKeysAttributes"
+ $ref: '#/components/schemas/ModelLabFacetKeysAttributes'
id:
description: The unique identifier of the facet keys resource.
example: "1"
type: string
type:
- $ref: "#/components/schemas/ModelLabFacetKeysType"
+ $ref: '#/components/schemas/ModelLabFacetKeysType'
required:
- id
- type
@@ -69597,7 +69658,7 @@ components:
description: Response containing available facet keys.
properties:
data:
- $ref: "#/components/schemas/ModelLabFacetKeysData"
+ $ref: '#/components/schemas/ModelLabFacetKeysData'
required:
- data
type: object
@@ -69637,10 +69698,10 @@ components:
metric_stat_ranges:
description: The ranges for each metric statistic.
items:
- $ref: "#/components/schemas/ModelLabMetricStatRange"
+ $ref: '#/components/schemas/ModelLabMetricStatRange'
type: array
numeric_range:
- $ref: "#/components/schemas/ModelLabNumericRange"
+ $ref: '#/components/schemas/ModelLabNumericRange'
values:
description: The list of available string values for this facet.
example:
@@ -69657,13 +69718,13 @@ components:
description: A facet values JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabFacetValuesAttributes"
+ $ref: '#/components/schemas/ModelLabFacetValuesAttributes'
id:
description: The unique identifier of the facet values resource.
example: "1"
type: string
type:
- $ref: "#/components/schemas/ModelLabFacetValuesType"
+ $ref: '#/components/schemas/ModelLabFacetValuesType'
required:
- id
- type
@@ -69673,7 +69734,7 @@ components:
description: Response containing available values for a facet key.
properties:
data:
- $ref: "#/components/schemas/ModelLabFacetValuesData"
+ $ref: '#/components/schemas/ModelLabFacetValuesData'
required:
- data
type: object
@@ -69779,7 +69840,7 @@ components:
description: Pagination metadata for a list response.
properties:
page:
- $ref: "#/components/schemas/ModelLabPageMetaPage"
+ $ref: '#/components/schemas/ModelLabPageMetaPage'
required:
- page
type: object
@@ -69854,7 +69915,7 @@ components:
files:
description: The list of artifact files associated with the project.
items:
- $ref: "#/components/schemas/ModelLabArtifactInfo"
+ $ref: '#/components/schemas/ModelLabArtifactInfo'
type: array
required:
- files
@@ -69863,13 +69924,13 @@ components:
description: A project artifacts JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabProjectArtifactsAttributes"
+ $ref: '#/components/schemas/ModelLabProjectArtifactsAttributes'
id:
description: The unique identifier of the project artifacts resource.
example: "1"
type: string
type:
- $ref: "#/components/schemas/ModelLabProjectArtifactsType"
+ $ref: '#/components/schemas/ModelLabProjectArtifactsType'
required:
- id
- type
@@ -69879,7 +69940,7 @@ components:
description: Response containing the artifact listing for a Model Lab project.
properties:
data:
- $ref: "#/components/schemas/ModelLabProjectArtifactsData"
+ $ref: '#/components/schemas/ModelLabProjectArtifactsData'
required:
- data
type: object
@@ -69931,7 +69992,7 @@ components:
tags:
description: The list of tags associated with the project.
items:
- $ref: "#/components/schemas/ModelLabTag"
+ $ref: '#/components/schemas/ModelLabTag'
type: array
updated_at:
description: The date and time the project was last updated.
@@ -69951,13 +70012,13 @@ components:
description: A Model Lab project JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabProjectAttributes"
+ $ref: '#/components/schemas/ModelLabProjectAttributes'
id:
description: The unique identifier of the project.
example: "2"
type: string
type:
- $ref: "#/components/schemas/ModelLabProjectType"
+ $ref: '#/components/schemas/ModelLabProjectType'
required:
- id
- type
@@ -69975,7 +70036,7 @@ components:
description: Response containing a single Model Lab project.
properties:
data:
- $ref: "#/components/schemas/ModelLabProjectData"
+ $ref: '#/components/schemas/ModelLabProjectData'
required:
- data
type: object
@@ -69993,12 +70054,12 @@ components:
data:
description: The list of projects.
items:
- $ref: "#/components/schemas/ModelLabProjectData"
+ $ref: '#/components/schemas/ModelLabProjectData'
type: array
links:
- $ref: "#/components/schemas/ModelLabPaginationLinks"
+ $ref: '#/components/schemas/ModelLabPaginationLinks'
meta:
- $ref: "#/components/schemas/ModelLabPageMeta"
+ $ref: '#/components/schemas/ModelLabPageMeta'
required:
- data
- meta
@@ -70009,7 +70070,7 @@ components:
files:
description: The list of artifact files and directories.
items:
- $ref: "#/components/schemas/ModelLabArtifactObjectInfo"
+ $ref: '#/components/schemas/ModelLabArtifactObjectInfo'
type: array
path_in_project:
description: The path of the run's artifacts relative to the project's artifact root.
@@ -70023,13 +70084,13 @@ components:
description: A run artifacts JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabRunArtifactsAttributes"
+ $ref: '#/components/schemas/ModelLabRunArtifactsAttributes'
id:
description: The unique identifier of the artifacts resource.
example: "42"
type: string
type:
- $ref: "#/components/schemas/ModelLabRunArtifactsType"
+ $ref: '#/components/schemas/ModelLabRunArtifactsType'
required:
- id
- type
@@ -70039,7 +70100,7 @@ components:
description: Response containing the artifact listing for a Model Lab run.
properties:
data:
- $ref: "#/components/schemas/ModelLabRunArtifactsData"
+ $ref: '#/components/schemas/ModelLabRunArtifactsData'
required:
- data
type: object
@@ -70097,7 +70158,7 @@ components:
metric_summaries:
description: Summary statistics for metrics recorded during the run.
items:
- $ref: "#/components/schemas/ModelLabMetricSummary"
+ $ref: '#/components/schemas/ModelLabMetricSummary'
type: array
mlflow_artifact_location:
description: The MLflow artifact storage location for this run.
@@ -70114,7 +70175,7 @@ components:
params:
description: The list of parameters used for the run.
items:
- $ref: "#/components/schemas/ModelLabRunParam"
+ $ref: '#/components/schemas/ModelLabRunParam'
nullable: true
type: array
project_id:
@@ -70128,11 +70189,11 @@ components:
format: date-time
type: string
status:
- $ref: "#/components/schemas/ModelLabRunStatus"
+ $ref: '#/components/schemas/ModelLabRunStatus'
tags:
description: The list of tags associated with the run.
items:
- $ref: "#/components/schemas/ModelLabTag"
+ $ref: '#/components/schemas/ModelLabTag'
type: array
updated_at:
description: The date and time the run was last updated.
@@ -70159,13 +70220,13 @@ components:
description: A Model Lab run JSON:API resource object.
properties:
attributes:
- $ref: "#/components/schemas/ModelLabRunAttributes"
+ $ref: '#/components/schemas/ModelLabRunAttributes'
id:
description: The unique identifier of the run.
example: "42"
type: string
type:
- $ref: "#/components/schemas/ModelLabRunType"
+ $ref: '#/components/schemas/ModelLabRunType'
required:
- id
- type
@@ -70190,7 +70251,7 @@ components:
description: Response containing a single Model Lab run.
properties:
data:
- $ref: "#/components/schemas/ModelLabRunData"
+ $ref: '#/components/schemas/ModelLabRunData'
required:
- data
type: object
@@ -70228,12 +70289,12 @@ components:
data:
description: The list of runs.
items:
- $ref: "#/components/schemas/ModelLabRunData"
+ $ref: '#/components/schemas/ModelLabRunData'
type: array
links:
- $ref: "#/components/schemas/ModelLabPaginationLinks"
+ $ref: '#/components/schemas/ModelLabPaginationLinks'
meta:
- $ref: "#/components/schemas/ModelLabPageMeta"
+ $ref: '#/components/schemas/ModelLabPageMeta'
required:
- data
- meta
@@ -70279,9 +70340,9 @@ components:
description: Policy and policy type for a monitor configuration policy.
properties:
policy:
- $ref: "#/components/schemas/MonitorConfigPolicyPolicyCreateRequest"
+ $ref: '#/components/schemas/MonitorConfigPolicyPolicyCreateRequest'
policy_type:
- $ref: "#/components/schemas/MonitorConfigPolicyType"
+ $ref: '#/components/schemas/MonitorConfigPolicyType'
required:
- policy_type
- policy
@@ -70290,9 +70351,9 @@ components:
description: Policy and policy type for a monitor configuration policy.
properties:
policy:
- $ref: "#/components/schemas/MonitorConfigPolicyPolicy"
+ $ref: '#/components/schemas/MonitorConfigPolicyPolicy'
policy_type:
- $ref: "#/components/schemas/MonitorConfigPolicyType"
+ $ref: '#/components/schemas/MonitorConfigPolicyType'
required:
- policy_type
- policy
@@ -70301,17 +70362,17 @@ components:
description: Policy and policy type for a monitor configuration policy.
properties:
policy:
- $ref: "#/components/schemas/MonitorConfigPolicyPolicy"
+ $ref: '#/components/schemas/MonitorConfigPolicyPolicy'
policy_type:
- $ref: "#/components/schemas/MonitorConfigPolicyType"
+ $ref: '#/components/schemas/MonitorConfigPolicyType'
type: object
MonitorConfigPolicyCreateData:
description: A monitor configuration policy data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorConfigPolicyAttributeCreateRequest"
+ $ref: '#/components/schemas/MonitorConfigPolicyAttributeCreateRequest'
type:
- $ref: "#/components/schemas/MonitorConfigPolicyResourceType"
+ $ref: '#/components/schemas/MonitorConfigPolicyResourceType'
required:
- type
- attributes
@@ -70320,7 +70381,7 @@ components:
description: Request for creating a monitor configuration policy.
properties:
data:
- $ref: "#/components/schemas/MonitorConfigPolicyCreateData"
+ $ref: '#/components/schemas/MonitorConfigPolicyCreateData'
required:
- data
type: object
@@ -70328,13 +70389,13 @@ components:
description: A monitor configuration policy data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorConfigPolicyAttributeEditRequest"
+ $ref: '#/components/schemas/MonitorConfigPolicyAttributeEditRequest'
id:
description: ID of this monitor configuration policy.
example: "00000000-0000-1234-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/MonitorConfigPolicyResourceType"
+ $ref: '#/components/schemas/MonitorConfigPolicyResourceType'
required:
- id
- type
@@ -70344,7 +70405,7 @@ components:
description: Request for editing a monitor configuration policy.
properties:
data:
- $ref: "#/components/schemas/MonitorConfigPolicyEditData"
+ $ref: '#/components/schemas/MonitorConfigPolicyEditData'
required:
- data
type: object
@@ -70354,17 +70415,17 @@ components:
data:
description: An array of monitor configuration policies.
items:
- $ref: "#/components/schemas/MonitorConfigPolicyResponseData"
+ $ref: '#/components/schemas/MonitorConfigPolicyResponseData'
type: array
type: object
MonitorConfigPolicyPolicy:
description: Configuration for the policy.
oneOf:
- - $ref: "#/components/schemas/MonitorConfigPolicyTagPolicy"
+ - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicy'
MonitorConfigPolicyPolicyCreateRequest:
description: Configuration for the policy.
oneOf:
- - $ref: "#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest"
+ - $ref: '#/components/schemas/MonitorConfigPolicyTagPolicyCreateRequest'
MonitorConfigPolicyResourceType:
default: monitor-config-policy
description: Monitor configuration policy resource type.
@@ -70378,19 +70439,19 @@ components:
description: Response for retrieving a monitor configuration policy.
properties:
data:
- $ref: "#/components/schemas/MonitorConfigPolicyResponseData"
+ $ref: '#/components/schemas/MonitorConfigPolicyResponseData'
type: object
MonitorConfigPolicyResponseData:
description: A monitor configuration policy data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorConfigPolicyAttributeResponse"
+ $ref: '#/components/schemas/MonitorConfigPolicyAttributeResponse'
id:
description: ID of this monitor configuration policy.
example: "00000000-0000-1234-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/MonitorConfigPolicyResourceType"
+ $ref: '#/components/schemas/MonitorConfigPolicyResourceType'
type: object
MonitorConfigPolicyTagPolicy:
description: Tag attributes of a monitor configuration policy.
@@ -70462,10 +70523,10 @@ components:
data:
description: An array of downtime matches.
items:
- $ref: "#/components/schemas/MonitorDowntimeMatchResponseData"
+ $ref: '#/components/schemas/MonitorDowntimeMatchResponseData'
type: array
meta:
- $ref: "#/components/schemas/DowntimeMeta"
+ $ref: '#/components/schemas/DowntimeMeta'
type: object
MonitorDowntimeMatchResponseAttributes:
description: Downtime match details.
@@ -70485,7 +70546,7 @@ components:
type: string
type: array
scope:
- $ref: "#/components/schemas/DowntimeScope"
+ $ref: '#/components/schemas/DowntimeScope'
start:
description: The start of the downtime.
example: 2020-01-02 03:04:00+00:00
@@ -70496,29 +70557,29 @@ components:
description: A downtime match.
properties:
attributes:
- $ref: "#/components/schemas/MonitorDowntimeMatchResponseAttributes"
+ $ref: '#/components/schemas/MonitorDowntimeMatchResponseAttributes'
id:
description: The downtime ID.
example: "00000000-0000-1234-0000-000000000000"
nullable: true
type: string
type:
- $ref: "#/components/schemas/MonitorDowntimeMatchResourceType"
+ $ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
type: object
MonitorNotificationRuleAttributes:
additionalProperties: false
description: Attributes of the monitor notification rule.
properties:
bundle_config:
- $ref: "#/components/schemas/MonitorNotificationRuleBundleConfig"
+ $ref: '#/components/schemas/MonitorNotificationRuleBundleConfig'
conditional_recipients:
- $ref: "#/components/schemas/MonitorNotificationRuleConditionalRecipients"
+ $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients'
filter:
- $ref: "#/components/schemas/MonitorNotificationRuleFilter"
+ $ref: '#/components/schemas/MonitorNotificationRuleFilter'
name:
- $ref: "#/components/schemas/MonitorNotificationRuleName"
+ $ref: '#/components/schemas/MonitorNotificationRuleName'
recipients:
- $ref: "#/components/schemas/MonitorNotificationRuleRecipients"
+ $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
required: [name]
type: object
MonitorNotificationRuleBundleConfig:
@@ -70543,7 +70604,7 @@ components:
$ref: "#/components/schemas/MonitorNotificationRuleRecipients"
description: A list of recipients to notify. Uses the same format as the monitor `message` field. Must not start with an '@'.
scope:
- $ref: "#/components/schemas/MonitorNotificationRuleConditionScope"
+ $ref: '#/components/schemas/MonitorNotificationRuleConditionScope'
required: [scope, recipients]
type: object
MonitorNotificationRuleConditionScope:
@@ -70562,7 +70623,7 @@ components:
conditions:
description: Conditions of the notification rule.
items:
- $ref: "#/components/schemas/MonitorNotificationRuleCondition"
+ $ref: '#/components/schemas/MonitorNotificationRuleCondition'
maxItems: 10
minItems: 1
type: array
@@ -70575,35 +70636,35 @@ components:
description: Request for creating a monitor notification rule.
properties:
data:
- $ref: "#/components/schemas/MonitorNotificationRuleCreateRequestData"
+ $ref: '#/components/schemas/MonitorNotificationRuleCreateRequestData'
required: [data]
type: object
MonitorNotificationRuleCreateRequestData:
description: Object to create a monitor notification rule.
properties:
attributes:
- $ref: "#/components/schemas/MonitorNotificationRuleAttributes"
+ $ref: '#/components/schemas/MonitorNotificationRuleAttributes'
type:
- $ref: "#/components/schemas/MonitorNotificationRuleResourceType"
+ $ref: '#/components/schemas/MonitorNotificationRuleResourceType'
required: [attributes]
type: object
MonitorNotificationRuleData:
description: Monitor notification rule data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorNotificationRuleResponseAttributes"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponseAttributes'
id:
- $ref: "#/components/schemas/MonitorNotificationRuleId"
+ $ref: '#/components/schemas/MonitorNotificationRuleId'
relationships:
- $ref: "#/components/schemas/MonitorNotificationRuleRelationships"
+ $ref: '#/components/schemas/MonitorNotificationRuleRelationships'
type:
- $ref: "#/components/schemas/MonitorNotificationRuleResourceType"
+ $ref: '#/components/schemas/MonitorNotificationRuleResourceType'
type: object
MonitorNotificationRuleFilter:
description: Specifies the matching criteria for monitor notifications.
oneOf:
- - $ref: "#/components/schemas/MonitorNotificationRuleFilterTags"
- - $ref: "#/components/schemas/MonitorNotificationRuleFilterScope"
+ - $ref: '#/components/schemas/MonitorNotificationRuleFilterTags'
+ - $ref: '#/components/schemas/MonitorNotificationRuleFilterScope'
MonitorNotificationRuleFilterScope:
additionalProperties: false
description: Filters monitor notifications using a scope expression over key:value pairs with boolean logic (AND, OR, NOT).
@@ -70645,12 +70706,12 @@ components:
data:
description: A list of monitor notification rules.
items:
- $ref: "#/components/schemas/MonitorNotificationRuleData"
+ $ref: '#/components/schemas/MonitorNotificationRuleData'
type: array
included:
description: Array of objects related to the monitor notification rules.
items:
- $ref: "#/components/schemas/MonitorNotificationRuleResponseIncludedItem"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponseIncludedItem'
type: array
type: object
MonitorNotificationRuleName:
@@ -70675,13 +70736,13 @@ components:
description: All relationships associated with monitor notification rule.
properties:
created_by:
- $ref: "#/components/schemas/MonitorNotificationRuleRelationshipsCreatedBy"
+ $ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedBy'
type: object
MonitorNotificationRuleRelationshipsCreatedBy:
description: The user who created the monitor notification rule.
properties:
data:
- $ref: "#/components/schemas/MonitorNotificationRuleRelationshipsCreatedByData"
+ $ref: '#/components/schemas/MonitorNotificationRuleRelationshipsCreatedByData'
type: object
MonitorNotificationRuleRelationshipsCreatedByData:
description: Data for the user who created the monitor notification rule.
@@ -70692,7 +70753,7 @@ components:
example: "00000000-0000-1234-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
type: object
MonitorNotificationRuleResourceType:
default: monitor-notification-rule
@@ -70705,11 +70766,11 @@ components:
description: A monitor notification rule.
properties:
data:
- $ref: "#/components/schemas/MonitorNotificationRuleData"
+ $ref: '#/components/schemas/MonitorNotificationRuleData'
included:
description: Array of objects related to the monitor notification rule that the user requested.
items:
- $ref: "#/components/schemas/MonitorNotificationRuleResponseIncludedItem"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponseIncludedItem'
type: array
type: object
MonitorNotificationRuleResponseAttributes:
@@ -70717,61 +70778,61 @@ components:
description: Attributes of the monitor notification rule.
properties:
bundle_config:
- $ref: "#/components/schemas/MonitorNotificationRuleBundleConfig"
+ $ref: '#/components/schemas/MonitorNotificationRuleBundleConfig'
conditional_recipients:
- $ref: "#/components/schemas/MonitorNotificationRuleConditionalRecipients"
+ $ref: '#/components/schemas/MonitorNotificationRuleConditionalRecipients'
created:
description: Creation time of the monitor notification rule.
example: 2020-01-02 03:04:00+00:00
format: date-time
type: string
filter:
- $ref: "#/components/schemas/MonitorNotificationRuleFilter"
+ $ref: '#/components/schemas/MonitorNotificationRuleFilter'
modified:
description: Time the monitor notification rule was last modified.
example: 2020-01-02 03:04:00+00:00
format: date-time
type: string
name:
- $ref: "#/components/schemas/MonitorNotificationRuleName"
+ $ref: '#/components/schemas/MonitorNotificationRuleName'
recipients:
- $ref: "#/components/schemas/MonitorNotificationRuleRecipients"
+ $ref: '#/components/schemas/MonitorNotificationRuleRecipients'
type: object
MonitorNotificationRuleResponseIncludedItem:
description: An object related to a monitor notification rule.
oneOf:
- - $ref: "#/components/schemas/User"
+ - $ref: '#/components/schemas/User'
MonitorNotificationRuleUpdateRequest:
description: Request for updating a monitor notification rule.
properties:
data:
- $ref: "#/components/schemas/MonitorNotificationRuleUpdateRequestData"
+ $ref: '#/components/schemas/MonitorNotificationRuleUpdateRequestData'
required: [data]
type: object
MonitorNotificationRuleUpdateRequestData:
description: Object to update a monitor notification rule.
properties:
attributes:
- $ref: "#/components/schemas/MonitorNotificationRuleAttributes"
+ $ref: '#/components/schemas/MonitorNotificationRuleAttributes'
id:
- $ref: "#/components/schemas/MonitorNotificationRuleId"
+ $ref: '#/components/schemas/MonitorNotificationRuleId'
type:
- $ref: "#/components/schemas/MonitorNotificationRuleResourceType"
+ $ref: '#/components/schemas/MonitorNotificationRuleResourceType'
required: [id, attributes]
type: object
MonitorTrigger:
description: "Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
MonitorTriggerWrapper:
description: "Schema for a Monitor-based trigger."
properties:
monitorTrigger:
- $ref: "#/components/schemas/MonitorTrigger"
+ $ref: '#/components/schemas/MonitorTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- monitorTrigger
type: object
@@ -70832,37 +70893,37 @@ components:
description: A monitor user template object.
properties:
created:
- $ref: "#/components/schemas/MonitorUserTemplateCreated"
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
description:
- $ref: "#/components/schemas/MonitorUserTemplateDescription"
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
modified:
- $ref: "#/components/schemas/MonitorUserTemplateModified"
+ $ref: '#/components/schemas/MonitorUserTemplateModified'
monitor_definition:
additionalProperties: {}
description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"}
type: object
tags:
- $ref: "#/components/schemas/MonitorUserTemplateTags"
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
template_variables:
- $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables"
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
title:
- $ref: "#/components/schemas/MonitorUserTemplateTitle"
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
version:
- $ref: "#/components/schemas/MonitorUserTemplateVersion"
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
versions:
description: All versions of the monitor user template.
items:
- $ref: "#/components/schemas/SimpleMonitorUserTemplate"
+ $ref: '#/components/schemas/SimpleMonitorUserTemplate'
type: array
type: object
MonitorUserTemplateCreateData:
description: Monitor user template data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorUserTemplateRequestAttributes"
+ $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
type:
- $ref: "#/components/schemas/MonitorUserTemplateResourceType"
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
required:
- type
- attributes
@@ -70871,7 +70932,7 @@ components:
description: Request for creating a monitor user template.
properties:
data:
- $ref: "#/components/schemas/MonitorUserTemplateCreateData"
+ $ref: '#/components/schemas/MonitorUserTemplateCreateData'
required:
- data
type: object
@@ -70879,7 +70940,7 @@ components:
description: Response for creating a monitor user template.
properties:
data:
- $ref: "#/components/schemas/MonitorUserTemplateResponseData"
+ $ref: '#/components/schemas/MonitorUserTemplateResponseData'
type: object
MonitorUserTemplateCreated:
description: The created timestamp of the template.
@@ -70902,7 +70963,7 @@ components:
data:
description: An array of monitor user templates.
items:
- $ref: "#/components/schemas/MonitorUserTemplateResponseData"
+ $ref: '#/components/schemas/MonitorUserTemplateResponseData'
type: array
type: object
MonitorUserTemplateModified:
@@ -70916,18 +70977,18 @@ components:
description: Attributes for a monitor user template.
properties:
description:
- $ref: "#/components/schemas/MonitorUserTemplateDescription"
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
monitor_definition:
additionalProperties: {}
description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"}
type: object
tags:
- $ref: "#/components/schemas/MonitorUserTemplateTags"
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
template_variables:
- $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables"
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
title:
- $ref: "#/components/schemas/MonitorUserTemplateTitle"
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
required:
- title
- monitor_definition
@@ -70946,51 +71007,51 @@ components:
description: Response for retrieving a monitor user template.
properties:
data:
- $ref: "#/components/schemas/MonitorUserTemplateResponseDataWithVersions"
+ $ref: '#/components/schemas/MonitorUserTemplateResponseDataWithVersions'
type: object
MonitorUserTemplateResponseAttributes:
additionalProperties: {}
description: Attributes for a monitor user template.
properties:
created:
- $ref: "#/components/schemas/MonitorUserTemplateCreated"
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
description:
- $ref: "#/components/schemas/MonitorUserTemplateDescription"
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
modified:
- $ref: "#/components/schemas/MonitorUserTemplateModified"
+ $ref: '#/components/schemas/MonitorUserTemplateModified'
monitor_definition:
additionalProperties: {}
description: A valid monitor definition in the same format as the [V1 Monitor API](https://docs.datadoghq.com/api/latest/monitors/#create-a-monitor).
example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"}
type: object
tags:
- $ref: "#/components/schemas/MonitorUserTemplateTags"
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
template_variables:
- $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables"
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
title:
- $ref: "#/components/schemas/MonitorUserTemplateTitle"
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
version:
- $ref: "#/components/schemas/MonitorUserTemplateVersion"
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
type: object
MonitorUserTemplateResponseData:
description: Monitor user template list response data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorUserTemplateResponseAttributes"
+ $ref: '#/components/schemas/MonitorUserTemplateResponseAttributes'
id:
- $ref: "#/components/schemas/MonitorUserTemplateId"
+ $ref: '#/components/schemas/MonitorUserTemplateId'
type:
- $ref: "#/components/schemas/MonitorUserTemplateResourceType"
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
type: object
MonitorUserTemplateResponseDataWithVersions:
description: Monitor user template data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorUserTemplate"
+ $ref: '#/components/schemas/MonitorUserTemplate'
id:
- $ref: "#/components/schemas/MonitorUserTemplateId"
+ $ref: '#/components/schemas/MonitorUserTemplateId'
type:
- $ref: "#/components/schemas/MonitorUserTemplateResourceType"
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
type: object
MonitorUserTemplateTags:
description: The definition of `MonitorUserTemplateTags` object.
@@ -71008,7 +71069,7 @@ components:
MonitorUserTemplateTemplateVariables:
description: The definition of `MonitorUserTemplateTemplateVariables` object.
items:
- $ref: "#/components/schemas/MonitorUserTemplateTemplateVariablesItems"
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariablesItems'
type: array
MonitorUserTemplateTemplateVariablesItems:
additionalProperties: false
@@ -71052,11 +71113,11 @@ components:
description: Monitor user template data.
properties:
attributes:
- $ref: "#/components/schemas/MonitorUserTemplateRequestAttributes"
+ $ref: '#/components/schemas/MonitorUserTemplateRequestAttributes'
id:
- $ref: "#/components/schemas/MonitorUserTemplateId"
+ $ref: '#/components/schemas/MonitorUserTemplateId'
type:
- $ref: "#/components/schemas/MonitorUserTemplateResourceType"
+ $ref: '#/components/schemas/MonitorUserTemplateResourceType'
required:
- id
- type
@@ -71066,7 +71127,7 @@ components:
description: Request for creating a new monitor user template version.
properties:
data:
- $ref: "#/components/schemas/MonitorUserTemplateUpdateData"
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateData'
required:
- data
type: object
@@ -71094,7 +71155,7 @@ components:
description: The source of the cost attribution tag configuration and the selected tags in the format `::://////`.
type: string
tags:
- $ref: "#/components/schemas/CostAttributionTagNames"
+ $ref: '#/components/schemas/CostAttributionTagNames'
updated_at:
description: Shows the most recent hour in the current months for all organizations for which all costs were calculated.
type: string
@@ -71107,20 +71168,20 @@ components:
description: Cost data.
properties:
attributes:
- $ref: "#/components/schemas/MonthlyCostAttributionAttributes"
+ $ref: '#/components/schemas/MonthlyCostAttributionAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/CostAttributionType"
+ $ref: '#/components/schemas/CostAttributionType'
type: object
MonthlyCostAttributionMeta:
description: The object containing document metadata.
properties:
aggregates:
- $ref: "#/components/schemas/CostAttributionAggregates"
+ $ref: '#/components/schemas/CostAttributionAggregates'
pagination:
- $ref: "#/components/schemas/MonthlyCostAttributionPagination"
+ $ref: '#/components/schemas/MonthlyCostAttributionPagination'
type: object
MonthlyCostAttributionPagination:
description: The metadata for the current pagination.
@@ -71136,10 +71197,10 @@ components:
data:
description: Response containing cost attribution.
items:
- $ref: "#/components/schemas/MonthlyCostAttributionBody"
+ $ref: '#/components/schemas/MonthlyCostAttributionBody'
type: array
meta:
- $ref: "#/components/schemas/MonthlyCostAttributionMeta"
+ $ref: '#/components/schemas/MonthlyCostAttributionMeta'
type: object
MuteDataType:
default: mute
@@ -71202,7 +71263,7 @@ components:
description: Request to mute or unmute security findings.
properties:
data:
- $ref: "#/components/schemas/MuteFindingsRequestData"
+ $ref: '#/components/schemas/MuteFindingsRequestData'
required:
- data
type: object
@@ -71210,15 +71271,15 @@ components:
description: Data of the mute request.
properties:
attributes:
- $ref: "#/components/schemas/MuteFindingsRequestDataAttributes"
+ $ref: '#/components/schemas/MuteFindingsRequestDataAttributes'
id:
description: Unique identifier of the mute request.
example: "00000000-0000-0000-0000-000000000001"
type: string
relationships:
- $ref: "#/components/schemas/MuteFindingsRequestDataRelationships"
+ $ref: '#/components/schemas/MuteFindingsRequestDataRelationships'
type:
- $ref: "#/components/schemas/MuteDataType"
+ $ref: '#/components/schemas/MuteDataType'
required:
- attributes
- relationships
@@ -71228,7 +71289,7 @@ components:
description: Attributes of the mute request.
properties:
mute:
- $ref: "#/components/schemas/MuteFindingsMuteAttributes"
+ $ref: '#/components/schemas/MuteFindingsMuteAttributes'
required:
- mute
type: object
@@ -71245,7 +71306,7 @@ components:
description: Response for the mute or unmute request.
properties:
data:
- $ref: "#/components/schemas/MuteFindingsResponseData"
+ $ref: '#/components/schemas/MuteFindingsResponseData'
type: object
MuteFindingsResponseData:
description: Data of the mute response.
@@ -71255,7 +71316,7 @@ components:
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/MuteDataType"
+ $ref: '#/components/schemas/MuteDataType'
required:
- type
- id
@@ -71287,7 +71348,7 @@ components:
format: int64
type: integer
reason:
- $ref: "#/components/schemas/MuteReason"
+ $ref: '#/components/schemas/MuteReason'
reason_description:
description: An optional description providing more context for the mute reason.
example: "Accepted for dev environments only"
@@ -71300,7 +71361,7 @@ components:
description: Attributes for creating or updating a mute rule.
properties:
action:
- $ref: "#/components/schemas/MuteRuleAction"
+ $ref: '#/components/schemas/MuteRuleAction'
enabled:
description: Whether the mute rule is enabled.
example: true
@@ -71312,7 +71373,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- rule
@@ -71322,14 +71383,14 @@ components:
description: Attributes of a mute rule returned by the API.
properties:
action:
- $ref: "#/components/schemas/MuteRuleAction"
+ $ref: '#/components/schemas/MuteRuleAction'
created_at:
description: The Unix timestamp in milliseconds when the rule was created.
example: 1722439510282
format: int64
type: integer
created_by:
- $ref: "#/components/schemas/AutomationRuleCreatedBy"
+ $ref: '#/components/schemas/AutomationRuleCreatedBy'
enabled:
description: Whether the mute rule is enabled.
example: true
@@ -71340,7 +71401,7 @@ components:
format: int64
type: integer
modified_by:
- $ref: "#/components/schemas/AutomationRuleModifiedBy"
+ $ref: '#/components/schemas/AutomationRuleModifiedBy'
name:
description: The name of the mute rule.
example: "Mute accepted risks in dev"
@@ -71348,7 +71409,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- enabled
@@ -71363,7 +71424,7 @@ components:
description: The body of a mute rule create request.
properties:
data:
- $ref: "#/components/schemas/MuteRuleDataCreate"
+ $ref: '#/components/schemas/MuteRuleDataCreate'
required:
- data
type: object
@@ -71371,9 +71432,9 @@ components:
description: The data object for a mute rule create or update request.
properties:
attributes:
- $ref: "#/components/schemas/MuteRuleAttributesCreate"
+ $ref: '#/components/schemas/MuteRuleAttributesCreate'
type:
- $ref: "#/components/schemas/MuteRuleType"
+ $ref: '#/components/schemas/MuteRuleType'
required:
- type
- attributes
@@ -71382,14 +71443,14 @@ components:
description: The data object for a mute rule returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/MuteRuleAttributesResponse"
+ $ref: '#/components/schemas/MuteRuleAttributesResponse'
id:
description: The ID of the mute rule.
example: "00000000-0000-0000-0000-000000000000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/MuteRuleType"
+ $ref: '#/components/schemas/MuteRuleType'
required:
- id
- type
@@ -71398,7 +71459,7 @@ components:
MuteRuleReorderData:
description: The ordered list of all mute rules; every rule must be included.
items:
- $ref: "#/components/schemas/MuteRuleReorderItem"
+ $ref: '#/components/schemas/MuteRuleReorderItem'
type: array
MuteRuleReorderItem:
description: A reference to a mute rule used for reordering.
@@ -71409,7 +71470,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/MuteRuleType"
+ $ref: '#/components/schemas/MuteRuleType'
required:
- type
- id
@@ -71418,7 +71479,7 @@ components:
description: The body of the mute rule reorder request.
properties:
data:
- $ref: "#/components/schemas/MuteRuleReorderData"
+ $ref: '#/components/schemas/MuteRuleReorderData'
required:
- data
type: object
@@ -71426,7 +71487,7 @@ components:
description: A single mute rule response.
properties:
data:
- $ref: "#/components/schemas/MuteRuleDataResponse"
+ $ref: '#/components/schemas/MuteRuleDataResponse'
required:
- data
type: object
@@ -71442,24 +71503,24 @@ components:
description: The body of a mute rule update request.
properties:
data:
- $ref: "#/components/schemas/MuteRuleDataCreate"
+ $ref: '#/components/schemas/MuteRuleDataCreate'
required:
- data
type: object
MuteRulesDataList:
description: A list of mute rule data objects.
items:
- $ref: "#/components/schemas/MuteRuleDataResponse"
+ $ref: '#/components/schemas/MuteRuleDataResponse'
type: array
MuteRulesResponse:
description: A list of mute rules with pagination metadata.
properties:
data:
- $ref: "#/components/schemas/MuteRulesDataList"
+ $ref: '#/components/schemas/MuteRulesDataList'
links:
- $ref: "#/components/schemas/SecurityAutomationRulesLinks"
+ $ref: '#/components/schemas/SecurityAutomationRulesLinks'
meta:
- $ref: "#/components/schemas/SecurityAutomationRulesMeta"
+ $ref: '#/components/schemas/SecurityAutomationRulesMeta'
required:
- data
- meta
@@ -71503,13 +71564,13 @@ components:
description: Android NDK symbol file data object.
properties:
attributes:
- $ref: "#/components/schemas/NDKSourcemapAttributes"
+ $ref: '#/components/schemas/NDKSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "7"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -71535,7 +71596,7 @@ components:
maxLength: 500
type: string
type:
- $ref: "#/components/schemas/NDKSymbolFileFormDataType"
+ $ref: '#/components/schemas/NDKSymbolFileFormDataType'
required:
- type
- build_id
@@ -71545,7 +71606,7 @@ components:
description: Multipart form data for uploading Android NDK symbol files for native crash symbolication.
properties:
event:
- $ref: "#/components/schemas/NDKSymbolFileEvent"
+ $ref: '#/components/schemas/NDKSymbolFileEvent'
ndk_symbol_file:
description: The NDK symbol file.
example: libnative.so
@@ -71567,13 +71628,13 @@ components:
description: A single network health insight describing a service-to-service connectivity issue.
properties:
attributes:
- $ref: "#/components/schemas/NetworkHealthInsightAttributes"
+ $ref: '#/components/schemas/NetworkHealthInsightAttributes'
id:
description: Unique identifier for this network health insight.
example: example-insight-id
type: string
type:
- $ref: "#/components/schemas/NetworkHealthInsightsType"
+ $ref: '#/components/schemas/NetworkHealthInsightsType'
required:
- type
- id
@@ -71644,7 +71705,7 @@ components:
minimum: 0
type: number
failure_type:
- $ref: "#/components/schemas/NetworkHealthInsightFailureType"
+ $ref: '#/components/schemas/NetworkHealthInsightFailureType'
loadbalancer_id:
description: ARN of the load balancer using the certificate. Only set for `tls-cert` insights.
example: "arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/app/my-lb/50dc6c495c0c9188"
@@ -71666,9 +71727,9 @@ components:
minimum: 0
type: integer
traffic_volume:
- $ref: "#/components/schemas/NetworkHealthInsightTrafficVolume"
+ $ref: '#/components/schemas/NetworkHealthInsightTrafficVolume'
type:
- $ref: "#/components/schemas/NetworkHealthInsightCategory"
+ $ref: '#/components/schemas/NetworkHealthInsightCategory'
type: object
NetworkHealthInsightCategory:
description: |-
@@ -71734,7 +71795,7 @@ components:
data:
description: Array of network health insights returned for the query window.
items:
- $ref: "#/components/schemas/NetworkHealthInsight"
+ $ref: '#/components/schemas/NetworkHealthInsight'
type: array
required:
- data
@@ -71756,7 +71817,7 @@ components:
description: The response payload containing tree-sitter node type definitions for a programming language.
properties:
data:
- $ref: "#/components/schemas/NodeTypesResponseData"
+ $ref: '#/components/schemas/NodeTypesResponseData'
required:
- data
type: object
@@ -71764,13 +71825,13 @@ components:
description: The primary data object in the node types response.
properties:
attributes:
- $ref: "#/components/schemas/NodeTypesResponseDataAttributes"
+ $ref: '#/components/schemas/NodeTypesResponseDataAttributes'
id:
description: The unique identifier of the node types response resource.
example: python
type: string
type:
- $ref: "#/components/schemas/NodeTypesResponseDataType"
+ $ref: '#/components/schemas/NodeTypesResponseDataType'
required:
- id
- type
@@ -71782,7 +71843,7 @@ components:
node_types:
description: The list of tree-sitter node type definitions for the language.
items:
- $ref: "#/components/schemas/NodeType"
+ $ref: '#/components/schemas/NodeType'
type: array
required:
- node_types
@@ -71800,7 +71861,7 @@ components:
description: Notebook creation data
properties:
type:
- $ref: "#/components/schemas/NotebookResourceType"
+ $ref: '#/components/schemas/NotebookResourceType'
required:
- type
type: object
@@ -71808,7 +71869,7 @@ components:
description: Notebook creation request
properties:
data:
- $ref: "#/components/schemas/NotebookCreateData"
+ $ref: '#/components/schemas/NotebookCreateData'
required:
- data
type: object
@@ -71827,7 +71888,7 @@ components:
description: "Trigger a workflow from a Notebook."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- notebookTrigger
type: object
@@ -71844,7 +71905,7 @@ components:
type: notification_channels
properties:
data:
- $ref: "#/components/schemas/NotificationChannelData"
+ $ref: '#/components/schemas/NotificationChannelData'
type: object
NotificationChannelAttributes:
description: Attributes for an on-call notification channel.
@@ -71859,19 +71920,19 @@ components:
NotificationChannelConfig:
description: "Defines the configuration for an On-Call notification channel"
oneOf:
- - $ref: "#/components/schemas/NotificationChannelPhoneConfig"
- - $ref: "#/components/schemas/NotificationChannelEmailConfig"
- - $ref: "#/components/schemas/NotificationChannelPushConfig"
+ - $ref: '#/components/schemas/NotificationChannelPhoneConfig'
+ - $ref: '#/components/schemas/NotificationChannelEmailConfig'
+ - $ref: '#/components/schemas/NotificationChannelPushConfig'
NotificationChannelData:
description: Data for an on-call notification channel
properties:
attributes:
- $ref: "#/components/schemas/NotificationChannelAttributes"
+ $ref: '#/components/schemas/NotificationChannelAttributes'
id:
description: Unique identifier for the channel
type: string
type:
- $ref: "#/components/schemas/NotificationChannelType"
+ $ref: '#/components/schemas/NotificationChannelType'
required:
- type
type: object
@@ -71887,10 +71948,10 @@ components:
example:
- html
items:
- $ref: "#/components/schemas/NotificationChannelEmailFormatType"
+ $ref: '#/components/schemas/NotificationChannelEmailFormatType'
type: array
type:
- $ref: "#/components/schemas/NotificationChannelEmailConfigType"
+ $ref: '#/components/schemas/NotificationChannelEmailConfigType'
required:
- type
- address
@@ -71937,7 +71998,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/NotificationChannelPhoneConfigType"
+ $ref: '#/components/schemas/NotificationChannelPhoneConfigType'
verified:
description: "Indicates whether this phone has been verified by the user in Datadog On-Call"
example: false
@@ -71970,7 +72031,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/NotificationChannelPushConfigType"
+ $ref: '#/components/schemas/NotificationChannelPushConfigType'
required:
- type
- device_name
@@ -72002,11 +72063,11 @@ components:
A notification rule is composed of a rule ID, a rule type, and the rule attributes. All fields are required.
properties:
attributes:
- $ref: "#/components/schemas/NotificationRuleAttributes"
+ $ref: '#/components/schemas/NotificationRuleAttributes'
id:
- $ref: "#/components/schemas/ID"
+ $ref: '#/components/schemas/ID'
type:
- $ref: "#/components/schemas/NotificationRulesType"
+ $ref: '#/components/schemas/NotificationRulesType'
required:
- attributes
- id
@@ -72016,25 +72077,25 @@ components:
description: Attributes of the notification rule.
properties:
created_at:
- $ref: "#/components/schemas/Date"
+ $ref: '#/components/schemas/Date'
created_by:
- $ref: "#/components/schemas/RuleUser"
+ $ref: '#/components/schemas/RuleUser'
enabled:
- $ref: "#/components/schemas/Enabled"
+ $ref: '#/components/schemas/Enabled'
modified_at:
- $ref: "#/components/schemas/Date"
+ $ref: '#/components/schemas/Date'
modified_by:
- $ref: "#/components/schemas/RuleUser"
+ $ref: '#/components/schemas/RuleUser'
name:
- $ref: "#/components/schemas/RuleName"
+ $ref: '#/components/schemas/RuleName'
selectors:
- $ref: "#/components/schemas/Selectors"
+ $ref: '#/components/schemas/Selectors'
targets:
- $ref: "#/components/schemas/Targets"
+ $ref: '#/components/schemas/Targets'
time_aggregation:
- $ref: "#/components/schemas/TimeAggregation"
+ $ref: '#/components/schemas/TimeAggregation'
version:
- $ref: "#/components/schemas/Version"
+ $ref: '#/components/schemas/Version'
required:
- created_at
- created_by
@@ -72062,7 +72123,7 @@ components:
description: Response from the notification preview request.
properties:
data:
- $ref: "#/components/schemas/NotificationRulePreviewResponseData"
+ $ref: '#/components/schemas/NotificationRulePreviewResponseData'
required:
- data
type: object
@@ -72070,7 +72131,7 @@ components:
description: Attributes of the notification preview response.
properties:
preview_results:
- $ref: "#/components/schemas/NotificationRulePreviewResults"
+ $ref: '#/components/schemas/NotificationRulePreviewResults'
required:
- preview_results
type: object
@@ -72078,13 +72139,13 @@ components:
description: The notification preview response data.
properties:
attributes:
- $ref: "#/components/schemas/NotificationRulePreviewResponseAttributes"
+ $ref: '#/components/schemas/NotificationRulePreviewResponseAttributes'
id:
description: The ID of the notification preview response.
example: rka-loa-zwu
type: string
type:
- $ref: "#/components/schemas/NotificationRulePreviewResponseType"
+ $ref: '#/components/schemas/NotificationRulePreviewResponseType'
required:
- type
- attributes
@@ -72101,9 +72162,9 @@ components:
description: The preview result for a single rule type.
properties:
notification_status:
- $ref: "#/components/schemas/NotificationRulePreviewNotificationStatus"
+ $ref: '#/components/schemas/NotificationRulePreviewNotificationStatus'
rule_type:
- $ref: "#/components/schemas/RuleTypesItems"
+ $ref: '#/components/schemas/RuleTypesItems'
required:
- rule_type
- notification_status
@@ -72114,7 +72175,7 @@ components:
- notification_status: DEFAULT
rule_type: log_detection
items:
- $ref: "#/components/schemas/NotificationRulePreviewResult"
+ $ref: '#/components/schemas/NotificationRulePreviewResult'
type: array
NotificationRuleQuery:
description: The query is composed of one or several key:value pairs, which can be used to filter security issues on tags and attributes.
@@ -72124,13 +72185,13 @@ components:
description: Response object which includes a notification rule.
properties:
data:
- $ref: "#/components/schemas/NotificationRule"
+ $ref: '#/components/schemas/NotificationRule'
type: object
NotificationRuleRouting:
description: Routing configuration for the notification rule.
properties:
mode:
- $ref: "#/components/schemas/NotificationRuleRoutingMode"
+ $ref: '#/components/schemas/NotificationRuleRoutingMode'
required:
- mode
type: object
@@ -72147,7 +72208,7 @@ components:
properties:
data:
items:
- $ref: "#/components/schemas/NotificationRule"
+ $ref: '#/components/schemas/NotificationRule'
type: array
type: object
NotificationRulesType:
@@ -72166,7 +72227,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/NotionAPIKeyType"
+ $ref: '#/components/schemas/NotionAPIKeyType'
required:
- type
- api_token
@@ -72186,25 +72247,25 @@ components:
description: The `NotionAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/NotionAPIKeyType"
+ $ref: '#/components/schemas/NotionAPIKeyType'
required:
- type
type: object
NotionCredentials:
description: The definition of the `NotionCredentials` object.
oneOf:
- - $ref: "#/components/schemas/NotionAPIKey"
+ - $ref: '#/components/schemas/NotionAPIKey'
NotionCredentialsUpdate:
description: The definition of the `NotionCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/NotionAPIKeyUpdate"
+ - $ref: '#/components/schemas/NotionAPIKeyUpdate'
NotionIntegration:
description: The definition of the `NotionIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/NotionCredentials"
+ $ref: '#/components/schemas/NotionCredentials'
type:
- $ref: "#/components/schemas/NotionIntegrationType"
+ $ref: '#/components/schemas/NotionIntegrationType'
required:
- type
- credentials
@@ -72221,9 +72282,9 @@ components:
description: The definition of the `NotionIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/NotionCredentialsUpdate"
+ $ref: '#/components/schemas/NotionCredentialsUpdate'
type:
- $ref: "#/components/schemas/NotionIntegrationType"
+ $ref: '#/components/schemas/NotionIntegrationType'
required:
- type
type: object
@@ -72232,7 +72293,7 @@ components:
nullable: true
properties:
data:
- $ref: "#/components/schemas/NullableRelationshipToUserData"
+ $ref: '#/components/schemas/NullableRelationshipToUserData'
required:
- data
type: object
@@ -72245,7 +72306,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
required:
- id
- type
@@ -72255,7 +72316,7 @@ components:
nullable: true
properties:
data:
- $ref: "#/components/schemas/NullableUserRelationshipData"
+ $ref: '#/components/schemas/NullableUserRelationshipData'
required:
- data
type: object
@@ -72268,7 +72329,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UserResourceType"
+ $ref: '#/components/schemas/UserResourceType'
required:
- id
- type
@@ -72297,13 +72358,13 @@ components:
description: Data object containing OAuth2 well-known sites information.
properties:
attributes:
- $ref: "#/components/schemas/OAuth2WellKnownSitesAttributes"
+ $ref: '#/components/schemas/OAuth2WellKnownSitesAttributes'
id:
description: Environment identifier.
example: prod
type: string
type:
- $ref: "#/components/schemas/OAuth2WellKnownSitesEnvType"
+ $ref: '#/components/schemas/OAuth2WellKnownSitesEnvType'
required:
- id
- type
@@ -72322,7 +72383,7 @@ components:
description: Response payload containing the list of public OAuth2 sites for discovery.
properties:
data:
- $ref: "#/components/schemas/OAuth2WellKnownSitesData"
+ $ref: '#/components/schemas/OAuth2WellKnownSitesData'
required:
- data
type: object
@@ -72372,7 +72433,7 @@ components:
- authorization_code
- refresh_token
items:
- $ref: "#/components/schemas/OAuthClientRegistrationGrantType"
+ $ref: '#/components/schemas/OAuthClientRegistrationGrantType'
type: array
jwks_uri:
description: URL referencing the client's JSON Web Key Set.
@@ -72404,7 +72465,7 @@ components:
example:
- code
items:
- $ref: "#/components/schemas/OAuthClientRegistrationResponseType"
+ $ref: '#/components/schemas/OAuthClientRegistrationResponseType'
type: array
scope:
description: Space-separated list of scope values the client may request.
@@ -72443,7 +72504,7 @@ components:
- authorization_code
- refresh_token
items:
- $ref: "#/components/schemas/OAuthClientRegistrationGrantType"
+ $ref: '#/components/schemas/OAuthClientRegistrationGrantType'
type: array
redirect_uris:
description: Redirection URIs registered for the client.
@@ -72459,7 +72520,7 @@ components:
example:
- code
items:
- $ref: "#/components/schemas/OAuthClientRegistrationResponseType"
+ $ref: '#/components/schemas/OAuthClientRegistrationResponseType'
type: array
token_endpoint_auth_method:
description: Authentication method registered for the token endpoint. Always `none`.
@@ -72505,7 +72566,7 @@ components:
- openid
- email
items:
- $ref: "#/components/schemas/OAuthOidcScope"
+ $ref: '#/components/schemas/OAuthOidcScope'
type: array
permission_scopes:
description: Datadog permission scopes the client is restricted to.
@@ -72525,7 +72586,7 @@ components:
description: Response payload describing the scopes restriction of an OAuth2 client.
properties:
data:
- $ref: "#/components/schemas/OAuthScopesRestrictionResponseData"
+ $ref: '#/components/schemas/OAuthScopesRestrictionResponseData'
required:
- data
type: object
@@ -72545,7 +72606,7 @@ components:
nullable: true
type: array
scopes_restriction:
- $ref: "#/components/schemas/OAuthScopesRestriction"
+ $ref: '#/components/schemas/OAuthScopesRestriction'
required:
- scopes_restriction
- required_permission_scopes
@@ -72554,14 +72615,14 @@ components:
description: Data object of an OAuth2 client scopes restriction response.
properties:
attributes:
- $ref: "#/components/schemas/OAuthScopesRestrictionResponseAttributes"
+ $ref: '#/components/schemas/OAuthScopesRestrictionResponseAttributes'
id:
description: UUID of the OAuth2 client this restriction applies to.
example: fafa8e1c-36a5-11f0-a83d-da7ad0900001
format: uuid
type: string
type:
- $ref: "#/components/schemas/OAuthScopesRestrictionType"
+ $ref: '#/components/schemas/OAuthScopesRestrictionType'
required:
- id
- type
@@ -72580,13 +72641,13 @@ components:
description: OCI config.
properties:
attributes:
- $ref: "#/components/schemas/OCIConfigAttributes"
+ $ref: '#/components/schemas/OCIConfigAttributes'
id:
description: The ID of the OCI config.
example: "1"
type: string
type:
- $ref: "#/components/schemas/OCIConfigType"
+ $ref: '#/components/schemas/OCIConfigType'
required:
- attributes
- id
@@ -72655,7 +72716,7 @@ components:
data:
description: An OCI config.
items:
- $ref: "#/components/schemas/OCIConfig"
+ $ref: '#/components/schemas/OCIConfig'
type: array
required:
- data
@@ -72664,7 +72725,7 @@ components:
description: Top-level schema representing a pipeline.
properties:
data:
- $ref: "#/components/schemas/ObservabilityPipelineData"
+ $ref: '#/components/schemas/ObservabilityPipelineData'
required:
- data
type: object
@@ -72675,7 +72736,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -72689,11 +72750,11 @@ components:
example: service:my-service
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorType'
variables:
description: A list of environment variable mappings to apply to log fields.
items:
- $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorVariable"
+ $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessorVariable'
type: array
required:
- id
@@ -72734,7 +72795,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -72742,7 +72803,7 @@ components:
fields:
description: A list of static fields (key-value pairs) that is added to each log event processed by this component.
items:
- $ref: "#/components/schemas/ObservabilityPipelineFieldValue"
+ $ref: '#/components/schemas/ObservabilityPipelineFieldValue'
type: array
id:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
@@ -72753,7 +72814,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineAddFieldsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessorType'
required:
- id
- type
@@ -72778,7 +72839,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -72792,7 +72853,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineAddHostnameProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessorType'
required:
- id
- type
@@ -72816,7 +72877,7 @@ components:
**Supported pipeline types:** metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -72832,11 +72893,11 @@ components:
tags:
description: A list of static tags (key-value pairs) added to each metric processed by this component.
items:
- $ref: "#/components/schemas/ObservabilityPipelineFieldValue"
+ $ref: '#/components/schemas/ObservabilityPipelineFieldValue'
maxItems: 15
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineAddMetricTagsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineAddMetricTagsProcessorType'
required:
- id
- type
@@ -72860,7 +72921,7 @@ components:
**Supported pipeline types:** metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -72881,9 +72942,9 @@ components:
minimum: 1
type: integer
mode:
- $ref: "#/components/schemas/ObservabilityPipelineAggregateProcessorMode"
+ $ref: '#/components/schemas/ObservabilityPipelineAggregateProcessorMode'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAggregateProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineAggregateProcessorType'
required:
- id
- type
@@ -72932,15 +72993,15 @@ components:
example: FIREHOSE_ADDRESS
type: string
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAwsAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
id:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
example: amazon-firehose-source
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSourceType'
required:
- id
- type
@@ -72960,9 +73021,9 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
bulk_index:
description: The index to write logs to.
example: logs-index
@@ -72979,7 +73040,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationType'
required:
- id
- type
@@ -73005,7 +73066,7 @@ components:
description: Session name for the assumed role (used with `aws` strategy).
type: string
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy'
required:
- strategy
type: object
@@ -73033,15 +73094,15 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAwsAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
bucket:
description: S3 bucket name.
example: "error-logs"
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompression'
id:
description: Unique identifier for the destination component.
example: amazon-s3-destination
@@ -73061,7 +73122,7 @@ components:
example: "us-east-1"
type: string
server_side_encryption:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationServerSideEncryption"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationServerSideEncryption'
ssekms_key_id:
description: |-
The AWS KMS key ID used for SSE-KMS encryption.
@@ -73069,11 +73130,11 @@ components:
example: "arn:aws:kms:us-east-1:123456789012:key/mrk-abc123"
type: string
storage_class:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass'
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationType'
required:
- id
- type
@@ -73088,13 +73149,13 @@ components:
Compression configuration for archived logs. When omitted, logs are compressed with gzip
for backward compatibility.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionZstd"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionGzip"
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionZstd'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionGzip'
ObservabilityPipelineAmazonS3DestinationCompressionGzip:
description: Gzip compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionGzipType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionGzipType'
level:
description: Gzip compression level. Valid values range from `1` to `9`.
example: 6
@@ -73119,7 +73180,7 @@ components:
description: Zstd compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionZstdType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationCompressionZstdType'
level:
description: Zstd compression level. Valid values range from `1` to` 21`.
example: 3
@@ -73200,14 +73261,14 @@ components:
ObservabilityPipelineAmazonS3GenericCompression:
description: Compression algorithm applied to encoded logs.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy"
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstd'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzip'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappy'
ObservabilityPipelineAmazonS3GenericCompressionGzip:
description: Gzip compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionGzipType'
level:
description: Gzip compression level.
example: 6
@@ -73230,7 +73291,7 @@ components:
description: Snappy compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionSnappyType'
required:
- algorithm
type: object
@@ -73247,7 +73308,7 @@ components:
description: Zstd compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompressionZstdType'
level:
description: Zstd compression level.
example: 3
@@ -73273,19 +73334,19 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAwsAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
batch_settings:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericBatchSettings'
bucket:
description: S3 bucket name.
example: "my-bucket"
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericCompression'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncoding'
id:
description: Unique identifier for the destination component.
example: generic-s3-destination
@@ -73305,7 +73366,7 @@ components:
example: "us-east-1"
type: string
server_side_encryption:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationServerSideEncryption"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationServerSideEncryption'
ssekms_key_id:
description: |-
The AWS KMS key ID used for SSE-KMS encryption.
@@ -73313,9 +73374,9 @@ components:
example: "arn:aws:kms:us-east-1:123456789012:key/mrk-abc123"
type: string
storage_class:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3DestinationStorageClass'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestinationType'
required:
- id
- type
@@ -73339,13 +73400,13 @@ components:
ObservabilityPipelineAmazonS3GenericEncoding:
description: Encoding format for the destination.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet"
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJson'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquet'
ObservabilityPipelineAmazonS3GenericEncodingJson:
description: JSON encoding.
properties:
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingJsonType'
required:
- type
type: object
@@ -73362,7 +73423,7 @@ components:
description: Parquet encoding.
properties:
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericEncodingParquetType'
required:
- type
type: object
@@ -73383,9 +73444,9 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAwsAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3SourceCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3SourceCompression'
id:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
example: aws-s3-source
@@ -73395,9 +73456,9 @@ components:
example: us-east-1
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonS3SourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonS3SourceType'
url_key:
description: Name of the environment variable or secret that holds the S3 bucket URL.
example: S3_BUCKET_URL
@@ -73438,13 +73499,13 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineAwsAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineAwsAuth'
bucket:
description: Name of the Amazon S3 bucket in Security Lake (3-63 characters).
example: "security-lake-bucket"
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
custom_source_name:
description: Custom source name for the logs in Security Lake.
example: "my-custom-source"
@@ -73465,9 +73526,9 @@ components:
example: "us-east-1"
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestinationType'
required:
- id
- type
@@ -73506,13 +73567,13 @@ components:
Compression configuration for archived logs. When omitted, logs are compressed with gzip
for backward compatibility.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionZstd"
- - $ref: "#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionGzip"
+ - $ref: '#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionZstd'
+ - $ref: '#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionGzip'
ObservabilityPipelineAzureStorageDestinationCompressionGzip:
description: Gzip compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionGzipType"
+ $ref: '#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionGzipType'
level:
description: Gzip compression level. Valid values range from `1` to `9`.
example: 6
@@ -73537,7 +73598,7 @@ components:
description: Zstd compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionZstdType"
+ $ref: '#/components/schemas/ObservabilityPipelineAzureStorageDestinationCompressionZstdType'
level:
description: Zstd compression level. Valid values range from `1` to `21`.
example: 3
@@ -73561,9 +73622,9 @@ components:
ObservabilityPipelineBufferOptions:
description: Configuration for buffer settings on destination components.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineDiskBufferOptions"
- - $ref: "#/components/schemas/ObservabilityPipelineMemoryBufferOptions"
- - $ref: "#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions"
+ - $ref: '#/components/schemas/ObservabilityPipelineDiskBufferOptions'
+ - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferOptions'
+ - $ref: '#/components/schemas/ObservabilityPipelineMemoryBufferSizeOptions'
ObservabilityPipelineBufferOptionsDiskType:
default: disk
description: The type of the buffer that will be configured, a disk buffer.
@@ -73597,15 +73658,15 @@ components:
**Supported pipeline types:** logs.
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationAuth'
batch:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatch"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationBatch'
batch_encoding:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncoding'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationCompression'
database:
description: Optional ClickHouse database name. If omitted, the user's default database on the ClickHouse server is used.
example: my_database
@@ -73621,7 +73682,7 @@ components:
example: CLICKHOUSE_ENDPOINT_URL
type: string
format:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationFormat"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationFormat'
id:
description: The unique identifier for this component.
example: clickhouse-destination
@@ -73645,9 +73706,9 @@ components:
example: application_logs
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationType'
required:
- id
- type
@@ -73665,7 +73726,7 @@ components:
example: CLICKHOUSE_PASSWORD
type: string
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationAuthStrategy'
username_key:
description: Name of the environment variable or secret that contains the ClickHouse username.
example: CLICKHOUSE_USERNAME
@@ -73710,7 +73771,7 @@ components:
example: false
type: boolean
codec:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncodingCodec"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationBatchEncodingCodec'
required:
- codec
type: object
@@ -73728,8 +73789,8 @@ components:
Can be specified as a shorthand string (`"gzip"` or `"none"`) or as an object
with an `algorithm` field and an optional `level` (gzip only, 1–9).
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm"
- - $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionObject"
+ - $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm'
+ - $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionObject'
ObservabilityPipelineClickhouseDestinationCompressionAlgorithm:
description: The compression algorithm applied to outbound HTTP requests.
enum:
@@ -73746,7 +73807,7 @@ components:
Use `algorithm` to specify the compression type and `level` (optional, gzip only) to control compression strength.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm"
+ $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestinationCompressionAlgorithm'
level:
description: Compression level (1–9). Only applicable when `algorithm` is `gzip`.
example: 6
@@ -73818,7 +73879,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
endpoint_url_key:
description: Name of the environment variable or secret that holds the CloudPrem endpoint URL.
example: CLOUDPREM_ENDPOINT_URL
@@ -73838,7 +73899,7 @@ components:
$ref: "#/components/schemas/ObservabilityPipelineClientTls"
description: Configuration for TLS encryption.
type:
- $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestinationType'
required:
- id
- type
@@ -73865,15 +73926,15 @@ components:
description: A list of destination components where processed logs are sent.
example: [{"id": "datadog-logs-destination", "inputs": ["my-processor-group"], "type": "datadog_logs"}]
items:
- $ref: "#/components/schemas/ObservabilityPipelineConfigDestinationItem"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigDestinationItem'
type: array
pipeline_type:
- $ref: "#/components/schemas/ObservabilityPipelineConfigPipelineType"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigPipelineType'
processor_groups:
description: A list of processor groups that transform or enrich log data.
example: [{"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["datadog-agent-source"], "processors": [{"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}, {"enabled": true, "field": "message", "id": "json-processor", "include": "*", "type": "parse_json"}]}]
items:
- $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorGroup"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup'
type: array
processors:
deprecated: true
@@ -73883,13 +73944,13 @@ components:
**Deprecated:** This field is deprecated, you should now use the processor_groups field.
example: []
items:
- $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorGroup"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorGroup'
type: array
sources:
description: A list of configured data sources for the pipeline.
example: [{"id": "datadog-agent-source", "type": "datadog_agent"}]
items:
- $ref: "#/components/schemas/ObservabilityPipelineConfigSourceItem"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigSourceItem'
type: array
use_legacy_search_syntax:
description: |-
@@ -73906,34 +73967,34 @@ components:
ObservabilityPipelineConfigDestinationItem:
description: "A destination for the pipeline."
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3Destination"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination"
- - $ref: "#/components/schemas/AzureStorageDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineClickhouseDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineCloudPremDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineKafkaDestination"
- - $ref: "#/components/schemas/MicrosoftSentinelDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineRsyslogDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineOpentelemetryMetricsDestination"
- - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination"
+ - $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Destination'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3GenericDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonSecurityLakeDestination'
+ - $ref: '#/components/schemas/AzureStorageDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineClickhouseDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineCloudPremDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineKafkaDestination'
+ - $ref: '#/components/schemas/MicrosoftSentinelDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineDatabricksZerobusDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineOpentelemetryMetricsDestination'
+ - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestination'
ObservabilityPipelineConfigPipelineType:
default: logs
description: The type of data being ingested. Defaults to `logs` if not specified.
@@ -73948,7 +74009,7 @@ components:
example: {"enabled": true, "id": "my-processor-group", "include": "service:my-service", "inputs": ["datadog-agent-source"], "processors": [{"enabled": true, "fields": [{"name": "env", "value": "prod"}], "id": "add-fields-processor", "include": "*", "type": "add_fields"}, {"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}]}
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Whether this processor group is enabled.
example: true
@@ -73972,7 +74033,7 @@ components:
description: Processors applied sequentially within this group. Events flow through each processor in order.
example: [{"enabled": true, "fields": [{"name": "env", "value": "prod"}], "id": "add-fields-processor", "include": "*", "type": "add_fields"}, {"enabled": true, "id": "filter-processor", "include": "status:error", "type": "filter"}]
items:
- $ref: "#/components/schemas/ObservabilityPipelineConfigProcessorItem"
+ $ref: '#/components/schemas/ObservabilityPipelineConfigProcessorItem'
type: array
required:
- id
@@ -73984,54 +74045,54 @@ components:
ObservabilityPipelineConfigProcessorItem:
description: "A processor for the pipeline."
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineFilterProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineAddFieldsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineAddHostnameProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineCustomProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsV2Processor"
- - $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineParseJSONProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineParseXMLProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineReduceProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineSampleProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineThrottleProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineAddMetricTagsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineAggregateProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessor"
- - $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessor"
+ - $ref: '#/components/schemas/ObservabilityPipelineFilterProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineAddEnvVarsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineAddFieldsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineAddHostnameProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineCustomProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsV2Processor'
+ - $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineReduceProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineSampleProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineAddMetricTagsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineAggregateProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessor'
+ - $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessor'
ObservabilityPipelineConfigSourceItem:
description: "A data source for the pipeline."
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineDatadogAgentSource"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource"
- - $ref: "#/components/schemas/ObservabilityPipelineAmazonS3Source"
- - $ref: "#/components/schemas/ObservabilityPipelineFluentBitSource"
- - $ref: "#/components/schemas/ObservabilityPipelineFluentdSource"
- - $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubSource"
- - $ref: "#/components/schemas/ObservabilityPipelineHttpClientSource"
- - $ref: "#/components/schemas/ObservabilityPipelineHttpServerSource"
- - $ref: "#/components/schemas/ObservabilityPipelineKafkaSource"
- - $ref: "#/components/schemas/ObservabilityPipelineLogstashSource"
- - $ref: "#/components/schemas/ObservabilityPipelineRsyslogSource"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSource"
- - $ref: "#/components/schemas/ObservabilityPipelineSplunkHecSource"
- - $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSource"
- - $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSource"
- - $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSource"
- - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSource"
- - $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySource"
+ - $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonDataFirehoseSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineAmazonS3Source'
+ - $ref: '#/components/schemas/ObservabilityPipelineFluentBitSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineFluentdSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineHttpClientSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineKafkaSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineLogstashSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineRsyslogSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineSplunkTcpSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineWebsocketSource'
+ - $ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySource'
ObservabilityPipelineCrowdStrikeNextGenSiemDestination:
description: |-
The `crowdstrike_next_gen_siem` destination forwards logs to CrowdStrike Next Gen SIEM.
@@ -74039,11 +74100,11 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompression'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationEncoding'
endpoint_url_key:
description: Name of the environment variable or secret that holds the CrowdStrike endpoint URL.
example: CROWDSTRIKE_ENDPOINT_URL
@@ -74060,13 +74121,13 @@ components:
type: string
type: array
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
token_key:
description: Name of the environment variable or secret that holds the CrowdStrike API token.
example: CROWDSTRIKE_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationType'
required:
- id
- type
@@ -74078,7 +74139,7 @@ components:
description: Compression configuration for log events.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm"
+ $ref: '#/components/schemas/ObservabilityPipelineCrowdStrikeNextGenSiemDestinationCompressionAlgorithm'
level:
description: Compression level.
example: 6
@@ -74123,7 +74184,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -74140,11 +74201,11 @@ components:
remaps:
description: Array of VRL remap rules.
items:
- $ref: "#/components/schemas/ObservabilityPipelineCustomProcessorRemap"
+ $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorRemap'
minItems: 1
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineCustomProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineCustomProcessorType'
required:
- id
- type
@@ -74195,7 +74256,7 @@ components:
description: Contains the pipeline’s ID, type, and configuration attributes.
properties:
attributes:
- $ref: "#/components/schemas/ObservabilityPipelineDataAttributes"
+ $ref: '#/components/schemas/ObservabilityPipelineDataAttributes'
id:
description: Unique identifier for the pipeline.
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
@@ -74214,7 +74275,7 @@ components:
description: Defines the pipeline’s name and its components (sources, processors, and destinations).
properties:
config:
- $ref: "#/components/schemas/ObservabilityPipelineConfig"
+ $ref: '#/components/schemas/ObservabilityPipelineConfig'
name:
description: Name of the pipeline.
example: Main Observability Pipeline
@@ -74230,9 +74291,9 @@ components:
**Supported pipeline types:** Logs, rehydration
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestinationAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineDatabricksZerobusDestinationAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
id:
description: The unique identifier for this component.
example: databricks-zerobus-destination
@@ -74253,7 +74314,7 @@ components:
example: catalog.schema.table
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineDatabricksZerobusDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineDatabricksZerobusDestinationType'
unity_catalog_endpoint_key:
description: Name of the environment variable or the secret identifier that references your Databricks workspace URL, which is used to communicate with the Unity Catalog API.
example: DD_OP_DESTINATION_DATABRICKS_ZEROBUS_UNITY_CATALOG_ENDPOINT
@@ -74304,9 +74365,9 @@ components:
example: "datadog-agent-source"
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogAgentSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogAgentSourceType'
required:
- id
- type
@@ -74328,7 +74389,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
id:
description: The unique identifier for this component.
example: "datadog-logs-destination"
@@ -74344,11 +74405,11 @@ components:
description: A list of routing rules that forward matching logs to Datadog using dedicated API keys.
example: [{"api_key_key": "API_KEY_IDENTIFIER", "include": "service:api", "route_id": "datadog-logs-route-us1", "site": "us1"}]
items:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestinationRoute"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationRoute'
maxItems: 100
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogLogsDestinationType'
required:
- id
- type
@@ -74402,7 +74463,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogMetricsDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogMetricsDestinationType'
required:
- id
- type
@@ -74425,9 +74486,9 @@ components:
**Supported pipeline types:** logs
properties:
action:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorAction'
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -74448,9 +74509,9 @@ components:
type: string
type: array
mode:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorMode"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorMode'
type:
- $ref: "#/components/schemas/ObservabilityPipelineDatadogTagsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineDatadogTagsProcessorType'
required:
- id
- type
@@ -74509,9 +74570,9 @@ components:
**Supported pipeline types:** logs
properties:
cache:
- $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorCache"
+ $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorCache'
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -74532,9 +74593,9 @@ components:
example: service:my-service
type: string
mode:
- $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorMode"
+ $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorMode'
type:
- $ref: "#/components/schemas/ObservabilityPipelineDedupeProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineDedupeProcessorType'
required:
- id
- type
@@ -74585,9 +74646,9 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsDiskType"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsDiskType'
when_full:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
required:
- max_size
type: object
@@ -74598,19 +74659,19 @@ components:
**Supported pipeline types:** logs, metrics
properties:
api_version:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationApiVersion'
auth:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
bulk_index:
description: The name of the index to write events to in Elasticsearch.
example: logs-index
type: string
compression:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompression'
data_stream:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationDataStream'
endpoint_url_key:
description: Name of the environment variable or secret that holds the Elasticsearch endpoint URL.
example: ELASTICSEARCH_ENDPOINT_URL
@@ -74638,9 +74699,9 @@ components:
description: When `true`, retries failed partial bulk requests when some events in a batch fail while others succeed.
type: boolean
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationType'
required:
- id
- type
@@ -74667,7 +74728,7 @@ components:
example: ELASTICSEARCH_PASSWORD
type: string
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineAmazonOpenSearchDestinationAuthStrategy'
username_key:
description: Name of the environment variable or secret that holds the Elasticsearch username (used when `strategy` is `basic`).
example: ELASTICSEARCH_USERNAME
@@ -74679,7 +74740,7 @@ components:
description: Compression configuration for the Elasticsearch destination.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationCompressionAlgorithm'
level:
description: The compression level. Only applicable for `gzip`, `zlib`, and `zstd` algorithms.
example: 6
@@ -74765,11 +74826,11 @@ components:
description: Defines a static enrichment table loaded from a CSV file.
properties:
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncoding'
key:
description: Key fields used to look up enrichment values.
items:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItems"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItems'
type: array
path:
description: Path to the CSV file.
@@ -74778,7 +74839,7 @@ components:
schema:
description: Schema defining column names and their types.
items:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItems"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItems'
type: array
required:
- encoding
@@ -74798,7 +74859,7 @@ components:
example: true
type: boolean
type:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncodingType"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileEncodingType'
required:
- type
- delimiter
@@ -74817,10 +74878,10 @@ components:
Can be a plain field path string or an object specifying `event`, `vrl`, or `secret`.
example: log.user.id
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldStringPath"
- - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldEventLookup"
- - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldVrlLookup"
- - $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFieldSecretLookup"
+ - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFieldStringPath'
+ - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFieldEventLookup'
+ - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFieldVrlLookup'
+ - $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFieldSecretLookup'
ObservabilityPipelineEnrichmentTableFileKeyItems:
description: Defines how to map log fields to enrichment table columns during lookups.
properties:
@@ -74829,9 +74890,9 @@ components:
example: user_id
type: string
comparison:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemsComparison"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemsComparison'
field:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemField"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileKeyItemField'
required:
- column
- comparison
@@ -74852,7 +74913,7 @@ components:
example: region
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItemsType"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFileSchemaItemsType'
required:
- column
- type
@@ -74896,15 +74957,15 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
type: boolean
file:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableFile"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableFile'
geoip:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableGeoIp"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableGeoIp'
id:
description: The unique identifier for this processor.
example: enrichment-table-processor
@@ -74914,13 +74975,13 @@ components:
example: source:my-source
type: string
reference_table:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableReferenceTable"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableReferenceTable'
target:
description: Path where enrichment results should be stored in the log.
example: enriched.geoip
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineEnrichmentTableProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineEnrichmentTableProcessorType'
required:
- id
- type
@@ -74985,7 +75046,7 @@ components:
**Supported pipeline types:** logs, metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -74999,7 +75060,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineFilterProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineFilterProcessorType'
required:
- id
- type
@@ -75031,9 +75092,9 @@ components:
example: "fluent-source"
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineFluentBitSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineFluentBitSourceType'
required:
- id
- type
@@ -75063,9 +75124,9 @@ components:
example: "fluent-source"
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineFluentdSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineFluentdSourceType'
required:
- id
- type
@@ -75099,7 +75160,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -75115,10 +75176,10 @@ components:
metrics:
description: Configuration for generating individual metrics.
items:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetric"
+ $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetric'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsProcessorType'
required:
- id
- type
@@ -75143,7 +75204,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -75159,10 +75220,10 @@ components:
metrics:
description: Configuration for generating individual metrics.
items:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetric"
+ $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetric'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineGenerateMetricsV2ProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineGenerateMetricsV2ProcessorType'
required:
- id
- type
@@ -75195,13 +75256,13 @@ components:
example: service:billing
type: string
metric_type:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricMetricType"
+ $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricMetricType'
name:
description: Name of the custom metric to be created.
example: logs.processed
type: string
value:
- $ref: "#/components/schemas/ObservabilityPipelineMetricValue"
+ $ref: '#/components/schemas/ObservabilityPipelineMetricValue'
required:
- name
- include
@@ -75216,7 +75277,7 @@ components:
example: "errors"
type: string
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByFieldStrategy'
required:
- strategy
- field
@@ -75233,7 +75294,7 @@ components:
description: Strategy that increments a generated metric by one for each matching event.
properties:
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOneStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOneStrategy'
required:
- strategy
type: object
@@ -75264,15 +75325,15 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineGcpAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
customer_id:
description: The Google Chronicle customer ID.
example: abcdefg123456789
type: string
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationEncoding'
endpoint_url_key:
description: Name of the environment variable or secret that holds the Google Chronicle endpoint URL.
example: CHRONICLE_ENDPOINT_URL
@@ -75293,7 +75354,7 @@ components:
example: nginx_logs
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleChronicleDestinationType'
required:
- id
- type
@@ -75328,17 +75389,17 @@ components:
**Supported pipeline types:** logs
properties:
acl:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationAcl"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationAcl'
auth:
- $ref: "#/components/schemas/ObservabilityPipelineGcpAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
bucket:
description: Name of the GCS bucket.
example: "error-logs"
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompression'
id:
description: Unique identifier for the destination component.
example: gcs-destination
@@ -75356,12 +75417,12 @@ components:
metadata:
description: Custom metadata to attach to each object uploaded to the GCS bucket.
items:
- $ref: "#/components/schemas/ObservabilityPipelineMetadataEntry"
+ $ref: '#/components/schemas/ObservabilityPipelineMetadataEntry'
type: array
storage_class:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationStorageClass"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationStorageClass'
type:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationType'
required:
- id
- type
@@ -75393,13 +75454,13 @@ components:
Compression configuration for archived logs. When omitted, logs are compressed with gzip
for backward compatibility.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionZstd"
- - $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionGzip"
+ - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionZstd'
+ - $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionGzip'
ObservabilityPipelineGoogleCloudStorageDestinationCompressionGzip:
description: Gzip compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionGzipType"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionGzipType'
level:
description: Gzip compression level. Valid values range from `1` to `9`.
example: 6
@@ -75424,7 +75485,7 @@ components:
description: Zstd compression.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionZstdType"
+ $ref: '#/components/schemas/ObservabilityPipelineGoogleCloudStorageDestinationCompressionZstdType'
level:
description: Zstd compression level. Valid values range from `1` to `21`.
example: 3
@@ -75475,11 +75536,11 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineGcpAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationEncoding'
endpoint_url_key:
description: Name of the environment variable or secret that holds the Google Cloud Pub/Sub endpoint URL.
example: GCP_PUBSUB_ENDPOINT_URL
@@ -75500,13 +75561,13 @@ components:
example: my-gcp-project
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
topic:
description: The Pub/Sub topic name to publish logs to.
example: logs-subscription
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubDestinationType'
required:
- id
- type
@@ -75542,9 +75603,9 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineGcpAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineGcpAuth'
decoding:
- $ref: "#/components/schemas/ObservabilityPipelineDecoding"
+ $ref: '#/components/schemas/ObservabilityPipelineDecoding'
id:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
example: google-pubsub-source
@@ -75558,9 +75619,9 @@ components:
example: logs-subscription
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineGooglePubSubSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineGooglePubSubSourceType'
required:
- id
- type
@@ -75583,17 +75644,17 @@ components:
**Supported pipeline types:** logs, metrics
properties:
auth_strategy:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationAuthStrategy'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompression'
custom_key:
description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
example: HTTP_AUTH_CUSTOM_HEADER
type: string
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationEncoding'
id:
description: The unique identifier for this component.
example: http-client-destination
@@ -75610,13 +75671,13 @@ components:
example: HTTP_AUTH_PASSWORD
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineClientTls"
+ $ref: '#/components/schemas/ObservabilityPipelineClientTls'
token_key:
description: Name of the environment variable or secret that holds the bearer token (used when `auth_strategy` is `bearer`).
example: HTTP_AUTH_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationType'
uri_key:
description: Name of the environment variable or secret that holds the HTTP endpoint URI.
example: HTTP_DESTINATION_URI
@@ -75645,7 +75706,7 @@ components:
description: Compression configuration for HTTP requests.
properties:
algorithm:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientDestinationCompressionAlgorithm"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientDestinationCompressionAlgorithm'
required:
- algorithm
type: object
@@ -75678,13 +75739,13 @@ components:
**Supported pipeline types:** logs
properties:
auth_strategy:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientSourceAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientSourceAuthStrategy'
custom_key:
description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
example: HTTP_AUTH_CUSTOM_HEADER
type: string
decoding:
- $ref: "#/components/schemas/ObservabilityPipelineDecoding"
+ $ref: '#/components/schemas/ObservabilityPipelineDecoding'
endpoint_url_key:
description: Name of the environment variable or secret that holds the HTTP endpoint URL to scrape.
example: HTTP_ENDPOINT_URL
@@ -75708,13 +75769,13 @@ components:
format: int64
type: integer
tls:
- $ref: "#/components/schemas/ObservabilityPipelineClientTls"
+ $ref: '#/components/schemas/ObservabilityPipelineClientTls'
token_key:
description: Name of the environment variable or secret that holds the bearer token (used when `auth_strategy` is `bearer`).
example: HTTP_AUTH_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineHttpClientSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpClientSourceType'
username_key:
description: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `basic`).
example: HTTP_AUTH_USERNAME
@@ -75753,13 +75814,13 @@ components:
example: HTTP_SERVER_ADDRESS
type: string
auth_strategy:
- $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceAuthStrategy'
custom_key:
description: Name of the environment variable or secret that holds a custom header value (used with custom auth strategies).
example: HTTP_AUTH_CUSTOM_HEADER
type: string
decoding:
- $ref: "#/components/schemas/ObservabilityPipelineDecoding"
+ $ref: '#/components/schemas/ObservabilityPipelineDecoding'
id:
description: Unique ID for the HTTP server source.
example: "http-server-source"
@@ -75769,9 +75830,9 @@ components:
example: HTTP_AUTH_PASSWORD
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceType'
username_key:
description: Name of the environment variable or secret that holds the username (used when `auth_strategy` is `plain`).
example: HTTP_AUTH_USERNAME
@@ -75782,7 +75843,7 @@ components:
the source rejects any request whose token does not match an enabled entry in this list.
Cannot be combined with the `plain` auth strategy.
items:
- $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceValidToken"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceValidToken'
maxItems: 1000
minItems: 1
type: array
@@ -75822,9 +75883,9 @@ components:
example: true
type: boolean
field_to_add:
- $ref: "#/components/schemas/ObservabilityPipelineSourceValidTokenFieldToAdd"
+ $ref: '#/components/schemas/ObservabilityPipelineSourceValidTokenFieldToAdd'
path_to_token:
- $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToToken"
+ $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToToken'
token_key:
description: Name of the environment variable or secret that holds the expected token value.
example: HTTP_SERVER_TOKEN
@@ -75838,8 +75899,8 @@ components:
Specifies where the worker extracts the token from in the incoming HTTP request.
This can be either a built-in location (`path` or `address`) or an HTTP header object.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToTokenLocation"
- - $ref: "#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToTokenHeader"
+ - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToTokenLocation'
+ - $ref: '#/components/schemas/ObservabilityPipelineHttpServerSourceValidTokenPathToTokenHeader'
ObservabilityPipelineHttpServerSourceValidTokenPathToTokenHeader:
description: Extract the token from a specific HTTP request header.
properties:
@@ -75871,11 +75932,11 @@ components:
example: KAFKA_BOOTSTRAP_SERVERS
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationCompression'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationEncoding'
headers_key:
description: The field name to use for Kafka message headers.
example: headers
@@ -75898,7 +75959,7 @@ components:
librdkafka_options:
description: Optional list of advanced Kafka producer configuration options, defined as key-value pairs.
items:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption'
type: array
message_timeout_ms:
description: Maximum time in milliseconds to wait for message delivery confirmation.
@@ -75919,7 +75980,7 @@ components:
minimum: 1
type: integer
sasl:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaSasl"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSasl'
socket_timeout_ms:
description: Socket timeout in milliseconds for network requests.
example: 60000
@@ -75928,13 +75989,13 @@ components:
minimum: 10
type: integer
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
topic:
description: The Kafka topic name to publish logs to.
example: logs-topic
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaDestinationType'
required:
- id
- type
@@ -75997,7 +76058,7 @@ components:
description: Specifies the SASL mechanism for authenticating with a Kafka cluster.
properties:
mechanism:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaSaslMechanism"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSaslMechanism'
password_key:
description: Name of the environment variable or secret that holds the SASL password.
example: KAFKA_SASL_PASSWORD
@@ -76039,12 +76100,12 @@ components:
librdkafka_options:
description: Optional list of advanced Kafka client configuration options, defined as key-value pairs.
items:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaLibrdkafkaOption'
type: array
sasl:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaSasl"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSasl'
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
topics:
description: A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified.
example: ["topic1", "topic2"]
@@ -76053,7 +76114,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineKafkaSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineKafkaSourceType'
required:
- id
- type
@@ -76085,9 +76146,9 @@ components:
example: logstash-source
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineLogstashSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineLogstashSourceType'
required:
- id
- type
@@ -76111,9 +76172,9 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
when_full:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
required:
- max_size
type: object
@@ -76126,9 +76187,9 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsMemoryType'
when_full:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptionsWhenFull'
required:
- max_events
type: object
@@ -76154,7 +76215,7 @@ components:
**Supported pipeline types:** metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -76170,12 +76231,12 @@ components:
rules:
description: A list of rules for filtering metric tags.
items:
- $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRule"
+ $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRule'
maxItems: 100
minItems: 1
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorType'
required:
- id
- type
@@ -76188,7 +76249,7 @@ components:
description: Defines a rule for filtering metric tags based on key patterns.
properties:
action:
- $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleAction"
+ $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleAction'
include:
description: A Datadog search query used to determine which metrics this rule targets.
example: "*"
@@ -76201,7 +76262,7 @@ components:
type: string
type: array
mode:
- $ref: "#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleMode"
+ $ref: '#/components/schemas/ObservabilityPipelineMetricTagsProcessorRuleMode'
required:
- include
- mode
@@ -76234,8 +76295,8 @@ components:
ObservabilityPipelineMetricValue:
description: Specifies how the value of the generated metric is computed.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne"
- - $ref: "#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField"
+ - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByOne'
+ - $ref: '#/components/schemas/ObservabilityPipelineGeneratedMetricIncrementByField'
ObservabilityPipelineMtlsServerTls:
description: Configuration for enabling TLS encryption between the pipeline component and external connecting clients.
properties:
@@ -76270,7 +76331,7 @@ components:
example: NEW_RELIC_ACCOUNT_ID
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
id:
description: The unique identifier for this component.
example: new-relic-destination
@@ -76287,9 +76348,9 @@ components:
example: NEW_RELIC_LICENSE_KEY
type: string
region:
- $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestinationRegion"
+ $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestinationRegion'
type:
- $ref: "#/components/schemas/ObservabilityPipelineNewRelicDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineNewRelicDestinationType'
required:
- id
- type
@@ -76323,7 +76384,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -76343,10 +76404,10 @@ components:
mappings:
description: A list of mapping rules to convert events to the OCSF format.
items:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMapping"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMapping'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorType'
required:
- id
- type
@@ -76363,7 +76424,7 @@ components:
example: service:my-service
type: string
mapping:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMappingMapping"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMapperProcessorMappingMapping'
required:
- include
- mapping
@@ -76372,8 +76433,8 @@ components:
description: Defines a single mapping rule for transforming logs into the OCSF schema.
example: CloudTrail Account Change
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingLibrary"
- - $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustom"
+ - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingLibrary'
+ - $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustom'
ObservabilityPipelineOcsfMapperProcessorType:
default: ocsf_mapper
description: The processor type. The value should always be `ocsf_mapper`.
@@ -76389,10 +76450,10 @@ components:
mapping:
description: A list of field mapping rules for transforming log fields to OCSF schema fields.
items:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomFieldMapping"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomFieldMapping'
type: array
metadata:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomMetadata"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomMetadata'
version:
description: The version of the custom mapping configuration.
example: 1
@@ -76414,7 +76475,7 @@ components:
example: device.type
type: string
lookup:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookup"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookup'
source:
description: The source field path from the log event.
example: host.type
@@ -76438,7 +76499,7 @@ components:
table:
description: A list of lookup table entries for value transformation.
items:
- $ref: "#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookupTableEntry"
+ $ref: '#/components/schemas/ObservabilityPipelineOcsfMappingCustomLookupTableEntry'
type: array
type: object
ObservabilityPipelineOcsfMappingCustomLookupTableEntry:
@@ -76525,15 +76586,15 @@ components:
**Supported pipeline types:** logs
properties:
auth:
- $ref: "#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth"
+ $ref: '#/components/schemas/ObservabilityPipelineElasticsearchDestinationAuth'
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
bulk_index:
description: The index to write logs to.
example: logs-index
type: string
data_stream:
- $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestinationDataStream"
+ $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestinationDataStream'
endpoint_url_key:
description: Name of the environment variable or secret that holds the OpenSearch endpoint URL.
example: OPENSEARCH_ENDPOINT_URL
@@ -76550,7 +76611,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineOpenSearchDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineOpenSearchDestinationType'
required:
- id
- type
@@ -76586,7 +76647,7 @@ components:
**Supported pipeline types:** metrics
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
http_client_uri_key:
default: DESTINATION_OTEL_HTTP_CLIENT_URI
description: Environment variable name containing the URI of the OTLP HTTP endpoint to send metrics to.
@@ -76604,9 +76665,9 @@ components:
type: string
type: array
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineOpentelemetryMetricsDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineOpentelemetryMetricsDestinationType'
required:
- id
- type
@@ -76641,9 +76702,9 @@ components:
example: opentelemetry-source
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineOpentelemetrySourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineOpentelemetrySourceType'
required:
- id
- type
@@ -76673,7 +76734,7 @@ components:
example: true
type: boolean
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -76694,10 +76755,10 @@ components:
rules:
description: The list of Grok parsing rules selected by either source field or include query.
items:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleItem"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleItem'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorType'
required:
- id
- type
@@ -76723,7 +76784,7 @@ components:
- name: "MyParsingRule"
rule: '%{word:user} connected on %{date("MM/dd/yyyy"):date}'
items:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule'
type: array
support_rules:
description: A list of Grok helper rules that can be referenced by the parsing rules.
@@ -76731,7 +76792,7 @@ components:
- name: "user"
rule: "%{word:user.name}"
items:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule'
type: array
required:
- include
@@ -76750,7 +76811,7 @@ components:
- name: "MyParsingRule"
rule: '%{word:user} connected on %{date("MM/dd/yyyy"):date}'
items:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleMatchRule'
type: array
source:
description: The value of the source field in log events to be processed by the Grok rules.
@@ -76763,7 +76824,7 @@ components:
- name: "user"
rule: "%{word:user.name}"
items:
- $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule"
+ $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRuleSupportRule'
type: array
required:
- source
@@ -76772,8 +76833,8 @@ components:
ObservabilityPipelineParseGrokProcessorRuleItem:
description: A single Grok parsing rule, selected by either source field or include query.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorRule"
- - $ref: "#/components/schemas/ObservabilityPipelineParseGrokProcessorIncludeRule"
+ - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorRule'
+ - $ref: '#/components/schemas/ObservabilityPipelineParseGrokProcessorIncludeRule'
ObservabilityPipelineParseGrokProcessorRuleMatchRule:
description: |-
Defines a Grok parsing rule, which extracts structured fields from log content using named Grok patterns.
@@ -76821,7 +76882,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -76839,7 +76900,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineParseJSONProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineParseJSONProcessorType'
required:
- id
- type
@@ -76870,7 +76931,7 @@ components:
description: The prefix to use for XML attributes in the parsed output.
type: string
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -76904,7 +76965,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineParseXMLProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineParseXMLProcessorType'
required:
- id
- type
@@ -76929,7 +76990,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
drop_events:
description: |-
If set to `true`, logs that match the quota filter and are sent after the quota is exceeded are dropped. Logs that do not match the filter continue through the pipeline. **Note**: You can set either `drop_events` or `overflow_action`, but not both.
@@ -76951,17 +77012,17 @@ components:
example: "service:my-service"
type: string
limit:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimit"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit'
name:
description: Name of the quota.
example: MyQuota
type: string
overflow_action:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction'
overrides:
description: A list of alternate quota rules that apply to specific sets of events, identified by matching field values. Each override can define a custom limit.
items:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverride"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverride'
type: array
partition_fields:
description: A list of fields used to segment log traffic for quota enforcement. Quotas are tracked independently by unique combinations of these field values.
@@ -76970,9 +77031,9 @@ components:
type: string
type: array
too_many_buckets_action:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorOverflowAction'
type:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorType'
required:
- id
- type
@@ -76986,7 +77047,7 @@ components:
description: The maximum amount of data or number of events allowed before the quota is enforced. Can be specified in bytes or events.
properties:
enforce:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimitEnforceType"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimitEnforceType'
limit:
description: The limit for quota enforcement.
example: 1000
@@ -77028,10 +77089,10 @@ components:
fields:
description: A list of field matchers used to apply a specific override. If an event matches all listed key-value pairs, the corresponding override limit is enforced.
items:
- $ref: "#/components/schemas/ObservabilityPipelineFieldValue"
+ $ref: '#/components/schemas/ObservabilityPipelineFieldValue'
type: array
limit:
- $ref: "#/components/schemas/ObservabilityPipelineQuotaProcessorLimit"
+ $ref: '#/components/schemas/ObservabilityPipelineQuotaProcessorLimit'
required:
- fields
- limit
@@ -77052,7 +77113,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77075,10 +77136,10 @@ components:
merge_strategies:
description: List of merge strategies defining how values from grouped events should be combined.
items:
- $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategy'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorType'
required:
- id
- type
@@ -77096,7 +77157,7 @@ components:
example: log.user.roles
type: string
strategy:
- $ref: "#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategyStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineReduceProcessorMergeStrategyStrategy'
required:
- path
- strategy
@@ -77147,7 +77208,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77168,7 +77229,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineRemoveFieldsProcessorType'
required:
- id
- type
@@ -77193,7 +77254,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77201,7 +77262,7 @@ components:
fields:
description: A list of rename rules specifying which fields to rename in the event, what to rename them to, and whether to preserve the original fields.
items:
- $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessorField"
+ $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorField'
type: array
id:
description: A unique identifier for this component. Used to reference this component in other parts of the pipeline (e.g., as input to downstream components).
@@ -77212,7 +77273,7 @@ components:
example: "service:my-service"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineRenameFieldsProcessorType'
required:
- id
- type
@@ -77257,7 +77318,7 @@ components:
**Supported pipeline types:** metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77273,11 +77334,11 @@ components:
tags:
description: A list of rename rules specifying which tag keys to rename on each metric.
items:
- $ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorTag"
+ $ref: '#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorTag'
maxItems: 15
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineRenameMetricTagsProcessorType'
required:
- id
- type
@@ -77316,7 +77377,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
endpoint_url_key:
description: Name of the environment variable or secret that holds the syslog server endpoint URL.
example: SYSLOG_ENDPOINT_URL
@@ -77339,9 +77400,9 @@ components:
minimum: 0
type: integer
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineRsyslogDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineRsyslogDestinationType'
required:
- id
- type
@@ -77371,11 +77432,11 @@ components:
example: "rsyslog-source"
type: string
mode:
- $ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
+ $ref: '#/components/schemas/ObservabilityPipelineSyslogSourceMode'
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineRsyslogSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineRsyslogSourceType'
required:
- id
- type
@@ -77397,7 +77458,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77424,7 +77485,7 @@ components:
format: double
type: number
type:
- $ref: "#/components/schemas/ObservabilityPipelineSampleProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineSampleProcessorType'
required:
- id
- type
@@ -77448,7 +77509,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -77464,10 +77525,10 @@ components:
rules:
description: A list of rules for identifying and acting on sensitive data patterns.
items:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorRule"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorRule'
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorType'
required:
- id
- type
@@ -77479,14 +77540,14 @@ components:
ObservabilityPipelineSensitiveDataScannerProcessorAction:
description: Defines what action to take when sensitive data is matched.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedact"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHash"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact"
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedact'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHash'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedact'
ObservabilityPipelineSensitiveDataScannerProcessorActionHash:
description: Configuration for hashing matched sensitive values.
properties:
action:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction'
options:
description: |-
Optional settings for the hash action. When omitted or empty, matched sensitive data is
@@ -77506,9 +77567,9 @@ components:
description: Configuration for partially redacting matched sensitive data.
properties:
action:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction'
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions'
required: [action, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactAction:
@@ -77527,7 +77588,7 @@ components:
format: int64
type: integer
direction:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection'
required: [characters, direction]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection:
@@ -77542,9 +77603,9 @@ components:
description: Configuration for completely redacting matched sensitive data.
properties:
action:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction'
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions'
required: [action, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorActionRedactAction:
@@ -77567,9 +77628,9 @@ components:
description: Defines a custom regex-based pattern for identifying sensitive data in logs.
properties:
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternType'
required: [type, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions:
@@ -77613,9 +77674,9 @@ components:
description: Specifies a pattern from Datadog’s sensitive data detection library to match known sensitive data types.
properties:
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternType'
required: [type, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions:
@@ -77644,23 +77705,23 @@ components:
ObservabilityPipelineSensitiveDataScannerProcessorPattern:
description: Pattern detection configuration for identifying sensitive data using either a custom regex or a library reference.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern"
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorCustomPattern'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorLibraryPattern'
ObservabilityPipelineSensitiveDataScannerProcessorRule:
description: Defines a rule for detecting sensitive data, including matching pattern, scope, and the action to take.
properties:
keyword_options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions'
name:
description: A name identifying the rule.
example: "Redact Credit Card Numbers"
type: string
on_match:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorAction"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorAction'
pattern:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorPattern"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorPattern'
scope:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScope"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScope'
tags:
description: Tags assigned to this rule for filtering and classification.
example: ["pii", "ccn"]
@@ -77677,14 +77738,14 @@ components:
ObservabilityPipelineSensitiveDataScannerProcessorScope:
description: Determines which parts of the log the pattern-matching rule should be applied to.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude"
- - $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAll"
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeInclude'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude'
+ - $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAll'
ObservabilityPipelineSensitiveDataScannerProcessorScopeAll:
description: Applies scanning across all available fields.
properties:
target:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget'
required: [target]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorScopeAllTarget:
@@ -77698,9 +77759,9 @@ components:
description: Excludes specific fields from sensitive data scanning.
properties:
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions'
target:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget'
required: [target, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorScopeExcludeTarget:
@@ -77714,9 +77775,9 @@ components:
description: Includes only specific fields for sensitive data scanning.
properties:
options:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions'
target:
- $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget"
+ $ref: '#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget'
required: [target, options]
type: object
ObservabilityPipelineSensitiveDataScannerProcessorScopeIncludeTarget:
@@ -77754,7 +77815,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
id:
description: The unique identifier for this component.
example: sentinelone-destination
@@ -77767,13 +77828,13 @@ components:
type: string
type: array
region:
- $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestinationRegion"
+ $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestinationRegion'
token_key:
description: Name of the environment variable or secret that holds the SentinelOne API token.
example: SENTINELONE_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineSentinelOneDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSentinelOneDestinationType'
required:
- id
- type
@@ -77815,11 +77876,11 @@ components:
example: SOCKET_ADDRESS
type: string
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationEncoding'
framing:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFraming"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFraming'
id:
description: The unique identifier for this component.
example: socket-destination
@@ -77832,12 +77893,12 @@ components:
type: string
type: array
mode:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationMode"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationMode'
tls:
$ref: "#/components/schemas/ObservabilityPipelineClientTls"
description: TLS configuration. Relevant only when `mode` is `tcp`.
type:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationType'
required:
- id
- type
@@ -77858,14 +77919,14 @@ components:
ObservabilityPipelineSocketDestinationFraming:
description: Framing method configuration.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited"
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimited'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytes'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimited'
ObservabilityPipelineSocketDestinationFramingBytes:
description: Event data is not delimited at all.
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingBytesMethod'
required: [method]
type: object
ObservabilityPipelineSocketDestinationFramingBytesMethod:
@@ -77885,7 +77946,7 @@ components:
minLength: 1
type: string
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod'
required: [method, delimiter]
type: object
ObservabilityPipelineSocketDestinationFramingCharacterDelimitedMethod:
@@ -77899,7 +77960,7 @@ components:
description: Each log event is delimited by a newline character.
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod'
required: [method]
type: object
ObservabilityPipelineSocketDestinationFramingNewlineDelimitedMethod:
@@ -77936,18 +77997,18 @@ components:
example: SOCKET_ADDRESS
type: string
framing:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFraming"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFraming'
id:
description: The unique identifier for this component. Used in other parts of the pipeline to reference this component (for example, as the `input` to downstream components).
example: socket-source
type: string
mode:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceMode"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceMode'
tls:
$ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
description: TLS configuration. Relevant only when `mode` is `tcp`.
type:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceType'
required:
- id
- type
@@ -77958,16 +78019,16 @@ components:
ObservabilityPipelineSocketSourceFraming:
description: Framing method configuration for the socket source.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting"
- - $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf"
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimited'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytes'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimited'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCounting'
+ - $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelf'
ObservabilityPipelineSocketSourceFramingBytes:
description: Byte frames are passed through as-is according to the underlying I/O boundaries (for example, split between messages or stream segments).
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingBytesMethod'
required: [method]
type: object
ObservabilityPipelineSocketSourceFramingBytesMethod:
@@ -77987,7 +78048,7 @@ components:
minLength: 1
type: string
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod'
required: [method, delimiter]
type: object
ObservabilityPipelineSocketSourceFramingCharacterDelimitedMethod:
@@ -78001,7 +78062,7 @@ components:
description: Byte frames which are chunked GELF messages.
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingChunkedGelfMethod'
required: [method]
type: object
ObservabilityPipelineSocketSourceFramingChunkedGelfMethod:
@@ -78015,7 +78076,7 @@ components:
description: Byte frames which are delimited by a newline character.
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod'
required: [method]
type: object
ObservabilityPipelineSocketSourceFramingNewlineDelimitedMethod:
@@ -78029,7 +78090,7 @@ components:
description: Byte frames according to the octet counting format as per RFC6587.
properties:
method:
- $ref: "#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod"
+ $ref: '#/components/schemas/ObservabilityPipelineSocketSourceFramingOctetCountingMethod'
required: [method]
type: object
ObservabilityPipelineSocketSourceFramingOctetCountingMethod:
@@ -78080,7 +78141,7 @@ components:
description: Input schema representing an observability pipeline configuration. Used in create and validate requests.
properties:
data:
- $ref: "#/components/schemas/ObservabilityPipelineSpecData"
+ $ref: '#/components/schemas/ObservabilityPipelineSpecData'
required:
- data
type: object
@@ -78088,7 +78149,7 @@ components:
description: Contains the the pipeline configuration.
properties:
attributes:
- $ref: "#/components/schemas/ObservabilityPipelineDataAttributes"
+ $ref: '#/components/schemas/ObservabilityPipelineDataAttributes'
type:
default: pipelines
description: The resource type identifier. For pipeline resources, this should always be set to `pipelines`.
@@ -78107,12 +78168,12 @@ components:
arrays:
description: A list of array split configurations.
items:
- $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig"
+ $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorArrayConfig'
maxItems: 15
minItems: 1
type: array
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -78126,7 +78187,7 @@ components:
example: "*"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineSplitArrayProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineSplitArrayProcessorType'
required:
- id
- type
@@ -78173,11 +78234,11 @@ components:
example: true
type: boolean
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEncoding'
endpoint_target:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationEndpointTarget"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationEndpointTarget'
endpoint_url_key:
description: Name of the environment variable or secret that holds the Splunk HEC endpoint URL.
example: SPLUNK_HEC_ENDPOINT_URL
@@ -78213,9 +78274,9 @@ components:
example: SPLUNK_HEC_TOKEN
type: string
token_strategy:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationTokenStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationTokenStrategy'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecDestinationType'
required:
- id
- type
@@ -78268,9 +78329,9 @@ components:
**Supported pipeline types:** metrics
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
compression:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationCompression'
default_namespace:
description: Optional default namespace for metrics sent to Splunk HEC.
example: "custom_namespace"
@@ -78303,13 +78364,13 @@ components:
example: "custom_sourcetype"
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineTls"
+ $ref: '#/components/schemas/ObservabilityPipelineTls'
token_key:
description: Name of the environment variable or secret that holds the Splunk HEC token.
example: SPLUNK_HEC_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecMetricsDestinationType'
required:
- id
- type
@@ -78357,15 +78418,15 @@ components:
example: true
type: boolean
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSourceType'
valid_tokens:
description: |-
A list of tokens that are accepted for authenticating incoming HEC requests. When set, the source
rejects any request whose HEC token does not match an enabled entry in this list.
items:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkHecSourceValidToken"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkHecSourceValidToken'
maxItems: 1000
minItems: 1
type: array
@@ -78394,7 +78455,7 @@ components:
example: true
type: boolean
field_to_add:
- $ref: "#/components/schemas/ObservabilityPipelineSourceValidTokenFieldToAdd"
+ $ref: '#/components/schemas/ObservabilityPipelineSourceValidTokenFieldToAdd'
token_key:
description: Name of the environment variable or secret that holds the expected HEC token value.
example: SPLUNK_HEC_TOKEN
@@ -78426,9 +78487,9 @@ components:
minimum: 1
type: integer
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSplunkTcpSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineSplunkTcpSourceType'
required:
- id
- type
@@ -78450,9 +78511,9 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
encoding:
- $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding"
+ $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationEncoding'
endpoint_url_key:
description: Name of the environment variable or secret that holds the Sumo Logic HTTP endpoint URL.
example: SUMO_LOGIC_ENDPOINT_URL
@@ -78460,7 +78521,7 @@ components:
header_custom_fields:
description: A list of custom headers to include in the request to Sumo Logic.
items:
- $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem"
+ $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationHeaderCustomFieldsItem'
type: array
header_host_name:
description: Optional override for the host name header.
@@ -78486,7 +78547,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/ObservabilityPipelineSumoLogicDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSumoLogicDestinationType'
required:
- id
- type
@@ -78541,7 +78602,7 @@ components:
example: "sumo-logic-source"
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineSumoLogicSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineSumoLogicSourceType'
required:
- id
- type
@@ -78563,7 +78624,7 @@ components:
**Supported pipeline types:** logs
properties:
buffer:
- $ref: "#/components/schemas/ObservabilityPipelineBufferOptions"
+ $ref: '#/components/schemas/ObservabilityPipelineBufferOptions'
endpoint_url_key:
description: Name of the environment variable or secret that holds the syslog-ng server endpoint URL.
example: SYSLOG_ENDPOINT_URL
@@ -78586,9 +78647,9 @@ components:
minimum: 0
type: integer
tls:
- $ref: "#/components/schemas/ObservabilityPipelineClientTls"
+ $ref: '#/components/schemas/ObservabilityPipelineClientTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgDestinationType"
+ $ref: '#/components/schemas/ObservabilityPipelineSyslogNgDestinationType'
required:
- id
- type
@@ -78618,11 +78679,11 @@ components:
example: "syslog-ng-source"
type: string
mode:
- $ref: "#/components/schemas/ObservabilityPipelineSyslogSourceMode"
+ $ref: '#/components/schemas/ObservabilityPipelineSyslogSourceMode'
tls:
- $ref: "#/components/schemas/ObservabilityPipelineMtlsServerTls"
+ $ref: '#/components/schemas/ObservabilityPipelineMtlsServerTls'
type:
- $ref: "#/components/schemas/ObservabilityPipelineSyslogNgSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineSyslogNgSourceType'
required:
- id
- type
@@ -78652,7 +78713,7 @@ components:
**Supported pipeline types:** metrics
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -78666,17 +78727,17 @@ components:
example: "*"
type: string
limit_exceeded_action:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction'
per_metric_limits:
description: A list of per-metric cardinality overrides that take precedence over the default `value_limit`.
items:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerMetricLimit'
maxItems: 100
type: array
tracking_mode:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingMode'
type:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorType'
value_limit:
description: The default maximum number of distinct tag value combinations allowed per metric.
example: 10000
@@ -78718,17 +78779,17 @@ components:
description: A cardinality override applied to a specific metric.
properties:
limit_exceeded_action:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorAction'
metric_name:
description: The name of the metric this override applies to.
example: "system.cpu.user"
type: string
override_type:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType'
per_tag_limits:
description: A list of per-tag cardinality overrides that apply within this metric. Must be omitted when `override_type` is `excluded`.
items:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorPerTagLimit'
maxItems: 50
type: array
value_limit:
@@ -78746,7 +78807,7 @@ components:
description: A cardinality override for a specific tag key within a per-metric limit.
properties:
override_type:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorOverrideType'
tag_key:
description: The tag key this override applies to.
example: "host"
@@ -78766,7 +78827,7 @@ components:
description: Controls whether the processor uses exact or probabilistic tag tracking.
properties:
mode:
- $ref: "#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingModeMode"
+ $ref: '#/components/schemas/ObservabilityPipelineTagCardinalityLimitProcessorTrackingModeMode'
required:
- mode
type: object
@@ -78795,7 +78856,7 @@ components:
**Supported pipeline types:** logs
properties:
display_name:
- $ref: "#/components/schemas/ObservabilityPipelineComponentDisplayName"
+ $ref: '#/components/schemas/ObservabilityPipelineComponentDisplayName'
enabled:
description: Indicates whether the processor is enabled.
example: true
@@ -78821,7 +78882,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ObservabilityPipelineThrottleProcessorType"
+ $ref: '#/components/schemas/ObservabilityPipelineThrottleProcessorType'
window:
description: The time window in seconds over which the threshold applies.
example: 60.0
@@ -78872,13 +78933,13 @@ components:
**Supported pipeline types:** logs.
properties:
auth_strategy:
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceAuthStrategy"
+ $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceAuthStrategy'
custom_key:
description: Name of the environment variable or secret that holds the custom authorization header value. Used when `auth_strategy` is `custom`.
example: WS_AUTH_CUSTOM_HEADER
type: string
decoding:
- $ref: "#/components/schemas/ObservabilityPipelineDecoding"
+ $ref: '#/components/schemas/ObservabilityPipelineDecoding'
id:
description: The unique identifier for this component.
example: websocket-source
@@ -78888,13 +78949,13 @@ components:
example: WS_AUTH_PASSWORD
type: string
tls:
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTls"
+ $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceTls'
token_key:
description: Name of the environment variable or secret that holds the bearer token. Used when `auth_strategy` is `bearer`.
example: WS_BEARER_TOKEN
type: string
type:
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceType"
+ $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceType'
uri_key:
description: Name of the environment variable or secret that holds the WebSocket server URI (`ws://` or `wss://`).
example: WS_URI
@@ -78927,13 +78988,13 @@ components:
ObservabilityPipelineWebsocketSourceTls:
description: TLS configuration for the WebSocket source. Use `enabled` for standard `wss://` connections, or `with_client_cert` to present a client certificate for mutual TLS.
oneOf:
- - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabled"
- - $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCert"
+ - $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabled'
+ - $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCert'
ObservabilityPipelineWebsocketSourceTlsEnabled:
description: TLS configuration that enables encryption without a client certificate. Use this for standard `wss://` connections that do not require mutual TLS.
properties:
mode:
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabledMode"
+ $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceTlsEnabledMode'
required:
- mode
type: object
@@ -78965,7 +79026,7 @@ components:
example: WS_TLS_KEY_PASSPHRASE
type: string
mode:
- $ref: "#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCertMode"
+ $ref: '#/components/schemas/ObservabilityPipelineWebsocketSourceTlsWithClientCertMode'
required:
- mode
- crt_file
@@ -78999,7 +79060,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/OktaAPITokenType"
+ $ref: '#/components/schemas/OktaAPITokenType'
required:
- type
- domain
@@ -79023,7 +79084,7 @@ components:
description: The `OktaAPITokenUpdate` `domain`.
type: string
type:
- $ref: "#/components/schemas/OktaAPITokenType"
+ $ref: '#/components/schemas/OktaAPITokenType'
required:
- type
type: object
@@ -79031,13 +79092,13 @@ components:
description: Schema for an Okta account.
properties:
attributes:
- $ref: "#/components/schemas/OktaAccountAttributes"
+ $ref: '#/components/schemas/OktaAccountAttributes'
id:
description: The ID of the Okta account, a UUID hash of the account name.
example: "f749daaf-682e-4208-a38d-c9b43162c609"
type: string
type:
- $ref: "#/components/schemas/OktaAccountType"
+ $ref: '#/components/schemas/OktaAccountType'
required:
- attributes
- type
@@ -79077,7 +79138,7 @@ components:
description: Request object for an Okta account.
properties:
data:
- $ref: "#/components/schemas/OktaAccount"
+ $ref: '#/components/schemas/OktaAccount'
required:
- data
type: object
@@ -79085,19 +79146,19 @@ components:
description: Response object for an Okta account.
properties:
data:
- $ref: "#/components/schemas/OktaAccount"
+ $ref: '#/components/schemas/OktaAccount'
type: object
OktaAccountResponseData:
description: Data object of an Okta account
properties:
attributes:
- $ref: "#/components/schemas/OktaAccountAttributes"
+ $ref: '#/components/schemas/OktaAccountAttributes'
id:
description: The ID of the Okta account, a UUID hash of the account name.
example: "f749daaf-682e-4208-a38d-c9b43162c609"
type: string
type:
- $ref: "#/components/schemas/OktaAccountType"
+ $ref: '#/components/schemas/OktaAccountType'
required:
- attributes
- id
@@ -79116,7 +79177,7 @@ components:
description: Payload schema when updating an Okta account.
properties:
data:
- $ref: "#/components/schemas/OktaAccountUpdateRequestData"
+ $ref: '#/components/schemas/OktaAccountUpdateRequestData'
required:
- data
type: object
@@ -79150,9 +79211,9 @@ components:
description: Data object for updating an Okta account.
properties:
attributes:
- $ref: "#/components/schemas/OktaAccountUpdateRequestAttributes"
+ $ref: '#/components/schemas/OktaAccountUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/OktaAccountType"
+ $ref: '#/components/schemas/OktaAccountType'
type: object
OktaAccountsResponse:
description: The expected response schema when getting Okta accounts.
@@ -79160,24 +79221,24 @@ components:
data:
description: List of Okta accounts.
items:
- $ref: "#/components/schemas/OktaAccountResponseData"
+ $ref: '#/components/schemas/OktaAccountResponseData'
type: array
type: object
OktaCredentials:
description: The definition of the `OktaCredentials` object.
oneOf:
- - $ref: "#/components/schemas/OktaAPIToken"
+ - $ref: '#/components/schemas/OktaAPIToken'
OktaCredentialsUpdate:
description: The definition of the `OktaCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/OktaAPITokenUpdate"
+ - $ref: '#/components/schemas/OktaAPITokenUpdate'
OktaIntegration:
description: The definition of the `OktaIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/OktaCredentials"
+ $ref: '#/components/schemas/OktaCredentials'
type:
- $ref: "#/components/schemas/OktaIntegrationType"
+ $ref: '#/components/schemas/OktaIntegrationType'
required:
- type
- credentials
@@ -79194,9 +79255,9 @@ components:
description: The definition of the `OktaIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/OktaCredentialsUpdate"
+ $ref: '#/components/schemas/OktaCredentialsUpdate'
type:
- $ref: "#/components/schemas/OktaIntegrationType"
+ $ref: '#/components/schemas/OktaIntegrationType'
required:
- type
type: object
@@ -79219,10 +79280,10 @@ components:
type: notification_rules
properties:
data:
- $ref: "#/components/schemas/OnCallNotificationRuleData"
+ $ref: '#/components/schemas/OnCallNotificationRuleData'
included:
items:
- $ref: "#/components/schemas/OnCallNotificationRulesIncluded"
+ $ref: '#/components/schemas/OnCallNotificationRulesIncluded'
type: array
required:
- data
@@ -79231,7 +79292,7 @@ components:
description: Attributes for an on-call notification rule.
properties:
category:
- $ref: "#/components/schemas/OnCallNotificationRuleCategory"
+ $ref: '#/components/schemas/OnCallNotificationRuleCategory'
channel_settings:
$ref: "#/components/schemas/OnCallNotificationRuleChannelSettings"
description: Configuration for the associated channel, if necessary
@@ -79255,7 +79316,7 @@ components:
description: Relationship object for creating a notification rule
properties:
data:
- $ref: "#/components/schemas/OnCallNotificationRuleChannelRelationshipData"
+ $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationshipData'
required:
- data
type: object
@@ -79266,24 +79327,24 @@ components:
description: ID of the notification channel
type: string
type:
- $ref: "#/components/schemas/NotificationChannelType"
+ $ref: '#/components/schemas/NotificationChannelType'
type: object
OnCallNotificationRuleChannelSettings:
description: "Defines the configuration for a channel associated with a notification rule"
oneOf:
- - $ref: "#/components/schemas/OnCallPhoneNotificationRuleSettings"
+ - $ref: '#/components/schemas/OnCallPhoneNotificationRuleSettings'
OnCallNotificationRuleData:
description: Data for an on-call notification rule
properties:
attributes:
- $ref: "#/components/schemas/OnCallNotificationRuleAttributes"
+ $ref: '#/components/schemas/OnCallNotificationRuleAttributes'
id:
description: Unique identifier for the rule
type: string
relationships:
- $ref: "#/components/schemas/OnCallNotificationRuleRelationships"
+ $ref: '#/components/schemas/OnCallNotificationRuleRelationships'
type:
- $ref: "#/components/schemas/OnCallNotificationRuleType"
+ $ref: '#/components/schemas/OnCallNotificationRuleType'
required:
- type
type: object
@@ -79291,13 +79352,13 @@ components:
description: Relationship object for creating a notification rule
properties:
channel:
- $ref: "#/components/schemas/OnCallNotificationRuleChannelRelationship"
+ $ref: '#/components/schemas/OnCallNotificationRuleChannelRelationship'
type: object
OnCallNotificationRuleRequestAttributes:
description: Attributes for creating or modifying an on-call notification rule.
properties:
category:
- $ref: "#/components/schemas/OnCallNotificationRuleCategory"
+ $ref: '#/components/schemas/OnCallNotificationRuleCategory'
channel_settings:
$ref: "#/components/schemas/OnCallNotificationRuleChannelSettings"
description: Configuration for the associated channel, if necessary
@@ -79319,7 +79380,7 @@ components:
OnCallNotificationRulesIncluded:
description: Represents additional included resources for a on-call notification rules
oneOf:
- - $ref: "#/components/schemas/NotificationChannelData"
+ - $ref: '#/components/schemas/NotificationChannelData'
OnCallPageTargetType:
description: The kind of target, `team_id` | `team_handle` | `user_id`.
enum:
@@ -79346,9 +79407,9 @@ components:
description: "Configuration for using a phone notification channel in a notification rule"
properties:
method:
- $ref: "#/components/schemas/OnCallPhoneNotificationRuleMethod"
+ $ref: '#/components/schemas/OnCallPhoneNotificationRuleMethod'
type:
- $ref: "#/components/schemas/NotificationChannelPhoneConfigType"
+ $ref: '#/components/schemas/NotificationChannelPhoneConfigType'
required:
- type
- method
@@ -79357,15 +79418,15 @@ components:
description: "Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
OnCallTriggerWrapper:
description: "Schema for an On-Call-based trigger."
properties:
onCallTrigger:
- $ref: "#/components/schemas/OnCallTrigger"
+ $ref: '#/components/schemas/OnCallTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- onCallTrigger
type: object
@@ -79373,9 +79434,9 @@ components:
description: On-demand concurrency cap.
properties:
attributes:
- $ref: "#/components/schemas/OnDemandConcurrencyCapAttributes"
+ $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
type:
- $ref: "#/components/schemas/OnDemandConcurrencyCapType"
+ $ref: '#/components/schemas/OnDemandConcurrencyCapType'
type: object
OnDemandConcurrencyCapAttributes:
description: On-demand concurrency cap attributes.
@@ -79389,7 +79450,7 @@ components:
description: On-demand concurrency cap response.
properties:
data:
- $ref: "#/components/schemas/OnDemandConcurrencyCap"
+ $ref: '#/components/schemas/OnDemandConcurrencyCap'
type: object
OnDemandConcurrencyCapType:
description: On-demand concurrency cap type.
@@ -79406,7 +79467,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/OpenAIAPIKeyType"
+ $ref: '#/components/schemas/OpenAIAPIKeyType'
required:
- type
- api_token
@@ -79426,25 +79487,25 @@ components:
description: The `OpenAIAPIKeyUpdate` `api_token`.
type: string
type:
- $ref: "#/components/schemas/OpenAIAPIKeyType"
+ $ref: '#/components/schemas/OpenAIAPIKeyType'
required:
- type
type: object
OpenAICredentials:
description: The definition of the `OpenAICredentials` object.
oneOf:
- - $ref: "#/components/schemas/OpenAIAPIKey"
+ - $ref: '#/components/schemas/OpenAIAPIKey'
OpenAICredentialsUpdate:
description: The definition of the `OpenAICredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/OpenAIAPIKeyUpdate"
+ - $ref: '#/components/schemas/OpenAIAPIKeyUpdate'
OpenAIIntegration:
description: The definition of the `OpenAIIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/OpenAICredentials"
+ $ref: '#/components/schemas/OpenAICredentials'
type:
- $ref: "#/components/schemas/OpenAIIntegrationType"
+ $ref: '#/components/schemas/OpenAIIntegrationType'
required:
- type
- credentials
@@ -79461,9 +79522,9 @@ components:
description: The definition of the `OpenAIIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/OpenAICredentialsUpdate"
+ $ref: '#/components/schemas/OpenAICredentialsUpdate'
type:
- $ref: "#/components/schemas/OpenAIIntegrationType"
+ $ref: '#/components/schemas/OpenAIIntegrationType'
required:
- type
type: object
@@ -79494,7 +79555,7 @@ components:
minLength: 1
type: string
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
required:
- api_key
- region
@@ -79503,9 +79564,9 @@ components:
description: Opsgenie account data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieAccountCreateAttributes"
+ $ref: '#/components/schemas/OpsgenieAccountCreateAttributes'
type:
- $ref: "#/components/schemas/OpsgenieAccountType"
+ $ref: '#/components/schemas/OpsgenieAccountType'
required:
- type
- attributes
@@ -79514,7 +79575,7 @@ components:
description: Create request for an Opsgenie account.
properties:
data:
- $ref: "#/components/schemas/OpsgenieAccountCreateData"
+ $ref: '#/components/schemas/OpsgenieAccountCreateData'
required:
- data
type: object
@@ -79522,7 +79583,7 @@ components:
description: Response containing an Opsgenie account.
properties:
data:
- $ref: "#/components/schemas/OpsgenieAccountResponseData"
+ $ref: '#/components/schemas/OpsgenieAccountResponseData'
required:
- data
type: object
@@ -79530,13 +79591,13 @@ components:
description: The attributes from an Opsgenie account response.
properties:
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
type: object
OpsgenieAccountResponseData:
description: Opsgenie account data from a response.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieAccountResponseAttributes"
+ $ref: '#/components/schemas/OpsgenieAccountResponseAttributes'
id:
description: The ID of the Opsgenie account.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -79544,7 +79605,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/OpsgenieAccountType"
+ $ref: '#/components/schemas/OpsgenieAccountType'
required:
- id
- type
@@ -79568,13 +79629,13 @@ components:
minLength: 1
type: string
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
type: object
OpsgenieAccountUpdateData:
description: Opsgenie account data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieAccountUpdateAttributes"
+ $ref: '#/components/schemas/OpsgenieAccountUpdateAttributes'
id:
description: The ID of the Opsgenie account.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -79582,7 +79643,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/OpsgenieAccountType"
+ $ref: '#/components/schemas/OpsgenieAccountType'
required:
- id
- type
@@ -79592,7 +79653,7 @@ components:
description: Update request for an Opsgenie account.
properties:
data:
- $ref: "#/components/schemas/OpsgenieAccountUpdateData"
+ $ref: '#/components/schemas/OpsgenieAccountUpdateData'
required:
- data
type: object
@@ -79603,7 +79664,7 @@ components:
description: An array of Opsgenie accounts.
example: [{"attributes": {"region": "us"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "opsgenie-account"}, {"attributes": {"region": "eu"}, "id": "0d2937f1-b561-44fa-914a-99910f848014", "type": "opsgenie-account"}]
items:
- $ref: "#/components/schemas/OpsgenieAccountResponseData"
+ $ref: '#/components/schemas/OpsgenieAccountResponseData'
type: array
required:
- data
@@ -79625,7 +79686,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
required:
- name
- opsgenie_api_key
@@ -79635,9 +79696,9 @@ components:
description: Opsgenie service data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieServiceCreateAttributes"
+ $ref: '#/components/schemas/OpsgenieServiceCreateAttributes'
type:
- $ref: "#/components/schemas/OpsgenieServiceType"
+ $ref: '#/components/schemas/OpsgenieServiceType'
required:
- type
- attributes
@@ -79646,7 +79707,7 @@ components:
description: Create request for an Opsgenie service.
properties:
data:
- $ref: "#/components/schemas/OpsgenieServiceCreateData"
+ $ref: '#/components/schemas/OpsgenieServiceCreateData'
required:
- data
type: object
@@ -79666,7 +79727,7 @@ components:
description: Response of an Opsgenie service.
properties:
data:
- $ref: "#/components/schemas/OpsgenieServiceResponseData"
+ $ref: '#/components/schemas/OpsgenieServiceResponseData'
required:
- data
type: object
@@ -79684,13 +79745,13 @@ components:
maxLength: 100
type: string
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
type: object
OpsgenieServiceResponseData:
description: Opsgenie service data from a response.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieServiceResponseAttributes"
+ $ref: '#/components/schemas/OpsgenieServiceResponseAttributes'
id:
description: The ID of the Opsgenie service.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -79698,7 +79759,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/OpsgenieServiceType"
+ $ref: '#/components/schemas/OpsgenieServiceType'
required:
- id
- type
@@ -79731,13 +79792,13 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
region:
- $ref: "#/components/schemas/OpsgenieServiceRegionType"
+ $ref: '#/components/schemas/OpsgenieServiceRegionType'
type: object
OpsgenieServiceUpdateData:
description: Opsgenie service for an update request.
properties:
attributes:
- $ref: "#/components/schemas/OpsgenieServiceUpdateAttributes"
+ $ref: '#/components/schemas/OpsgenieServiceUpdateAttributes'
id:
description: The ID of the Opsgenie service.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -79745,7 +79806,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/OpsgenieServiceType"
+ $ref: '#/components/schemas/OpsgenieServiceType'
required:
- id
- type
@@ -79755,7 +79816,7 @@ components:
description: Update request for an Opsgenie service.
properties:
data:
- $ref: "#/components/schemas/OpsgenieServiceUpdateData"
+ $ref: '#/components/schemas/OpsgenieServiceUpdateData'
required:
- data
type: object
@@ -79766,7 +79827,7 @@ components:
description: An array of Opsgenie services.
example: [{"attributes": {"custom_url": null, "name": "fake-opsgenie-service-name", "region": "us"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "opsgenie-service"}, {"attributes": {"custom_url": null, "name": "fake-opsgenie-service-name-2", "region": "eu"}, "id": "0d2937f1-b561-44fa-914a-99910f848014", "type": "opsgenie-service"}]
items:
- $ref: "#/components/schemas/OpsgenieServiceResponseData"
+ $ref: '#/components/schemas/OpsgenieServiceResponseData'
type: array
required:
- data
@@ -79855,15 +79916,15 @@ components:
description: Data object representing an org authorized client.
properties:
attributes:
- $ref: "#/components/schemas/OrgAuthorizedClientAttributes"
+ $ref: '#/components/schemas/OrgAuthorizedClientAttributes'
id:
description: The unique identifier of the org authorized client.
example: "00000000-0000-0000-0000-000000000001"
type: string
relationships:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationships"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationships'
type:
- $ref: "#/components/schemas/OrgAuthorizedClientType"
+ $ref: '#/components/schemas/OrgAuthorizedClientType'
required:
- id
- type
@@ -79873,13 +79934,13 @@ components:
OrgAuthorizedClientDataList:
description: List of org authorized client data objects.
items:
- $ref: "#/components/schemas/OrgAuthorizedClientData"
+ $ref: '#/components/schemas/OrgAuthorizedClientData'
type: array
OrgAuthorizedClientRelationshipOAuth2Client:
description: Relationship to the OAuth2 client for this org authorized client.
properties:
data:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientData"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientData'
required:
- data
type: object
@@ -79891,7 +79952,7 @@ components:
example: "00000000-0000-0000-0000-000000000010"
type: string
type:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientDataType"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipOAuth2ClientDataType'
required:
- type
- id
@@ -79908,9 +79969,9 @@ components:
description: Relationship to the user authorized clients for this org authorized client.
properties:
data:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataList"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataList'
links:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsLinks"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsLinks'
required:
- links
- data
@@ -79923,7 +79984,7 @@ components:
example: "00000000-0000-0000-0000-000000000020"
type: string
type:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataType"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsDataType'
required:
- type
- id
@@ -79931,7 +79992,7 @@ components:
OrgAuthorizedClientRelationshipUserAuthorizedClientsDataList:
description: List of user authorized client relationship data objects.
items:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsData"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClientsData'
type: array
OrgAuthorizedClientRelationshipUserAuthorizedClientsDataType:
description: User authorized client resource type.
@@ -79955,9 +80016,9 @@ components:
description: Relationships for an org authorized client.
properties:
oauth2_client:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipOAuth2Client"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipOAuth2Client'
user_authorized_clients:
- $ref: "#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClients"
+ $ref: '#/components/schemas/OrgAuthorizedClientRelationshipUserAuthorizedClients'
required:
- oauth2_client
- user_authorized_clients
@@ -79966,7 +80027,7 @@ components:
description: Response containing a single org authorized client.
properties:
data:
- $ref: "#/components/schemas/OrgAuthorizedClientData"
+ $ref: '#/components/schemas/OrgAuthorizedClientData'
required:
- data
type: object
@@ -79990,13 +80051,13 @@ components:
description: Data object for updating an org authorized client.
properties:
attributes:
- $ref: "#/components/schemas/OrgAuthorizedClientUpdateAttributes"
+ $ref: '#/components/schemas/OrgAuthorizedClientUpdateAttributes'
id:
description: The unique identifier of the org authorized client to update.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/OrgAuthorizedClientType"
+ $ref: '#/components/schemas/OrgAuthorizedClientType'
required:
- id
- type
@@ -80005,7 +80066,7 @@ components:
description: Request body for updating an org authorized client.
properties:
data:
- $ref: "#/components/schemas/OrgAuthorizedClientUpdateData"
+ $ref: '#/components/schemas/OrgAuthorizedClientUpdateData'
required:
- data
type: object
@@ -80025,9 +80086,9 @@ components:
description: Response containing a list of org authorized clients.
properties:
data:
- $ref: "#/components/schemas/OrgAuthorizedClientDataList"
+ $ref: '#/components/schemas/OrgAuthorizedClientDataList'
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
required:
- data
- meta
@@ -80036,7 +80097,7 @@ components:
description: A response with a single Org Config.
properties:
data:
- $ref: "#/components/schemas/OrgConfigRead"
+ $ref: '#/components/schemas/OrgConfigRead'
required: [data]
type: object
OrgConfigListResponse:
@@ -80045,7 +80106,7 @@ components:
data:
description: An array of Org Configs.
items:
- $ref: "#/components/schemas/OrgConfigRead"
+ $ref: '#/components/schemas/OrgConfigRead'
type: array
required: [data]
type: object
@@ -80053,13 +80114,13 @@ components:
description: A single Org Config.
properties:
attributes:
- $ref: "#/components/schemas/OrgConfigReadAttributes"
+ $ref: '#/components/schemas/OrgConfigReadAttributes'
id:
description: A unique identifier for an Org Config.
example: abcd1234
type: string
type:
- $ref: "#/components/schemas/OrgConfigType"
+ $ref: '#/components/schemas/OrgConfigType'
required: [id, type, attributes]
type: object
OrgConfigReadAttributes:
@@ -80097,9 +80158,9 @@ components:
description: An Org Config write operation.
properties:
attributes:
- $ref: "#/components/schemas/OrgConfigWriteAttributes"
+ $ref: '#/components/schemas/OrgConfigWriteAttributes'
type:
- $ref: "#/components/schemas/OrgConfigType"
+ $ref: '#/components/schemas/OrgConfigType'
required: [type, attributes]
type: object
OrgConfigWriteAttributes:
@@ -80113,23 +80174,23 @@ components:
description: A request to update an Org Config.
properties:
data:
- $ref: "#/components/schemas/OrgConfigWrite"
+ $ref: '#/components/schemas/OrgConfigWrite'
required: [data]
type: object
OrgConnection:
description: An org connection.
properties:
attributes:
- $ref: "#/components/schemas/OrgConnectionAttributes"
+ $ref: '#/components/schemas/OrgConnectionAttributes'
id:
description: The unique identifier of the org connection.
example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/OrgConnectionRelationships"
+ $ref: '#/components/schemas/OrgConnectionRelationships'
type:
- $ref: "#/components/schemas/OrgConnectionType"
+ $ref: '#/components/schemas/OrgConnectionType'
required: [id, type, attributes, relationships]
type: object
OrgConnectionAttributes:
@@ -80139,7 +80200,7 @@ components:
description: List of connection types.
example: ["logs", "metrics"]
items:
- $ref: "#/components/schemas/OrgConnectionTypeEnum"
+ $ref: '#/components/schemas/OrgConnectionTypeEnum'
type: array
created_at:
description: Timestamp when the connection was created.
@@ -80152,11 +80213,11 @@ components:
description: Org connection creation data.
properties:
attributes:
- $ref: "#/components/schemas/OrgConnectionCreateAttributes"
+ $ref: '#/components/schemas/OrgConnectionCreateAttributes'
relationships:
- $ref: "#/components/schemas/OrgConnectionCreateRelationships"
+ $ref: '#/components/schemas/OrgConnectionCreateRelationships'
type:
- $ref: "#/components/schemas/OrgConnectionType"
+ $ref: '#/components/schemas/OrgConnectionType'
required: [type, attributes, relationships]
type: object
OrgConnectionCreateAttributes:
@@ -80166,7 +80227,7 @@ components:
description: List of connection types to establish.
example: ["logs"]
items:
- $ref: "#/components/schemas/OrgConnectionTypeEnum"
+ $ref: '#/components/schemas/OrgConnectionTypeEnum'
minItems: 1
type: array
required: [connection_types]
@@ -80175,14 +80236,14 @@ components:
description: Relationships for org connection creation.
properties:
sink_org:
- $ref: "#/components/schemas/OrgConnectionOrgRelationship"
+ $ref: '#/components/schemas/OrgConnectionOrgRelationship'
required: [sink_org]
type: object
OrgConnectionCreateRequest:
description: Request to create an org connection.
properties:
data:
- $ref: "#/components/schemas/OrgConnectionCreate"
+ $ref: '#/components/schemas/OrgConnectionCreate'
required: [data]
type: object
OrgConnectionListResponse:
@@ -80191,17 +80252,17 @@ components:
data:
description: List of org connections.
items:
- $ref: "#/components/schemas/OrgConnection"
+ $ref: '#/components/schemas/OrgConnection'
type: array
meta:
- $ref: "#/components/schemas/OrgConnectionListResponseMeta"
+ $ref: '#/components/schemas/OrgConnectionListResponseMeta'
required: [data]
type: object
OrgConnectionListResponseMeta:
description: Pagination metadata.
properties:
page:
- $ref: "#/components/schemas/OrgConnectionListResponseMetaPage"
+ $ref: '#/components/schemas/OrgConnectionListResponseMetaPage'
type: object
OrgConnectionListResponseMetaPage:
description: Page information.
@@ -80221,7 +80282,7 @@ components:
description: Org relationship.
properties:
data:
- $ref: "#/components/schemas/OrgConnectionOrgRelationshipData"
+ $ref: '#/components/schemas/OrgConnectionOrgRelationshipData'
type: object
OrgConnectionOrgRelationshipData:
description: The definition of `OrgConnectionOrgRelationshipData` object.
@@ -80235,7 +80296,7 @@ components:
example: "Example Org"
type: string
type:
- $ref: "#/components/schemas/OrgConnectionOrgRelationshipDataType"
+ $ref: '#/components/schemas/OrgConnectionOrgRelationshipDataType'
type: object
OrgConnectionOrgRelationshipDataType:
description: The type of the organization relationship.
@@ -80248,17 +80309,17 @@ components:
description: Related organizations and user.
properties:
created_by:
- $ref: "#/components/schemas/OrgConnectionUserRelationship"
+ $ref: '#/components/schemas/OrgConnectionUserRelationship'
sink_org:
- $ref: "#/components/schemas/OrgConnectionOrgRelationship"
+ $ref: '#/components/schemas/OrgConnectionOrgRelationship'
source_org:
- $ref: "#/components/schemas/OrgConnectionOrgRelationship"
+ $ref: '#/components/schemas/OrgConnectionOrgRelationship'
type: object
OrgConnectionResponse:
description: Response containing a single org connection.
properties:
data:
- $ref: "#/components/schemas/OrgConnection"
+ $ref: '#/components/schemas/OrgConnection'
required: [data]
type: object
OrgConnectionType:
@@ -80284,14 +80345,14 @@ components:
description: Org connection update data.
properties:
attributes:
- $ref: "#/components/schemas/OrgConnectionUpdateAttributes"
+ $ref: '#/components/schemas/OrgConnectionUpdateAttributes'
id:
description: The unique identifier of the org connection.
example: "f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgConnectionType"
+ $ref: '#/components/schemas/OrgConnectionType'
required: [type, id, attributes]
type: object
OrgConnectionUpdateAttributes:
@@ -80301,7 +80362,7 @@ components:
description: Updated list of connection types.
example: ["logs", "metrics"]
items:
- $ref: "#/components/schemas/OrgConnectionTypeEnum"
+ $ref: '#/components/schemas/OrgConnectionTypeEnum'
minItems: 1
type: array
required: [connection_types]
@@ -80310,14 +80371,14 @@ components:
description: Request to update an org connection.
properties:
data:
- $ref: "#/components/schemas/OrgConnectionUpdate"
+ $ref: '#/components/schemas/OrgConnectionUpdate'
required: [data]
type: object
OrgConnectionUserRelationship:
description: User relationship.
properties:
data:
- $ref: "#/components/schemas/OrgConnectionUserRelationshipData"
+ $ref: '#/components/schemas/OrgConnectionUserRelationshipData'
type: object
OrgConnectionUserRelationshipData:
description: The data for a user relationship.
@@ -80331,7 +80392,7 @@ components:
example: "John Doe"
type: string
type:
- $ref: "#/components/schemas/OrgConnectionUserRelationshipDataType"
+ $ref: '#/components/schemas/OrgConnectionUserRelationshipDataType'
type: object
OrgConnectionUserRelationshipDataType:
description: The type of the user relationship.
@@ -80344,14 +80405,14 @@ components:
description: An organization resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgAttributes"
+ $ref: '#/components/schemas/OrgAttributes'
id:
description: The UUID of the organization.
example: "4dee724d-00cc-11ea-a77b-570c9d03c6c5"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgResourceType"
+ $ref: '#/components/schemas/OrgResourceType'
required:
- id
- type
@@ -80404,9 +80465,9 @@ components:
description: Data for creating an org group.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupCreateAttributes"
+ $ref: '#/components/schemas/OrgGroupCreateAttributes'
type:
- $ref: "#/components/schemas/OrgGroupType"
+ $ref: '#/components/schemas/OrgGroupType'
required:
- type
- attributes
@@ -80415,7 +80476,7 @@ components:
description: Request to create an org group.
properties:
data:
- $ref: "#/components/schemas/OrgGroupCreateData"
+ $ref: '#/components/schemas/OrgGroupCreateData'
required:
- data
type: object
@@ -80423,14 +80484,14 @@ components:
description: An org group resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupAttributes"
+ $ref: '#/components/schemas/OrgGroupAttributes'
id:
description: The ID of the org group.
example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupType"
+ $ref: '#/components/schemas/OrgGroupType'
required:
- id
- type
@@ -80442,12 +80503,12 @@ components:
data:
description: An array of org groups.
items:
- $ref: "#/components/schemas/OrgGroupData"
+ $ref: '#/components/schemas/OrgGroupData'
type: array
links:
- $ref: "#/components/schemas/OrgGroupPaginationLinks"
+ $ref: '#/components/schemas/OrgGroupPaginationLinks'
meta:
- $ref: "#/components/schemas/OrgGroupPaginationMeta"
+ $ref: '#/components/schemas/OrgGroupPaginationMeta'
required:
- data
type: object
@@ -80490,7 +80551,7 @@ components:
orgs:
description: List of organizations to move. Maximum 100 per request.
items:
- $ref: "#/components/schemas/GlobalOrgIdentifier"
+ $ref: '#/components/schemas/GlobalOrgIdentifier'
type: array
required:
- orgs
@@ -80499,11 +80560,11 @@ components:
description: Data for bulk updating org group memberships.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupMembershipBulkUpdateAttributes"
+ $ref: '#/components/schemas/OrgGroupMembershipBulkUpdateAttributes'
relationships:
- $ref: "#/components/schemas/OrgGroupMembershipBulkUpdateRelationships"
+ $ref: '#/components/schemas/OrgGroupMembershipBulkUpdateRelationships'
type:
- $ref: "#/components/schemas/OrgGroupMembershipBulkUpdateType"
+ $ref: '#/components/schemas/OrgGroupMembershipBulkUpdateType'
required:
- type
- attributes
@@ -80513,9 +80574,9 @@ components:
description: Relationships for bulk updating memberships.
properties:
source_org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
target_org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
required:
- source_org_group
- target_org_group
@@ -80524,7 +80585,7 @@ components:
description: Request to bulk update org group memberships.
properties:
data:
- $ref: "#/components/schemas/OrgGroupMembershipBulkUpdateData"
+ $ref: '#/components/schemas/OrgGroupMembershipBulkUpdateData'
required:
- data
type: object
@@ -80540,16 +80601,16 @@ components:
description: An org group membership resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupMembershipAttributes"
+ $ref: '#/components/schemas/OrgGroupMembershipAttributes'
id:
description: The ID of the org group membership.
example: "f1e2d3c4-b5a6-7890-1234-567890abcdef"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/OrgGroupMembershipRelationships"
+ $ref: '#/components/schemas/OrgGroupMembershipRelationships'
type:
- $ref: "#/components/schemas/OrgGroupMembershipType"
+ $ref: '#/components/schemas/OrgGroupMembershipType'
required:
- id
- type
@@ -80561,12 +80622,12 @@ components:
data:
description: An array of org group memberships.
items:
- $ref: "#/components/schemas/OrgGroupMembershipData"
+ $ref: '#/components/schemas/OrgGroupMembershipData'
type: array
links:
- $ref: "#/components/schemas/OrgGroupPaginationLinks"
+ $ref: '#/components/schemas/OrgGroupPaginationLinks'
meta:
- $ref: "#/components/schemas/OrgGroupPaginationMeta"
+ $ref: '#/components/schemas/OrgGroupPaginationMeta'
required:
- data
type: object
@@ -80574,13 +80635,13 @@ components:
description: Relationships of an org group membership.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
type: object
OrgGroupMembershipResponse:
description: Response containing a single org group membership.
properties:
data:
- $ref: "#/components/schemas/OrgGroupMembershipData"
+ $ref: '#/components/schemas/OrgGroupMembershipData'
required:
- data
type: object
@@ -80616,9 +80677,9 @@ components:
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/OrgGroupMembershipUpdateRelationships"
+ $ref: '#/components/schemas/OrgGroupMembershipUpdateRelationships'
type:
- $ref: "#/components/schemas/OrgGroupMembershipType"
+ $ref: '#/components/schemas/OrgGroupMembershipType'
required:
- id
- type
@@ -80628,7 +80689,7 @@ components:
description: Relationships for updating a membership.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
required:
- org_group
type: object
@@ -80636,7 +80697,7 @@ components:
description: Request to update an org group membership.
properties:
data:
- $ref: "#/components/schemas/OrgGroupMembershipUpdateData"
+ $ref: '#/components/schemas/OrgGroupMembershipUpdateData'
required:
- data
type: object
@@ -80665,7 +80726,7 @@ components:
description: Pagination metadata for org group list responses.
properties:
page:
- $ref: "#/components/schemas/OrgGroupPaginationMetaPage"
+ $ref: '#/components/schemas/OrgGroupPaginationMetaPage'
type: object
OrgGroupPaginationMetaPage:
description: Page-based pagination details for org group list responses.
@@ -80717,7 +80778,7 @@ components:
value: "UTC"
type: object
enforcement_tier:
- $ref: "#/components/schemas/OrgGroupPolicyEnforcementTier"
+ $ref: '#/components/schemas/OrgGroupPolicyEnforcementTier'
modified_at:
description: Timestamp when the policy was last modified.
example: "2024-01-15T10:30:00Z"
@@ -80729,7 +80790,7 @@ components:
example: "monitor_timezone"
type: string
policy_type:
- $ref: "#/components/schemas/OrgGroupPolicyPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyPolicyType'
required:
- policy_name
- policy_type
@@ -80772,13 +80833,13 @@ components:
description: An org group policy config resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyConfigAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyConfigAttributes'
id:
description: The identifier of the policy config (uses the config name).
example: "monitor_timezone"
type: string
type:
- $ref: "#/components/schemas/OrgGroupPolicyConfigType"
+ $ref: '#/components/schemas/OrgGroupPolicyConfigType'
required:
- id
- type
@@ -80790,7 +80851,7 @@ components:
data:
description: An array of org group policy configs.
items:
- $ref: "#/components/schemas/OrgGroupPolicyConfigData"
+ $ref: '#/components/schemas/OrgGroupPolicyConfigData'
type: array
required:
- data
@@ -80815,14 +80876,14 @@ components:
value: "UTC"
type: object
enforcement_tier:
- $ref: "#/components/schemas/OrgGroupPolicyEnforcementTier"
+ $ref: '#/components/schemas/OrgGroupPolicyEnforcementTier'
policy_name:
description: >-
The name of the policy. This becomes the name of the resource created across orgs in the group (for example, for `role` policies, the name of the created role).
example: "monitor_timezone"
type: string
policy_type:
- $ref: "#/components/schemas/OrgGroupPolicyPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyPolicyType'
required:
- policy_name
- content
@@ -80831,11 +80892,11 @@ components:
description: Data for creating an org group policy.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyCreateAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyCreateAttributes'
relationships:
- $ref: "#/components/schemas/OrgGroupPolicyCreateRelationships"
+ $ref: '#/components/schemas/OrgGroupPolicyCreateRelationships'
type:
- $ref: "#/components/schemas/OrgGroupPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyType'
required:
- type
- attributes
@@ -80845,7 +80906,7 @@ components:
description: Relationships for creating a policy.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
required:
- org_group
type: object
@@ -80853,7 +80914,7 @@ components:
description: Request to create an org group policy.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyCreateData"
+ $ref: '#/components/schemas/OrgGroupPolicyCreateData'
required:
- data
type: object
@@ -80861,16 +80922,16 @@ components:
description: An org group policy resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyAttributes'
id:
description: The ID of the org group policy.
example: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/OrgGroupPolicyRelationships"
+ $ref: '#/components/schemas/OrgGroupPolicyRelationships'
type:
- $ref: "#/components/schemas/OrgGroupPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyType'
required:
- id
- type
@@ -80906,12 +80967,12 @@ components:
data:
description: An array of org group policies.
items:
- $ref: "#/components/schemas/OrgGroupPolicyData"
+ $ref: '#/components/schemas/OrgGroupPolicyData'
type: array
links:
- $ref: "#/components/schemas/OrgGroupPaginationLinks"
+ $ref: '#/components/schemas/OrgGroupPaginationLinks'
meta:
- $ref: "#/components/schemas/OrgGroupPaginationMeta"
+ $ref: '#/components/schemas/OrgGroupPaginationMeta'
required:
- data
type: object
@@ -80967,11 +81028,11 @@ components:
description: Data for creating an org group policy override.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideCreateAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideCreateAttributes'
relationships:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideCreateRelationships"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideCreateRelationships'
type:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideType"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideType'
required:
- type
- attributes
@@ -80981,9 +81042,9 @@ components:
description: Relationships for creating a policy override.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
org_group_policy:
- $ref: "#/components/schemas/OrgGroupPolicyRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupPolicyRelationshipToOne'
required:
- org_group
- org_group_policy
@@ -80992,7 +81053,7 @@ components:
description: Request to create an org group policy override.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideCreateData"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideCreateData'
required:
- data
type: object
@@ -81000,16 +81061,16 @@ components:
description: An org group policy override resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideAttributes'
id:
description: The ID of the policy override.
example: "9f8e7d6c-5b4a-3210-fedc-ba0987654321"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideRelationships"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideRelationships'
type:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideType"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideType'
required:
- id
- type
@@ -81021,12 +81082,12 @@ components:
data:
description: An array of org group policy overrides.
items:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideData"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideData'
type: array
links:
- $ref: "#/components/schemas/OrgGroupPaginationLinks"
+ $ref: '#/components/schemas/OrgGroupPaginationLinks'
meta:
- $ref: "#/components/schemas/OrgGroupPaginationMeta"
+ $ref: '#/components/schemas/OrgGroupPaginationMeta'
required:
- data
type: object
@@ -81034,15 +81095,15 @@ components:
description: Relationships of an org group policy override.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
org_group_policy:
- $ref: "#/components/schemas/OrgGroupPolicyRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupPolicyRelationshipToOne'
type: object
OrgGroupPolicyOverrideResponse:
description: Response containing a single org group policy override.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideData"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideData'
required:
- data
type: object
@@ -81090,14 +81151,14 @@ components:
description: Data for updating a policy override.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideUpdateAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideUpdateAttributes'
id:
description: The ID of the policy override.
example: "9f8e7d6c-5b4a-3210-fedc-ba0987654321"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideType"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideType'
required:
- id
- type
@@ -81107,7 +81168,7 @@ components:
description: Request to update an org group policy override.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideUpdateData"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideUpdateData'
required:
- data
type: object
@@ -81127,7 +81188,7 @@ components:
description: Relationship to a single org group policy.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyRelationshipToOneData"
+ $ref: '#/components/schemas/OrgGroupPolicyRelationshipToOneData'
required:
- data
type: object
@@ -81140,7 +81201,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyType'
required:
- id
- type
@@ -81149,13 +81210,13 @@ components:
description: Relationships of an org group policy.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
type: object
OrgGroupPolicyResponse:
description: Response containing a single org group policy.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyData"
+ $ref: '#/components/schemas/OrgGroupPolicyData'
required:
- data
type: object
@@ -81192,7 +81253,7 @@ components:
description: The recommended value for the policy, based on member org consensus.
example: "UTC"
status:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionStatus"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionStatus'
required:
- policy_name
- status
@@ -81203,15 +81264,15 @@ components:
description: An org group policy suggestion resource.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionAttributes'
id:
description: The ID of the org group policy suggestion.
example: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
type: string
relationships:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionRelationships"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionRelationships'
type:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionType"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionType'
required:
- id
- type
@@ -81223,7 +81284,7 @@ components:
data:
description: An array of org group policy suggestions.
items:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionData"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionData'
type: array
required:
- data
@@ -81232,7 +81293,7 @@ components:
description: Relationships of an org group policy suggestion.
properties:
org_group:
- $ref: "#/components/schemas/OrgGroupRelationshipToOne"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOne'
type: object
OrgGroupPolicySuggestionStatus:
description: The status of the policy suggestion.
@@ -81274,7 +81335,7 @@ components:
value: "UTC"
type: object
enforcement_tier:
- $ref: "#/components/schemas/OrgGroupPolicyEnforcementTier"
+ $ref: '#/components/schemas/OrgGroupPolicyEnforcementTier'
policy_name:
description: >-
The name of the policy. This becomes the name of the resource created across orgs in the group (for example, for `role` policies, the name of the created role). Omit to leave unchanged.
@@ -81285,14 +81346,14 @@ components:
description: Data for updating an org group policy.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupPolicyUpdateAttributes"
+ $ref: '#/components/schemas/OrgGroupPolicyUpdateAttributes'
id:
description: The ID of the policy.
example: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupPolicyType"
+ $ref: '#/components/schemas/OrgGroupPolicyType'
required:
- id
- type
@@ -81302,7 +81363,7 @@ components:
description: Request to update an org group policy.
properties:
data:
- $ref: "#/components/schemas/OrgGroupPolicyUpdateData"
+ $ref: '#/components/schemas/OrgGroupPolicyUpdateData'
required:
- data
type: object
@@ -81310,7 +81371,7 @@ components:
description: Relationship to a single org group.
properties:
data:
- $ref: "#/components/schemas/OrgGroupRelationshipToOneData"
+ $ref: '#/components/schemas/OrgGroupRelationshipToOneData'
required:
- data
type: object
@@ -81323,7 +81384,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupType"
+ $ref: '#/components/schemas/OrgGroupType'
required:
- id
- type
@@ -81332,7 +81393,7 @@ components:
description: Response containing a single org group.
properties:
data:
- $ref: "#/components/schemas/OrgGroupData"
+ $ref: '#/components/schemas/OrgGroupData'
required:
- data
type: object
@@ -81373,14 +81434,14 @@ components:
description: Data for updating an org group.
properties:
attributes:
- $ref: "#/components/schemas/OrgGroupUpdateAttributes"
+ $ref: '#/components/schemas/OrgGroupUpdateAttributes'
id:
description: The ID of the org group.
example: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgGroupType"
+ $ref: '#/components/schemas/OrgGroupType'
required:
- id
- type
@@ -81390,7 +81451,7 @@ components:
description: Request to update an org group.
properties:
data:
- $ref: "#/components/schemas/OrgGroupUpdateData"
+ $ref: '#/components/schemas/OrgGroupUpdateData'
required:
- data
type: object
@@ -81403,7 +81464,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/OrgResourceType"
+ $ref: '#/components/schemas/OrgResourceType'
required:
- id
- type
@@ -81454,13 +81515,13 @@ components:
description: Data for updating an organization's SAML preferences.
properties:
attributes:
- $ref: "#/components/schemas/OrgSAMLPreferencesAttributes"
+ $ref: '#/components/schemas/OrgSAMLPreferencesAttributes'
id:
description: The identifier of the SAML preferences resource.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/OrgSAMLPreferencesType"
+ $ref: '#/components/schemas/OrgSAMLPreferencesType'
required:
- type
- attributes
@@ -81478,7 +81539,7 @@ components:
description: Request to update an organization's SAML preferences.
properties:
data:
- $ref: "#/components/schemas/OrgSAMLPreferencesData"
+ $ref: '#/components/schemas/OrgSAMLPreferencesData'
required:
- data
type: object
@@ -81486,12 +81547,12 @@ components:
description: Organization object.
properties:
attributes:
- $ref: "#/components/schemas/OrganizationAttributes"
+ $ref: '#/components/schemas/OrganizationAttributes'
id:
description: ID of the organization.
type: string
type:
- $ref: "#/components/schemas/OrganizationsType"
+ $ref: '#/components/schemas/OrganizationsType'
required:
- type
type: object
@@ -81566,22 +81627,22 @@ components:
results:
description: Set of scorecard outcomes to update.
items:
- $ref: "#/components/schemas/OutcomesBatchRequestItem"
+ $ref: '#/components/schemas/OutcomesBatchRequestItem'
type: array
type: object
OutcomesBatchRequest:
description: Scorecard outcomes batch request.
properties:
data:
- $ref: "#/components/schemas/OutcomesBatchRequestData"
+ $ref: '#/components/schemas/OutcomesBatchRequestData'
type: object
OutcomesBatchRequestData:
description: Scorecard outcomes batch request data.
properties:
attributes:
- $ref: "#/components/schemas/OutcomesBatchAttributes"
+ $ref: '#/components/schemas/OutcomesBatchAttributes'
type:
- $ref: "#/components/schemas/OutcomesBatchType"
+ $ref: '#/components/schemas/OutcomesBatchType'
type: object
OutcomesBatchRequestItem:
description: Scorecard outcome for a specific rule, for a given service within a batched update.
@@ -81592,13 +81653,13 @@ components:
example: 'See: Services'
type: string
rule_id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
service_name:
description: The unique name for a service in the catalog.
example: my-service
type: string
state:
- $ref: "#/components/schemas/State"
+ $ref: '#/components/schemas/State'
required:
- rule_id
- service_name
@@ -81616,7 +81677,7 @@ components:
id: "outcome-abc123"
type: rule-outcome
meta:
- $ref: "#/components/schemas/OutcomesBatchResponseMeta"
+ $ref: '#/components/schemas/OutcomesBatchResponseMeta'
required:
- data
- meta
@@ -81642,12 +81703,12 @@ components:
example: my-service
type: string
state:
- $ref: "#/components/schemas/State"
+ $ref: '#/components/schemas/State'
type: object
OutcomesBatchResponseData:
description: List of rule outcomes which were affected during the bulk operation.
items:
- $ref: "#/components/schemas/OutcomesResponseDataItem"
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
type: array
OutcomesBatchResponseMeta:
description: Metadata pertaining to the bulk operation.
@@ -81672,44 +81733,44 @@ components:
description: Scorecard outcomes - the result of a rule for a service.
properties:
data:
- $ref: "#/components/schemas/OutcomesResponseData"
+ $ref: '#/components/schemas/OutcomesResponseData'
included:
- $ref: "#/components/schemas/OutcomesResponseIncluded"
+ $ref: '#/components/schemas/OutcomesResponseIncluded'
links:
- $ref: "#/components/schemas/OutcomesResponseLinks"
+ $ref: '#/components/schemas/OutcomesResponseLinks'
type: object
OutcomesResponseData:
description: List of rule outcomes.
items:
- $ref: "#/components/schemas/OutcomesResponseDataItem"
+ $ref: '#/components/schemas/OutcomesResponseDataItem'
type: array
OutcomesResponseDataItem:
description: A single rule outcome.
properties:
attributes:
- $ref: "#/components/schemas/OutcomesBatchResponseAttributes"
+ $ref: '#/components/schemas/OutcomesBatchResponseAttributes'
id:
description: The unique ID for a rule outcome.
type: string
relationships:
- $ref: "#/components/schemas/RuleOutcomeRelationships"
+ $ref: '#/components/schemas/RuleOutcomeRelationships'
type:
- $ref: "#/components/schemas/OutcomeType"
+ $ref: '#/components/schemas/OutcomeType'
type: object
OutcomesResponseIncluded:
description: Array of rule details.
items:
- $ref: "#/components/schemas/OutcomesResponseIncludedItem"
+ $ref: '#/components/schemas/OutcomesResponseIncludedItem'
type: array
OutcomesResponseIncludedItem:
description: Attributes of the included rule.
properties:
attributes:
- $ref: "#/components/schemas/OutcomesResponseIncludedRuleAttributes"
+ $ref: '#/components/schemas/OutcomesResponseIncludedRuleAttributes'
id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
OutcomesResponseIncludedRuleAttributes:
description: Details of a rule.
@@ -81738,7 +81799,7 @@ components:
parameters:
description: The `OutputSchema` `parameters`.
items:
- $ref: "#/components/schemas/OutputSchemaParameters"
+ $ref: '#/components/schemas/OutputSchemaParameters'
type: array
type: object
OutputSchemaParameters:
@@ -81757,7 +81818,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/OutputSchemaParametersType"
+ $ref: '#/components/schemas/OutputSchemaParametersType'
value:
description: The `OutputSchemaParameters` `value`.
required:
@@ -81792,7 +81853,7 @@ components:
data:
description: Targeting rules (allocations) to replace existing ones with.
items:
- $ref: "#/components/schemas/AllocationDataRequest"
+ $ref: '#/components/schemas/AllocationDataRequest'
type: array
required:
- data
@@ -81813,7 +81874,7 @@ components:
description: The attributes of an ownership evidence response.
properties:
evidence_versions:
- $ref: "#/components/schemas/OwnershipEvidenceVersions"
+ $ref: '#/components/schemas/OwnershipEvidenceVersions'
required:
- evidence_versions
type: object
@@ -81821,13 +81882,13 @@ components:
description: The data wrapper for an ownership evidence response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipEvidenceAttributes"
+ $ref: '#/components/schemas/OwnershipEvidenceAttributes'
id:
description: The identifier of the resource the evidence applies to.
example: test-resource
type: string
type:
- $ref: "#/components/schemas/OwnershipEvidenceType"
+ $ref: '#/components/schemas/OwnershipEvidenceType'
required:
- id
- type
@@ -81837,7 +81898,7 @@ components:
description: The response returned when retrieving the evidence backing an ownership inference for an owner type.
properties:
data:
- $ref: "#/components/schemas/OwnershipEvidenceData"
+ $ref: '#/components/schemas/OwnershipEvidenceData'
required:
- data
type: object
@@ -81863,7 +81924,7 @@ components:
- pipeline_id: p1
version: v3
items:
- $ref: "#/components/schemas/OwnershipEvidenceVersion"
+ $ref: '#/components/schemas/OwnershipEvidenceVersion'
nullable: true
type: array
OwnershipFeedbackAction:
@@ -81884,7 +81945,7 @@ components:
description: The request body for submitting ownership feedback.
properties:
data:
- $ref: "#/components/schemas/OwnershipFeedbackRequestData"
+ $ref: '#/components/schemas/OwnershipFeedbackRequestData'
required:
- data
type: object
@@ -81892,7 +81953,7 @@ components:
description: The attributes of an ownership feedback request.
properties:
action:
- $ref: "#/components/schemas/OwnershipFeedbackAction"
+ $ref: '#/components/schemas/OwnershipFeedbackAction'
corrected_owner_handle:
description: The corrected owner handle. Required when `action` is `correct`.
example: team-b
@@ -81920,9 +81981,9 @@ components:
description: The data wrapper for an ownership feedback request.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipFeedbackRequestAttributes"
+ $ref: '#/components/schemas/OwnershipFeedbackRequestAttributes'
type:
- $ref: "#/components/schemas/OwnershipFeedbackType"
+ $ref: '#/components/schemas/OwnershipFeedbackType'
required:
- type
- attributes
@@ -81931,7 +81992,7 @@ components:
description: The response returned after applying ownership feedback to an inference.
properties:
data:
- $ref: "#/components/schemas/OwnershipFeedbackResultData"
+ $ref: '#/components/schemas/OwnershipFeedbackResultData'
required:
- data
type: object
@@ -81939,17 +82000,17 @@ components:
description: The attributes of an ownership feedback result.
properties:
action:
- $ref: "#/components/schemas/OwnershipFeedbackAction"
+ $ref: '#/components/schemas/OwnershipFeedbackAction'
checksum:
description: The checksum of the inference after the feedback was applied.
example: abc123
type: string
new_status:
- $ref: "#/components/schemas/OwnershipInferenceStatus"
+ $ref: '#/components/schemas/OwnershipInferenceStatus'
owner_type:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
previous_status:
- $ref: "#/components/schemas/OwnershipInferenceStatus"
+ $ref: '#/components/schemas/OwnershipInferenceStatus'
primary_contact_ref:
description: The primary contact reference for the inferred owner after the feedback was applied, formatted as `ref:handle/`.
example: ref:handle/team-a
@@ -81972,13 +82033,13 @@ components:
description: The data wrapper for an ownership feedback result response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipFeedbackResultAttributes"
+ $ref: '#/components/schemas/OwnershipFeedbackResultAttributes'
id:
description: The identifier of the resource that the feedback was applied to.
example: res-1
type: string
type:
- $ref: "#/components/schemas/OwnershipFeedbackResultType"
+ $ref: '#/components/schemas/OwnershipFeedbackResultType'
required:
- id
- type
@@ -82006,9 +82067,9 @@ components:
description: The attributes of an ownership history response.
properties:
items:
- $ref: "#/components/schemas/OwnershipHistoryItems"
+ $ref: '#/components/schemas/OwnershipHistoryItems'
pagination:
- $ref: "#/components/schemas/OwnershipHistoryPagination"
+ $ref: '#/components/schemas/OwnershipHistoryPagination'
required:
- items
- pagination
@@ -82017,13 +82078,13 @@ components:
description: The data wrapper for an ownership history response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipHistoryAttributes"
+ $ref: '#/components/schemas/OwnershipHistoryAttributes'
id:
description: The resource identifier for which history is returned.
example: res-1
type: string
type:
- $ref: "#/components/schemas/OwnershipHistoryType"
+ $ref: '#/components/schemas/OwnershipHistoryType'
required:
- id
- type
@@ -82046,7 +82107,7 @@ components:
format: date-time
type: string
evidence_versions:
- $ref: "#/components/schemas/OwnershipEvidenceVersions"
+ $ref: '#/components/schemas/OwnershipEvidenceVersions'
explanation:
description: A human-readable explanation of how the inference was produced.
example: ""
@@ -82068,7 +82129,7 @@ components:
format: int64
type: integer
owner_type:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
primary_contact_ref:
description: The primary contact reference for the inferred owner, formatted as `ref:handle/`.
example: ref:handle/team-a
@@ -82085,9 +82146,9 @@ components:
nullable: true
type: string
sources:
- $ref: "#/components/schemas/OwnershipInferenceSources"
+ $ref: '#/components/schemas/OwnershipInferenceSources'
status:
- $ref: "#/components/schemas/OwnershipInferenceStatus"
+ $ref: '#/components/schemas/OwnershipInferenceStatus'
required:
- id
- resource_id
@@ -82103,7 +82164,7 @@ components:
OwnershipHistoryItems:
description: The list of history entries returned for this page.
items:
- $ref: "#/components/schemas/OwnershipHistoryItem"
+ $ref: '#/components/schemas/OwnershipHistoryItem'
type: array
OwnershipHistoryPagination:
description: Cursor-based pagination metadata for the history response.
@@ -82124,7 +82185,7 @@ components:
description: The response returned when listing the inference history for a resource.
properties:
data:
- $ref: "#/components/schemas/OwnershipHistoryData"
+ $ref: '#/components/schemas/OwnershipHistoryData'
required:
- data
type: object
@@ -82154,22 +82215,22 @@ components:
format: date-time
type: string
evidence_versions:
- $ref: "#/components/schemas/OwnershipEvidenceVersions"
+ $ref: '#/components/schemas/OwnershipEvidenceVersions'
explanation:
description: A human-readable explanation of how the inference was produced.
example: High confidence match
type: string
owner_type:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
primary_contact_ref:
description: The primary contact reference for the inferred owner, formatted as `ref:handle/`.
example: ref:handle/team-a
nullable: true
type: string
sources:
- $ref: "#/components/schemas/OwnershipInferenceSources"
+ $ref: '#/components/schemas/OwnershipInferenceSources'
status:
- $ref: "#/components/schemas/OwnershipInferenceStatus"
+ $ref: '#/components/schemas/OwnershipInferenceStatus'
updated_at:
description: The time when the inference was last updated.
example: "2026-01-15T10:00:00Z"
@@ -82190,13 +82251,13 @@ components:
description: The data wrapper for a single ownership inference response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipInferenceAttributes"
+ $ref: '#/components/schemas/OwnershipInferenceAttributes'
id:
description: The identifier of the inference, formatted as `resource_id:owner_type`.
example: test-resource:team
type: string
type:
- $ref: "#/components/schemas/OwnershipInferenceType"
+ $ref: '#/components/schemas/OwnershipInferenceType'
required:
- id
- type
@@ -82219,7 +82280,7 @@ components:
format: date-time
type: string
evidence_versions:
- $ref: "#/components/schemas/OwnershipEvidenceVersions"
+ $ref: '#/components/schemas/OwnershipEvidenceVersions'
explanation:
description: A human-readable explanation of how the inference was produced.
example: High confidence match
@@ -82229,16 +82290,16 @@ components:
example: test-resource:team
type: string
owner_type:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
primary_contact_ref:
description: The primary contact reference for the inferred owner, formatted as `ref:handle/`.
example: ref:handle/team-a
nullable: true
type: string
sources:
- $ref: "#/components/schemas/OwnershipInferenceSources"
+ $ref: '#/components/schemas/OwnershipInferenceSources'
status:
- $ref: "#/components/schemas/OwnershipInferenceStatus"
+ $ref: '#/components/schemas/OwnershipInferenceStatus'
updated_at:
description: The time when the inference was last updated.
example: "2026-01-15T10:00:00Z"
@@ -82259,13 +82320,13 @@ components:
OwnershipInferenceItems:
description: The list of inferences for a resource, with one inference per owner type.
items:
- $ref: "#/components/schemas/OwnershipInferenceItem"
+ $ref: '#/components/schemas/OwnershipInferenceItem'
type: array
OwnershipInferenceListAttributes:
description: The attributes of the ownership inferences collection response.
properties:
items:
- $ref: "#/components/schemas/OwnershipInferenceItems"
+ $ref: '#/components/schemas/OwnershipInferenceItems'
required:
- items
type: object
@@ -82273,13 +82334,13 @@ components:
description: The data wrapper for the ownership inferences collection response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipInferenceListAttributes"
+ $ref: '#/components/schemas/OwnershipInferenceListAttributes'
id:
description: The resource identifier associated with the returned inferences.
example: test-resource
type: string
type:
- $ref: "#/components/schemas/OwnershipInferencesType"
+ $ref: '#/components/schemas/OwnershipInferencesType'
required:
- id
- type
@@ -82289,7 +82350,7 @@ components:
description: The response returned when listing all current ownership inferences for a resource.
properties:
data:
- $ref: "#/components/schemas/OwnershipInferenceListData"
+ $ref: '#/components/schemas/OwnershipInferenceListData'
required:
- data
type: object
@@ -82297,7 +82358,7 @@ components:
description: The response returned when retrieving a single ownership inference for an owner type.
properties:
data:
- $ref: "#/components/schemas/OwnershipInferenceData"
+ $ref: '#/components/schemas/OwnershipInferenceData'
required:
- data
type: object
@@ -82312,7 +82373,7 @@ components:
example:
- kind: code_owners
items:
- $ref: "#/components/schemas/OwnershipInferenceSource"
+ $ref: '#/components/schemas/OwnershipInferenceSource'
type: array
OwnershipInferenceStatus:
description: The lifecycle status of an ownership inference.
@@ -82370,7 +82431,7 @@ components:
example: true
type: boolean
confidence_level:
- $ref: "#/components/schemas/OwnershipConfidenceLevel"
+ $ref: '#/components/schemas/OwnershipConfidenceLevel'
version:
description: The current version of the ownership settings.
example: 1
@@ -82385,13 +82446,13 @@ components:
description: The data wrapper for an ownership settings response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipSettingsAttributes"
+ $ref: '#/components/schemas/OwnershipSettingsAttributes'
id:
description: The identifier of the ownership settings resource.
example: settings
type: string
type:
- $ref: "#/components/schemas/OwnershipSettingsType"
+ $ref: '#/components/schemas/OwnershipSettingsType'
required:
- id
- type
@@ -82401,7 +82462,7 @@ components:
description: The request body for updating ownership settings.
properties:
data:
- $ref: "#/components/schemas/OwnershipSettingsRequestData"
+ $ref: '#/components/schemas/OwnershipSettingsRequestData'
required:
- data
type: object
@@ -82413,7 +82474,7 @@ components:
example: true
type: boolean
confidence_level:
- $ref: "#/components/schemas/OwnershipConfidenceLevel"
+ $ref: '#/components/schemas/OwnershipConfidenceLevel'
required:
- auto_tag
- confidence_level
@@ -82422,9 +82483,9 @@ components:
description: The data wrapper for an ownership settings request.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipSettingsRequestAttributes"
+ $ref: '#/components/schemas/OwnershipSettingsRequestAttributes'
type:
- $ref: "#/components/schemas/OwnershipSettingsType"
+ $ref: '#/components/schemas/OwnershipSettingsType'
required:
- type
- attributes
@@ -82433,7 +82494,7 @@ components:
description: The response returned when retrieving or updating ownership settings.
properties:
data:
- $ref: "#/components/schemas/OwnershipSettingsData"
+ $ref: '#/components/schemas/OwnershipSettingsData'
required:
- data
type: object
@@ -82479,13 +82540,13 @@ components:
description: The data wrapper for an ownership untagged findings response.
properties:
attributes:
- $ref: "#/components/schemas/OwnershipUntaggedFindingsAttributes"
+ $ref: '#/components/schemas/OwnershipUntaggedFindingsAttributes'
id:
description: The identifier of the ownership untagged findings resource.
example: untagged
type: string
type:
- $ref: "#/components/schemas/OwnershipUntaggedFindingsType"
+ $ref: '#/components/schemas/OwnershipUntaggedFindingsType'
required:
- id
- type
@@ -82495,7 +82556,7 @@ components:
description: The response returned when counting findings without a team tag by ownership confidence.
properties:
data:
- $ref: "#/components/schemas/OwnershipUntaggedFindingsData"
+ $ref: '#/components/schemas/OwnershipUntaggedFindingsData'
required:
- data
type: object
@@ -82549,7 +82610,7 @@ components:
pattern: "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$"
type: string
type:
- $ref: "#/components/schemas/PESymbolFileFormDataType"
+ $ref: '#/components/schemas/PESymbolFileFormDataType'
required:
- type
- pdb_sig
@@ -82560,7 +82621,7 @@ components:
description: Multipart form data for uploading PE/PDB symbol files for Windows crash symbolication.
properties:
event:
- $ref: "#/components/schemas/PESymbolFileEvent"
+ $ref: '#/components/schemas/PESymbolFileEvent'
pe_symbol_file:
description: The PDB symbol file.
example: myapp.pdb
@@ -82582,11 +82643,11 @@ components:
description: Attributes of the annotations on a page.
properties:
annotations:
- $ref: "#/components/schemas/AnnotationsInPageMap"
+ $ref: '#/components/schemas/AnnotationsInPageMap'
global_annotations:
- $ref: "#/components/schemas/GlobalAnnotationIds"
+ $ref: '#/components/schemas/GlobalAnnotationIds'
widget_mapping:
- $ref: "#/components/schemas/WidgetAnnotationsMap"
+ $ref: '#/components/schemas/WidgetAnnotationsMap'
required:
- annotations
- widget_mapping
@@ -82596,7 +82657,7 @@ components:
description: Annotations grouped by widget for a single page.
properties:
attributes:
- $ref: "#/components/schemas/PageAnnotationsAttributes"
+ $ref: '#/components/schemas/PageAnnotationsAttributes'
id:
description: |-
ID of the page, prefixed with the page type and joined by a colon
@@ -82604,7 +82665,7 @@ components:
example: "dashboard:abc-def-xyz"
type: string
type:
- $ref: "#/components/schemas/PageAnnotationsType"
+ $ref: '#/components/schemas/PageAnnotationsType'
required:
- id
- type
@@ -82614,7 +82675,7 @@ components:
description: Response containing all annotations on a page, grouped by widget.
properties:
data:
- $ref: "#/components/schemas/PageAnnotationsData"
+ $ref: '#/components/schemas/PageAnnotationsData'
required:
- data
type: object
@@ -82682,7 +82743,7 @@ components:
description: Response metadata.
properties:
page:
- $ref: "#/components/schemas/PaginationMetaPage"
+ $ref: '#/components/schemas/PaginationMetaPage'
readOnly: true
type: object
PaginationMetaPage:
@@ -82738,7 +82799,7 @@ components:
nullable: true
type: integer
type:
- $ref: "#/components/schemas/PaginationMetaPageType"
+ $ref: '#/components/schemas/PaginationMetaPageType'
type: object
PaginationMetaPageType:
default: offset_limit
@@ -82767,14 +82828,14 @@ components:
description: Partial Datadog API key.
properties:
attributes:
- $ref: "#/components/schemas/PartialAPIKeyAttributes"
+ $ref: '#/components/schemas/PartialAPIKeyAttributes'
id:
description: ID of the API key.
type: string
relationships:
- $ref: "#/components/schemas/APIKeyRelationships"
+ $ref: '#/components/schemas/APIKeyRelationships'
type:
- $ref: "#/components/schemas/APIKeysType"
+ $ref: '#/components/schemas/APIKeysType'
type: object
PartialAPIKeyAttributes:
description: Attributes of a partial API key.
@@ -82818,14 +82879,14 @@ components:
description: Partial Datadog application key.
properties:
attributes:
- $ref: "#/components/schemas/PartialApplicationKeyAttributes"
+ $ref: '#/components/schemas/PartialApplicationKeyAttributes'
id:
description: ID of the application key.
type: string
relationships:
- $ref: "#/components/schemas/ApplicationKeyRelationships"
+ $ref: '#/components/schemas/ApplicationKeyRelationships'
type:
- $ref: "#/components/schemas/ApplicationKeysType"
+ $ref: '#/components/schemas/ApplicationKeysType'
type: object
PartialApplicationKeyAttributes:
description: Attributes of a partial application key.
@@ -82865,30 +82926,30 @@ components:
description: Response for retrieving a partial application key.
properties:
data:
- $ref: "#/components/schemas/PartialApplicationKey"
+ $ref: '#/components/schemas/PartialApplicationKey'
included:
description: Array of objects related to the application key.
items:
- $ref: "#/components/schemas/ApplicationKeyResponseIncludedItem"
+ $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
type: array
type: object
PatchAttachmentRequest:
description: Request to update an attachment.
properties:
data:
- $ref: "#/components/schemas/PatchAttachmentRequestData"
+ $ref: '#/components/schemas/PatchAttachmentRequestData'
type: object
PatchAttachmentRequestData:
description: Attachment data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/PatchAttachmentRequestDataAttributes"
+ $ref: '#/components/schemas/PatchAttachmentRequestDataAttributes'
id:
description: The unique identifier of the attachment.
example: "00000000-abcd-0002-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentAttachmentType"
+ $ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
type: object
@@ -82896,7 +82957,7 @@ components:
description: The attributes for updating an attachment.
properties:
attachment:
- $ref: "#/components/schemas/PatchAttachmentRequestDataAttributesAttachment"
+ $ref: '#/components/schemas/PatchAttachmentRequestDataAttributesAttachment'
type: object
PatchAttachmentRequestDataAttributesAttachment:
description: The updated attachment object.
@@ -82921,20 +82982,20 @@ components:
type: components
properties:
data:
- $ref: "#/components/schemas/PatchComponentRequestData"
+ $ref: '#/components/schemas/PatchComponentRequestData'
type: object
PatchComponentRequestData:
description: The data object for updating a component.
properties:
attributes:
- $ref: "#/components/schemas/PatchComponentRequestDataAttributes"
+ $ref: '#/components/schemas/PatchComponentRequestDataAttributes'
id:
description: The ID of the component.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- attributes
- id
@@ -82967,7 +83028,7 @@ components:
type: degradations
properties:
data:
- $ref: "#/components/schemas/PatchDegradationRequestData"
+ $ref: '#/components/schemas/PatchDegradationRequestData'
meta:
$ref: "#/components/schemas/DegradationRequestMeta"
description: The supported metadata for updating a degradation.
@@ -82976,16 +83037,16 @@ components:
description: The data object for updating a degradation.
properties:
attributes:
- $ref: "#/components/schemas/PatchDegradationRequestDataAttributes"
+ $ref: '#/components/schemas/PatchDegradationRequestDataAttributes'
id:
description: The ID of the degradation.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/PatchDegradationRequestDataRelationships"
+ $ref: '#/components/schemas/PatchDegradationRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchDegradationRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationRequestDataType'
required:
- attributes
- id
@@ -83000,7 +83061,7 @@ components:
- id: 1234abcd-12ab-34cd-56ef-123456abcdef
status: operational
items:
- $ref: "#/components/schemas/PatchDegradationRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/PatchDegradationRequestDataAttributesComponentsAffectedItems'
type: array
description:
description: The description of the degradation.
@@ -83027,7 +83088,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
required:
- id
- status
@@ -83056,7 +83117,7 @@ components:
description: The template used to create the degradation.
properties:
data:
- $ref: "#/components/schemas/PatchDegradationRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/PatchDegradationRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -83068,7 +83129,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
- id
@@ -83086,19 +83147,19 @@ components:
description: Request object for updating a degradation template.
properties:
data:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestData"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestData'
type: object
PatchDegradationTemplateRequestData:
description: The data object for updating a degradation template.
properties:
attributes:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributes"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributes'
id:
description: The ID of the degradation template.
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataType'
required:
- type
- id
@@ -83109,7 +83170,7 @@ components:
components_affected:
description: The components affected by a degradation created from this template.
items:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItems'
type: array
degradation_title:
description: The title used for a degradation created from this template.
@@ -83120,7 +83181,7 @@ components:
updates:
description: The pre-filled updates for a degradation created from this template.
items:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesUpdatesItems"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributesUpdatesItems'
type: array
type: object
PatchDegradationTemplateRequestDataAttributesComponentsAffectedItems:
@@ -83135,7 +83196,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -83161,7 +83222,7 @@ components:
description: The message of the update.
type: string
status:
- $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus"
+ $ref: '#/components/schemas/CreateDegradationRequestDataAttributesStatus'
required:
- status
type: object
@@ -83185,18 +83246,18 @@ components:
type: degradation_updates
properties:
data:
- $ref: "#/components/schemas/PatchDegradationUpdateRequestData"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequestData'
type: object
PatchDegradationUpdateRequestData:
description: The data object for editing a degradation update.
properties:
attributes:
- $ref: "#/components/schemas/PatchDegradationUpdateRequestDataAttributes"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequestDataAttributes'
id:
description: The ID of the degradation update to edit.
type: string
type:
- $ref: "#/components/schemas/PatchDegradationUpdateRequestDataType"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequestDataType'
required:
- type
type: object
@@ -83207,7 +83268,7 @@ components:
description: The message body of the update.
type: string
status:
- $ref: "#/components/schemas/PatchDegradationUpdateRequestDataAttributesStatus"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequestDataAttributesStatus'
type: object
PatchDegradationUpdateRequestDataAttributesStatus:
description: The status of the degradation update.
@@ -83233,7 +83294,7 @@ components:
description: Update request for a notification template.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationTemplateUpdateData"
+ $ref: '#/components/schemas/IncidentNotificationTemplateUpdateData'
required:
- data
type: object
@@ -83251,22 +83312,22 @@ components:
type: maintenances
properties:
data:
- $ref: "#/components/schemas/PatchMaintenanceRequestData"
+ $ref: '#/components/schemas/PatchMaintenanceRequestData'
type: object
PatchMaintenanceRequestData:
description: The data object for updating a maintenance.
properties:
attributes:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributes"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributes'
id:
description: The ID of the maintenance.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataRelationships"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataRelationships'
type:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataType'
required:
- attributes
- type
@@ -83288,7 +83349,7 @@ components:
components_affected:
description: The components affected by the maintenance.
items:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItems"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItems'
type: array
in_progress_description:
description: The description shown while the maintenance is in progress.
@@ -83320,7 +83381,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus'
required:
- id
- status
@@ -83346,7 +83407,7 @@ components:
description: The template used to create the maintenance.
properties:
data:
- $ref: "#/components/schemas/PatchMaintenanceRequestDataRelationshipsTemplateData"
+ $ref: '#/components/schemas/PatchMaintenanceRequestDataRelationshipsTemplateData'
required:
- data
type: object
@@ -83358,7 +83419,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
- id
@@ -83376,19 +83437,19 @@ components:
description: Request object for updating a maintenance template.
properties:
data:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestData"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestData'
type: object
PatchMaintenanceTemplateRequestData:
description: The data object for updating a maintenance template.
properties:
attributes:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataAttributes"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataAttributes'
id:
description: The ID of the maintenance template.
example: ""
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequestDataType'
required:
- type
- id
@@ -83436,19 +83497,19 @@ components:
type: maintenance_updates
properties:
data:
- $ref: "#/components/schemas/PatchMaintenanceUpdateRequestData"
+ $ref: '#/components/schemas/PatchMaintenanceUpdateRequestData'
type: object
PatchMaintenanceUpdateRequestData:
description: The data object for editing a maintenance update.
properties:
attributes:
- $ref: "#/components/schemas/PatchMaintenanceUpdateRequestDataAttributes"
+ $ref: '#/components/schemas/PatchMaintenanceUpdateRequestDataAttributes'
id:
description: The ID of the maintenance update to edit. Must match the `update_id` path parameter.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
type: string
type:
- $ref: "#/components/schemas/PatchMaintenanceUpdateRequestDataType"
+ $ref: '#/components/schemas/PatchMaintenanceUpdateRequestDataType'
required:
- id
- type
@@ -83474,18 +83535,18 @@ components:
description: Body of the notification rule patch request.
properties:
data:
- $ref: "#/components/schemas/PatchNotificationRuleParametersData"
+ $ref: '#/components/schemas/PatchNotificationRuleParametersData'
type: object
PatchNotificationRuleParametersData:
description: |-
Data of the notification rule patch request: the rule ID, the rule type, and the rule attributes. All fields are required.
properties:
attributes:
- $ref: "#/components/schemas/PatchNotificationRuleParametersDataAttributes"
+ $ref: '#/components/schemas/PatchNotificationRuleParametersDataAttributes'
id:
- $ref: "#/components/schemas/ID"
+ $ref: '#/components/schemas/ID'
type:
- $ref: "#/components/schemas/NotificationRulesType"
+ $ref: '#/components/schemas/NotificationRulesType'
required:
- attributes
- id
@@ -83496,19 +83557,19 @@ components:
Attributes of the notification rule patch request. It is required to update the version of the rule when patching it.
properties:
enabled:
- $ref: "#/components/schemas/Enabled"
+ $ref: '#/components/schemas/Enabled'
name:
- $ref: "#/components/schemas/RuleName"
+ $ref: '#/components/schemas/RuleName'
routing:
- $ref: "#/components/schemas/NotificationRuleRouting"
+ $ref: '#/components/schemas/NotificationRuleRouting'
selectors:
- $ref: "#/components/schemas/Selectors"
+ $ref: '#/components/schemas/Selectors'
targets:
- $ref: "#/components/schemas/Targets"
+ $ref: '#/components/schemas/Targets'
time_aggregation:
- $ref: "#/components/schemas/TimeAggregation"
+ $ref: '#/components/schemas/TimeAggregation'
version:
- $ref: "#/components/schemas/Version"
+ $ref: '#/components/schemas/Version'
type: object
PatchStatusPageRequest:
description: Request object for updating a status page.
@@ -83527,20 +83588,20 @@ components:
type: status_pages
properties:
data:
- $ref: "#/components/schemas/PatchStatusPageRequestData"
+ $ref: '#/components/schemas/PatchStatusPageRequestData'
type: object
PatchStatusPageRequestData:
description: The data object for updating a status page.
properties:
attributes:
- $ref: "#/components/schemas/PatchStatusPageRequestDataAttributes"
+ $ref: '#/components/schemas/PatchStatusPageRequestDataAttributes'
id:
description: The ID of the status page.
example: "1234abcd-12ab-34cd-56ef-123456abcdef"
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- attributes
- id
@@ -83612,16 +83673,16 @@ components:
type: reference_table
properties:
data:
- $ref: "#/components/schemas/PatchTableRequestData"
+ $ref: '#/components/schemas/PatchTableRequestData'
type: object
PatchTableRequestData:
additionalProperties: false
description: The data object containing the partial table definition updates.
properties:
attributes:
- $ref: "#/components/schemas/PatchTableRequestDataAttributes"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributes'
type:
- $ref: "#/components/schemas/PatchTableRequestDataType"
+ $ref: '#/components/schemas/PatchTableRequestDataType'
required:
- type
type: object
@@ -83633,9 +83694,9 @@ components:
example: "example description"
type: string
file_metadata:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadata"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadata'
schema:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesSchema"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesSchema'
tags:
description: Tags for organizing and filtering reference tables.
example:
@@ -83649,14 +83710,14 @@ components:
PatchTableRequestDataAttributesFileMetadata:
description: Metadata specifying where and how to access the reference table's data file.
oneOf:
- - $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage"
- - $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile"
+ - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataCloudStorage'
+ - $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataLocalFile'
PatchTableRequestDataAttributesFileMetadataCloudStorage:
additionalProperties: false
description: Cloud storage file metadata for patch requests. Allows partial updates of access_details and sync_enabled.
properties:
access_details:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetails'
sync_enabled:
description: Whether this table is synced automatically.
example: false
@@ -83679,11 +83740,11 @@ components:
description: Cloud storage access configuration for the reference table data file.
properties:
aws_detail:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail'
azure_detail:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAzureDetail'
gcp_detail:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsGcpDetail'
type: object
PatchTableRequestDataAttributesFileMetadataOneOfAccessDetailsAwsDetail:
description: Amazon Web Services S3 storage access configuration.
@@ -83757,7 +83818,7 @@ components:
fields:
description: The schema fields. Maximum of 200 columns.
items:
- $ref: "#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems"
+ $ref: '#/components/schemas/PatchTableRequestDataAttributesSchemaFieldsItems'
maxItems: 200
minItems: 1
type: array
@@ -83781,7 +83842,7 @@ components:
example: "field_1"
type: string
type:
- $ref: "#/components/schemas/ReferenceTableSchemaFieldType"
+ $ref: '#/components/schemas/ReferenceTableSchemaFieldType'
required:
- name
- type
@@ -83799,12 +83860,12 @@ components:
description: Permission object.
properties:
attributes:
- $ref: "#/components/schemas/PermissionAttributes"
+ $ref: '#/components/schemas/PermissionAttributes'
id:
description: ID of the permission.
type: string
type:
- $ref: "#/components/schemas/PermissionsType"
+ $ref: '#/components/schemas/PermissionsType'
required:
- type
type: object
@@ -83846,7 +83907,7 @@ components:
data:
description: Array of permissions.
items:
- $ref: "#/components/schemas/Permission"
+ $ref: '#/components/schemas/Permission'
type: array
type: object
PermissionsType:
@@ -83862,14 +83923,14 @@ components:
description: Datadog access token.
properties:
attributes:
- $ref: "#/components/schemas/PersonalAccessTokenAttributes"
+ $ref: '#/components/schemas/PersonalAccessTokenAttributes'
id:
description: ID of the access token.
type: string
relationships:
- $ref: "#/components/schemas/PersonalAccessTokenRelationships"
+ $ref: '#/components/schemas/PersonalAccessTokenRelationships'
type:
- $ref: "#/components/schemas/PersonalAccessTokensType"
+ $ref: '#/components/schemas/PersonalAccessTokensType'
type: object
PersonalAccessTokenAttributes:
description: Attributes of an access token.
@@ -83950,9 +84011,9 @@ components:
description: Object used to create an access token.
properties:
attributes:
- $ref: "#/components/schemas/PersonalAccessTokenCreateAttributes"
+ $ref: '#/components/schemas/PersonalAccessTokenCreateAttributes'
type:
- $ref: "#/components/schemas/PersonalAccessTokensType"
+ $ref: '#/components/schemas/PersonalAccessTokensType'
required:
- attributes
- type
@@ -83961,7 +84022,7 @@ components:
description: Request used to create an access token.
properties:
data:
- $ref: "#/components/schemas/PersonalAccessTokenCreateData"
+ $ref: '#/components/schemas/PersonalAccessTokenCreateData'
required:
- data
type: object
@@ -83969,25 +84030,25 @@ components:
description: Response for creating an access token. Includes the token key.
properties:
data:
- $ref: "#/components/schemas/FullPersonalAccessToken"
+ $ref: '#/components/schemas/FullPersonalAccessToken'
type: object
PersonalAccessTokenRelationships:
description: Resources related to the access token.
properties:
owned_by:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
PersonalAccessTokenResponse:
description: Response for retrieving an access token.
properties:
data:
- $ref: "#/components/schemas/PersonalAccessToken"
+ $ref: '#/components/schemas/PersonalAccessToken'
type: object
PersonalAccessTokenResponseMeta:
description: Additional information related to the access token response.
properties:
page:
- $ref: "#/components/schemas/PersonalAccessTokenResponseMetaPage"
+ $ref: '#/components/schemas/PersonalAccessTokenResponseMetaPage'
type: object
PersonalAccessTokenResponseMetaPage:
description: Pagination information.
@@ -84018,13 +84079,13 @@ components:
description: Object used to update an access token.
properties:
attributes:
- $ref: "#/components/schemas/PersonalAccessTokenUpdateAttributes"
+ $ref: '#/components/schemas/PersonalAccessTokenUpdateAttributes'
id:
description: ID of the access token.
example: "00112233-4455-6677-8899-aabbccddeeff"
type: string
type:
- $ref: "#/components/schemas/PersonalAccessTokensType"
+ $ref: '#/components/schemas/PersonalAccessTokensType'
required:
- attributes
- id
@@ -84034,7 +84095,7 @@ components:
description: Request used to update an access token.
properties:
data:
- $ref: "#/components/schemas/PersonalAccessTokenUpdateData"
+ $ref: '#/components/schemas/PersonalAccessTokenUpdateData'
required:
- data
type: object
@@ -84073,7 +84134,7 @@ components:
description: A single RUM replay playlist resource returned by create, update, or get operations.
properties:
data:
- $ref: "#/components/schemas/PlaylistData"
+ $ref: '#/components/schemas/PlaylistData'
required:
- data
type: object
@@ -84083,7 +84144,7 @@ components:
data:
description: Array of playlist data objects.
items:
- $ref: "#/components/schemas/PlaylistData"
+ $ref: '#/components/schemas/PlaylistData'
type: array
required:
- data
@@ -84092,12 +84153,12 @@ components:
description: Data object representing a RUM replay playlist, including its identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/PlaylistDataAttributes"
+ $ref: '#/components/schemas/PlaylistDataAttributes'
id:
description: Unique identifier of the playlist.
type: string
type:
- $ref: "#/components/schemas/PlaylistDataType"
+ $ref: '#/components/schemas/PlaylistDataType'
required:
- type
type: object
@@ -84109,7 +84170,7 @@ components:
format: date-time
type: string
created_by:
- $ref: "#/components/schemas/PlaylistDataAttributesCreatedBy"
+ $ref: '#/components/schemas/PlaylistDataAttributesCreatedBy'
description:
description: Optional human-readable description of the playlist's purpose or contents.
type: string
@@ -84167,7 +84228,7 @@ components:
description: A single RUM replay session resource as it appears within a playlist context.
properties:
data:
- $ref: "#/components/schemas/PlaylistsSessionData"
+ $ref: '#/components/schemas/PlaylistsSessionData'
required:
- data
type: object
@@ -84177,7 +84238,7 @@ components:
data:
description: Array of playlist session data objects.
items:
- $ref: "#/components/schemas/PlaylistsSessionData"
+ $ref: '#/components/schemas/PlaylistsSessionData'
type: array
required:
- data
@@ -84186,12 +84247,12 @@ components:
description: Data object representing a session within a playlist, including its identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/PlaylistsSessionDataAttributes"
+ $ref: '#/components/schemas/PlaylistsSessionDataAttributes'
id:
description: Unique identifier of the RUM replay session.
type: string
type:
- $ref: "#/components/schemas/ViewershipHistorySessionDataType"
+ $ref: '#/components/schemas/ViewershipHistorySessionDataType'
required:
- type
type: object
@@ -84210,7 +84271,7 @@ components:
description: Request body for creating a postmortem attachment.
properties:
data:
- $ref: "#/components/schemas/PostmortemAttachmentRequestData"
+ $ref: '#/components/schemas/PostmortemAttachmentRequestData'
required:
- data
type: object
@@ -84220,7 +84281,7 @@ components:
cells:
description: The cells of the postmortem
items:
- $ref: "#/components/schemas/PostmortemCell"
+ $ref: '#/components/schemas/PostmortemCell'
type: array
content:
description: The content of the postmortem
@@ -84241,9 +84302,9 @@ components:
description: Postmortem attachment data
properties:
attributes:
- $ref: "#/components/schemas/PostmortemAttachmentRequestAttributes"
+ $ref: '#/components/schemas/PostmortemAttachmentRequestAttributes'
type:
- $ref: "#/components/schemas/IncidentAttachmentType"
+ $ref: '#/components/schemas/IncidentAttachmentType'
required:
- type
- attributes
@@ -84252,19 +84313,19 @@ components:
description: A cell in the postmortem
properties:
attributes:
- $ref: "#/components/schemas/PostmortemCellAttributes"
+ $ref: '#/components/schemas/PostmortemCellAttributes'
id:
description: The unique identifier of the cell
example: "cell-1"
type: string
type:
- $ref: "#/components/schemas/PostmortemCellType"
+ $ref: '#/components/schemas/PostmortemCellType'
type: object
PostmortemCellAttributes:
description: Attributes of a postmortem cell
properties:
definition:
- $ref: "#/components/schemas/PostmortemCellDefinition"
+ $ref: '#/components/schemas/PostmortemCellDefinition'
type: object
PostmortemCellDefinition:
description: Definition of a postmortem cell
@@ -84288,13 +84349,13 @@ components:
description: Attributes for creating or updating a postmortem template.
properties:
confluence_postmortem_settings:
- $ref: "#/components/schemas/ConfluencePostmortemSettings"
+ $ref: '#/components/schemas/ConfluencePostmortemSettings'
content:
description: The templated content of the postmortem, supporting Markdown and incident template variables.
example: "# Overview\n\n# What Happened\n\n# Timeline\n\n# Action Items"
type: string
google_docs_postmortem_settings:
- $ref: "#/components/schemas/GoogleDocsPostmortemSettings"
+ $ref: '#/components/schemas/GoogleDocsPostmortemSettings'
is_default:
description: When set, marks this template as a default. The effective default for an incident type is the template with the most recent `is_default` timestamp. Set to `null` to unset.
example: "2024-01-01T00:00:00+00:00"
@@ -84302,7 +84363,7 @@ components:
nullable: true
type: string
location:
- $ref: "#/components/schemas/PostmortemTemplateLocation"
+ $ref: '#/components/schemas/PostmortemTemplateLocation'
name:
description: The name of the template.
example: "Standard Postmortem Template"
@@ -84314,7 +84375,7 @@ components:
description: Attributes of a postmortem template returned in a response.
properties:
confluence_postmortem_settings:
- $ref: "#/components/schemas/ConfluencePostmortemSettings"
+ $ref: '#/components/schemas/ConfluencePostmortemSettings'
content:
description: The templated content of the postmortem, supporting Markdown and incident template variables.
example: "# Overview\n\n# What Happened\n\n# Timeline\n\n# Action Items"
@@ -84325,7 +84386,7 @@ components:
format: date-time
type: string
google_docs_postmortem_settings:
- $ref: "#/components/schemas/GoogleDocsPostmortemSettings"
+ $ref: '#/components/schemas/GoogleDocsPostmortemSettings'
is_default:
description: When set, marks this template as a default. The effective default for an incident type is the template with the most recent `is_default` timestamp.
example: "2024-01-01T00:00:00+00:00"
@@ -84333,7 +84394,7 @@ components:
nullable: true
type: string
location:
- $ref: "#/components/schemas/PostmortemTemplateLocation"
+ $ref: '#/components/schemas/PostmortemTemplateLocation'
modifiedAt:
description: When the template was last modified.
example: "2026-01-13T17:15:53.208340Z"
@@ -84355,21 +84416,21 @@ components:
description: Relationships for a postmortem template. `incident_type` is required when creating a template and is immutable afterwards.
properties:
incident_type:
- $ref: "#/components/schemas/PostmortemTemplateIncidentTypeRelationship"
+ $ref: '#/components/schemas/PostmortemTemplateIncidentTypeRelationship'
type: object
PostmortemTemplateDataRequest:
description: Data object for creating or updating a postmortem template.
properties:
attributes:
- $ref: "#/components/schemas/PostmortemTemplateAttributesRequest"
+ $ref: '#/components/schemas/PostmortemTemplateAttributesRequest'
id:
description: The ID of the template. Required when updating.
example: 00000000-0000-0000-0000-000000000000
type: string
relationships:
- $ref: "#/components/schemas/PostmortemTemplateCreateRelationships"
+ $ref: '#/components/schemas/PostmortemTemplateCreateRelationships'
type:
- $ref: "#/components/schemas/PostmortemTemplateType"
+ $ref: '#/components/schemas/PostmortemTemplateType'
required:
- type
- attributes
@@ -84378,15 +84439,15 @@ components:
description: Data object for a postmortem template returned in a response.
properties:
attributes:
- $ref: "#/components/schemas/PostmortemTemplateAttributesResponse"
+ $ref: '#/components/schemas/PostmortemTemplateAttributesResponse'
id:
description: The ID of the template.
example: 00000000-0000-0000-0000-000000000000
type: string
relationships:
- $ref: "#/components/schemas/PostmortemTemplateResponseRelationships"
+ $ref: '#/components/schemas/PostmortemTemplateResponseRelationships'
type:
- $ref: "#/components/schemas/PostmortemTemplateType"
+ $ref: '#/components/schemas/PostmortemTemplateType'
required:
- id
- type
@@ -84396,7 +84457,7 @@ components:
description: Relationship to the incident type this template belongs to.
properties:
data:
- $ref: "#/components/schemas/PostmortemTemplateIncidentTypeRelationshipData"
+ $ref: '#/components/schemas/PostmortemTemplateIncidentTypeRelationshipData'
required:
- data
type: object
@@ -84433,7 +84494,7 @@ components:
description: Request body for creating or updating a postmortem template.
properties:
data:
- $ref: "#/components/schemas/PostmortemTemplateDataRequest"
+ $ref: '#/components/schemas/PostmortemTemplateDataRequest'
required:
- data
type: object
@@ -84441,7 +84502,7 @@ components:
description: Response containing a single postmortem template.
properties:
data:
- $ref: "#/components/schemas/PostmortemTemplateDataResponse"
+ $ref: '#/components/schemas/PostmortemTemplateDataResponse'
required:
- data
type: object
@@ -84449,9 +84510,9 @@ components:
description: Relationships of a postmortem template returned in a response.
properties:
incident_type:
- $ref: "#/components/schemas/PostmortemTemplateIncidentTypeRelationship"
+ $ref: '#/components/schemas/PostmortemTemplateIncidentTypeRelationship'
last_modified_by_user:
- $ref: "#/components/schemas/PostmortemTemplateUserRelationship"
+ $ref: '#/components/schemas/PostmortemTemplateUserRelationship'
type: object
PostmortemTemplateType:
description: Postmortem template resource type.
@@ -84467,7 +84528,7 @@ components:
description: Relationship to a user.
properties:
data:
- $ref: "#/components/schemas/PostmortemTemplateUserRelationshipData"
+ $ref: '#/components/schemas/PostmortemTemplateUserRelationshipData'
required:
- data
type: object
@@ -84493,7 +84554,7 @@ components:
data:
description: An array of postmortem template data objects.
items:
- $ref: "#/components/schemas/PostmortemTemplateDataResponse"
+ $ref: '#/components/schemas/PostmortemTemplateDataResponse'
type: array
required:
- data
@@ -84503,7 +84564,7 @@ components:
Powerpacks are templated groups of dashboard widgets you can save from an existing dashboard and turn into reusable packs in the widget tray.
properties:
data:
- $ref: "#/components/schemas/PowerpackData"
+ $ref: '#/components/schemas/PowerpackData'
type: object
PowerpackAttributes:
description: Powerpack attribute object.
@@ -84513,7 +84574,7 @@ components:
example: "Powerpack for ABC"
type: string
group_widget:
- $ref: "#/components/schemas/PowerpackGroupWidget"
+ $ref: '#/components/schemas/PowerpackGroupWidget'
name:
description: Name of the powerpack.
example: "Sample Powerpack"
@@ -84531,7 +84592,7 @@ components:
description: List of template variables for this powerpack.
example: [{"defaults": ["*"], "name": "test"}]
items:
- $ref: "#/components/schemas/PowerpackTemplateVariable"
+ $ref: '#/components/schemas/PowerpackTemplateVariable'
type: array
required:
- group_widget
@@ -84541,12 +84602,12 @@ components:
description: Powerpack data object.
properties:
attributes:
- $ref: "#/components/schemas/PowerpackAttributes"
+ $ref: '#/components/schemas/PowerpackAttributes'
id:
description: ID of the powerpack.
type: string
relationships:
- $ref: "#/components/schemas/PowerpackRelationships"
+ $ref: '#/components/schemas/PowerpackRelationships'
type:
description: Type of widget, must be powerpack.
example: "powerpack"
@@ -84556,11 +84617,11 @@ components:
description: Powerpack group widget definition object.
properties:
definition:
- $ref: "#/components/schemas/PowerpackGroupWidgetDefinition"
+ $ref: '#/components/schemas/PowerpackGroupWidgetDefinition'
layout:
- $ref: "#/components/schemas/PowerpackGroupWidgetLayout"
+ $ref: '#/components/schemas/PowerpackGroupWidgetLayout'
live_span:
- $ref: "#/components/schemas/WidgetLiveSpan"
+ $ref: '#/components/schemas/WidgetLiveSpan'
required:
- definition
type: object
@@ -84587,7 +84648,7 @@ components:
description: Widgets inside the powerpack.
example: [{"definition": {"content": "example", "type": "note"}, "layout": {"height": 5, "width": 10, "x": 0, "y": 0}}]
items:
- $ref: "#/components/schemas/PowerpackInnerWidgets"
+ $ref: '#/components/schemas/PowerpackInnerWidgets'
type: array
required:
- widgets
@@ -84669,7 +84730,7 @@ components:
example: {"definition": {"content": "example", "type": "note"}}
type: object
layout:
- $ref: "#/components/schemas/PowerpackInnerWidgetLayout"
+ $ref: '#/components/schemas/PowerpackInnerWidgetLayout'
required:
- definition
type: object
@@ -84677,17 +84738,17 @@ components:
description: Powerpack relationship object.
properties:
author:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
type: object
PowerpackResponse:
description: Response object which includes a single powerpack configuration.
properties:
data:
- $ref: "#/components/schemas/PowerpackData"
+ $ref: '#/components/schemas/PowerpackData'
included:
description: Array of objects related to the users.
items:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
readOnly: true
type: object
@@ -84749,7 +84810,7 @@ components:
description: Powerpack response metadata.
properties:
pagination:
- $ref: "#/components/schemas/PowerpacksResponseMetaPagination"
+ $ref: '#/components/schemas/PowerpacksResponseMetaPagination'
type: object
PowerpacksResponseMetaPagination:
description: Powerpack response pagination metadata.
@@ -84791,14 +84852,14 @@ components:
description: Entity data returned in a preview response, including attributes, relationships, and type.
properties:
attributes:
- $ref: "#/components/schemas/EntityResponseDataAttributes"
+ $ref: '#/components/schemas/EntityResponseDataAttributes'
id:
description: Entity unique identifier.
type: string
relationships:
- $ref: "#/components/schemas/EntityResponseDataRelationships"
+ $ref: '#/components/schemas/EntityResponseDataRelationships'
type:
- $ref: "#/components/schemas/EntityResponseDataType"
+ $ref: '#/components/schemas/EntityResponseDataType'
required:
- type
type: object
@@ -84806,7 +84867,7 @@ components:
description: Request body for initiating a print-only report.
properties:
data:
- $ref: "#/components/schemas/PrintReportRequestData"
+ $ref: '#/components/schemas/PrintReportRequestData'
required:
- data
type: object
@@ -84827,11 +84888,11 @@ components:
example: "abc-def-ghi"
type: string
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: |-
@@ -84860,9 +84921,9 @@ components:
description: The JSON:API data object for a print report request.
properties:
attributes:
- $ref: "#/components/schemas/PrintReportRequestAttributes"
+ $ref: '#/components/schemas/PrintReportRequestAttributes'
type:
- $ref: "#/components/schemas/PrintReportType"
+ $ref: '#/components/schemas/PrintReportType'
required:
- type
- attributes
@@ -84871,7 +84932,7 @@ components:
description: Response containing the initiated print-only report.
properties:
data:
- $ref: "#/components/schemas/PrintReportResponseData"
+ $ref: '#/components/schemas/PrintReportResponseData'
required:
- data
type: object
@@ -84892,11 +84953,11 @@ components:
example: "abc-def-ghi"
type: string
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: The relative time window used, if one was specified in the request.
@@ -84924,14 +84985,14 @@ components:
description: The JSON:API data object for a print-only report.
properties:
attributes:
- $ref: "#/components/schemas/PrintReportResponseAttributes"
+ $ref: '#/components/schemas/PrintReportResponseAttributes'
id:
description: The unique identifier of the report.
example: "11111111-2222-3333-4444-555555555555"
format: uuid
type: string
type:
- $ref: "#/components/schemas/PrintReportType"
+ $ref: '#/components/schemas/PrintReportType'
required:
- id
- type
@@ -84958,11 +85019,11 @@ components:
description: A query for host-level process metrics such as CPU and memory usage.
properties:
aggregator:
- $ref: "#/components/schemas/MetricsAggregator"
+ $ref: '#/components/schemas/MetricsAggregator'
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ProcessDataSource"
+ $ref: '#/components/schemas/ProcessDataSource'
is_normalized_cpu:
description: Whether CPU metrics should be normalized by core count.
type: boolean
@@ -84979,7 +85040,7 @@ components:
example: query1
type: string
sort:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: Tag filters to narrow down processes.
items:
@@ -84999,7 +85060,7 @@ components:
description: Response metadata object.
properties:
page:
- $ref: "#/components/schemas/ProcessSummariesMetaPage"
+ $ref: '#/components/schemas/ProcessSummariesMetaPage'
type: object
ProcessSummariesMetaPage:
description: Paging attributes.
@@ -85023,21 +85084,21 @@ components:
data:
description: Array of process summary objects.
items:
- $ref: "#/components/schemas/ProcessSummary"
+ $ref: '#/components/schemas/ProcessSummary'
type: array
meta:
- $ref: "#/components/schemas/ProcessSummariesMeta"
+ $ref: '#/components/schemas/ProcessSummariesMeta'
type: object
ProcessSummary:
description: Process summary object.
properties:
attributes:
- $ref: "#/components/schemas/ProcessSummaryAttributes"
+ $ref: '#/components/schemas/ProcessSummaryAttributes'
id:
description: Process ID.
type: string
type:
- $ref: "#/components/schemas/ProcessSummaryType"
+ $ref: '#/components/schemas/ProcessSummaryType'
type: object
ProcessSummaryAttributes:
description: Attributes for a process summary.
@@ -85085,9 +85146,9 @@ components:
description: A query for host-level process metrics such as CPU and memory usage.
properties:
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/ProcessDataSource"
+ $ref: '#/components/schemas/ProcessDataSource'
is_normalized_cpu:
description: Whether CPU metrics should be normalized by core count.
type: boolean
@@ -85104,7 +85165,7 @@ components:
example: query1
type: string
sort:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
tag_filters:
description: Tag filters to narrow down processes.
items:
@@ -85128,7 +85189,7 @@ components:
aggregates, so it takes no compute or group-by rule.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
columns:
description: Attribute columns to include in each event row.
items:
@@ -85143,9 +85204,9 @@ components:
minimum: 1
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
sort:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListSort"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListSort'
required:
- query
type: object
@@ -85172,7 +85233,7 @@ components:
type: formula_analytics_extended_list_request
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListRequestData'
required:
- data
type: object
@@ -85185,7 +85246,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListQuery"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListQuery'
to:
description: End time in epoch milliseconds.
example: 1771836848262
@@ -85200,9 +85261,9 @@ components:
description: Data object for an analytics list request.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListRequestType'
required:
- type
- attributes
@@ -85219,9 +85280,9 @@ components:
description: Response for an analytics list query, containing individual event records.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListResponseData'
meta:
- $ref: "#/components/schemas/ProductAnalyticsResponseMeta"
+ $ref: '#/components/schemas/ProductAnalyticsResponseMeta'
required:
- data
type: object
@@ -85231,7 +85292,7 @@ components:
records:
description: The event rows, each holding the values of the requested columns.
items:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListRecord"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListRecord'
type: array
total_count:
description: Total number of records matching the query, before the row limit is applied.
@@ -85242,13 +85303,13 @@ components:
description: Data object for an analytics list response.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListResponseAttributes'
id:
description: Unique identifier for this response data object.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListResponseType'
required:
- id
- type
@@ -85269,7 +85330,7 @@ components:
description: Name of the facet to sort the rows by.
type: string
order:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListSortOrder"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListSortOrder'
type: object
ProductAnalyticsAnalyticsListSortOrder:
description: The direction rows are sorted in.
@@ -85284,13 +85345,13 @@ components:
description: The analytics query definition containing a base query, compute rule, and optional grouping.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
compute:
- $ref: "#/components/schemas/ProductAnalyticsCompute"
+ $ref: '#/components/schemas/ProductAnalyticsCompute'
group_by:
description: Group-by rules for segmenting results.
items:
- $ref: "#/components/schemas/ProductAnalyticsGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsGroupBy'
type: array
indexes:
deprecated: true
@@ -85303,7 +85364,7 @@ components:
maxItems: 1
type: array
query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
required:
- query
- compute
@@ -85325,7 +85386,7 @@ components:
type: formula_analytics_extended_request
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestData'
required:
- data
type: object
@@ -85344,7 +85405,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsQuery"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsQuery'
request_id:
description: Unique identifier of the query.
type: string
@@ -85362,9 +85423,9 @@ components:
description: Data object for an analytics request.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequestType'
required:
- type
- attributes
@@ -85396,7 +85457,7 @@ components:
accounts:
description: Account audience queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceAccountSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceAccountSubquery'
type: array
formula:
description: Boolean formula combining audience queries by name.
@@ -85405,12 +85466,12 @@ components:
segments:
description: Segment audience queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceSegmentSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceSegmentSubquery'
type: array
users:
description: User audience queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsAudienceUserSubquery"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceUserSubquery'
type: array
type: object
ProductAnalyticsAudienceSegmentSubquery:
@@ -85449,8 +85510,8 @@ components:
Use `product_analytics` for standard event queries, or
`product_analytics_occurrence` for occurrence-filtered queries.
oneOf:
- - $ref: "#/components/schemas/ProductAnalyticsEventQuery"
- - $ref: "#/components/schemas/ProductAnalyticsOccurrenceQuery"
+ - $ref: '#/components/schemas/ProductAnalyticsEventQuery'
+ - $ref: '#/components/schemas/ProductAnalyticsOccurrenceQuery'
ProductAnalyticsCalendarInterval:
description: A calendar-aligned bucket definition, such as "every 1 week starting on Monday".
properties:
@@ -85471,7 +85532,7 @@ components:
example: UTC
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsCalendarIntervalType"
+ $ref: '#/components/schemas/ProductAnalyticsCalendarIntervalType'
required:
- type
type: object
@@ -85543,9 +85604,9 @@ components:
description: A standard Product Analytics event query.
properties:
data_source:
- $ref: "#/components/schemas/ProductAnalyticsEventQueryDataSource"
+ $ref: '#/components/schemas/ProductAnalyticsEventQueryDataSource'
search:
- $ref: "#/components/schemas/ProductAnalyticsEventSearch"
+ $ref: '#/components/schemas/ProductAnalyticsEventSearch'
required:
- data_source
- search
@@ -85583,17 +85644,17 @@ components:
description: Query definition for a journey timeseries request.
properties:
compute:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryCompute"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryCompute'
group_by:
description: Segments the results by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryGroupBy'
type: array
query_id:
description: Caller-defined identifier echoed back in the results.
type: string
search:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearch"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearch'
required:
- search
- compute
@@ -85602,7 +85663,7 @@ components:
description: Request body for a journey timeseries query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyRequestData'
required:
- data
type: object
@@ -85619,7 +85680,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyQuery"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -85636,9 +85697,9 @@ components:
window, the bucket interval that splits it, and the journey metric to compute per bucket.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyRequestType'
required:
- type
- attributes
@@ -85655,16 +85716,16 @@ components:
description: Query definition for a retention scalar or retention timeseries request.
properties:
computation_scope:
- $ref: "#/components/schemas/ProductAnalyticsRetentionScope"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionScope'
compute:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCompute"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCompute'
group_by:
description: Splits the results by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGroupBy'
type: array
search:
- $ref: "#/components/schemas/ProductAnalyticsRetentionSearch"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionSearch'
required:
- search
- compute
@@ -85673,7 +85734,7 @@ components:
description: Request body for a retention scalar or retention timeseries query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionRequestData'
required:
- data
type: object
@@ -85690,7 +85751,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionQuery"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -85707,9 +85768,9 @@ components:
hold the time window to query and the retention query definition to evaluate.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionRequestType'
required:
- type
- attributes
@@ -85743,7 +85804,7 @@ components:
or `__dd.dropoff_rate`. Defaults to `__dd.conversion`.
type: string
target:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTarget"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTarget'
required:
- aggregation
type: object
@@ -85764,11 +85825,11 @@ components:
description: Whether to exclude entities that have no value for this facet.
type: boolean
sort:
- $ref: "#/components/schemas/ProductAnalyticsGroupBySort"
+ $ref: '#/components/schemas/ProductAnalyticsGroupBySort'
source:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryGroupBySource"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryGroupBySource'
target:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTarget"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTarget'
value_filters:
description: Restricts the results to these facet values.
items:
@@ -85805,7 +85866,7 @@ components:
description: Exclude results with missing facet values.
type: boolean
sort:
- $ref: "#/components/schemas/ProductAnalyticsGroupBySort"
+ $ref: '#/components/schemas/ProductAnalyticsGroupBySort'
source:
description: The source for audience-filter-based group-by.
type: string
@@ -85823,7 +85884,7 @@ components:
description: The metric to sort by.
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
type: object
ProductAnalyticsInterval:
description: An interval definition in a timeseries response.
@@ -85882,7 +85943,7 @@ components:
accounts:
description: Named account sub-queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyAudienceAccountQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyAudienceAccountQuery'
type: array
formula:
description: |-
@@ -85893,12 +85954,12 @@ components:
segments:
description: Named segment sub-queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyAudienceSegmentQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyAudienceSegmentQuery'
type: array
users:
description: Named user sub-queries.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyAudienceUserQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyAudienceUserQuery'
type: array
type: object
ProductAnalyticsJourneyAudienceSegmentQuery:
@@ -85935,7 +85996,7 @@ components:
`_timestamp` key per step.
properties:
name:
- $ref: "#/components/schemas/ProductAnalyticsJourneyComputedColumnName"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyComputedColumnName'
required:
- name
type: object
@@ -85986,14 +86047,14 @@ components:
description: Query definition for a journey funnel request.
properties:
compute:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelCompute"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelCompute'
group_by:
description: Segments the funnel by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryGroupBy'
type: array
search:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearch"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearch'
required:
- search
type: object
@@ -86001,7 +86062,7 @@ components:
description: Request body for a journey funnel analysis.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelRequestData'
required:
- data
type: object
@@ -86018,7 +86079,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -86035,9 +86096,9 @@ components:
query and the journey whose step-to-step conversion should be measured.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyRequestType'
required:
- type
- attributes
@@ -86046,7 +86107,7 @@ components:
description: Response for a journey funnel analysis.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelResponseData'
required:
- data
type: object
@@ -86059,11 +86120,11 @@ components:
format: double
type: number
end_to_end_elapsed_time:
- $ref: "#/components/schemas/ProductAnalyticsElapsedTime"
+ $ref: '#/components/schemas/ProductAnalyticsElapsedTime'
funnel_steps:
description: The funnel steps, in the order given by the search expression.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelStep"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelStep'
type: array
initial_count:
description: Number of entities that entered the funnel.
@@ -86082,13 +86143,13 @@ components:
entities that entered, the end-to-end conversion, and one entry per funnel step.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelResponseAttributes'
id:
description: Identifier of this result.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelResponseType'
required:
- id
- type
@@ -86106,11 +86167,11 @@ components:
description: A single step of the funnel with its conversion counts and timings.
properties:
elapsed_time_to_next_step:
- $ref: "#/components/schemas/ProductAnalyticsElapsedTime"
+ $ref: '#/components/schemas/ProductAnalyticsElapsedTime'
groups:
description: Breakdown of this step by the requested group-by facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelStepGroup"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelStepGroup'
type: array
label:
description: Label of the step, derived from the node alias.
@@ -86141,7 +86202,7 @@ components:
format: int64
type: integer
elapsed_time_to_next_step:
- $ref: "#/components/schemas/ProductAnalyticsElapsedTime"
+ $ref: '#/components/schemas/ProductAnalyticsElapsedTime'
group_tags:
description: Group-by values identifying this cohort.
example:
@@ -86167,10 +86228,10 @@ components:
computed_columns:
description: Computed columns to add to each row.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyComputedColumn"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyComputedColumn'
type: array
conversion_type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyConversionType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyConversionType'
entity_columns:
description: Attribute columns to return for each row, in addition to the identity join key and `timestamp`.
items:
@@ -86183,7 +86244,7 @@ components:
group_by:
description: Segments the results by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryGroupBy'
type: array
limit:
description: Maximum number of rows to return. Omit it to let the service choose.
@@ -86191,11 +86252,11 @@ components:
minimum: 1
type: integer
search:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearch"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearch'
sort:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListSort"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListSort'
target:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTarget"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTarget'
required:
- search
type: object
@@ -86210,7 +86271,7 @@ components:
description: Request body for a journey list query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListRequestData'
required:
- data
type: object
@@ -86223,7 +86284,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -86240,9 +86301,9 @@ components:
and the journey whose matching entities should be listed, one row each.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListRequestType'
required:
- type
- attributes
@@ -86259,7 +86320,7 @@ components:
description: Response for a journey list query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListResponseData'
required:
- data
type: object
@@ -86267,11 +86328,11 @@ components:
description: Attributes of a journey list response.
properties:
entity:
- $ref: "#/components/schemas/ProductAnalyticsJourneyEntity"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyEntity'
records:
description: The returned rows.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListRecord"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListRecord'
type: array
total_count:
description: Total number of rows matching the query, ignoring `limit`.
@@ -86289,13 +86350,13 @@ components:
the returned rows and the total number of rows that matched, ignoring `limit`.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListResponseAttributes'
id:
description: Identifier of this result.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListResponseType'
required:
- id
- type
@@ -86318,13 +86379,13 @@ components:
description: Column to sort on.
type: string
order:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
type: object
ProductAnalyticsJourneyNodeTarget:
description: A reference to a single step of the journey.
properties:
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyNodeTargetType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyNodeTargetType'
value:
description: Alias of the targeted node.
example: A
@@ -86353,7 +86414,7 @@ components:
example: A
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyPathTargetType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyPathTargetType'
required:
- type
- start
@@ -86392,7 +86453,7 @@ components:
or `__dd.dropoff_rate`. Defaults to `__dd.conversion`.
type: string
target:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTarget"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTarget'
required:
- aggregation
type: object
@@ -86400,17 +86461,17 @@ components:
description: Query definition for a journey scalar request.
properties:
compute:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarCompute"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarCompute'
group_by:
description: Segments the results by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsGraphQueryGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsGraphQueryGroupBy'
type: array
query_id:
description: Caller-defined identifier echoed back in the results.
type: string
search:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearch"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearch'
required:
- search
- compute
@@ -86419,7 +86480,7 @@ components:
description: Request body for a journey scalar query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarRequestData'
required:
- data
type: object
@@ -86432,7 +86493,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarQuery"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -86449,9 +86510,9 @@ components:
window and the journey metric to reduce to one value over that window.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyRequestType'
required:
- type
- attributes
@@ -86460,7 +86521,7 @@ components:
description: Response for a journey scalar query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarResponseData'
required:
- data
type: object
@@ -86470,13 +86531,13 @@ components:
per group, suitable for a query value or top list widget.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponseAttributes'
id:
description: Identifier of this result.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarResponseType'
required:
- id
- type
@@ -86498,12 +86559,12 @@ components:
example: A -> B
type: string
filters:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearchFilters"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearchFilters'
join_keys:
- $ref: "#/components/schemas/ProductAnalyticsJoinKeys"
+ $ref: '#/components/schemas/ProductAnalyticsJoinKeys'
node_objects:
additionalProperties:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
description: |-
Map of node alias to the query matching that step of the journey.
Every alias used in `expression` must have an entry here.
@@ -86525,11 +86586,11 @@ components:
description: Filters applied on top of the journey step expression.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsJourneyAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyAudienceFilters'
graph_filters:
description: Filters on journey-level metrics such as time to convert.
items:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearchGraphFilter"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearchGraphFilter'
type: array
string_filter:
description: Free-text search query applied to the whole journey.
@@ -86539,11 +86600,11 @@ components:
description: A filter applied to a step, or a range of steps, of the journey graph.
properties:
name:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearchGraphFilterName"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearchGraphFilterName'
operator:
- $ref: "#/components/schemas/ProductAnalyticsJourneySearchGraphFilterOperator"
+ $ref: '#/components/schemas/ProductAnalyticsJourneySearchGraphFilterOperator'
target:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTarget"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTarget'
value:
description: Value compared against the metric. Durations are expressed in milliseconds.
example: 60000
@@ -86588,13 +86649,13 @@ components:
Use a `node` target to name a single step, or a `path` target to name the range
between two steps.
oneOf:
- - $ref: "#/components/schemas/ProductAnalyticsJourneyNodeTarget"
- - $ref: "#/components/schemas/ProductAnalyticsJourneyPathTarget"
+ - $ref: '#/components/schemas/ProductAnalyticsJourneyNodeTarget'
+ - $ref: '#/components/schemas/ProductAnalyticsJourneyPathTarget'
ProductAnalyticsJourneyTimeseriesResponse:
description: Response for a journey timeseries query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTimeseriesResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTimeseriesResponseData'
required:
- data
type: object
@@ -86604,13 +86665,13 @@ components:
series per group along with the timestamps the points fall on.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes'
id:
description: Identifier of this result.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTimeseriesResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTimeseriesResponseType'
required:
- id
- type
@@ -86648,9 +86709,9 @@ components:
description: A Product Analytics occurrence-filtered query.
properties:
data_source:
- $ref: "#/components/schemas/ProductAnalyticsOccurrenceQueryDataSource"
+ $ref: '#/components/schemas/ProductAnalyticsOccurrenceQueryDataSource'
search:
- $ref: "#/components/schemas/ProductAnalyticsOccurrenceSearch"
+ $ref: '#/components/schemas/ProductAnalyticsOccurrenceSearch'
required:
- data_source
- search
@@ -86667,7 +86728,7 @@ components:
description: Search parameters for an occurrence query.
properties:
occurrences:
- $ref: "#/components/schemas/ProductAnalyticsOccurrenceFilter"
+ $ref: '#/components/schemas/ProductAnalyticsOccurrenceFilter'
query:
description: The search query using Datadog search syntax.
example: "@type:action"
@@ -86680,7 +86741,7 @@ components:
description: Unique identifier of the query.
type: string
status:
- $ref: "#/components/schemas/ProductAnalyticsResponseMetaStatus"
+ $ref: '#/components/schemas/ProductAnalyticsResponseMetaStatus'
type: object
ProductAnalyticsResponseMetaStatus:
description: The execution status of a Product Analytics query.
@@ -86697,7 +86758,7 @@ components:
description: Selects the rolled-up row that aggregates every cohort, rather than a single cohort.
properties:
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionAggregationTargetType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionAggregationTargetType'
value:
description: The aggregation that produced the rolled-up row.
example: weighted_avg
@@ -86718,9 +86779,9 @@ components:
description: A retention interval aligned to calendar boundaries.
properties:
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCalendarTimeIntervalType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCalendarTimeIntervalType'
value:
- $ref: "#/components/schemas/ProductAnalyticsCalendarInterval"
+ $ref: '#/components/schemas/ProductAnalyticsCalendarInterval'
required:
- type
- value
@@ -86737,11 +86798,11 @@ components:
description: Narrows a retention query to a single cell, at the intersection of one cohort and one return period.
properties:
cohort_target:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCohortTarget"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCohortTarget'
return_period_target:
- $ref: "#/components/schemas/ProductAnalyticsRetentionIndexTarget"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionIndexTarget'
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCellScopeType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCellScopeType'
required:
- type
- cohort_target
@@ -86759,9 +86820,9 @@ components:
description: Defines the event that places an entity into a cohort, and how cohorts are bucketed over time.
properties:
base_query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
time_interval:
- $ref: "#/components/schemas/ProductAnalyticsRetentionTimeInterval"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionTimeInterval'
required:
- base_query
- time_interval
@@ -86770,9 +86831,9 @@ components:
description: Narrows a retention query to a single cohort row.
properties:
target:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCohortTarget"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCohortTarget'
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCohortScopeType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCohortScopeType'
required:
- type
- target
@@ -86788,8 +86849,8 @@ components:
ProductAnalyticsRetentionCohortTarget:
description: Selects a cohort, either by index or by the aggregation that rolls all cohorts together.
oneOf:
- - $ref: "#/components/schemas/ProductAnalyticsRetentionIndexTarget"
- - $ref: "#/components/schemas/ProductAnalyticsRetentionAggregationTarget"
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionIndexTarget'
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionAggregationTarget'
ProductAnalyticsRetentionCompute:
description: The metric and aggregation applied to a retention query.
properties:
@@ -86798,7 +86859,7 @@ components:
example: count
type: string
metric:
- $ref: "#/components/schemas/ProductAnalyticsRetentionComputeMetric"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionComputeMetric'
required:
- metric
- aggregation
@@ -86827,7 +86888,7 @@ components:
description: Filters narrowing the events considered by a retention query.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
string_filter:
description: Free-text search query applied to the events.
type: string
@@ -86836,9 +86897,9 @@ components:
description: A retention interval of fixed length, such as "7 days".
properties:
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionFixedTimeIntervalType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionFixedTimeIntervalType'
unit:
- $ref: "#/components/schemas/ProductAnalyticsRetentionFixedTimeIntervalUnit"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionFixedTimeIntervalUnit'
value:
description: Length of the interval, expressed in `unit`.
example: 7
@@ -86877,7 +86938,7 @@ components:
cells:
description: The cells of the row, one per return period.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridCohortCell"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridCohortCell'
type: array
cohort_end_time:
description: End of the cohort window, in epoch milliseconds.
@@ -86905,11 +86966,11 @@ components:
description: Label identifying the cohort, such as the week it started.
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridCohortType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridCohortType'
unit:
description: Unit definitions for the cell values.
items:
- $ref: "#/components/schemas/ProductAnalyticsUnit"
+ $ref: '#/components/schemas/ProductAnalyticsUnit'
type: array
type: object
ProductAnalyticsRetentionGridCohortCell:
@@ -86951,7 +87012,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridCohortType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridCohortType'
type: object
ProductAnalyticsRetentionGridCohortType:
description: |-
@@ -86968,16 +87029,16 @@ components:
description: Query definition for a retention grid or retention metadata request.
properties:
computation_scope:
- $ref: "#/components/schemas/ProductAnalyticsRetentionScope"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionScope'
compute:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCompute"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCompute'
group_by:
description: Splits the results by the values of one or more facets.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGroupBy"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGroupBy'
type: array
search:
- $ref: "#/components/schemas/ProductAnalyticsRetentionSearch"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionSearch'
required:
- search
- compute
@@ -86986,7 +87047,7 @@ components:
description: Request body for a retention grid query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridRequestData'
required:
- data
type: object
@@ -87003,7 +87064,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridQuery"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -87020,9 +87081,9 @@ components:
window to query and the cohort and return criteria that define the grid.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridRequestType'
required:
- type
- attributes
@@ -87039,7 +87100,7 @@ components:
description: Response for a retention grid query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridResponseData'
required:
- data
type: object
@@ -87049,7 +87110,7 @@ components:
cohorts:
description: The cohorts forming the rows of the grid.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridCohort"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridCohort'
type: array
retention_entity:
description: The entity whose retention was measured.
@@ -87057,12 +87118,12 @@ components:
retention_periods:
description: The return periods forming the columns of the grid.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionPeriod"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionPeriod'
type: array
unit:
description: Unit definitions for the grid values.
items:
- $ref: "#/components/schemas/ProductAnalyticsUnit"
+ $ref: '#/components/schemas/ProductAnalyticsUnit'
type: array
type: object
ProductAnalyticsRetentionGridResponseData:
@@ -87071,13 +87132,13 @@ components:
return periods forming the columns and the cohorts forming the rows.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridResponseAttributes'
id:
description: Unique identifier for this response data object.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridResponseType'
required:
- id
- type
@@ -87109,12 +87170,12 @@ components:
description: Whether to drop entities that have no value for the facet.
type: boolean
sort:
- $ref: "#/components/schemas/ProductAnalyticsGroupBySort"
+ $ref: '#/components/schemas/ProductAnalyticsGroupBySort'
source:
description: Audience source backing the group-by, when grouping by an audience rather than a facet.
type: string
target:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGroupByTarget"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGroupByTarget'
required:
- target
- facet
@@ -87133,7 +87194,7 @@ components:
description: Selects a cohort or return period by its zero-based position in the grid.
properties:
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionIndexTargetType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionIndexTargetType'
value:
description: Zero-based index of the targeted cohort or return period.
example: 0
@@ -87156,7 +87217,7 @@ components:
description: A column to include in each returned entity row.
properties:
field:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListColumnField"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListColumnField'
type: object
ProductAnalyticsRetentionListColumnField:
description: The attribute selected for a column.
@@ -87172,10 +87233,10 @@ components:
columns:
description: The attribute columns to include in each returned row.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListColumn"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListColumn'
type: array
computation_scope:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCellScope"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCellScope'
limit:
description: Maximum number of rows to return. Use `0` for no limit.
example: 100
@@ -87183,7 +87244,7 @@ components:
minimum: 0
type: integer
search:
- $ref: "#/components/schemas/ProductAnalyticsRetentionSearch"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionSearch'
required:
- search
- computation_scope
@@ -87196,7 +87257,7 @@ components:
description: Request body listing the individual entities behind one cell of the retention grid.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListRequestData'
required:
- data
type: object
@@ -87209,7 +87270,7 @@ components:
format: int64
type: integer
query:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListQuery"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListQuery'
to:
description: End of the query window, in epoch milliseconds.
example: 1756857600000
@@ -87226,9 +87287,9 @@ components:
window, the cell to list, and the columns to return for each entity.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListRequestType'
required:
- type
- attributes
@@ -87245,7 +87306,7 @@ components:
description: Response for a retention list query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListResponseData'
required:
- data
type: object
@@ -87255,7 +87316,7 @@ components:
records:
description: The matching entity rows.
items:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListRecord"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListRecord'
type: array
retention_entity:
description: The entity whose retention was measured.
@@ -87267,13 +87328,13 @@ components:
contain the entity whose retention was measured and one row per matching entity.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListResponseAttributes'
id:
description: Unique identifier for this response data object.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListResponseType'
required:
- id
- type
@@ -87316,9 +87377,9 @@ components:
description: Defines the event that counts as a return, and the window in which it must occur.
properties:
base_query:
- $ref: "#/components/schemas/ProductAnalyticsBaseQuery"
+ $ref: '#/components/schemas/ProductAnalyticsBaseQuery'
time_interval:
- $ref: "#/components/schemas/ProductAnalyticsRetentionTimeInterval"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionTimeInterval'
required:
- base_query
type: object
@@ -87326,9 +87387,9 @@ components:
description: Narrows a retention query to a single return-period column.
properties:
target:
- $ref: "#/components/schemas/ProductAnalyticsRetentionIndexTarget"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionIndexTarget'
type:
- $ref: "#/components/schemas/ProductAnalyticsRetentionReturnPeriodScopeType"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionReturnPeriodScopeType'
required:
- type
- target
@@ -87346,22 +87407,22 @@ components:
Restricts a retention query to part of the grid, so that results can be examined in detail.
Omit it to compute the whole grid.
oneOf:
- - $ref: "#/components/schemas/ProductAnalyticsRetentionCohortScope"
- - $ref: "#/components/schemas/ProductAnalyticsRetentionReturnPeriodScope"
- - $ref: "#/components/schemas/ProductAnalyticsRetentionCellScope"
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionCohortScope'
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionReturnPeriodScope'
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionCellScope'
ProductAnalyticsRetentionSearch:
description: Defines the cohort and return criteria that make up a retention query.
properties:
cohort_criteria:
- $ref: "#/components/schemas/ProductAnalyticsRetentionCohortCriteria"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionCohortCriteria'
filters:
- $ref: "#/components/schemas/ProductAnalyticsRetentionFilters"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionFilters'
retention_entity:
- $ref: "#/components/schemas/ProductAnalyticsRetentionEntity"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionEntity'
return_condition:
- $ref: "#/components/schemas/ProductAnalyticsRetentionReturnCondition"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionReturnCondition'
return_criteria:
- $ref: "#/components/schemas/ProductAnalyticsRetentionReturnCriteria"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionReturnCriteria'
required:
- cohort_criteria
- retention_entity
@@ -87372,8 +87433,8 @@ components:
A retention interval, either aligned to calendar boundaries or of a fixed length.
Cohort criteria use calendar intervals; return criteria use fixed intervals.
oneOf:
- - $ref: "#/components/schemas/ProductAnalyticsRetentionCalendarTimeInterval"
- - $ref: "#/components/schemas/ProductAnalyticsRetentionFixedTimeInterval"
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionCalendarTimeInterval'
+ - $ref: '#/components/schemas/ProductAnalyticsRetentionFixedTimeInterval'
ProductAnalyticsSankeyAggregatedNode:
description: One of the nodes rolled up into an aggregated node, retained so the roll-up can be broken down.
properties:
@@ -87392,7 +87453,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ProductAnalyticsSankeyAggregatedNodeType"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyAggregatedNodeType'
value:
description: Number of sessions passing through the node.
format: int64
@@ -87465,7 +87526,7 @@ components:
aggregated_nodes:
description: The nodes rolled up into this one, when the node is an aggregate.
items:
- $ref: "#/components/schemas/ProductAnalyticsSankeyAggregatedNode"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyAggregatedNode'
type: array
column:
description: Zero-based index of the column the node sits in.
@@ -87490,7 +87551,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ProductAnalyticsSankeyNodeType"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyNodeType'
value:
description: Number of sessions passing through the node.
format: int64
@@ -87513,7 +87574,7 @@ components:
description: Request body for a Sankey diagram query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsSankeyRequestData"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyRequestData'
required:
- data
type: object
@@ -87521,11 +87582,11 @@ components:
description: Attributes of a Sankey request.
properties:
definition:
- $ref: "#/components/schemas/ProductAnalyticsSankeyDefinition"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyDefinition'
search:
- $ref: "#/components/schemas/ProductAnalyticsSankeySearch"
+ $ref: '#/components/schemas/ProductAnalyticsSankeySearch'
time:
- $ref: "#/components/schemas/ProductAnalyticsSankeyTime"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyTime'
required:
- time
- search
@@ -87537,9 +87598,9 @@ components:
query, the search that selects the sessions, and the definition of the diagram to build.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsSankeyRequestAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyRequestAttributes'
type:
- $ref: "#/components/schemas/ProductAnalyticsSankeyRequestType"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyRequestType'
required:
- type
- attributes
@@ -87556,7 +87617,7 @@ components:
description: Response for a Sankey diagram query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsSankeyResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyResponseData'
required:
- data
type: object
@@ -87566,12 +87627,12 @@ components:
links:
description: The links of the diagram, one per pair of connected nodes.
items:
- $ref: "#/components/schemas/ProductAnalyticsSankeyLink"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyLink'
type: array
nodes:
description: The nodes of the diagram, one per facet value and column.
items:
- $ref: "#/components/schemas/ProductAnalyticsSankeyNode"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyNode'
type: array
type: object
ProductAnalyticsSankeyResponseData:
@@ -87580,13 +87641,13 @@ components:
nodes of every column and the links that carry sessions between them.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsSankeyResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyResponseAttributes'
id:
description: Unique identifier for this response data object.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsSankeyResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyResponseType'
required:
- id
- type
@@ -87604,9 +87665,9 @@ components:
description: Selects the sessions a Sankey diagram is built from.
properties:
audience_filters:
- $ref: "#/components/schemas/ProductAnalyticsAudienceFilters"
+ $ref: '#/components/schemas/ProductAnalyticsAudienceFilters'
join_keys:
- $ref: "#/components/schemas/ProductAnalyticsJoinKeys"
+ $ref: '#/components/schemas/ProductAnalyticsJoinKeys'
query:
description: Datadog search query restricting the events considered.
example: "@type:view"
@@ -87633,12 +87694,12 @@ components:
description: A column in a scalar response.
properties:
meta:
- $ref: "#/components/schemas/ProductAnalyticsScalarColumnMeta"
+ $ref: '#/components/schemas/ProductAnalyticsScalarColumnMeta'
name:
description: Column name (facet name for group-by, or "query").
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsScalarColumnType"
+ $ref: '#/components/schemas/ProductAnalyticsScalarColumnType'
values:
description: Column values.
items:
@@ -87651,7 +87712,7 @@ components:
unit:
description: Unit definitions for the column values, if applicable.
items:
- $ref: "#/components/schemas/ProductAnalyticsUnit"
+ $ref: '#/components/schemas/ProductAnalyticsUnit'
nullable: true
type: array
type: object
@@ -87668,9 +87729,9 @@ components:
description: Response for a scalar analytics query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponseData'
meta:
- $ref: "#/components/schemas/ProductAnalyticsResponseMeta"
+ $ref: '#/components/schemas/ProductAnalyticsResponseMeta'
type: object
ProductAnalyticsScalarResponseAttributes:
description: Attributes of a scalar analytics response, containing the result columns.
@@ -87678,19 +87739,19 @@ components:
columns:
description: The list of result columns, each containing values and metadata.
items:
- $ref: "#/components/schemas/ProductAnalyticsScalarColumn"
+ $ref: '#/components/schemas/ProductAnalyticsScalarColumn'
type: array
type: object
ProductAnalyticsScalarResponseData:
description: Data object for a scalar response.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponseAttributes'
id:
description: Unique identifier for this response data object.
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponseType'
type: object
ProductAnalyticsScalarResponseType:
description: The resource type identifier for a scalar analytics response.
@@ -87715,7 +87776,7 @@ components:
unit:
description: Unit definitions for the series values.
items:
- $ref: "#/components/schemas/ProductAnalyticsUnit"
+ $ref: '#/components/schemas/ProductAnalyticsUnit'
type: array
type: object
ProductAnalyticsServerSideEventError:
@@ -87740,24 +87801,24 @@ components:
errors:
description: Structured errors.
items:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventError"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventError'
type: array
type: object
ProductAnalyticsServerSideEventItem:
description: A Product Analytics server-side event.
properties:
account:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemAccount"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemAccount'
application:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemApplication"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemApplication'
event:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemEvent"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemEvent'
session:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemSession"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemSession'
type:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemType"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemType'
usr:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItemUsr"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItemUsr'
required:
- application
- event
@@ -87828,9 +87889,9 @@ components:
description: Response for a timeseries analytics query.
properties:
data:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseData"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseData'
meta:
- $ref: "#/components/schemas/ProductAnalyticsResponseMeta"
+ $ref: '#/components/schemas/ProductAnalyticsResponseMeta'
type: object
ProductAnalyticsTimeseriesResponseAttributes:
description: |-
@@ -87840,12 +87901,12 @@ components:
intervals:
description: Interval definitions describing the time buckets used in the response.
items:
- $ref: "#/components/schemas/ProductAnalyticsInterval"
+ $ref: '#/components/schemas/ProductAnalyticsInterval'
type: array
series:
description: The list of series, each corresponding to a query or group-by combination.
items:
- $ref: "#/components/schemas/ProductAnalyticsSerie"
+ $ref: '#/components/schemas/ProductAnalyticsSerie'
type: array
times:
description: Timestamps for each data point (epoch milliseconds).
@@ -87870,12 +87931,12 @@ components:
description: Data object for a timeseries analytics response.
properties:
attributes:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes'
id:
description: Unique identifier for this response data object.
type: string
type:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseType"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponseType'
type: object
ProductAnalyticsTimeseriesResponseType:
description: The resource type identifier for a timeseries analytics response.
@@ -87951,7 +88012,7 @@ components:
The allotments the SKU provides to other SKUs. Every entry carries the code of this
SKU as its `parent_sku_code`. Empty when the SKU provides no allotments.
items:
- $ref: "#/components/schemas/ProductCatalogSKUAllotment"
+ $ref: '#/components/schemas/ProductCatalogSKUAllotment'
type: array
billing_dimension:
description: |-
@@ -87972,7 +88033,7 @@ components:
example: USD
type: string
default_on_demand_option:
- $ref: "#/components/schemas/ProductCatalogSKUOnDemandOption"
+ $ref: '#/components/schemas/ProductCatalogSKUOnDemandOption'
number_of_units_included_in_price:
description: |-
The number of billable usage units included in the price. `0` for SKUs that are not
@@ -87990,9 +88051,9 @@ components:
nullable: true
type: string
on_demand_tiered:
- $ref: "#/components/schemas/ProductCatalogSKUTieredPricing"
+ $ref: '#/components/schemas/ProductCatalogSKUTieredPricing'
pricing_type:
- $ref: "#/components/schemas/ProductCatalogSKUPricingType"
+ $ref: '#/components/schemas/ProductCatalogSKUPricingType'
sku_name:
description: The human-readable name of the SKU.
example: Infra Pro
@@ -88013,13 +88074,13 @@ components:
description: A SKU and the pricing metadata that applies to it.
properties:
attributes:
- $ref: "#/components/schemas/ProductCatalogSKUDataAttributesResponse"
+ $ref: '#/components/schemas/ProductCatalogSKUDataAttributesResponse'
id:
description: The code that identifies the SKU.
example: HOSTS-PRO
type: string
type:
- $ref: "#/components/schemas/ProductCatalogSKUType"
+ $ref: '#/components/schemas/ProductCatalogSKUType'
required:
- id
- type
@@ -88058,7 +88119,7 @@ components:
example: "120.00"
type: string
pricing_unit_type:
- $ref: "#/components/schemas/ProductCatalogSKUPricingUnitType"
+ $ref: '#/components/schemas/ProductCatalogSKUPricingUnitType'
required:
- min_usage_quantity
- max_usage_quantity
@@ -88097,7 +88158,7 @@ components:
tiers:
description: The pricing tiers, ordered by ascending usage quantity.
items:
- $ref: "#/components/schemas/ProductCatalogSKUPricingTier"
+ $ref: '#/components/schemas/ProductCatalogSKUPricingTier'
type: array
required:
- tiers
@@ -88124,7 +88185,7 @@ components:
data:
description: The generally available SKUs, sorted by SKU code in ascending order.
items:
- $ref: "#/components/schemas/ProductCatalogSKUDataResponse"
+ $ref: '#/components/schemas/ProductCatalogSKUDataResponse'
type: array
required:
- data
@@ -88133,15 +88194,15 @@ components:
description: A Project.
properties:
attributes:
- $ref: "#/components/schemas/ProjectAttributes"
+ $ref: '#/components/schemas/ProjectAttributes'
id:
description: The Project's identifier.
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
- $ref: "#/components/schemas/ProjectRelationships"
+ $ref: '#/components/schemas/ProjectRelationships'
type:
- $ref: "#/components/schemas/ProjectResourceType"
+ $ref: '#/components/schemas/ProjectResourceType'
required:
- id
- type
@@ -88151,7 +88212,7 @@ components:
description: Project attributes.
properties:
columns_config:
- $ref: "#/components/schemas/ProjectColumnsConfig"
+ $ref: '#/components/schemas/ProjectColumnsConfig'
enabled_custom_case_types:
description: List of enabled custom case type IDs.
items:
@@ -88170,7 +88231,7 @@ components:
description: Whether the project is restricted.
type: boolean
settings:
- $ref: "#/components/schemas/ProjectSettings"
+ $ref: '#/components/schemas/ProjectSettings'
type: object
ProjectColumnsConfig:
description: Project columns configuration.
@@ -88178,14 +88239,14 @@ components:
columns:
description: List of column configurations for the project board view.
items:
- $ref: "#/components/schemas/ProjectColumnsConfigColumnsItems"
+ $ref: '#/components/schemas/ProjectColumnsConfigColumnsItems'
type: array
type: object
ProjectColumnsConfigColumnsItems:
description: Configuration for a single column in a project board view.
properties:
sort:
- $ref: "#/components/schemas/ProjectColumnsConfigColumnsItemsSort"
+ $ref: '#/components/schemas/ProjectColumnsConfigColumnsItemsSort'
sort_field:
description: The field used to sort items in this column.
type: string
@@ -88208,9 +88269,9 @@ components:
description: Project create.
properties:
attributes:
- $ref: "#/components/schemas/ProjectCreateAttributes"
+ $ref: '#/components/schemas/ProjectCreateAttributes'
type:
- $ref: "#/components/schemas/ProjectResourceType"
+ $ref: '#/components/schemas/ProjectResourceType'
required:
- attributes
- type
@@ -88243,7 +88304,7 @@ components:
description: Project create request.
properties:
data:
- $ref: "#/components/schemas/ProjectCreate"
+ $ref: '#/components/schemas/ProjectCreate'
required:
- data
type: object
@@ -88255,7 +88316,7 @@ components:
example: "e555e290-ed65-49bd-ae18-8acbfcf18db7"
type: string
type:
- $ref: "#/components/schemas/ProjectFavoriteResourceType"
+ $ref: '#/components/schemas/ProjectFavoriteResourceType'
required:
- id
- type
@@ -88275,7 +88336,7 @@ components:
data:
description: List of project favorites.
items:
- $ref: "#/components/schemas/ProjectFavorite"
+ $ref: '#/components/schemas/ProjectFavorite'
type: array
required:
- data
@@ -88319,7 +88380,7 @@ components:
description: Relationship to project.
properties:
data:
- $ref: "#/components/schemas/ProjectRelationshipData"
+ $ref: '#/components/schemas/ProjectRelationshipData'
required:
- data
type: object
@@ -88331,7 +88392,7 @@ components:
example: "e555e290-ed65-49bd-ae18-8acbfcf18db7"
type: string
type:
- $ref: "#/components/schemas/ProjectResourceType"
+ $ref: '#/components/schemas/ProjectResourceType'
required:
- id
- type
@@ -88340,9 +88401,9 @@ components:
description: Project relationships.
properties:
member_team:
- $ref: "#/components/schemas/RelationshipToTeamLinks"
+ $ref: '#/components/schemas/RelationshipToTeamLinks'
member_user:
- $ref: "#/components/schemas/UsersRelationship"
+ $ref: '#/components/schemas/UsersRelationship'
type: object
ProjectResourceType:
default: project
@@ -88357,35 +88418,35 @@ components:
description: Project response.
properties:
data:
- $ref: "#/components/schemas/Project"
+ $ref: '#/components/schemas/Project'
type: object
ProjectSettings:
description: Project settings.
properties:
auto_close_inactive_cases:
- $ref: "#/components/schemas/AutoCloseInactiveCases"
+ $ref: '#/components/schemas/AutoCloseInactiveCases'
auto_transition_assigned_cases:
- $ref: "#/components/schemas/AutoTransitionAssignedCases"
+ $ref: '#/components/schemas/AutoTransitionAssignedCases'
integration_incident:
- $ref: "#/components/schemas/IntegrationIncident"
+ $ref: '#/components/schemas/IntegrationIncident'
integration_jira:
- $ref: "#/components/schemas/IntegrationJira"
+ $ref: '#/components/schemas/IntegrationJira'
integration_monitor:
- $ref: "#/components/schemas/IntegrationMonitor"
+ $ref: '#/components/schemas/IntegrationMonitor'
integration_on_call:
- $ref: "#/components/schemas/IntegrationOnCall"
+ $ref: '#/components/schemas/IntegrationOnCall'
integration_service_now:
- $ref: "#/components/schemas/IntegrationServiceNow"
+ $ref: '#/components/schemas/IntegrationServiceNow'
notification:
- $ref: "#/components/schemas/ProjectNotificationSettings"
+ $ref: '#/components/schemas/ProjectNotificationSettings'
type: object
ProjectUpdate:
description: Project update.
properties:
attributes:
- $ref: "#/components/schemas/ProjectUpdateAttributes"
+ $ref: '#/components/schemas/ProjectUpdateAttributes'
type:
- $ref: "#/components/schemas/ProjectResourceType"
+ $ref: '#/components/schemas/ProjectResourceType'
required:
- type
type: object
@@ -88393,7 +88454,7 @@ components:
description: Project update attributes.
properties:
columns_config:
- $ref: "#/components/schemas/ProjectColumnsConfig"
+ $ref: '#/components/schemas/ProjectColumnsConfig'
enabled_custom_case_types:
description: List of enabled custom case type IDs.
items:
@@ -88404,7 +88465,7 @@ components:
description: Project name.
type: string
settings:
- $ref: "#/components/schemas/ProjectSettings"
+ $ref: '#/components/schemas/ProjectSettings'
team_uuid:
description: Team UUID to associate with the project.
type: string
@@ -88413,7 +88474,7 @@ components:
description: Project update request.
properties:
data:
- $ref: "#/components/schemas/ProjectUpdate"
+ $ref: '#/components/schemas/ProjectUpdate'
required:
- data
type: object
@@ -88421,12 +88482,12 @@ components:
description: Projected Cost data.
properties:
attributes:
- $ref: "#/components/schemas/ProjectedCostAttributes"
+ $ref: '#/components/schemas/ProjectedCostAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/ProjectedCostType"
+ $ref: '#/components/schemas/ProjectedCostType'
type: object
ProjectedCostAttributes:
description: Projected Cost attributes data.
@@ -88440,7 +88501,7 @@ components:
charges:
description: List of charges data reported for the requested month.
items:
- $ref: "#/components/schemas/ChargebackBreakdown"
+ $ref: '#/components/schemas/ChargebackBreakdown'
type: array
date:
description: The month requested.
@@ -88466,7 +88527,7 @@ components:
data:
description: Response containing Projected Cost.
items:
- $ref: "#/components/schemas/ProjectedCost"
+ $ref: '#/components/schemas/ProjectedCost'
type: array
type: object
ProjectedCostType:
@@ -88484,7 +88545,7 @@ components:
data:
description: Projects response data.
items:
- $ref: "#/components/schemas/Project"
+ $ref: '#/components/schemas/Project'
type: array
type: object
PrunedTraceAttributes:
@@ -88503,7 +88564,7 @@ components:
maximum: 2147483647
type: integer
summarized_trace:
- $ref: "#/components/schemas/SummarizedTrace"
+ $ref: '#/components/schemas/SummarizedTrace'
required:
- summarized_trace
- is_truncated
@@ -88513,13 +88574,13 @@ components:
description: A pruned trace resource document.
properties:
attributes:
- $ref: "#/components/schemas/PrunedTraceAttributes"
+ $ref: '#/components/schemas/PrunedTraceAttributes'
id:
description: The full 128-bit trace ID, encoded as a 32-character hexadecimal string.
example: "0000000000000000abc1230000000000"
type: string
type:
- $ref: "#/components/schemas/PrunedTraceType"
+ $ref: '#/components/schemas/PrunedTraceType'
required:
- id
- type
@@ -88529,7 +88590,7 @@ components:
description: Response containing a single pruned trace.
properties:
data:
- $ref: "#/components/schemas/PrunedTraceData"
+ $ref: '#/components/schemas/PrunedTraceData'
required:
- data
type: object
@@ -88545,15 +88606,15 @@ components:
description: The response object after an app is successfully published.
properties:
data:
- $ref: "#/components/schemas/Deployment"
+ $ref: '#/components/schemas/Deployment'
type: object
PublishFormData:
description: The data for publishing a form version.
properties:
attributes:
- $ref: "#/components/schemas/PublishFormDataAttributes"
+ $ref: '#/components/schemas/PublishFormDataAttributes'
type:
- $ref: "#/components/schemas/FormPublicationType"
+ $ref: '#/components/schemas/FormPublicationType'
required:
- type
- attributes
@@ -88573,7 +88634,7 @@ components:
description: A request to publish a form version.
properties:
data:
- $ref: "#/components/schemas/PublishFormData"
+ $ref: '#/components/schemas/PublishFormData'
required:
- data
type: object
@@ -88592,7 +88653,7 @@ components:
data:
description: An array of data objects containing the identifiers of the successfully inserted items.
items:
- $ref: "#/components/schemas/PutAppsDatastoreItemResponseData"
+ $ref: '#/components/schemas/PutAppsDatastoreItemResponseData'
maxItems: 100
type: array
required:
@@ -88605,7 +88666,7 @@ components:
description: The unique identifier assigned to the inserted item.
type: string
type:
- $ref: "#/components/schemas/DatastoreItemsDataType"
+ $ref: '#/components/schemas/DatastoreItemsDataType'
required:
- type
type: object
@@ -88613,16 +88674,16 @@ components:
description: Put request for a notification rule.
properties:
data:
- $ref: "#/components/schemas/IncidentNotificationRuleUpdateData"
+ $ref: '#/components/schemas/IncidentNotificationRuleUpdateData'
required:
- data
type: object
Query:
description: A data query used by an app. This can take the form of an external action, a data transformation, or a state variable.
oneOf:
- - $ref: "#/components/schemas/ActionQuery"
- - $ref: "#/components/schemas/DataTransform"
- - $ref: "#/components/schemas/StateVariable"
+ - $ref: '#/components/schemas/ActionQuery'
+ - $ref: '#/components/schemas/DataTransform'
+ - $ref: '#/components/schemas/StateVariable'
QueryAccountRequest:
description: Request body for querying accounts with optional filtering, column selection, and sorting.
example:
@@ -88647,18 +88708,18 @@ components:
type: query_account_request
properties:
data:
- $ref: "#/components/schemas/QueryAccountRequestData"
+ $ref: '#/components/schemas/QueryAccountRequestData'
type: object
QueryAccountRequestData:
description: The data object containing the resource type and attributes for querying accounts.
properties:
attributes:
- $ref: "#/components/schemas/QueryAccountRequestDataAttributes"
+ $ref: '#/components/schemas/QueryAccountRequestDataAttributes'
id:
description: Unique identifier for the query account request resource.
type: string
type:
- $ref: "#/components/schemas/QueryAccountRequestDataType"
+ $ref: '#/components/schemas/QueryAccountRequestDataType'
required:
- type
type: object
@@ -88679,7 +88740,7 @@ components:
type: string
type: array
sort:
- $ref: "#/components/schemas/QueryAccountRequestDataAttributesSort"
+ $ref: '#/components/schemas/QueryAccountRequestDataAttributesSort'
wildcard_search_term:
description: Free-text term used for wildcard search across account attribute values.
type: string
@@ -88729,18 +88790,18 @@ components:
type: query_event_filtered_users_request
properties:
data:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequestData"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequestData'
type: object
QueryEventFilteredUsersRequestData:
description: The data object containing the resource type and attributes for querying event-filtered users.
properties:
attributes:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributes"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributes'
id:
description: Unique identifier for the query event filtered users request resource.
type: string
type:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataType"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataType'
required:
- type
type: object
@@ -88748,7 +88809,7 @@ components:
description: Attributes for filtering users by both user properties and event platform activity.
properties:
event_query:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery'
include_row_count:
description: Whether to include the total count of matching users in the response.
type: boolean
@@ -88773,7 +88834,7 @@ components:
description: The event platform query expression for filtering users by their event activity.
type: string
time_frame:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame'
type: object
QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame:
description: The time window defining the start and end of the event query period as Unix timestamps.
@@ -88804,7 +88865,7 @@ components:
example: "a+b"
type: string
limit:
- $ref: "#/components/schemas/FormulaLimit"
+ $ref: '#/components/schemas/FormulaLimit'
required:
- formula
type: object
@@ -88852,18 +88913,18 @@ components:
type: query_response
properties:
data:
- $ref: "#/components/schemas/QueryResponseData"
+ $ref: '#/components/schemas/QueryResponseData'
type: object
QueryResponseData:
description: The data object containing the resource type and attributes of the query response.
properties:
attributes:
- $ref: "#/components/schemas/QueryResponseDataAttributes"
+ $ref: '#/components/schemas/QueryResponseDataAttributes'
id:
description: Unique identifier for the query response resource.
type: string
type:
- $ref: "#/components/schemas/QueryResponseDataType"
+ $ref: '#/components/schemas/QueryResponseDataType'
required:
- type
type: object
@@ -88924,18 +88985,18 @@ components:
type: query_users_request
properties:
data:
- $ref: "#/components/schemas/QueryUsersRequestData"
+ $ref: '#/components/schemas/QueryUsersRequestData'
type: object
QueryUsersRequestData:
description: The data object containing the resource type and attributes for querying users.
properties:
attributes:
- $ref: "#/components/schemas/QueryUsersRequestDataAttributes"
+ $ref: '#/components/schemas/QueryUsersRequestDataAttributes'
id:
description: Unique identifier for the query users request resource.
type: string
type:
- $ref: "#/components/schemas/QueryUsersRequestDataType"
+ $ref: '#/components/schemas/QueryUsersRequestDataType'
required:
- type
type: object
@@ -88956,7 +89017,7 @@ components:
type: string
type: array
sort:
- $ref: "#/components/schemas/QueryUsersRequestDataAttributesSort"
+ $ref: '#/components/schemas/QueryUsersRequestDataAttributesSort'
wildcard_search_term:
description: Free-text term used for wildcard search across user attribute values.
type: string
@@ -88983,9 +89044,9 @@ components:
RUMAggregateBucketValue:
description: A bucket value, can be either a timeseries or a single value.
oneOf:
- - $ref: "#/components/schemas/RUMAggregateBucketValueSingleString"
- - $ref: "#/components/schemas/RUMAggregateBucketValueSingleNumber"
- - $ref: "#/components/schemas/RUMAggregateBucketValueTimeseries"
+ - $ref: '#/components/schemas/RUMAggregateBucketValueSingleString'
+ - $ref: '#/components/schemas/RUMAggregateBucketValueSingleNumber'
+ - $ref: '#/components/schemas/RUMAggregateBucketValueTimeseries'
RUMAggregateBucketValueSingleNumber:
description: A single number value.
format: double
@@ -88996,7 +89057,7 @@ components:
RUMAggregateBucketValueTimeseries:
description: A timeseries array.
items:
- $ref: "#/components/schemas/RUMAggregateBucketValueTimeseriesPoint"
+ $ref: '#/components/schemas/RUMAggregateBucketValueTimeseriesPoint'
type: array
x-generate-alias-as-model: true
RUMAggregateBucketValueTimeseriesPoint:
@@ -89019,34 +89080,34 @@ components:
compute:
description: The list of metrics or timeseries to compute for the retrieved buckets.
items:
- $ref: "#/components/schemas/RUMCompute"
+ $ref: '#/components/schemas/RUMCompute'
type: array
filter:
- $ref: "#/components/schemas/RUMQueryFilter"
+ $ref: '#/components/schemas/RUMQueryFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/RUMGroupBy"
+ $ref: '#/components/schemas/RUMGroupBy'
type: array
options:
- $ref: "#/components/schemas/RUMQueryOptions"
+ $ref: '#/components/schemas/RUMQueryOptions'
page:
- $ref: "#/components/schemas/RUMQueryPageOptions"
+ $ref: '#/components/schemas/RUMQueryPageOptions'
type: object
RUMAggregateSort:
description: A sort rule.
example: {"aggregation": "count", "order": "asc"}
properties:
aggregation:
- $ref: "#/components/schemas/RUMAggregationFunction"
+ $ref: '#/components/schemas/RUMAggregationFunction'
metric:
description: The metric to sort by (only used for `type=measure`).
example: "@duration"
type: string
order:
- $ref: "#/components/schemas/RUMSortOrder"
+ $ref: '#/components/schemas/RUMSortOrder'
type:
- $ref: "#/components/schemas/RUMAggregateSortType"
+ $ref: '#/components/schemas/RUMAggregateSortType'
type: object
RUMAggregateSortType:
default: "alphabetical"
@@ -89060,7 +89121,7 @@ components:
buckets:
description: The list of matching buckets, one item per bucket.
items:
- $ref: "#/components/schemas/RUMBucketResponse"
+ $ref: '#/components/schemas/RUMBucketResponse'
type: array
type: object
RUMAggregationFunction:
@@ -89073,23 +89134,23 @@ components:
description: The response object for the RUM events aggregate API endpoint.
properties:
data:
- $ref: "#/components/schemas/RUMAggregationBucketsResponse"
+ $ref: '#/components/schemas/RUMAggregationBucketsResponse'
links:
- $ref: "#/components/schemas/RUMResponseLinks"
+ $ref: '#/components/schemas/RUMResponseLinks'
meta:
- $ref: "#/components/schemas/RUMResponseMetadata"
+ $ref: '#/components/schemas/RUMResponseMetadata'
type: object
RUMApplication:
description: RUM application.
properties:
attributes:
- $ref: "#/components/schemas/RUMApplicationAttributes"
+ $ref: '#/components/schemas/RUMApplicationAttributes'
id:
description: RUM application ID.
example: abcd1234-0000-0000-abcd-1234abcd5678
type: string
type:
- $ref: "#/components/schemas/RUMApplicationType"
+ $ref: '#/components/schemas/RUMApplicationType'
required:
- attributes
- id
@@ -89139,7 +89200,7 @@ components:
maximum: 2147483647
type: integer
product_scales:
- $ref: "#/components/schemas/RUMProductScales"
+ $ref: '#/components/schemas/RUMProductScales'
remote_config_id:
description: ID of the RUM SDK remote configuration for the application, if one exists.
example: abc12345-1234-5678-abcd-ef1234567890
@@ -89172,9 +89233,9 @@ components:
description: RUM application creation.
properties:
attributes:
- $ref: "#/components/schemas/RUMApplicationCreateAttributes"
+ $ref: '#/components/schemas/RUMApplicationCreateAttributes'
type:
- $ref: "#/components/schemas/RUMApplicationCreateType"
+ $ref: '#/components/schemas/RUMApplicationCreateType'
required:
- attributes
- type
@@ -89187,9 +89248,9 @@ components:
example: my_new_rum_application
type: string
product_analytics_retention_state:
- $ref: "#/components/schemas/RUMProductAnalyticsRetentionState"
+ $ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
rum_event_processing_state:
- $ref: "#/components/schemas/RUMEventProcessingState"
+ $ref: '#/components/schemas/RUMEventProcessingState'
type:
description: "Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`."
example: browser
@@ -89201,7 +89262,7 @@ components:
description: RUM application creation request attributes.
properties:
data:
- $ref: "#/components/schemas/RUMApplicationCreate"
+ $ref: '#/components/schemas/RUMApplicationCreate'
required:
- data
type: object
@@ -89218,13 +89279,13 @@ components:
description: RUM application list.
properties:
attributes:
- $ref: "#/components/schemas/RUMApplicationListAttributes"
+ $ref: '#/components/schemas/RUMApplicationListAttributes'
id:
description: RUM application ID.
example: abcd1234-0000-0000-abcd-1234abcd5678
type: string
type:
- $ref: "#/components/schemas/RUMApplicationListType"
+ $ref: '#/components/schemas/RUMApplicationListType'
required:
- attributes
- type
@@ -89263,7 +89324,7 @@ components:
maximum: 2147483647
type: integer
product_scales:
- $ref: "#/components/schemas/RUMProductScales"
+ $ref: '#/components/schemas/RUMProductScales'
type:
description: Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`.
example: browser
@@ -89300,7 +89361,7 @@ components:
description: RUM application response.
properties:
data:
- $ref: "#/components/schemas/RUMApplication"
+ $ref: '#/components/schemas/RUMApplication'
type: object
RUMApplicationType:
default: rum_application
@@ -89315,13 +89376,13 @@ components:
description: RUM application update.
properties:
attributes:
- $ref: "#/components/schemas/RUMApplicationUpdateAttributes"
+ $ref: '#/components/schemas/RUMApplicationUpdateAttributes'
id:
description: RUM application ID.
example: abcd1234-0000-0000-abcd-1234abcd5678
type: string
type:
- $ref: "#/components/schemas/RUMApplicationUpdateType"
+ $ref: '#/components/schemas/RUMApplicationUpdateType'
required:
- id
- type
@@ -89334,9 +89395,9 @@ components:
example: updated_name_for_my_existing_rum_application
type: string
product_analytics_retention_state:
- $ref: "#/components/schemas/RUMProductAnalyticsRetentionState"
+ $ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
rum_event_processing_state:
- $ref: "#/components/schemas/RUMEventProcessingState"
+ $ref: '#/components/schemas/RUMEventProcessingState'
type:
description: "Type of the RUM application. Supported values are `browser`, `ios`, `android`, `react-native`, `flutter`, `roku`, `electron`, `unity`, `kotlin-multiplatform`."
example: browser
@@ -89346,7 +89407,7 @@ components:
description: RUM application update request.
properties:
data:
- $ref: "#/components/schemas/RUMApplicationUpdate"
+ $ref: '#/components/schemas/RUMApplicationUpdate'
required:
- data
type: object
@@ -89365,7 +89426,7 @@ components:
data:
description: RUM applications array response.
items:
- $ref: "#/components/schemas/RUMApplicationList"
+ $ref: '#/components/schemas/RUMApplicationList'
type: array
type: object
RUMBucketResponse:
@@ -89380,7 +89441,7 @@ components:
type: object
computes:
additionalProperties:
- $ref: "#/components/schemas/RUMAggregateBucketValue"
+ $ref: '#/components/schemas/RUMAggregateBucketValue'
description: A map of the metric name to value for regular compute, or a list of values for a timeseries.
type: object
type: object
@@ -89388,7 +89449,7 @@ components:
description: A compute rule to compute metrics or timeseries.
properties:
aggregation:
- $ref: "#/components/schemas/RUMAggregationFunction"
+ $ref: '#/components/schemas/RUMAggregationFunction'
interval:
description: |-
The time buckets' size (only used for type=timeseries)
@@ -89400,7 +89461,7 @@ components:
example: "@duration"
type: string
type:
- $ref: "#/components/schemas/RUMComputeType"
+ $ref: '#/components/schemas/RUMComputeType'
required:
- aggregation
type: object
@@ -89414,13 +89475,13 @@ components:
description: Object description of a RUM event after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/RUMEventAttributes"
+ $ref: '#/components/schemas/RUMEventAttributes'
id:
description: Unique ID of the event.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/RUMEventType"
+ $ref: '#/components/schemas/RUMEventType'
type: object
RUMEventAttributes:
description: JSON object containing all event attributes and their associated values.
@@ -89459,7 +89520,7 @@ components:
format: int64
type: integer
state:
- $ref: "#/components/schemas/RUMEventProcessingState"
+ $ref: '#/components/schemas/RUMEventProcessingState'
type: object
RUMEventProcessingState:
description: Configures which RUM events are processed and stored for the application.
@@ -89492,12 +89553,12 @@ components:
data:
description: Array of events matching the request.
items:
- $ref: "#/components/schemas/RUMEvent"
+ $ref: '#/components/schemas/RUMEvent'
type: array
links:
- $ref: "#/components/schemas/RUMResponseLinks"
+ $ref: '#/components/schemas/RUMResponseLinks'
meta:
- $ref: "#/components/schemas/RUMResponseMetadata"
+ $ref: '#/components/schemas/RUMResponseMetadata'
type: object
RUMGroupBy:
description: A group-by rule.
@@ -89507,18 +89568,18 @@ components:
example: "@view.time_spent"
type: string
histogram:
- $ref: "#/components/schemas/RUMGroupByHistogram"
+ $ref: '#/components/schemas/RUMGroupByHistogram'
limit:
default: 10
description: The maximum buckets to return for this group-by.
format: int64
type: integer
missing:
- $ref: "#/components/schemas/RUMGroupByMissing"
+ $ref: '#/components/schemas/RUMGroupByMissing'
sort:
- $ref: "#/components/schemas/RUMAggregateSort"
+ $ref: '#/components/schemas/RUMAggregateSort'
total:
- $ref: "#/components/schemas/RUMGroupByTotal"
+ $ref: '#/components/schemas/RUMGroupByTotal'
required:
- facet
type: object
@@ -89554,8 +89615,8 @@ components:
RUMGroupByMissing:
description: The value to use for logs that don't have the facet used to group by.
oneOf:
- - $ref: "#/components/schemas/RUMGroupByMissingString"
- - $ref: "#/components/schemas/RUMGroupByMissingNumber"
+ - $ref: '#/components/schemas/RUMGroupByMissingString'
+ - $ref: '#/components/schemas/RUMGroupByMissingNumber'
RUMGroupByMissingNumber:
description: The missing value to use if there is a number valued facet.
format: double
@@ -89568,9 +89629,9 @@ components:
description: |-
A resulting object to put the given computes in over all the matching records.
oneOf:
- - $ref: "#/components/schemas/RUMGroupByTotalBoolean"
- - $ref: "#/components/schemas/RUMGroupByTotalString"
- - $ref: "#/components/schemas/RUMGroupByTotalNumber"
+ - $ref: '#/components/schemas/RUMGroupByTotalBoolean'
+ - $ref: '#/components/schemas/RUMGroupByTotalString'
+ - $ref: '#/components/schemas/RUMGroupByTotalNumber'
RUMGroupByTotalBoolean:
description: If set to true, creates an additional bucket labeled "$facet_total".
type: boolean
@@ -89585,7 +89646,7 @@ components:
description: The request body for creating a RUM operation.
properties:
data:
- $ref: "#/components/schemas/RUMOperationCreateRequestData"
+ $ref: '#/components/schemas/RUMOperationCreateRequestData'
required:
- data
type: object
@@ -89593,9 +89654,9 @@ components:
description: The data object for creating a RUM operation.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationRequestAttributes"
+ $ref: '#/components/schemas/RUMOperationRequestAttributes'
type:
- $ref: "#/components/schemas/RUMOperationType"
+ $ref: '#/components/schemas/RUMOperationType'
required:
- type
- attributes
@@ -89614,7 +89675,7 @@ components:
readOnly: true
type: string
kind:
- $ref: "#/components/schemas/RUMOperationJourneyCompositeRuleKind"
+ $ref: '#/components/schemas/RUMOperationJourneyCompositeRuleKind'
max_window_ms:
description: The maximum time window, in milliseconds, in which all predicates must match.
example: 30000
@@ -89623,7 +89684,7 @@ components:
predicates:
description: The list of predicates that must be matched by RUM events.
items:
- $ref: "#/components/schemas/RUMOperationJourneyPredicate"
+ $ref: '#/components/schemas/RUMOperationJourneyPredicate'
type: array
required:
- kind
@@ -89671,7 +89732,7 @@ components:
rum_steps:
description: The ordered list of steps composing the RUM journey.
items:
- $ref: "#/components/schemas/RUMOperationJourneyStep"
+ $ref: '#/components/schemas/RUMOperationJourneyStep'
type: array
required:
- rum_steps
@@ -89682,14 +89743,14 @@ components:
or through a `composite` rule; the two are mutually exclusive.
properties:
composite:
- $ref: "#/components/schemas/RUMOperationJourneyCompositeRule"
+ $ref: '#/components/schemas/RUMOperationJourneyCompositeRule'
nodes:
description: The list of nodes that can match this step. Mutually exclusive with `composite`.
items:
- $ref: "#/components/schemas/RUMOperationJourneyNode"
+ $ref: '#/components/schemas/RUMOperationJourneyNode'
type: array
type:
- $ref: "#/components/schemas/RUMOperationJourneyStepType"
+ $ref: '#/components/schemas/RUMOperationJourneyStepType'
required:
- type
type: object
@@ -89735,7 +89796,7 @@ components:
type: string
type: array
journey_rum:
- $ref: "#/components/schemas/RUMOperationJourneyRum"
+ $ref: '#/components/schemas/RUMOperationJourneyRum'
name:
description: The unique name of the RUM operation. Must not contain spaces.
example: checkout_completed
@@ -89756,7 +89817,7 @@ components:
description: The response for a single RUM operation.
properties:
data:
- $ref: "#/components/schemas/RUMOperationResponseData"
+ $ref: '#/components/schemas/RUMOperationResponseData'
required:
- data
type: object
@@ -89778,7 +89839,7 @@ components:
readOnly: true
type: string
created_by:
- $ref: "#/components/schemas/RUMOperationUser"
+ $ref: '#/components/schemas/RUMOperationUser'
description:
description: A description of the RUM operation.
nullable: true
@@ -89793,7 +89854,7 @@ components:
type: string
type: array
journey_rum:
- $ref: "#/components/schemas/RUMOperationJourneyRum"
+ $ref: '#/components/schemas/RUMOperationJourneyRum'
name:
description: The unique name of the RUM operation. Must not contain spaces.
example: checkout_completed
@@ -89817,7 +89878,7 @@ components:
readOnly: true
type: string
updated_by:
- $ref: "#/components/schemas/RUMOperationUser"
+ $ref: '#/components/schemas/RUMOperationUser'
required:
- name
- tags
@@ -89827,14 +89888,14 @@ components:
description: The data object in a RUM operation response.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationResponseAttributes"
+ $ref: '#/components/schemas/RUMOperationResponseAttributes'
id:
description: The unique identifier of the RUM operation.
example: "abc12345-1234-5678-abcd-ef1234567890"
readOnly: true
type: string
type:
- $ref: "#/components/schemas/RUMOperationType"
+ $ref: '#/components/schemas/RUMOperationType'
required:
- id
- type
@@ -89844,7 +89905,7 @@ components:
description: The request body for creating a RUM operation strong link.
properties:
data:
- $ref: "#/components/schemas/RUMOperationStrongLinkCreateRequestData"
+ $ref: '#/components/schemas/RUMOperationStrongLinkCreateRequestData'
required:
- data
type: object
@@ -89875,7 +89936,7 @@ components:
required. If no operation with this name exists, a stub operation is created.
type: string
status:
- $ref: "#/components/schemas/RUMOperationStrongLinkStatus"
+ $ref: '#/components/schemas/RUMOperationStrongLinkStatus'
tags:
description: A list of tags associated with the strong link.
items:
@@ -89888,9 +89949,9 @@ components:
description: The data object for creating a RUM operation strong link.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationStrongLinkCreateRequestAttributes"
+ $ref: '#/components/schemas/RUMOperationStrongLinkCreateRequestAttributes'
type:
- $ref: "#/components/schemas/RUMOperationStrongLinkType"
+ $ref: '#/components/schemas/RUMOperationStrongLinkType'
required:
- type
- attributes
@@ -89899,7 +89960,7 @@ components:
description: The response for a single RUM operation strong link.
properties:
data:
- $ref: "#/components/schemas/RUMOperationStrongLinkResponseData"
+ $ref: '#/components/schemas/RUMOperationStrongLinkResponseData'
required:
- data
type: object
@@ -89926,7 +89987,7 @@ components:
readOnly: true
type: string
status:
- $ref: "#/components/schemas/RUMOperationStrongLinkStatus"
+ $ref: '#/components/schemas/RUMOperationStrongLinkStatus'
tags:
description: A list of tags associated with the strong link.
items:
@@ -89947,14 +90008,14 @@ components:
description: The data object in a RUM operation strong link response.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationStrongLinkResponseAttributes"
+ $ref: '#/components/schemas/RUMOperationStrongLinkResponseAttributes'
id:
description: The unique identifier of the strong link, formatted as `:`.
example: "abc12345-1234-5678-abcd-ef1234567890:feature-123"
readOnly: true
type: string
type:
- $ref: "#/components/schemas/RUMOperationStrongLinkType"
+ $ref: '#/components/schemas/RUMOperationStrongLinkType'
required:
- id
- type
@@ -89984,7 +90045,7 @@ components:
description: The request body for updating a RUM operation strong link.
properties:
data:
- $ref: "#/components/schemas/RUMOperationStrongLinkUpdateRequestData"
+ $ref: '#/components/schemas/RUMOperationStrongLinkUpdateRequestData'
required:
- data
type: object
@@ -89992,7 +90053,7 @@ components:
description: Attributes for updating a RUM operation strong link.
properties:
status:
- $ref: "#/components/schemas/RUMOperationStrongLinkUpdateStatus"
+ $ref: '#/components/schemas/RUMOperationStrongLinkUpdateStatus'
required:
- status
type: object
@@ -90000,9 +90061,9 @@ components:
description: The data object for updating a RUM operation strong link.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationStrongLinkUpdateRequestAttributes"
+ $ref: '#/components/schemas/RUMOperationStrongLinkUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/RUMOperationStrongLinkType"
+ $ref: '#/components/schemas/RUMOperationStrongLinkType'
required:
- type
- attributes
@@ -90022,10 +90083,10 @@ components:
properties:
data:
items:
- $ref: "#/components/schemas/RUMOperationStrongLinkResponseData"
+ $ref: '#/components/schemas/RUMOperationStrongLinkResponseData'
type: array
meta:
- $ref: "#/components/schemas/RUMOperationStrongLinksListResponseMeta"
+ $ref: '#/components/schemas/RUMOperationStrongLinksListResponseMeta'
required:
- data
type: object
@@ -90057,7 +90118,7 @@ components:
description: The request body for updating a RUM operation.
properties:
data:
- $ref: "#/components/schemas/RUMOperationUpdateRequestData"
+ $ref: '#/components/schemas/RUMOperationUpdateRequestData'
required:
- data
type: object
@@ -90065,13 +90126,13 @@ components:
description: The data object for updating a RUM operation.
properties:
attributes:
- $ref: "#/components/schemas/RUMOperationRequestAttributes"
+ $ref: '#/components/schemas/RUMOperationRequestAttributes'
id:
description: The unique identifier of the RUM operation. Must match the ID in the URL path.
example: "abc12345-1234-5678-abcd-ef1234567890"
type: string
type:
- $ref: "#/components/schemas/RUMOperationType"
+ $ref: '#/components/schemas/RUMOperationType'
required:
- id
- type
@@ -90102,10 +90163,10 @@ components:
properties:
data:
items:
- $ref: "#/components/schemas/RUMOperationResponseData"
+ $ref: '#/components/schemas/RUMOperationResponseData'
type: array
meta:
- $ref: "#/components/schemas/RUMOperationsListResponseMeta"
+ $ref: '#/components/schemas/RUMOperationsListResponseMeta'
required:
- data
type: object
@@ -90113,7 +90174,7 @@ components:
description: Metadata for a list of RUM operations.
properties:
page:
- $ref: "#/components/schemas/RUMOperationsListResponseMetaPage"
+ $ref: '#/components/schemas/RUMOperationsListResponseMetaPage'
type: object
RUMOperationsListResponseMetaPage:
description: Pagination metadata for a list of RUM operations.
@@ -90162,7 +90223,7 @@ components:
format: int64
type: integer
state:
- $ref: "#/components/schemas/RUMProductAnalyticsRetentionState"
+ $ref: '#/components/schemas/RUMProductAnalyticsRetentionState'
type: object
RUMProductAnalyticsRetentionState:
description: Controls the retention policy for Product Analytics data derived from RUM events.
@@ -90181,9 +90242,9 @@ components:
description: Product Scales configuration for the RUM application.
properties:
product_analytics_retention_scale:
- $ref: "#/components/schemas/RUMProductAnalyticsRetentionScale"
+ $ref: '#/components/schemas/RUMProductAnalyticsRetentionScale'
rum_event_processing_scale:
- $ref: "#/components/schemas/RUMEventProcessingScale"
+ $ref: '#/components/schemas/RUMEventProcessingScale'
type: object
RUMQueryFilter:
description: The search and filter query settings.
@@ -90255,19 +90316,19 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/RUMResponsePage"
+ $ref: '#/components/schemas/RUMResponsePage'
request_id:
description: The identifier of the request.
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/RUMResponseStatus"
+ $ref: '#/components/schemas/RUMResponseStatus'
warnings:
description: |-
A list of warnings (non-fatal errors) encountered. Partial results may return if
warnings are present in the response.
items:
- $ref: "#/components/schemas/RUMWarning"
+ $ref: '#/components/schemas/RUMWarning'
type: array
type: object
RUMResponsePage:
@@ -90289,13 +90350,13 @@ components:
description: The request for a RUM events list.
properties:
filter:
- $ref: "#/components/schemas/RUMQueryFilter"
+ $ref: '#/components/schemas/RUMQueryFilter'
options:
- $ref: "#/components/schemas/RUMQueryOptions"
+ $ref: '#/components/schemas/RUMQueryOptions'
page:
- $ref: "#/components/schemas/RUMQueryPageOptions"
+ $ref: '#/components/schemas/RUMQueryPageOptions'
sort:
- $ref: "#/components/schemas/RUMSort"
+ $ref: '#/components/schemas/RUMSort'
type: object
RUMSort:
description: Sort parameters when querying events.
@@ -90375,7 +90436,7 @@ components:
example: 550e8400-e29b-41d4-a716-446655440000
type: string
platform:
- $ref: "#/components/schemas/SourceMapPlatform"
+ $ref: '#/components/schemas/SourceMapPlatform'
project_path:
description: Path to the project root (max 500 characters).
maxLength: 500
@@ -90387,7 +90448,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/ReactNativeSourceMapFormDataType"
+ $ref: '#/components/schemas/ReactNativeSourceMapFormDataType'
version:
description: Version of the service (1-200 characters).
example: "2.0.0"
@@ -90405,7 +90466,7 @@ components:
description: Multipart form data for uploading React Native source maps for mobile applications.
properties:
event:
- $ref: "#/components/schemas/ReactNativeSourceMapEvent"
+ $ref: '#/components/schemas/ReactNativeSourceMapEvent'
minified_file:
description: The minified JavaScript bundle (optional).
format: binary
@@ -90485,13 +90546,13 @@ components:
description: React Native source map data object.
properties:
attributes:
- $ref: "#/components/schemas/ReactNativeSourcemapAttributes"
+ $ref: '#/components/schemas/ReactNativeSourcemapAttributes'
id:
description: The unique identifier of the source map.
example: "10"
type: string
type:
- $ref: "#/components/schemas/SourcemapDataType"
+ $ref: '#/components/schemas/SourcemapDataType'
required:
- id
- type
@@ -90502,7 +90563,7 @@ components:
description: Used to merge multiple branches into a single branch.
properties:
thresholdType:
- $ref: "#/components/schemas/ReadinessGateThresholdType"
+ $ref: '#/components/schemas/ReadinessGateThresholdType'
required:
- thresholdType
type: object
@@ -90524,28 +90585,28 @@ components:
format: double
type: number
driver:
- $ref: "#/components/schemas/ComponentRecommendation"
+ $ref: '#/components/schemas/ComponentRecommendation'
executor:
- $ref: "#/components/schemas/ComponentRecommendation"
+ $ref: '#/components/schemas/ComponentRecommendation'
required: [driver, executor]
type: object
RecommendationData:
description: JSON:API resource object for SPA Recommendation. Includes type, optional ID, and resource attributes with structured recommendations.
properties:
attributes:
- $ref: "#/components/schemas/RecommendationAttributes"
+ $ref: '#/components/schemas/RecommendationAttributes'
id:
description: Resource identifier for the recommendation. Optional in responses.
type: string
type:
- $ref: "#/components/schemas/RecommendationType"
+ $ref: '#/components/schemas/RecommendationType'
required: [type, attributes]
type: object
RecommendationDocument:
description: JSON:API document containing a single Recommendation resource. Returned by SPA when the Spark Gateway requests recommendations.
properties:
data:
- $ref: "#/components/schemas/RecommendationData"
+ $ref: '#/components/schemas/RecommendationData'
required: [data]
type: object
RecommendationType:
@@ -90571,7 +90632,7 @@ components:
sort:
description: Ordered list of sort clauses applied to the result set.
items:
- $ref: "#/components/schemas/RecommendationsFilterRequestSortItems"
+ $ref: '#/components/schemas/RecommendationsFilterRequestSortItems'
type: array
view:
description: Active view name (for example, `active`, `dismissed`, `open`, `in-progress`, or `completed`).
@@ -90591,7 +90652,7 @@ components:
description: Top-level JSON:API meta object for paginated cost recommendation responses.
properties:
page:
- $ref: "#/components/schemas/RecommendationsPageMetaPage"
+ $ref: '#/components/schemas/RecommendationsPageMetaPage'
type: object
RecommendationsPageMetaPage:
description: Pagination metadata for a page of cost recommendations.
@@ -90680,17 +90741,17 @@ components:
description: The response object after creating an app key registration.
properties:
data:
- $ref: "#/components/schemas/AppKeyRegistrationData"
+ $ref: '#/components/schemas/AppKeyRegistrationData'
type: object
RelationAttributes:
description: Relation attributes.
properties:
from:
- $ref: "#/components/schemas/RelationEntity"
+ $ref: '#/components/schemas/RelationEntity'
to:
- $ref: "#/components/schemas/RelationEntity"
+ $ref: '#/components/schemas/RelationEntity'
type:
- $ref: "#/components/schemas/RelationType"
+ $ref: '#/components/schemas/RelationType'
type: object
RelationEntity:
description: Relation entity reference.
@@ -90736,32 +90797,32 @@ components:
description: Relation relationships.
properties:
fromEntity:
- $ref: "#/components/schemas/RelationToEntity"
+ $ref: '#/components/schemas/RelationToEntity'
toEntity:
- $ref: "#/components/schemas/RelationToEntity"
+ $ref: '#/components/schemas/RelationToEntity'
type: object
RelationResponse:
description: Relation response data.
properties:
attributes:
- $ref: "#/components/schemas/RelationAttributes"
+ $ref: '#/components/schemas/RelationAttributes'
id:
description: Relation ID.
type: string
meta:
- $ref: "#/components/schemas/RelationMeta"
+ $ref: '#/components/schemas/RelationMeta'
relationships:
- $ref: "#/components/schemas/RelationRelationships"
+ $ref: '#/components/schemas/RelationRelationships'
subtype:
description: Relation subtype.
type: string
type:
- $ref: "#/components/schemas/RelationResponseType"
+ $ref: '#/components/schemas/RelationResponseType'
type: object
RelationResponseData:
description: Array of relation responses
items:
- $ref: "#/components/schemas/RelationResponse"
+ $ref: '#/components/schemas/RelationResponse'
type: array
RelationResponseMeta:
description: Relation response metadata.
@@ -90785,9 +90846,9 @@ components:
description: Relation to entity.
properties:
data:
- $ref: "#/components/schemas/RelationshipItem"
+ $ref: '#/components/schemas/RelationshipItem'
meta:
- $ref: "#/components/schemas/EntityMeta"
+ $ref: '#/components/schemas/EntityMeta'
type: object
RelationType:
description: Supported relation types.
@@ -90817,7 +90878,7 @@ components:
RelationshipArray:
description: Relationships.
items:
- $ref: "#/components/schemas/RelationshipItem"
+ $ref: '#/components/schemas/RelationshipItem'
type: array
RelationshipItem:
description: Relationship entry.
@@ -90833,7 +90894,7 @@ components:
description: Relationship to the access token's owner.
properties:
data:
- $ref: "#/components/schemas/RelationshipToAccessTokenOwnerData"
+ $ref: '#/components/schemas/RelationshipToAccessTokenOwnerData'
required:
- data
type: object
@@ -90845,7 +90906,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/AccessTokenOwnerType"
+ $ref: '#/components/schemas/AccessTokenOwnerType'
required:
- id
- type
@@ -90854,7 +90915,7 @@ components:
description: Relationship to incident.
properties:
data:
- $ref: "#/components/schemas/RelationshipToIncidentData"
+ $ref: '#/components/schemas/RelationshipToIncidentData'
required:
- data
type: object
@@ -90865,7 +90926,7 @@ components:
description: |-
An array of incident attachments.
items:
- $ref: "#/components/schemas/RelationshipToIncidentAttachmentData"
+ $ref: '#/components/schemas/RelationshipToIncidentAttachmentData'
type: array
required:
- data
@@ -90878,7 +90939,7 @@ components:
example: "00000000-0000-abcd-1000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentAttachmentType"
+ $ref: '#/components/schemas/IncidentAttachmentType'
required:
- id
- type
@@ -90891,7 +90952,7 @@ components:
example: "00000000-0000-0000-1234-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentType"
+ $ref: '#/components/schemas/IncidentType'
required:
- id
- type
@@ -90904,7 +90965,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentImpactsType"
+ $ref: '#/components/schemas/IncidentImpactsType'
required:
- id
- type
@@ -90915,7 +90976,7 @@ components:
data:
description: An array of incident impacts.
items:
- $ref: "#/components/schemas/RelationshipToIncidentImpactData"
+ $ref: '#/components/schemas/RelationshipToIncidentImpactData'
type: array
required:
- data
@@ -90929,7 +90990,7 @@ components:
example: "00000000-abcd-0001-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentIntegrationMetadataType"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataType'
required:
- id
- type
@@ -90942,7 +91003,7 @@ components:
description: Integration metadata relationship array
example: [{"id": "00000000-abcd-0003-0000-000000000000", "type": "incident_integrations"}, {"id": "00000000-abcd-0004-0000-000000000000", "type": "incident_integrations"}]
items:
- $ref: "#/components/schemas/RelationshipToIncidentIntegrationMetadataData"
+ $ref: '#/components/schemas/RelationshipToIncidentIntegrationMetadataData'
type: array
required:
- data
@@ -90951,7 +91012,7 @@ components:
description: A relationship reference to a notification template.
properties:
data:
- $ref: "#/components/schemas/RelationshipToIncidentNotificationTemplateData"
+ $ref: '#/components/schemas/RelationshipToIncidentNotificationTemplateData'
required:
- data
type: object
@@ -90964,7 +91025,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/IncidentNotificationTemplateType"
+ $ref: '#/components/schemas/IncidentNotificationTemplateType'
required:
- id
- type
@@ -90974,7 +91035,7 @@ components:
example: {"data": {"id": "00000000-0000-abcd-3000-000000000000", "type": "incident_postmortems"}}
properties:
data:
- $ref: "#/components/schemas/RelationshipToIncidentPostmortemData"
+ $ref: '#/components/schemas/RelationshipToIncidentPostmortemData'
required:
- data
type: object
@@ -90987,7 +91048,7 @@ components:
example: "00000000-0000-abcd-1000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentPostmortemType"
+ $ref: '#/components/schemas/IncidentPostmortemType'
required:
- id
- type
@@ -90996,7 +91057,7 @@ components:
description: Relationship to incident request
properties:
data:
- $ref: "#/components/schemas/IncidentRelationshipData"
+ $ref: '#/components/schemas/IncidentRelationshipData'
required:
- data
type: object
@@ -91008,7 +91069,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentRespondersType"
+ $ref: '#/components/schemas/IncidentRespondersType'
required:
- id
- type
@@ -91019,7 +91080,7 @@ components:
data:
description: An array of incident responders.
items:
- $ref: "#/components/schemas/RelationshipToIncidentResponderData"
+ $ref: '#/components/schemas/RelationshipToIncidentResponderData'
type: array
required:
- data
@@ -91028,7 +91089,7 @@ components:
description: Relationship to an incident type.
properties:
data:
- $ref: "#/components/schemas/RelationshipToIncidentTypeData"
+ $ref: '#/components/schemas/RelationshipToIncidentTypeData'
required:
- data
type: object
@@ -91040,7 +91101,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentTypeType"
+ $ref: '#/components/schemas/IncidentTypeType'
required:
- id
- type
@@ -91053,7 +91114,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/IncidentUserDefinedFieldType"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldType'
required:
- id
- type
@@ -91064,7 +91125,7 @@ components:
data:
description: An array of user defined fields.
items:
- $ref: "#/components/schemas/RelationshipToIncidentUserDefinedFieldData"
+ $ref: '#/components/schemas/RelationshipToIncidentUserDefinedFieldData'
type: array
required:
- data
@@ -91073,7 +91134,7 @@ components:
description: Relationship to an organization.
properties:
data:
- $ref: "#/components/schemas/RelationshipToOrganizationData"
+ $ref: '#/components/schemas/RelationshipToOrganizationData'
required:
- data
type: object
@@ -91085,7 +91146,7 @@ components:
example: "00000000-0000-beef-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/OrganizationsType"
+ $ref: '#/components/schemas/OrganizationsType'
required:
- id
- type
@@ -91097,7 +91158,7 @@ components:
description: Relationships to organization objects.
example: []
items:
- $ref: "#/components/schemas/RelationshipToOrganizationData"
+ $ref: '#/components/schemas/RelationshipToOrganizationData'
type: array
required:
- data
@@ -91106,21 +91167,21 @@ components:
description: The JSON:API relationship to a scorecard outcome.
properties:
data:
- $ref: "#/components/schemas/RelationshipToOutcomeData"
+ $ref: '#/components/schemas/RelationshipToOutcomeData'
type: object
RelationshipToOutcomeData:
description: The JSON:API relationship to an outcome, which returns the related rule id.
properties:
id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
RelationshipToPermission:
description: Relationship to a permissions object.
properties:
data:
- $ref: "#/components/schemas/RelationshipToPermissionData"
+ $ref: '#/components/schemas/RelationshipToPermissionData'
type: object
RelationshipToPermissionData:
description: Relationship to permission object.
@@ -91129,7 +91190,7 @@ components:
description: ID of the permission.
type: string
type:
- $ref: "#/components/schemas/PermissionsType"
+ $ref: '#/components/schemas/PermissionsType'
type: object
RelationshipToPermissions:
description: Relationship to multiple permissions objects.
@@ -91137,14 +91198,14 @@ components:
data:
description: Relationships to permission objects.
items:
- $ref: "#/components/schemas/RelationshipToPermissionData"
+ $ref: '#/components/schemas/RelationshipToPermissionData'
type: array
type: object
RelationshipToRole:
description: Relationship to role.
properties:
data:
- $ref: "#/components/schemas/RelationshipToRoleData"
+ $ref: '#/components/schemas/RelationshipToRoleData'
type: object
RelationshipToRoleData:
description: Relationship to role object.
@@ -91154,7 +91215,7 @@ components:
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
type: object
RelationshipToRoles:
description: Relationship to roles.
@@ -91162,20 +91223,20 @@ components:
data:
description: An array containing type and the unique identifier of a role.
items:
- $ref: "#/components/schemas/RelationshipToRoleData"
+ $ref: '#/components/schemas/RelationshipToRoleData'
type: array
type: object
RelationshipToRule:
description: Scorecard create rule response relationship.
properties:
scorecard:
- $ref: "#/components/schemas/RelationshipToRuleData"
+ $ref: '#/components/schemas/RelationshipToRuleData'
type: object
RelationshipToRuleData:
description: Relationship data for a rule.
properties:
data:
- $ref: "#/components/schemas/RelationshipToRuleDataObject"
+ $ref: '#/components/schemas/RelationshipToRuleDataObject'
type: object
RelationshipToRuleDataObject:
description: Rule relationship data.
@@ -91185,13 +91246,13 @@ components:
example: q8MQxk8TCqrHnWkp
type: string
type:
- $ref: "#/components/schemas/ScorecardType"
+ $ref: '#/components/schemas/ScorecardType'
type: object
RelationshipToSAMLAssertionAttribute:
description: AuthN Mapping relationship to SAML Assertion Attribute.
properties:
data:
- $ref: "#/components/schemas/RelationshipToSAMLAssertionAttributeData"
+ $ref: '#/components/schemas/RelationshipToSAMLAssertionAttributeData'
required:
- data
type: object
@@ -91203,7 +91264,7 @@ components:
example: "0"
type: string
type:
- $ref: "#/components/schemas/SAMLAssertionAttributesType"
+ $ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
@@ -91212,7 +91273,7 @@ components:
description: Relationship to service account.
properties:
data:
- $ref: "#/components/schemas/RelationshipToServiceAccountData"
+ $ref: '#/components/schemas/RelationshipToServiceAccountData'
required:
- data
type: object
@@ -91224,7 +91285,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/ServiceAccountType"
+ $ref: '#/components/schemas/ServiceAccountType'
required:
- id
- type
@@ -91233,7 +91294,7 @@ components:
description: Relationship to team.
properties:
data:
- $ref: "#/components/schemas/RelationshipToTeamData"
+ $ref: '#/components/schemas/RelationshipToTeamData'
type: object
RelationshipToTeamData:
description: Relationship to Team object.
@@ -91243,7 +91304,7 @@ components:
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
type: object
RelationshipToTeamLinkData:
description: Relationship between a link and a team
@@ -91253,7 +91314,7 @@ components:
example: f9bb8444-af7f-11ec-ac2c-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TeamLinkType"
+ $ref: '#/components/schemas/TeamLinkType'
required:
- id
- type
@@ -91264,16 +91325,16 @@ components:
data:
description: Related team links
items:
- $ref: "#/components/schemas/RelationshipToTeamLinkData"
+ $ref: '#/components/schemas/RelationshipToTeamLinkData'
type: array
links:
- $ref: "#/components/schemas/TeamRelationshipsLinks"
+ $ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
RelationshipToUser:
description: Relationship to user.
properties:
data:
- $ref: "#/components/schemas/RelationshipToUserData"
+ $ref: '#/components/schemas/RelationshipToUserData'
required:
- data
type: object
@@ -91285,7 +91346,7 @@ components:
example: "00000000-0000-0000-2345-000000000000"
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
required:
- id
- type
@@ -91294,9 +91355,9 @@ components:
description: Relationship between a user team permission and a team
properties:
data:
- $ref: "#/components/schemas/RelationshipToUserTeamPermissionData"
+ $ref: '#/components/schemas/RelationshipToUserTeamPermissionData'
links:
- $ref: "#/components/schemas/TeamRelationshipsLinks"
+ $ref: '#/components/schemas/TeamRelationshipsLinks'
type: object
RelationshipToUserTeamPermissionData:
description: Related user team permission data
@@ -91307,7 +91368,7 @@ components:
example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595
type: string
type:
- $ref: "#/components/schemas/UserTeamPermissionType"
+ $ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
@@ -91316,7 +91377,7 @@ components:
description: Relationship between team membership and team
properties:
data:
- $ref: "#/components/schemas/RelationshipToUserTeamTeamData"
+ $ref: '#/components/schemas/RelationshipToUserTeamTeamData'
required:
- data
type: object
@@ -91328,7 +91389,7 @@ components:
example: d7e15d9d-d346-43da-81d8-3d9e71d9a5e9
type: string
type:
- $ref: "#/components/schemas/UserTeamTeamType"
+ $ref: '#/components/schemas/UserTeamTeamType'
required:
- id
- type
@@ -91337,7 +91398,7 @@ components:
description: Relationship between team membership and user
properties:
data:
- $ref: "#/components/schemas/RelationshipToUserTeamUserData"
+ $ref: '#/components/schemas/RelationshipToUserTeamUserData'
required:
- data
type: object
@@ -91349,7 +91410,7 @@ components:
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/UserTeamUserType"
+ $ref: '#/components/schemas/UserTeamUserType'
required:
- id
- type
@@ -91361,7 +91422,7 @@ components:
description: Relationships to user objects.
example: []
items:
- $ref: "#/components/schemas/RelationshipToUserData"
+ $ref: '#/components/schemas/RelationshipToUserData'
type: array
required:
- data
@@ -91376,12 +91437,12 @@ components:
avoided_advisories:
description: Avoided advisories.
items:
- $ref: "#/components/schemas/Advisory"
+ $ref: '#/components/schemas/Advisory'
type: array
fixed_advisories:
description: Remediation fixed advisories.
items:
- $ref: "#/components/schemas/Advisory"
+ $ref: '#/components/schemas/Advisory'
type: array
library_name:
description: Library name remediating the vulnerability.
@@ -91394,12 +91455,12 @@ components:
new_advisories:
description: New advisories.
items:
- $ref: "#/components/schemas/Advisory"
+ $ref: '#/components/schemas/Advisory'
type: array
remaining_advisories:
description: Remaining advisories.
items:
- $ref: "#/components/schemas/Advisory"
+ $ref: '#/components/schemas/Advisory'
type: array
type:
description: Remediation type.
@@ -91421,7 +91482,7 @@ components:
data:
description: A list of retention filters objects.
items:
- $ref: "#/components/schemas/RetentionFilterWithoutAttributes"
+ $ref: '#/components/schemas/RetentionFilterWithoutAttributes'
type: array
required:
- data
@@ -91440,7 +91501,7 @@ components:
data:
description: The `ReorderRuleResourceArray` `data`.
items:
- $ref: "#/components/schemas/ReorderRuleResourceData"
+ $ref: '#/components/schemas/ReorderRuleResourceData'
type: array
required:
- data
@@ -91452,7 +91513,7 @@ components:
description: The `ReorderRuleResourceData` `id`.
type: string
type:
- $ref: "#/components/schemas/ReorderRuleResourceDataType"
+ $ref: '#/components/schemas/ReorderRuleResourceDataType'
required:
- type
type: object
@@ -91479,7 +91540,7 @@ components:
data:
description: The `ReorderRulesetResourceArray` `data`.
items:
- $ref: "#/components/schemas/ReorderRulesetResourceData"
+ $ref: '#/components/schemas/ReorderRulesetResourceData'
type: array
required:
- data
@@ -91491,7 +91552,7 @@ components:
description: The `ReorderRulesetResourceData` `id`.
type: string
type:
- $ref: "#/components/schemas/ReorderRulesetResourceDataType"
+ $ref: '#/components/schemas/ReorderRulesetResourceDataType'
required:
- type
type: object
@@ -91508,13 +91569,13 @@ components:
description: A user included as a related JSON:API resource.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleAuthorAttributes"
+ $ref: '#/components/schemas/ReportScheduleAuthorAttributes'
id:
description: The user UUID.
example: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: string
type:
- $ref: "#/components/schemas/ReportScheduleAuthorType"
+ $ref: '#/components/schemas/ReportScheduleAuthorType'
required:
- type
- id
@@ -91541,7 +91602,7 @@ components:
description: Relationship to the author of the report schedule.
properties:
data:
- $ref: "#/components/schemas/ReportScheduleAuthorRelationshipData"
+ $ref: '#/components/schemas/ReportScheduleAuthorRelationshipData'
required:
- data
type: object
@@ -91553,7 +91614,7 @@ components:
example: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: string
type:
- $ref: "#/components/schemas/ReportScheduleAuthorType"
+ $ref: '#/components/schemas/ReportScheduleAuthorType'
required:
- id
- type
@@ -91570,7 +91631,7 @@ components:
description: Request body for creating a report schedule.
properties:
data:
- $ref: "#/components/schemas/ReportScheduleCreateRequestData"
+ $ref: '#/components/schemas/ReportScheduleCreateRequestData'
required:
- data
type: object
@@ -91578,7 +91639,7 @@ components:
description: The configuration of the report schedule to create.
properties:
delivery_format:
- $ref: "#/components/schemas/ReportScheduleDeliveryFormat"
+ $ref: '#/components/schemas/ReportScheduleDeliveryFormat'
description:
description: A description of the report, up to 4096 characters.
example: "Weekly summary of infrastructure health."
@@ -91602,7 +91663,7 @@ components:
example: "abc-def-ghi"
type: string
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
rrule:
description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string.
example: "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0"
@@ -91615,7 +91676,7 @@ components:
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: The relative timeframe of data to include in the report.
@@ -91646,9 +91707,9 @@ components:
description: The JSON:API data object for a report schedule creation request.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleCreateRequestAttributes"
+ $ref: '#/components/schemas/ReportScheduleCreateRequestAttributes'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- type
- attributes
@@ -91670,8 +91731,8 @@ components:
ReportScheduleIncludedResource:
description: A related resource included with a report schedule.
oneOf:
- - $ref: "#/components/schemas/ReportScheduleAuthor"
- - $ref: "#/components/schemas/ReportScheduleResource"
+ - $ref: '#/components/schemas/ReportScheduleAuthor'
+ - $ref: '#/components/schemas/ReportScheduleResource'
ReportScheduleIncludedResourceType:
description: JSON:API resource type for an included report resource.
enum:
@@ -91715,7 +91776,7 @@ components:
description: Relationship to the report target resource.
properties:
data:
- $ref: "#/components/schemas/ReportScheduleListResourceRelationshipData"
+ $ref: '#/components/schemas/ReportScheduleListResourceRelationshipData'
required:
- data
type: object
@@ -91727,7 +91788,7 @@ components:
example: "abc-def-ghi"
type: string
type:
- $ref: "#/components/schemas/ReportScheduleIncludedResourceType"
+ $ref: '#/components/schemas/ReportScheduleIncludedResourceType'
required:
- id
- type
@@ -91738,17 +91799,17 @@ components:
data:
description: The list of report schedules.
items:
- $ref: "#/components/schemas/ReportScheduleListResponseData"
+ $ref: '#/components/schemas/ReportScheduleListResponseData'
type: array
included:
description: Related resources included with the report schedules, such as authors and rendered resources.
items:
- $ref: "#/components/schemas/ReportScheduleIncludedResource"
+ $ref: '#/components/schemas/ReportScheduleIncludedResource'
type: array
links:
- $ref: "#/components/schemas/ReportScheduleListResponseLinks"
+ $ref: '#/components/schemas/ReportScheduleListResponseLinks'
meta:
- $ref: "#/components/schemas/ReportScheduleListResponseMeta"
+ $ref: '#/components/schemas/ReportScheduleListResponseMeta'
required:
- data
type: object
@@ -91756,7 +91817,7 @@ components:
description: The configuration and derived state of a report schedule in a list response.
properties:
delivery_format:
- $ref: "#/components/schemas/ReportScheduleResponseAttributesDeliveryFormat"
+ $ref: '#/components/schemas/ReportScheduleResponseAttributesDeliveryFormat'
description:
description: The description of the report.
example: "Weekly summary of infrastructure health."
@@ -91782,17 +91843,17 @@ components:
example: "abc-def-ghi"
type: string
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
rrule:
description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string.
example: "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0"
type: string
status:
- $ref: "#/components/schemas/ReportScheduleStatus"
+ $ref: '#/components/schemas/ReportScheduleStatus'
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: The relative timeframe of data included in the report, or `null` if not set.
@@ -91824,15 +91885,15 @@ components:
description: The JSON:API data object representing a report schedule in a list response.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleListResponseAttributes"
+ $ref: '#/components/schemas/ReportScheduleListResponseAttributes'
id:
description: The unique identifier of the report schedule.
example: "11111111-2222-3333-4444-555555555555"
type: string
relationships:
- $ref: "#/components/schemas/ReportScheduleListResponseRelationships"
+ $ref: '#/components/schemas/ReportScheduleListResponseRelationships'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- id
- type
@@ -91872,7 +91933,7 @@ components:
description: Metadata for a paginated report schedule list response.
properties:
pagination:
- $ref: "#/components/schemas/ReportScheduleListResponsePagination"
+ $ref: '#/components/schemas/ReportScheduleListResponsePagination'
type: object
ReportScheduleListResponsePagination:
description: Offset and limit pagination metadata for a report schedule list response.
@@ -91914,7 +91975,7 @@ components:
format: int64
type: integer
type:
- $ref: "#/components/schemas/ReportScheduleListResponsePaginationType"
+ $ref: '#/components/schemas/ReportScheduleListResponsePaginationType'
type: object
ReportScheduleListResponsePaginationType:
description: The pagination type.
@@ -91928,9 +91989,9 @@ components:
description: Relationships for a report schedule in a list response.
properties:
author:
- $ref: "#/components/schemas/ReportScheduleAuthorRelationship"
+ $ref: '#/components/schemas/ReportScheduleAuthorRelationship'
resource:
- $ref: "#/components/schemas/ReportScheduleListResourceRelationship"
+ $ref: '#/components/schemas/ReportScheduleListResourceRelationship'
required:
- author
type: object
@@ -91938,7 +91999,7 @@ components:
description: Request body for updating a report schedule.
properties:
data:
- $ref: "#/components/schemas/ReportSchedulePatchRequestData"
+ $ref: '#/components/schemas/ReportSchedulePatchRequestData'
required:
- data
type: object
@@ -91948,7 +92009,7 @@ components:
ones; the targeted resource (`resource_id` and `resource_type`) cannot be changed.
properties:
delivery_format:
- $ref: "#/components/schemas/ReportScheduleDeliveryFormat"
+ $ref: '#/components/schemas/ReportScheduleDeliveryFormat'
description:
description: A description of the report, up to 4096 characters.
example: "Updated weekly summary of infrastructure health."
@@ -91979,7 +92040,7 @@ components:
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: The relative timeframe of data to include in the report.
@@ -92008,9 +92069,9 @@ components:
description: The JSON:API data object for a report schedule update request.
properties:
attributes:
- $ref: "#/components/schemas/ReportSchedulePatchRequestAttributes"
+ $ref: '#/components/schemas/ReportSchedulePatchRequestAttributes'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- type
- attributes
@@ -92019,13 +92080,13 @@ components:
description: A report target resource included as a related JSON:API resource.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleResourceAttributes"
+ $ref: '#/components/schemas/ReportScheduleResourceAttributes'
id:
description: The resource identifier.
example: "abc-def-ghi"
type: string
type:
- $ref: "#/components/schemas/ReportScheduleIncludedResourceType"
+ $ref: '#/components/schemas/ReportScheduleIncludedResourceType'
required:
- type
- id
@@ -92035,11 +92096,11 @@ components:
description: Attributes of an included report target resource.
properties:
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
template_variables:
description: Template variable metadata from the dashboard resource, when available.
items:
- $ref: "#/components/schemas/ReportScheduleIndexTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleIndexTemplateVariable'
nullable: true
type: array
title:
@@ -92064,11 +92125,11 @@ components:
description: Response containing a single report schedule.
properties:
data:
- $ref: "#/components/schemas/ReportScheduleResponseData"
+ $ref: '#/components/schemas/ReportScheduleResponseData'
included:
description: Related resources included with the report schedule, such as the author.
items:
- $ref: "#/components/schemas/ReportScheduleIncludedResource"
+ $ref: '#/components/schemas/ReportScheduleIncludedResource'
type: array
required:
- data
@@ -92077,7 +92138,7 @@ components:
description: The configuration and derived state of a report schedule.
properties:
delivery_format:
- $ref: "#/components/schemas/ReportScheduleResponseAttributesDeliveryFormat"
+ $ref: '#/components/schemas/ReportScheduleResponseAttributesDeliveryFormat'
description:
description: The description of the report.
example: "Weekly summary of infrastructure health."
@@ -92103,13 +92164,13 @@ components:
example: "abc-def-ghi"
type: string
resource_type:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
rrule:
description: The recurrence rule for the schedule, expressed as an iCalendar `RRULE` string.
example: "DTSTART;TZID=America/New_York:20260601T090000\nRRULE:FREQ=WEEKLY;BYDAY=MO;BYHOUR=9;BYMINUTE=0"
type: string
status:
- $ref: "#/components/schemas/ReportScheduleStatus"
+ $ref: '#/components/schemas/ReportScheduleStatus'
tab_id:
description: The identifier of the dashboard tab rendered in the report, or `null` if not set.
example: "66666666-7777-8888-9999-000000000000"
@@ -92118,7 +92179,7 @@ components:
template_variables:
description: The dashboard template variables applied when rendering the report.
items:
- $ref: "#/components/schemas/ReportScheduleTemplateVariable"
+ $ref: '#/components/schemas/ReportScheduleTemplateVariable'
type: array
timeframe:
description: The relative timeframe of data included in the report, or `null` if not set.
@@ -92164,15 +92225,15 @@ components:
description: The JSON:API data object representing a report schedule.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleResponseAttributes"
+ $ref: '#/components/schemas/ReportScheduleResponseAttributes'
id:
description: The unique identifier of the report schedule.
example: "11111111-2222-3333-4444-555555555555"
type: string
relationships:
- $ref: "#/components/schemas/ReportScheduleResponseRelationships"
+ $ref: '#/components/schemas/ReportScheduleResponseRelationships'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- id
- type
@@ -92183,7 +92244,7 @@ components:
description: Relationships for the report schedule.
properties:
author:
- $ref: "#/components/schemas/ReportScheduleAuthorRelationship"
+ $ref: '#/components/schemas/ReportScheduleAuthorRelationship'
required:
- author
type: object
@@ -92220,7 +92281,7 @@ components:
description: Request body for toggling a report schedule.
properties:
data:
- $ref: "#/components/schemas/ReportScheduleToggleRequestData"
+ $ref: '#/components/schemas/ReportScheduleToggleRequestData'
required:
- data
type: object
@@ -92228,7 +92289,7 @@ components:
description: The status to set on the report schedule.
properties:
status:
- $ref: "#/components/schemas/ReportScheduleStatus"
+ $ref: '#/components/schemas/ReportScheduleStatus'
required:
- status
type: object
@@ -92236,9 +92297,9 @@ components:
description: The JSON:API data object for a report schedule toggle request.
properties:
attributes:
- $ref: "#/components/schemas/ReportScheduleToggleRequestAttributes"
+ $ref: '#/components/schemas/ReportScheduleToggleRequestAttributes'
type:
- $ref: "#/components/schemas/ReportScheduleType"
+ $ref: '#/components/schemas/ReportScheduleType'
required:
- type
- attributes
@@ -92269,7 +92330,7 @@ components:
maxLength: 2048
type: string
type:
- $ref: "#/components/schemas/RepositoryFormDataType"
+ $ref: '#/components/schemas/RepositoryFormDataType'
required:
- type
- git_commit_sha
@@ -92279,7 +92340,7 @@ components:
description: Multipart form data for uploading repository metadata for source code linking.
properties:
event:
- $ref: "#/components/schemas/RepositoryEvent"
+ $ref: '#/components/schemas/RepositoryEvent'
repository:
description: Repository metadata file.
example: repository.json
@@ -92300,33 +92361,33 @@ components:
RequestSchema:
description: Multipart form data for uploading a source map, symbol file, or mapping file.
oneOf:
- - $ref: "#/components/schemas/JSSourceMapFormData"
- - $ref: "#/components/schemas/ReactNativeSourceMapFormData"
- - $ref: "#/components/schemas/JVMMappingFileFormData"
- - $ref: "#/components/schemas/IOSSymbolsFormData"
- - $ref: "#/components/schemas/FlutterSymbolFileFormData"
- - $ref: "#/components/schemas/NDKSymbolFileFormData"
- - $ref: "#/components/schemas/IL2CPPMappingFileFormData"
- - $ref: "#/components/schemas/ELFSymbolFileFormData"
- - $ref: "#/components/schemas/PESymbolFileFormData"
- - $ref: "#/components/schemas/RepositoryFormData"
+ - $ref: '#/components/schemas/JSSourceMapFormData'
+ - $ref: '#/components/schemas/ReactNativeSourceMapFormData'
+ - $ref: '#/components/schemas/JVMMappingFileFormData'
+ - $ref: '#/components/schemas/IOSSymbolsFormData'
+ - $ref: '#/components/schemas/FlutterSymbolFileFormData'
+ - $ref: '#/components/schemas/NDKSymbolFileFormData'
+ - $ref: '#/components/schemas/IL2CPPMappingFileFormData'
+ - $ref: '#/components/schemas/ELFSymbolFileFormData'
+ - $ref: '#/components/schemas/PESymbolFileFormData'
+ - $ref: '#/components/schemas/RepositoryFormData'
ResolveVulnerableSymbolsRequest:
description: The top-level request object for resolving vulnerable symbols in a set of packages.
properties:
data:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestData"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestData'
type: object
ResolveVulnerableSymbolsRequestData:
description: >-
The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type.
properties:
attributes:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataAttributes'
id:
description: An optional identifier for this request data object.
type: string
type:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataType"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsRequestDataType'
required:
- type
type: object
@@ -92354,19 +92415,19 @@ components:
description: The top-level response object returned when resolving vulnerable symbols for a set of packages.
properties:
data:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseData"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseData'
type: object
ResolveVulnerableSymbolsResponseData:
description: >-
The data object in a response for resolving vulnerable symbols, containing the result attributes and response type.
properties:
attributes:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataAttributes'
id:
description: The unique identifier for this response data object.
type: string
type:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataType"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseDataType'
required:
- type
type: object
@@ -92376,7 +92437,7 @@ components:
results:
description: The list of resolved vulnerable symbol results, one entry per queried package.
items:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResults"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResults'
type: array
type: object
ResolveVulnerableSymbolsResponseDataType:
@@ -92398,7 +92459,7 @@ components:
vulnerable_symbols:
description: The list of vulnerable symbol groups found in this package, organized by advisory.
items:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols'
type: array
type: object
ResolveVulnerableSymbolsResponseResultsVulnerableSymbols:
@@ -92410,7 +92471,7 @@ components:
symbols:
description: The list of symbols that are vulnerable according to this advisory.
items:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols'
type: array
type: object
ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols:
@@ -92469,19 +92530,19 @@ components:
description: Object describing meta attributes of response.
properties:
page:
- $ref: "#/components/schemas/Pagination"
+ $ref: '#/components/schemas/Pagination'
type: object
RestrictionPolicy:
description: Restriction policy object.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionPolicyAttributes"
+ $ref: '#/components/schemas/RestrictionPolicyAttributes'
id:
description: The identifier, always equivalent to the value specified in the `resource_id` path parameter.
example: "dashboard:abc-def-ghi"
type: string
type:
- $ref: "#/components/schemas/RestrictionPolicyType"
+ $ref: '#/components/schemas/RestrictionPolicyType'
required:
- type
- id
@@ -92494,7 +92555,7 @@ components:
bindings:
description: An array of bindings.
items:
- $ref: "#/components/schemas/RestrictionPolicyBinding"
+ $ref: '#/components/schemas/RestrictionPolicyBinding'
type: array
required:
- bindings
@@ -92529,7 +92590,7 @@ components:
description: Response containing information about a single restriction policy.
properties:
data:
- $ref: "#/components/schemas/RestrictionPolicy"
+ $ref: '#/components/schemas/RestrictionPolicy'
required:
- data
type: object
@@ -92546,7 +92607,7 @@ components:
description: Update request for a restriction policy.
properties:
data:
- $ref: "#/components/schemas/RestrictionPolicy"
+ $ref: '#/components/schemas/RestrictionPolicy'
required:
- data
type: object
@@ -92606,15 +92667,15 @@ components:
description: Data related to the creation of a restriction query.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionQueryCreateAttributes"
+ $ref: '#/components/schemas/RestrictionQueryCreateAttributes'
type:
- $ref: "#/components/schemas/LogsRestrictionQueriesType"
+ $ref: '#/components/schemas/LogsRestrictionQueriesType'
type: object
RestrictionQueryCreatePayload:
description: Create a restriction query.
properties:
data:
- $ref: "#/components/schemas/RestrictionQueryCreateData"
+ $ref: '#/components/schemas/RestrictionQueryCreateData'
type: object
RestrictionQueryListResponse:
description: Response containing information about multiple restriction queries.
@@ -92622,24 +92683,24 @@ components:
data:
description: Array of returned restriction queries.
items:
- $ref: "#/components/schemas/RestrictionQueryWithoutRelationships"
+ $ref: '#/components/schemas/RestrictionQueryWithoutRelationships'
type: array
type: object
RestrictionQueryResponseIncludedItem:
description: An object related to a restriction query.
oneOf:
- - $ref: "#/components/schemas/RestrictionQueryRole"
+ - $ref: '#/components/schemas/RestrictionQueryRole'
RestrictionQueryRole:
description: Partial role object.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionQueryRoleAttribute"
+ $ref: '#/components/schemas/RestrictionQueryRoleAttribute'
id:
description: ID of the role.
example: ""
type: string
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- type
- id
@@ -92659,7 +92720,7 @@ components:
data:
description: Array of roles.
items:
- $ref: "#/components/schemas/RestrictionQueryRole"
+ $ref: '#/components/schemas/RestrictionQueryRole'
type: array
type: object
RestrictionQueryUpdateAttributes:
@@ -92676,46 +92737,46 @@ components:
description: Data related to the update of a restriction query.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionQueryUpdateAttributes"
+ $ref: '#/components/schemas/RestrictionQueryUpdateAttributes'
type:
- $ref: "#/components/schemas/LogsRestrictionQueriesType"
+ $ref: '#/components/schemas/LogsRestrictionQueriesType'
type: object
RestrictionQueryUpdatePayload:
description: Update a restriction query.
properties:
data:
- $ref: "#/components/schemas/RestrictionQueryUpdateData"
+ $ref: '#/components/schemas/RestrictionQueryUpdateData'
type: object
RestrictionQueryWithRelationships:
description: Restriction query object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionQueryAttributes"
+ $ref: '#/components/schemas/RestrictionQueryAttributes'
id:
description: ID of the restriction query.
example: "79a0e60a-644a-11ea-ad29-43329f7f58b5"
type: string
relationships:
- $ref: "#/components/schemas/UserRelationships"
+ $ref: '#/components/schemas/UserRelationships'
type:
- $ref: "#/components/schemas/LogsRestrictionQueriesType"
+ $ref: '#/components/schemas/LogsRestrictionQueriesType'
type: object
RestrictionQueryWithRelationshipsResponse:
description: Response containing information about a single restriction query.
properties:
data:
- $ref: "#/components/schemas/RestrictionQueryWithRelationships"
+ $ref: '#/components/schemas/RestrictionQueryWithRelationships'
included:
description: Array of objects related to the restriction query.
items:
- $ref: "#/components/schemas/RestrictionQueryResponseIncludedItem"
+ $ref: '#/components/schemas/RestrictionQueryResponseIncludedItem'
type: array
type: object
RestrictionQueryWithoutRelationships:
description: Restriction query object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/RestrictionQueryAttributes"
+ $ref: '#/components/schemas/RestrictionQueryAttributes'
id:
description: ID of the restriction query.
example: "79a0e60a-644a-11ea-ad29-43329f7f58b5"
@@ -92731,19 +92792,19 @@ components:
description: Response containing information about a single restriction query.
properties:
data:
- $ref: "#/components/schemas/RestrictionQueryWithoutRelationships"
+ $ref: '#/components/schemas/RestrictionQueryWithoutRelationships'
type: object
RetentionFilter:
description: The definition of the retention filter.
properties:
attributes:
- $ref: "#/components/schemas/RetentionFilterAttributes"
+ $ref: '#/components/schemas/RetentionFilterAttributes'
id:
description: The ID of the retention filter.
example: "7RBOb7dLSYWI01yc3pIH8w"
type: string
type:
- $ref: "#/components/schemas/ApmRetentionFilterType"
+ $ref: '#/components/schemas/ApmRetentionFilterType'
required:
- id
- type
@@ -92753,13 +92814,13 @@ components:
description: The definition of the retention filter.
properties:
attributes:
- $ref: "#/components/schemas/RetentionFilterAllAttributes"
+ $ref: '#/components/schemas/RetentionFilterAllAttributes'
id:
description: The ID of the retention filter.
example: "7RBOb7dLSYWI01yc3pIH8w"
type: string
type:
- $ref: "#/components/schemas/ApmRetentionFilterType"
+ $ref: '#/components/schemas/ApmRetentionFilterType'
required:
- id
- type
@@ -92788,9 +92849,9 @@ components:
format: int64
type: integer
filter:
- $ref: "#/components/schemas/SpansFilter"
+ $ref: '#/components/schemas/SpansFilter'
filter_type:
- $ref: "#/components/schemas/RetentionFilterAllType"
+ $ref: '#/components/schemas/RetentionFilterAllType'
modified_at:
description: The modification timestamp of the retention filter.
format: int64
@@ -92853,9 +92914,9 @@ components:
format: int64
type: integer
filter:
- $ref: "#/components/schemas/SpansFilter"
+ $ref: '#/components/schemas/SpansFilter'
filter_type:
- $ref: "#/components/schemas/RetentionFilterType"
+ $ref: '#/components/schemas/RetentionFilterType'
modified_at:
description: The modification timestamp of the retention filter.
format: int64
@@ -92890,9 +92951,9 @@ components:
example: true
type: boolean
filter:
- $ref: "#/components/schemas/SpansFilterCreate"
+ $ref: '#/components/schemas/SpansFilterCreate'
filter_type:
- $ref: "#/components/schemas/RetentionFilterType"
+ $ref: '#/components/schemas/RetentionFilterType'
name:
description: The name of the retention filter.
example: my retention filter
@@ -92922,9 +92983,9 @@ components:
description: The body of the retention filter to be created.
properties:
attributes:
- $ref: "#/components/schemas/RetentionFilterCreateAttributes"
+ $ref: '#/components/schemas/RetentionFilterCreateAttributes'
type:
- $ref: "#/components/schemas/ApmRetentionFilterType"
+ $ref: '#/components/schemas/ApmRetentionFilterType'
required:
- attributes
- type
@@ -92933,7 +92994,7 @@ components:
description: The body of the retention filter to be created.
properties:
data:
- $ref: "#/components/schemas/RetentionFilterCreateData"
+ $ref: '#/components/schemas/RetentionFilterCreateData'
required:
- data
type: object
@@ -92941,13 +93002,13 @@ components:
description: The retention filters definition.
properties:
data:
- $ref: "#/components/schemas/RetentionFilter"
+ $ref: '#/components/schemas/RetentionFilter'
type: object
RetentionFilterResponse:
description: The retention filters definition.
properties:
data:
- $ref: "#/components/schemas/RetentionFilterAll"
+ $ref: '#/components/schemas/RetentionFilterAll'
type: object
RetentionFilterType:
default: spans-sampling-processor
@@ -92966,9 +93027,9 @@ components:
example: true
type: boolean
filter:
- $ref: "#/components/schemas/SpansFilterCreate"
+ $ref: '#/components/schemas/SpansFilterCreate'
filter_type:
- $ref: "#/components/schemas/RetentionFilterAllType"
+ $ref: '#/components/schemas/RetentionFilterAllType'
name:
description: The name of the retention filter.
example: my retention filter
@@ -92998,13 +93059,13 @@ components:
description: The body of the retention filter to be updated.
properties:
attributes:
- $ref: "#/components/schemas/RetentionFilterUpdateAttributes"
+ $ref: '#/components/schemas/RetentionFilterUpdateAttributes'
id:
description: The ID of the retention filter.
example: "retention-filter-id"
type: string
type:
- $ref: "#/components/schemas/ApmRetentionFilterType"
+ $ref: '#/components/schemas/ApmRetentionFilterType'
required:
- id
- attributes
@@ -93014,7 +93075,7 @@ components:
description: The body of the retention filter to be updated.
properties:
data:
- $ref: "#/components/schemas/RetentionFilterUpdateData"
+ $ref: '#/components/schemas/RetentionFilterUpdateData'
required:
- data
type: object
@@ -93026,7 +93087,7 @@ components:
example: "7RBOb7dLSYWI01yc3pIH8w"
type: string
type:
- $ref: "#/components/schemas/ApmRetentionFilterType"
+ $ref: '#/components/schemas/ApmRetentionFilterType'
required:
- id
- type
@@ -93037,7 +93098,7 @@ components:
data:
description: A list of retention filters objects.
items:
- $ref: "#/components/schemas/RetentionFilterAll"
+ $ref: '#/components/schemas/RetentionFilterAll'
type: array
required:
- data
@@ -93047,9 +93108,9 @@ components:
description: The definition of `RetryStrategy` object.
properties:
kind:
- $ref: "#/components/schemas/RetryStrategyKind"
+ $ref: '#/components/schemas/RetryStrategyKind'
linear:
- $ref: "#/components/schemas/RetryStrategyLinear"
+ $ref: '#/components/schemas/RetryStrategyLinear'
required:
- kind
- linear
@@ -93092,18 +93153,18 @@ components:
description: Request body for reverting a custom rule to a previous revision.
properties:
data:
- $ref: "#/components/schemas/RevertCustomRuleRevisionRequestData"
+ $ref: '#/components/schemas/RevertCustomRuleRevisionRequestData'
type: object
RevertCustomRuleRevisionRequestData:
description: Data object for a request to revert a custom rule to a previous revision.
properties:
attributes:
- $ref: "#/components/schemas/RevertCustomRuleRevisionRequestDataAttributes"
+ $ref: '#/components/schemas/RevertCustomRuleRevisionRequestDataAttributes'
id:
description: Request identifier
type: string
type:
- $ref: "#/components/schemas/RevertCustomRuleRevisionDataType"
+ $ref: '#/components/schemas/RevertCustomRuleRevisionDataType'
type: object
RevertCustomRuleRevisionRequestDataAttributes:
description: Attributes specifying the current and target revision IDs for a revert operation.
@@ -93119,14 +93180,14 @@ components:
description: Role object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/RoleAttributes"
+ $ref: '#/components/schemas/RoleAttributes'
id:
description: The unique identifier of the role.
type: string
relationships:
- $ref: "#/components/schemas/RoleResponseRelationships"
+ $ref: '#/components/schemas/RoleResponseRelationships'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- type
type: object
@@ -93166,9 +93227,9 @@ components:
description: Data for the clone role request.
properties:
attributes:
- $ref: "#/components/schemas/RoleCloneAttributes"
+ $ref: '#/components/schemas/RoleCloneAttributes'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- type
- attributes
@@ -93196,7 +93257,7 @@ components:
description: Request to create a role by cloning an existing role.
properties:
data:
- $ref: "#/components/schemas/RoleClone"
+ $ref: '#/components/schemas/RoleClone'
required:
- data
type: object
@@ -93233,11 +93294,11 @@ components:
description: Data related to the creation of a role.
properties:
attributes:
- $ref: "#/components/schemas/RoleCreateAttributes"
+ $ref: '#/components/schemas/RoleCreateAttributes'
relationships:
- $ref: "#/components/schemas/RoleRelationships"
+ $ref: '#/components/schemas/RoleRelationships'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- attributes
type: object
@@ -93245,7 +93306,7 @@ components:
description: Create a role.
properties:
data:
- $ref: "#/components/schemas/RoleCreateData"
+ $ref: '#/components/schemas/RoleCreateData'
required:
- data
type: object
@@ -93253,20 +93314,20 @@ components:
description: Response containing information about a created role.
properties:
data:
- $ref: "#/components/schemas/RoleCreateResponseData"
+ $ref: '#/components/schemas/RoleCreateResponseData'
type: object
RoleCreateResponseData:
description: Role object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/RoleCreateAttributes"
+ $ref: '#/components/schemas/RoleCreateAttributes'
id:
description: The unique identifier of the role.
type: string
relationships:
- $ref: "#/components/schemas/RoleResponseRelationships"
+ $ref: '#/components/schemas/RoleResponseRelationships'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- type
type: object
@@ -93274,19 +93335,19 @@ components:
description: Relationships of the role object.
properties:
permissions:
- $ref: "#/components/schemas/RelationshipToPermissions"
+ $ref: '#/components/schemas/RelationshipToPermissions'
type: object
RoleResponse:
description: Response containing information about a single role.
properties:
data:
- $ref: "#/components/schemas/Role"
+ $ref: '#/components/schemas/Role'
type: object
RoleResponseRelationships:
description: Relationships of the role object returned by the API.
properties:
permissions:
- $ref: "#/components/schemas/RelationshipToPermissions"
+ $ref: '#/components/schemas/RelationshipToPermissions'
type: object
RoleTemplateArray:
description: The definition of `RoleTemplateArray` object.
@@ -93294,7 +93355,7 @@ components:
data:
description: The `RoleTemplateArray` `data`.
items:
- $ref: "#/components/schemas/RoleTemplateData"
+ $ref: '#/components/schemas/RoleTemplateData'
type: array
required:
- data
@@ -93303,12 +93364,12 @@ components:
description: The definition of `RoleTemplateData` object.
properties:
attributes:
- $ref: "#/components/schemas/RoleTemplateDataAttributes"
+ $ref: '#/components/schemas/RoleTemplateDataAttributes'
id:
description: The `RoleTemplateData` `id`.
type: string
type:
- $ref: "#/components/schemas/RoleTemplateDataType"
+ $ref: '#/components/schemas/RoleTemplateDataType'
required:
- type
type: object
@@ -93366,15 +93427,15 @@ components:
description: Data related to the update of a role.
properties:
attributes:
- $ref: "#/components/schemas/RoleUpdateAttributes"
+ $ref: '#/components/schemas/RoleUpdateAttributes'
id:
description: The unique identifier of the role.
example: "00000000-0000-1111-0000-000000000000"
type: string
relationships:
- $ref: "#/components/schemas/RoleRelationships"
+ $ref: '#/components/schemas/RoleRelationships'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- attributes
- type
@@ -93384,7 +93445,7 @@ components:
description: Update a role.
properties:
data:
- $ref: "#/components/schemas/RoleUpdateData"
+ $ref: '#/components/schemas/RoleUpdateData'
required:
- data
type: object
@@ -93392,20 +93453,20 @@ components:
description: Response containing information about an updated role.
properties:
data:
- $ref: "#/components/schemas/RoleUpdateResponseData"
+ $ref: '#/components/schemas/RoleUpdateResponseData'
type: object
RoleUpdateResponseData:
description: Role object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/RoleUpdateAttributes"
+ $ref: '#/components/schemas/RoleUpdateAttributes'
id:
description: The unique identifier of the role.
type: string
relationships:
- $ref: "#/components/schemas/RoleResponseRelationships"
+ $ref: '#/components/schemas/RoleResponseRelationships'
type:
- $ref: "#/components/schemas/RolesType"
+ $ref: '#/components/schemas/RolesType'
required:
- type
type: object
@@ -93415,10 +93476,10 @@ components:
data:
description: Array of returned roles.
items:
- $ref: "#/components/schemas/Role"
+ $ref: '#/components/schemas/Role'
type: array
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
type: object
RolesSort:
default: name
@@ -93460,7 +93521,7 @@ components:
format: int64
type: integer
strategy:
- $ref: "#/components/schemas/RolloutStrategy"
+ $ref: '#/components/schemas/RolloutStrategy'
required:
- strategy
- autostart
@@ -93480,7 +93541,7 @@ components:
format: int64
type: integer
strategy:
- $ref: "#/components/schemas/RolloutStrategy"
+ $ref: '#/components/schemas/RolloutStrategy'
required:
- strategy
type: object
@@ -93498,31 +93559,31 @@ components:
description: Represents a routing rule, including its attributes, relationships, and unique identifier.
properties:
attributes:
- $ref: "#/components/schemas/RoutingRuleAttributes"
+ $ref: '#/components/schemas/RoutingRuleAttributes'
id:
description: Specifies the unique identifier of this routing rule.
type: string
relationships:
- $ref: "#/components/schemas/RoutingRuleRelationships"
+ $ref: '#/components/schemas/RoutingRuleRelationships'
type:
- $ref: "#/components/schemas/RoutingRuleType"
+ $ref: '#/components/schemas/RoutingRuleType'
required:
- type
type: object
RoutingRuleAction:
description: "Defines an action that is executed when a routing rule matches certain criteria."
oneOf:
- - $ref: "#/components/schemas/SendSlackMessageAction"
- - $ref: "#/components/schemas/SendTeamsMessageAction"
- - $ref: "#/components/schemas/TriggerWorkflowAutomationAction"
- - $ref: "#/components/schemas/RoutingRuleEscalationPolicyAction"
+ - $ref: '#/components/schemas/SendSlackMessageAction'
+ - $ref: '#/components/schemas/SendTeamsMessageAction'
+ - $ref: '#/components/schemas/TriggerWorkflowAutomationAction'
+ - $ref: '#/components/schemas/RoutingRuleEscalationPolicyAction'
RoutingRuleAttributes:
description: Defines the configurable attributes of a routing rule, such as actions, query, time restriction, and urgency.
properties:
actions:
description: Specifies the list of actions to perform when the routing rule matches.
items:
- $ref: "#/components/schemas/RoutingRuleAction"
+ $ref: '#/components/schemas/RoutingRuleAction'
type: array
query:
description: Defines the query or condition that triggers this routing rule.
@@ -93531,7 +93592,7 @@ components:
$ref: "#/components/schemas/TimeRestrictions"
nullable: true
urgency:
- $ref: "#/components/schemas/Urgency"
+ $ref: '#/components/schemas/Urgency'
type: object
RoutingRuleEscalationPolicyAction:
description: "Triggers an escalation policy."
@@ -93546,11 +93607,11 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
support_hours:
- $ref: "#/components/schemas/RoutingRuleEscalationPolicyActionSupportHours"
+ $ref: '#/components/schemas/RoutingRuleEscalationPolicyActionSupportHours'
type:
- $ref: "#/components/schemas/RoutingRuleEscalationPolicyActionType"
+ $ref: '#/components/schemas/RoutingRuleEscalationPolicyActionType'
urgency:
- $ref: "#/components/schemas/Urgency"
+ $ref: '#/components/schemas/Urgency'
required:
- type
- policy_id
@@ -93561,7 +93622,7 @@ components:
restrictions:
description: "The list of support hours time windows."
items:
- $ref: "#/components/schemas/TimeRestriction"
+ $ref: '#/components/schemas/TimeRestriction'
type: array
time_zone:
description: "The time zone in which the support hours are expressed."
@@ -93583,7 +93644,7 @@ components:
description: Specifies relationships for a routing rule, linking to associated policy resources.
properties:
policy:
- $ref: "#/components/schemas/RoutingRuleRelationshipsPolicy"
+ $ref: '#/components/schemas/RoutingRuleRelationshipsPolicy'
type: object
RoutingRuleRelationshipsPolicy:
description: Defines the relationship that links a routing rule to a policy.
@@ -93600,7 +93661,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/RoutingRuleRelationshipsPolicyDataType"
+ $ref: '#/components/schemas/RoutingRuleRelationshipsPolicyDataType'
required:
- type
- id
@@ -93645,7 +93706,7 @@ components:
example: true
type: boolean
level:
- $ref: "#/components/schemas/RuleLevel"
+ $ref: '#/components/schemas/RuleLevel'
modified_at:
description: Time of the last rule outcome modification.
format: date-time
@@ -93677,7 +93738,7 @@ components:
example: true
type: boolean
level:
- $ref: "#/components/schemas/RuleLevel"
+ $ref: '#/components/schemas/RuleLevel'
name:
description: Name of the rule.
example: Team Defined
@@ -93703,7 +93764,7 @@ components:
format: int64
type: integer
rules:
- $ref: "#/components/schemas/RuleBasedViewRules"
+ $ref: '#/components/schemas/RuleBasedViewRules'
required:
- count
- rules
@@ -93739,19 +93800,19 @@ components:
RuleBasedViewComplianceFrameworks:
description: List of compliance framework mappings associated with the rule.
items:
- $ref: "#/components/schemas/RuleBasedViewComplianceFramework"
+ $ref: '#/components/schemas/RuleBasedViewComplianceFramework'
type: array
RuleBasedViewData:
description: Data envelope for the rule-based view response.
properties:
attributes:
- $ref: "#/components/schemas/RuleBasedViewAttributes"
+ $ref: '#/components/schemas/RuleBasedViewAttributes'
id:
description: Unique identifier of the rule-based view document.
example: JSONAPI_USELESS_ID
type: string
type:
- $ref: "#/components/schemas/RuleBasedViewType"
+ $ref: '#/components/schemas/RuleBasedViewType'
required:
- attributes
- id
@@ -93770,7 +93831,7 @@ components:
description: Response containing an aggregated view of compliance rules with their finding statistics.
properties:
data:
- $ref: "#/components/schemas/RuleBasedViewData"
+ $ref: '#/components/schemas/RuleBasedViewData'
required:
- data
type: object
@@ -93778,7 +93839,7 @@ components:
description: A compliance rule along with its evaluation statistics and framework mappings.
properties:
compliance_frameworks:
- $ref: "#/components/schemas/RuleBasedViewComplianceFrameworks"
+ $ref: '#/components/schemas/RuleBasedViewComplianceFrameworks'
enabled:
description: Whether the rule is enabled.
example: true
@@ -93792,7 +93853,7 @@ components:
example: IAM roles should not allow untrusted GitHub Actions to assume them
type: string
resourceAttributes:
- $ref: "#/components/schemas/RuleBasedViewResourceAttributes"
+ $ref: '#/components/schemas/RuleBasedViewResourceAttributes'
resourceCategory:
description: Resource category targeted by the rule.
example: identity
@@ -93802,15 +93863,15 @@ components:
example: aws_iam_role
type: string
stats:
- $ref: "#/components/schemas/RuleBasedViewRuleStats"
+ $ref: '#/components/schemas/RuleBasedViewRuleStats'
status:
description: Severity associated with the rule (for example, `info`, `low`, `medium`, `high`, or `critical`).
example: critical
type: string
tags:
- $ref: "#/components/schemas/RuleBasedViewRuleTags"
+ $ref: '#/components/schemas/RuleBasedViewRuleTags'
type:
- $ref: "#/components/schemas/RuleBasedViewRuleCategory"
+ $ref: '#/components/schemas/RuleBasedViewRuleCategory'
required:
- compliance_frameworks
- enabled
@@ -93871,7 +93932,7 @@ components:
RuleBasedViewRules:
description: List of rules in the rule-based view.
items:
- $ref: "#/components/schemas/RuleBasedViewRule"
+ $ref: '#/components/schemas/RuleBasedViewRule'
type: array
RuleBasedViewType:
default: rule_based_view
@@ -93901,7 +93962,7 @@ components:
description: The JSON:API relationship to a scorecard rule.
properties:
rule:
- $ref: "#/components/schemas/RelationshipToOutcome"
+ $ref: '#/components/schemas/RelationshipToOutcome'
type: object
RuleSeverity:
description: Severity of a security rule.
@@ -93934,7 +93995,7 @@ components:
description: Security rule types used as filters in security rules.
example: [misconfiguration, attack_path]
items:
- $ref: "#/components/schemas/RuleTypesItems"
+ $ref: '#/components/schemas/RuleTypesItems'
type: array
RuleTypesItems:
description: |-
@@ -94022,10 +94083,10 @@ components:
changes:
description: A list of changes.
items:
- $ref: "#/components/schemas/VersionHistoryUpdate"
+ $ref: '#/components/schemas/VersionHistoryUpdate'
type: array
rule:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
type: object
RulesValidateQueryRequest:
description: The definition of `RulesValidateQueryRequest` object.
@@ -94036,18 +94097,18 @@ components:
type: validate_query
properties:
data:
- $ref: "#/components/schemas/RulesValidateQueryRequestData"
+ $ref: '#/components/schemas/RulesValidateQueryRequestData'
type: object
RulesValidateQueryRequestData:
description: The definition of `RulesValidateQueryRequestData` object.
properties:
attributes:
- $ref: "#/components/schemas/RulesValidateQueryRequestDataAttributes"
+ $ref: '#/components/schemas/RulesValidateQueryRequestDataAttributes'
id:
description: The `RulesValidateQueryRequestData` `id`.
type: string
type:
- $ref: "#/components/schemas/RulesValidateQueryRequestDataType"
+ $ref: '#/components/schemas/RulesValidateQueryRequestDataType'
required:
- type
type: object
@@ -94079,18 +94140,18 @@ components:
type: validate_response
properties:
data:
- $ref: "#/components/schemas/RulesValidateQueryResponseData"
+ $ref: '#/components/schemas/RulesValidateQueryResponseData'
type: object
RulesValidateQueryResponseData:
description: The definition of `RulesValidateQueryResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/RulesValidateQueryResponseDataAttributes"
+ $ref: '#/components/schemas/RulesValidateQueryResponseDataAttributes'
id:
description: The `RulesValidateQueryResponseData` `id`.
type: string
type:
- $ref: "#/components/schemas/RulesValidateQueryResponseDataType"
+ $ref: '#/components/schemas/RulesValidateQueryResponseDataType'
required:
- type
type: object
@@ -94176,7 +94237,7 @@ components:
type: ruleset
properties:
data:
- $ref: "#/components/schemas/RulesetRespData"
+ $ref: '#/components/schemas/RulesetRespData'
type: object
RulesetRespArray:
description: The definition of `RulesetRespArray` object.
@@ -94260,7 +94321,7 @@ components:
data:
description: The `RulesetRespArray` `data`.
items:
- $ref: "#/components/schemas/RulesetRespData"
+ $ref: '#/components/schemas/RulesetRespData'
type: array
required:
- data
@@ -94269,12 +94330,12 @@ components:
description: The definition of `RulesetRespData` object.
properties:
attributes:
- $ref: "#/components/schemas/RulesetRespDataAttributes"
+ $ref: '#/components/schemas/RulesetRespDataAttributes'
id:
description: The `RulesetRespData` `id`.
type: string
type:
- $ref: "#/components/schemas/RulesetRespDataType"
+ $ref: '#/components/schemas/RulesetRespDataType'
required:
- type
type: object
@@ -94282,7 +94343,7 @@ components:
description: The definition of `RulesetRespDataAttributes` object.
properties:
created:
- $ref: "#/components/schemas/RulesetRespDataAttributesCreated"
+ $ref: '#/components/schemas/RulesetRespDataAttributesCreated'
enabled:
description: The `attributes` `enabled`.
example: false
@@ -94292,7 +94353,7 @@ components:
example: ""
type: string
modified:
- $ref: "#/components/schemas/RulesetRespDataAttributesModified"
+ $ref: '#/components/schemas/RulesetRespDataAttributesModified'
name:
description: The `attributes` `name`.
example: ""
@@ -94310,7 +94371,7 @@ components:
rules:
description: The `attributes` `rules`.
items:
- $ref: "#/components/schemas/RulesetRespDataAttributesRulesItems"
+ $ref: '#/components/schemas/RulesetRespDataAttributesRulesItems'
type: array
version:
description: The `attributes` `version`.
@@ -94361,17 +94422,17 @@ components:
example: false
type: boolean
mapping:
- $ref: "#/components/schemas/DataAttributesRulesItemsMapping"
+ $ref: '#/components/schemas/DataAttributesRulesItemsMapping'
metadata:
- $ref: "#/components/schemas/RulesetItemMetadata"
+ $ref: '#/components/schemas/RulesetItemMetadata'
name:
description: The `items` `name`.
example: ""
type: string
query:
- $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsQuery"
+ $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsQuery'
reference_table:
- $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTable"
+ $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTable'
required:
- enabled
- name
@@ -94381,7 +94442,7 @@ components:
nullable: true
properties:
addition:
- $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsQueryAddition"
+ $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsQueryAddition'
case_insensitivity:
description: The `query` `case_insensitivity`.
type: boolean
@@ -94390,7 +94451,7 @@ components:
description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
query:
description: The `query` `query`.
example: ""
@@ -94425,14 +94486,14 @@ components:
field_pairs:
description: The `reference_table` `field_pairs`.
items:
- $ref: "#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems"
+ $ref: '#/components/schemas/RulesetRespDataAttributesRulesItemsReferenceTableFieldPairsItems'
type: array
if_not_exists:
deprecated: true
description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
source_keys:
description: The `reference_table` `source_keys`.
example:
@@ -94490,7 +94551,7 @@ components:
data:
description: Processing status for a tag pipeline ruleset.
items:
- $ref: "#/components/schemas/RulesetStatusRespData"
+ $ref: '#/components/schemas/RulesetStatusRespData'
type: array
required:
- data
@@ -94499,13 +94560,13 @@ components:
description: Processing status for a tag pipeline ruleset.
properties:
attributes:
- $ref: "#/components/schemas/RulesetStatusRespDataAttributes"
+ $ref: '#/components/schemas/RulesetStatusRespDataAttributes'
id:
description: The unique identifier of the ruleset.
example: 55ef2385-9ae1-4410-90c4-5ac1b60fec10
type: string
type:
- $ref: "#/components/schemas/RulesetStatusRespDataType"
+ $ref: '#/components/schemas/RulesetStatusRespDataType'
required:
- id
- type
@@ -94591,9 +94652,9 @@ components:
description: Object describing the RUM configuration to create.
properties:
attributes:
- $ref: "#/components/schemas/RumConfigCreateAttributes"
+ $ref: '#/components/schemas/RumConfigCreateAttributes'
type:
- $ref: "#/components/schemas/RumConfigType"
+ $ref: '#/components/schemas/RumConfigType'
required:
- type
- attributes
@@ -94602,7 +94663,7 @@ components:
description: Request body for creating the RUM configuration.
properties:
data:
- $ref: "#/components/schemas/RumConfigCreateData"
+ $ref: '#/components/schemas/RumConfigCreateData'
required:
- data
type: object
@@ -94610,13 +94671,13 @@ components:
description: The RUM configuration data.
properties:
attributes:
- $ref: "#/components/schemas/RumConfigAttributes"
+ $ref: '#/components/schemas/RumConfigAttributes'
id:
description: The organization ID associated with the RUM configuration.
example: "1234"
type: string
type:
- $ref: "#/components/schemas/RumConfigType"
+ $ref: '#/components/schemas/RumConfigType'
required:
- id
- type
@@ -94626,7 +94687,7 @@ components:
description: The RUM configuration object.
properties:
data:
- $ref: "#/components/schemas/RumConfigData"
+ $ref: '#/components/schemas/RumConfigData'
required:
- data
type: object
@@ -94653,9 +94714,9 @@ components:
description: Object describing the RUM configuration to update.
properties:
attributes:
- $ref: "#/components/schemas/RumConfigUpdateAttributes"
+ $ref: '#/components/schemas/RumConfigUpdateAttributes'
type:
- $ref: "#/components/schemas/RumConfigType"
+ $ref: '#/components/schemas/RumConfigType'
required:
- type
- attributes
@@ -94664,7 +94725,7 @@ components:
description: Request body for updating the RUM configuration.
properties:
data:
- $ref: "#/components/schemas/RumConfigUpdateData"
+ $ref: '#/components/schemas/RumConfigUpdateData'
required:
- data
type: object
@@ -94719,13 +94780,13 @@ components:
description: The attributes of an exclusion filter.
properties:
enabled:
- $ref: "#/components/schemas/RumExclusionFilterEnabled"
+ $ref: '#/components/schemas/RumExclusionFilterEnabled'
event_type:
- $ref: "#/components/schemas/RumExclusionFilterEventType"
+ $ref: '#/components/schemas/RumExclusionFilterEventType'
name:
- $ref: "#/components/schemas/RumExclusionFilterName"
+ $ref: '#/components/schemas/RumExclusionFilterName'
query:
- $ref: "#/components/schemas/RumExclusionFilterQuery"
+ $ref: '#/components/schemas/RumExclusionFilterQuery'
type: object
RumExclusionFilterCreateAttributes:
description: The attributes of an exclusion filter to create.
@@ -94735,11 +94796,11 @@ components:
example: true
type: boolean
event_type:
- $ref: "#/components/schemas/RumExclusionFilterEventType"
+ $ref: '#/components/schemas/RumExclusionFilterEventType'
name:
- $ref: "#/components/schemas/RumExclusionFilterName"
+ $ref: '#/components/schemas/RumExclusionFilterName'
query:
- $ref: "#/components/schemas/RumExclusionFilterQuery"
+ $ref: '#/components/schemas/RumExclusionFilterQuery'
required:
- name
type: object
@@ -94747,9 +94808,9 @@ components:
description: The new exclusion filter properties to create.
properties:
attributes:
- $ref: "#/components/schemas/RumExclusionFilterCreateAttributes"
+ $ref: '#/components/schemas/RumExclusionFilterCreateAttributes'
type:
- $ref: "#/components/schemas/RumExclusionFilterType"
+ $ref: '#/components/schemas/RumExclusionFilterType'
required:
- type
- attributes
@@ -94758,7 +94819,7 @@ components:
description: The exclusion filter body to create.
properties:
data:
- $ref: "#/components/schemas/RumExclusionFilterCreateData"
+ $ref: '#/components/schemas/RumExclusionFilterCreateData'
required:
- data
type: object
@@ -94766,15 +94827,15 @@ components:
description: An exclusion filter.
properties:
attributes:
- $ref: "#/components/schemas/RumExclusionFilterAttributes"
+ $ref: '#/components/schemas/RumExclusionFilterAttributes'
id:
description: The ID of the exclusion filter.
example: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: string
meta:
- $ref: "#/components/schemas/RumExclusionFilterMeta"
+ $ref: '#/components/schemas/RumExclusionFilterMeta'
type:
- $ref: "#/components/schemas/RumExclusionFilterType"
+ $ref: '#/components/schemas/RumExclusionFilterType'
required:
- id
- type
@@ -94835,7 +94896,7 @@ components:
description: An exclusion filter response body.
properties:
data:
- $ref: "#/components/schemas/RumExclusionFilterData"
+ $ref: '#/components/schemas/RumExclusionFilterData'
type: object
RumExclusionFilterType:
default: exclusion_filters
@@ -94853,25 +94914,25 @@ components:
`name`, `event_type`, and `query` must be omitted.
properties:
enabled:
- $ref: "#/components/schemas/RumExclusionFilterEnabled"
+ $ref: '#/components/schemas/RumExclusionFilterEnabled'
event_type:
- $ref: "#/components/schemas/RumExclusionFilterEventType"
+ $ref: '#/components/schemas/RumExclusionFilterEventType'
name:
- $ref: "#/components/schemas/RumExclusionFilterName"
+ $ref: '#/components/schemas/RumExclusionFilterName'
query:
- $ref: "#/components/schemas/RumExclusionFilterQuery"
+ $ref: '#/components/schemas/RumExclusionFilterQuery'
type: object
RumExclusionFilterUpdateData:
description: The exclusion filter properties to update.
properties:
attributes:
- $ref: "#/components/schemas/RumExclusionFilterUpdateAttributes"
+ $ref: '#/components/schemas/RumExclusionFilterUpdateAttributes'
id:
description: The ID of the exclusion filter. Must match the `ef_id` path parameter.
example: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: string
type:
- $ref: "#/components/schemas/RumExclusionFilterType"
+ $ref: '#/components/schemas/RumExclusionFilterType'
required:
- id
- type
@@ -94881,7 +94942,7 @@ components:
description: The exclusion filter body to update.
properties:
data:
- $ref: "#/components/schemas/RumExclusionFilterUpdateData"
+ $ref: '#/components/schemas/RumExclusionFilterUpdateData'
required:
- data
type: object
@@ -94891,16 +94952,16 @@ components:
data:
description: A list of exclusion filters.
items:
- $ref: "#/components/schemas/RumExclusionFilterData"
+ $ref: '#/components/schemas/RumExclusionFilterData'
type: array
type: object
RumMetricCompute:
description: The compute rule to compute the RUM-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/RumMetricComputeAggregationType"
+ $ref: '#/components/schemas/RumMetricComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/RumMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
path:
description: |-
The path to the value the RUM-based metric will aggregate on.
@@ -94926,18 +94987,18 @@ components:
description: The object describing the Datadog RUM-based metric to create.
properties:
compute:
- $ref: "#/components/schemas/RumMetricCompute"
+ $ref: '#/components/schemas/RumMetricCompute'
event_type:
- $ref: "#/components/schemas/RumMetricEventType"
+ $ref: '#/components/schemas/RumMetricEventType'
filter:
- $ref: "#/components/schemas/RumMetricFilter"
+ $ref: '#/components/schemas/RumMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/RumMetricGroupBy"
+ $ref: '#/components/schemas/RumMetricGroupBy'
type: array
uniqueness:
- $ref: "#/components/schemas/RumMetricUniqueness"
+ $ref: '#/components/schemas/RumMetricUniqueness'
required:
- event_type
- compute
@@ -94946,11 +95007,11 @@ components:
description: The new RUM-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/RumMetricCreateAttributes"
+ $ref: '#/components/schemas/RumMetricCreateAttributes'
id:
- $ref: "#/components/schemas/RumMetricID"
+ $ref: '#/components/schemas/RumMetricID'
type:
- $ref: "#/components/schemas/RumMetricType"
+ $ref: '#/components/schemas/RumMetricType'
required:
- id
- type
@@ -94960,7 +95021,7 @@ components:
description: The new RUM-based metric body.
properties:
data:
- $ref: "#/components/schemas/RumMetricCreateData"
+ $ref: '#/components/schemas/RumMetricCreateData'
required:
- data
type: object
@@ -95003,32 +95064,32 @@ components:
description: The RUM-based metric object.
properties:
data:
- $ref: "#/components/schemas/RumMetricResponseData"
+ $ref: '#/components/schemas/RumMetricResponseData'
type: object
RumMetricResponseAttributes:
description: The object describing a Datadog RUM-based metric.
properties:
compute:
- $ref: "#/components/schemas/RumMetricResponseCompute"
+ $ref: '#/components/schemas/RumMetricResponseCompute'
event_type:
- $ref: "#/components/schemas/RumMetricEventType"
+ $ref: '#/components/schemas/RumMetricEventType'
filter:
- $ref: "#/components/schemas/RumMetricResponseFilter"
+ $ref: '#/components/schemas/RumMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/RumMetricResponseGroupBy"
+ $ref: '#/components/schemas/RumMetricResponseGroupBy'
type: array
uniqueness:
- $ref: "#/components/schemas/RumMetricResponseUniqueness"
+ $ref: '#/components/schemas/RumMetricResponseUniqueness'
type: object
RumMetricResponseCompute:
description: The compute rule to compute the RUM-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/RumMetricComputeAggregationType"
+ $ref: '#/components/schemas/RumMetricComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/RumMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
path:
description: |-
The path to the value the RUM-based metric will aggregate on.
@@ -95040,11 +95101,11 @@ components:
description: The RUM-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/RumMetricResponseAttributes"
+ $ref: '#/components/schemas/RumMetricResponseAttributes'
id:
- $ref: "#/components/schemas/RumMetricID"
+ $ref: '#/components/schemas/RumMetricID'
type:
- $ref: "#/components/schemas/RumMetricType"
+ $ref: '#/components/schemas/RumMetricType'
type: object
RumMetricResponseFilter:
description: The RUM-based metric filter. RUM events matching this filter will be aggregated in this metric.
@@ -95070,7 +95131,7 @@ components:
description: The rule to count updatable events. Is only set if `event_type` is `session` or `view`.
properties:
when:
- $ref: "#/components/schemas/RumMetricUniquenessWhen"
+ $ref: '#/components/schemas/RumMetricUniquenessWhen'
type: object
RumMetricType:
default: rum_metrics
@@ -95084,7 +95145,7 @@ components:
description: The rule to count updatable events. Is only set if `event_type` is `sessions` or `views`.
properties:
when:
- $ref: "#/components/schemas/RumMetricUniquenessWhen"
+ $ref: '#/components/schemas/RumMetricUniquenessWhen'
required:
- when
type: object
@@ -95098,30 +95159,30 @@ components:
description: The RUM-based metric properties that will be updated.
properties:
compute:
- $ref: "#/components/schemas/RumMetricUpdateCompute"
+ $ref: '#/components/schemas/RumMetricUpdateCompute'
filter:
- $ref: "#/components/schemas/RumMetricFilter"
+ $ref: '#/components/schemas/RumMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/RumMetricGroupBy"
+ $ref: '#/components/schemas/RumMetricGroupBy'
type: array
type: object
RumMetricUpdateCompute:
description: The compute rule to compute the RUM-based metric.
properties:
include_percentiles:
- $ref: "#/components/schemas/RumMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/RumMetricComputeIncludePercentiles'
type: object
RumMetricUpdateData:
description: The new RUM-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/RumMetricUpdateAttributes"
+ $ref: '#/components/schemas/RumMetricUpdateAttributes'
id:
- $ref: "#/components/schemas/RumMetricID"
+ $ref: '#/components/schemas/RumMetricID'
type:
- $ref: "#/components/schemas/RumMetricType"
+ $ref: '#/components/schemas/RumMetricType'
required:
- type
- attributes
@@ -95130,7 +95191,7 @@ components:
description: The new RUM-based metric body.
properties:
data:
- $ref: "#/components/schemas/RumMetricUpdateData"
+ $ref: '#/components/schemas/RumMetricUpdateData'
required:
- data
type: object
@@ -95140,20 +95201,20 @@ components:
data:
description: A list of RUM-based metric objects.
items:
- $ref: "#/components/schemas/RumMetricResponseData"
+ $ref: '#/components/schemas/RumMetricResponseData'
type: array
type: object
RumPermanentRetentionFilterAttributes:
description: The attributes of a permanent RUM retention filter.
properties:
cross_product_sampling:
- $ref: "#/components/schemas/RumCrossProductSampling"
+ $ref: '#/components/schemas/RumCrossProductSampling'
description:
description: A description of what the filter retains.
example: "All sessions generated by Synthetics are retained at 100%."
type: string
editability:
- $ref: "#/components/schemas/RumPermanentRetentionFilterEditability"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterEditability'
name:
description: The display name of the permanent retention filter.
example: "Synthetics Sessions"
@@ -95163,11 +95224,11 @@ components:
description: A permanent RUM retention filter.
properties:
attributes:
- $ref: "#/components/schemas/RumPermanentRetentionFilterAttributes"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterAttributes'
id:
- $ref: "#/components/schemas/RumPermanentRetentionFilterID"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterID'
type:
- $ref: "#/components/schemas/RumPermanentRetentionFilterType"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterType'
type: object
RumPermanentRetentionFilterEditability:
description: Indicates which cross-product fields of a permanent RUM retention filter can be updated.
@@ -95190,7 +95251,7 @@ components:
description: A permanent RUM retention filter object.
properties:
data:
- $ref: "#/components/schemas/RumPermanentRetentionFilterData"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterData'
type: object
RumPermanentRetentionFilterType:
default: permanent_retention_filters
@@ -95204,17 +95265,17 @@ components:
description: The configuration to update on a permanent RUM retention filter.
properties:
cross_product_sampling:
- $ref: "#/components/schemas/RumCrossProductSamplingUpdate"
+ $ref: '#/components/schemas/RumCrossProductSamplingUpdate'
type: object
RumPermanentRetentionFilterUpdateData:
description: The new permanent RUM retention filter configuration to update.
properties:
attributes:
- $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateAttributes"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterUpdateAttributes'
id:
- $ref: "#/components/schemas/RumPermanentRetentionFilterID"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterID'
type:
- $ref: "#/components/schemas/RumPermanentRetentionFilterType"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterType'
required:
- id
- type
@@ -95224,7 +95285,7 @@ components:
description: The permanent RUM retention filter body to update.
properties:
data:
- $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateData"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterUpdateData'
required:
- data
type: object
@@ -95234,40 +95295,40 @@ components:
data:
description: A list of permanent RUM retention filters.
items:
- $ref: "#/components/schemas/RumPermanentRetentionFilterData"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterData'
type: array
type: object
RumRetentionFilterAttributes:
description: The object describing attributes of a RUM retention filter.
properties:
cross_product_sampling:
- $ref: "#/components/schemas/RumCrossProductSampling"
+ $ref: '#/components/schemas/RumCrossProductSampling'
enabled:
- $ref: "#/components/schemas/RumRetentionFilterEnabled"
+ $ref: '#/components/schemas/RumRetentionFilterEnabled'
event_type:
- $ref: "#/components/schemas/RumRetentionFilterEventType"
+ $ref: '#/components/schemas/RumRetentionFilterEventType'
name:
- $ref: "#/components/schemas/RunRetentionFilterName"
+ $ref: '#/components/schemas/RunRetentionFilterName'
query:
- $ref: "#/components/schemas/RumRetentionFilterQuery"
+ $ref: '#/components/schemas/RumRetentionFilterQuery'
sample_rate:
- $ref: "#/components/schemas/RumRetentionFilterSampleRate"
+ $ref: '#/components/schemas/RumRetentionFilterSampleRate'
type: object
RumRetentionFilterCreateAttributes:
description: The object describing attributes of a RUM retention filter to create.
properties:
cross_product_sampling:
- $ref: "#/components/schemas/RumCrossProductSamplingCreate"
+ $ref: '#/components/schemas/RumCrossProductSamplingCreate'
enabled:
- $ref: "#/components/schemas/RumRetentionFilterEnabled"
+ $ref: '#/components/schemas/RumRetentionFilterEnabled'
event_type:
- $ref: "#/components/schemas/RumRetentionFilterEventType"
+ $ref: '#/components/schemas/RumRetentionFilterEventType'
name:
- $ref: "#/components/schemas/RunRetentionFilterName"
+ $ref: '#/components/schemas/RunRetentionFilterName'
query:
- $ref: "#/components/schemas/RumRetentionFilterQuery"
+ $ref: '#/components/schemas/RumRetentionFilterQuery'
sample_rate:
- $ref: "#/components/schemas/RumRetentionFilterSampleRate"
+ $ref: '#/components/schemas/RumRetentionFilterSampleRate'
required:
- event_type
- name
@@ -95277,9 +95338,9 @@ components:
description: The new RUM retention filter properties to create.
properties:
attributes:
- $ref: "#/components/schemas/RumRetentionFilterCreateAttributes"
+ $ref: '#/components/schemas/RumRetentionFilterCreateAttributes'
type:
- $ref: "#/components/schemas/RumRetentionFilterType"
+ $ref: '#/components/schemas/RumRetentionFilterType'
required:
- type
- attributes
@@ -95288,7 +95349,7 @@ components:
description: The RUM retention filter body to create.
properties:
data:
- $ref: "#/components/schemas/RumRetentionFilterCreateData"
+ $ref: '#/components/schemas/RumRetentionFilterCreateData'
required:
- data
type: object
@@ -95296,11 +95357,11 @@ components:
description: The RUM retention filter.
properties:
attributes:
- $ref: "#/components/schemas/RumRetentionFilterAttributes"
+ $ref: '#/components/schemas/RumRetentionFilterAttributes'
id:
- $ref: "#/components/schemas/RumRetentionFilterID"
+ $ref: '#/components/schemas/RumRetentionFilterID'
type:
- $ref: "#/components/schemas/RumRetentionFilterType"
+ $ref: '#/components/schemas/RumRetentionFilterType'
type: object
RumRetentionFilterEnabled:
description: Whether the retention filter is enabled.
@@ -95324,7 +95385,7 @@ components:
description: The RUM retention filter object.
properties:
data:
- $ref: "#/components/schemas/RumRetentionFilterData"
+ $ref: '#/components/schemas/RumRetentionFilterData'
type: object
RumRetentionFilterSampleRate:
description: The sample rate for a RUM retention filter, between 0.1 and 100.
@@ -95345,27 +95406,27 @@ components:
description: The object describing attributes of a RUM retention filter to update.
properties:
cross_product_sampling:
- $ref: "#/components/schemas/RumCrossProductSamplingUpdate"
+ $ref: '#/components/schemas/RumCrossProductSamplingUpdate'
enabled:
- $ref: "#/components/schemas/RumRetentionFilterEnabled"
+ $ref: '#/components/schemas/RumRetentionFilterEnabled'
event_type:
- $ref: "#/components/schemas/RumRetentionFilterEventType"
+ $ref: '#/components/schemas/RumRetentionFilterEventType'
name:
- $ref: "#/components/schemas/RunRetentionFilterName"
+ $ref: '#/components/schemas/RunRetentionFilterName'
query:
- $ref: "#/components/schemas/RumRetentionFilterQuery"
+ $ref: '#/components/schemas/RumRetentionFilterQuery'
sample_rate:
- $ref: "#/components/schemas/RumRetentionFilterSampleRate"
+ $ref: '#/components/schemas/RumRetentionFilterSampleRate'
type: object
RumRetentionFilterUpdateData:
description: The new RUM retention filter properties to update.
properties:
attributes:
- $ref: "#/components/schemas/RumRetentionFilterUpdateAttributes"
+ $ref: '#/components/schemas/RumRetentionFilterUpdateAttributes'
id:
- $ref: "#/components/schemas/RumRetentionFilterID"
+ $ref: '#/components/schemas/RumRetentionFilterID'
type:
- $ref: "#/components/schemas/RumRetentionFilterType"
+ $ref: '#/components/schemas/RumRetentionFilterType'
required:
- id
- type
@@ -95375,7 +95436,7 @@ components:
description: The RUM retention filter body to update.
properties:
data:
- $ref: "#/components/schemas/RumRetentionFilterUpdateData"
+ $ref: '#/components/schemas/RumRetentionFilterUpdateData'
required:
- data
type: object
@@ -95383,9 +95444,9 @@ components:
description: The RUM retention filter data for ordering.
properties:
id:
- $ref: "#/components/schemas/RumRetentionFilterID"
+ $ref: '#/components/schemas/RumRetentionFilterID'
type:
- $ref: "#/components/schemas/RumRetentionFilterType"
+ $ref: '#/components/schemas/RumRetentionFilterType'
required:
- id
- type
@@ -95398,7 +95459,7 @@ components:
data:
description: A list of RUM retention filter IDs along with type.
items:
- $ref: "#/components/schemas/RumRetentionFiltersOrderData"
+ $ref: '#/components/schemas/RumRetentionFiltersOrderData'
type: array
type: object
RumRetentionFiltersOrderResponse:
@@ -95407,7 +95468,7 @@ components:
data:
description: A list of RUM retention filter IDs along with type.
items:
- $ref: "#/components/schemas/RumRetentionFiltersOrderData"
+ $ref: '#/components/schemas/RumRetentionFiltersOrderData'
type: array
type: object
RumRetentionFiltersResponse:
@@ -95416,16 +95477,16 @@ components:
data:
description: A list of RUM retention filters.
items:
- $ref: "#/components/schemas/RumRetentionFilterData"
+ $ref: '#/components/schemas/RumRetentionFilterData'
type: array
type: object
RumRetentionQuotaConfigAttributes:
description: The RUM retention quota configuration properties.
properties:
custom:
- $ref: "#/components/schemas/RumRetentionQuotaCustomConfig"
+ $ref: '#/components/schemas/RumRetentionQuotaCustomConfig'
mode:
- $ref: "#/components/schemas/RumRetentionQuotaMode"
+ $ref: '#/components/schemas/RumRetentionQuotaMode'
org_id:
description: The ID of the organization the retention quota configuration belongs to.
example: 2
@@ -95448,13 +95509,13 @@ components:
description: The RUM retention quota configuration object.
properties:
attributes:
- $ref: "#/components/schemas/RumRetentionQuotaConfigAttributes"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigAttributes'
id:
description: The identifier of the scope the retention quota configuration applies to.
example: cd73a516-a481-4af5-8352-9b577465c77b
type: string
type:
- $ref: "#/components/schemas/RumRetentionQuotaConfigType"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigType'
required:
- id
- type
@@ -95464,7 +95525,7 @@ components:
description: The RUM retention quota configuration response.
properties:
data:
- $ref: "#/components/schemas/RumRetentionQuotaConfigData"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigData'
required:
- data
type: object
@@ -95480,9 +95541,9 @@ components:
description: The RUM retention quota configuration properties to create or update.
properties:
custom:
- $ref: "#/components/schemas/RumRetentionQuotaCustomConfig"
+ $ref: '#/components/schemas/RumRetentionQuotaCustomConfig'
mode:
- $ref: "#/components/schemas/RumRetentionQuotaMode"
+ $ref: '#/components/schemas/RumRetentionQuotaMode'
required:
- mode
type: object
@@ -95490,7 +95551,7 @@ components:
description: The RUM retention quota configuration to create or update.
properties:
attributes:
- $ref: "#/components/schemas/RumRetentionQuotaConfigUpdateAttributes"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigUpdateAttributes'
id:
description: |-
The identifier of the scope the retention quota configuration applies to.
@@ -95498,7 +95559,7 @@ components:
example: cd73a516-a481-4af5-8352-9b577465c77b
type: string
type:
- $ref: "#/components/schemas/RumRetentionQuotaConfigType"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigType'
required:
- id
- type
@@ -95508,7 +95569,7 @@ components:
description: The body of a request to create or update a RUM retention quota configuration.
properties:
data:
- $ref: "#/components/schemas/RumRetentionQuotaConfigUpdateData"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigUpdateData'
required:
- data
type: object
@@ -95526,7 +95587,7 @@ components:
pattern: "^[+-](0\\d|1[0-4]):[0-5]\\d$"
type: string
quota_reached_action:
- $ref: "#/components/schemas/RumRetentionQuotaReachedAction"
+ $ref: '#/components/schemas/RumRetentionQuotaReachedAction'
session_limit:
description: The maximum number of sessions allowed within the window. Must be at least `1000`.
example: 1000000
@@ -95534,7 +95595,7 @@ components:
minimum: 1000
type: integer
window_type:
- $ref: "#/components/schemas/RumRetentionQuotaWindowType"
+ $ref: '#/components/schemas/RumRetentionQuotaWindowType'
required:
- window_type
- session_limit
@@ -95579,18 +95640,18 @@ components:
RumSdkConfigAllowedTracingUrlList:
description: A list of URL configurations for distributed tracing.
items:
- $ref: "#/components/schemas/RumSdkConfigTracingUrlConfig"
+ $ref: '#/components/schemas/RumSdkConfigTracingUrlConfig'
type: array
RumSdkConfigAllowedTrackingOriginList:
description: A list of origin patterns allowed for cross-origin session tracking.
items:
- $ref: "#/components/schemas/RumSdkConfigMatchOption"
+ $ref: '#/components/schemas/RumSdkConfigMatchOption'
type: array
RumSdkConfigAttributes:
description: Attributes of the RUM SDK configuration.
properties:
rum:
- $ref: "#/components/schemas/RumSdkConfigRumAttributes"
+ $ref: '#/components/schemas/RumSdkConfigRumAttributes'
required:
- rum
type: object
@@ -95598,15 +95659,15 @@ components:
description: The RUM SDK configuration data object.
properties:
attributes:
- $ref: "#/components/schemas/RumSdkConfigAttributes"
+ $ref: '#/components/schemas/RumSdkConfigAttributes'
id:
description: The unique identifier of the RUM SDK configuration.
example: "abc12345-1234-5678-abcd-ef1234567890"
type: string
meta:
- $ref: "#/components/schemas/RumSdkConfigMeta"
+ $ref: '#/components/schemas/RumSdkConfigMeta'
type:
- $ref: "#/components/schemas/RumSdkConfigType"
+ $ref: '#/components/schemas/RumSdkConfigType'
required:
- id
- type
@@ -95620,7 +95681,7 @@ components:
example: "data-version"
type: string
extractor:
- $ref: "#/components/schemas/RumSdkConfigSerializedRegex"
+ $ref: '#/components/schemas/RumSdkConfigSerializedRegex'
key:
description: The `localStorage` key to read. Required when `strategy` is `localStorage`.
example: "app.version"
@@ -95634,13 +95695,13 @@ components:
example: "application.version"
type: string
rc_serialized_type:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionSerializedType"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionSerializedType'
selector:
description: The CSS selector to read from the page. Required when `strategy` is `dom`.
example: "#app-version"
type: string
strategy:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionStrategy"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionStrategy'
required:
- rc_serialized_type
- strategy
@@ -95653,7 +95714,7 @@ components:
example: "id"
type: string
value:
- $ref: "#/components/schemas/RumSdkConfigDynamicOption"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOption'
required:
- key
- value
@@ -95661,7 +95722,7 @@ components:
RumSdkConfigDynamicOptionPairList:
description: A list of dynamic option key-value pairs.
items:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionPair"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionPair'
type: array
RumSdkConfigDynamicOptionSerializedType:
description: The type identifier for a dynamic option. Always `dynamic`.
@@ -95689,7 +95750,7 @@ components:
description: A match option used for URL or origin pattern matching.
properties:
rc_serialized_type:
- $ref: "#/components/schemas/RumSdkConfigMatchOptionSerializedType"
+ $ref: '#/components/schemas/RumSdkConfigMatchOptionSerializedType'
value:
description: The value to match against.
example: "https://app.datadoghq.com"
@@ -95728,7 +95789,7 @@ components:
description: Response containing a RUM SDK configuration.
properties:
data:
- $ref: "#/components/schemas/RumSdkConfigData"
+ $ref: '#/components/schemas/RumSdkConfigData'
required:
- data
type: object
@@ -95736,15 +95797,15 @@ components:
description: The RUM SDK settings for a configuration.
properties:
allowed_tracing_urls:
- $ref: "#/components/schemas/RumSdkConfigAllowedTracingUrlList"
+ $ref: '#/components/schemas/RumSdkConfigAllowedTracingUrlList'
allowed_tracking_origins:
- $ref: "#/components/schemas/RumSdkConfigAllowedTrackingOriginList"
+ $ref: '#/components/schemas/RumSdkConfigAllowedTrackingOriginList'
application_id:
description: The ID of the RUM application this configuration belongs to.
example: "f80e917c-3cd0-4048-ade7-1c4c207baa99"
type: string
context:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionPairList"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionPairList'
default_privacy_level:
description: The default privacy masking level applied to all RUM data.
example: "mask-user-input"
@@ -95787,9 +95848,9 @@ components:
example: false
type: boolean
user:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionPairList"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionPairList'
version:
- $ref: "#/components/schemas/RumSdkConfigDynamicOption"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOption'
required:
- application_id
- session_sample_rate
@@ -95801,11 +95862,11 @@ components:
description: The RUM SDK settings to apply when updating a configuration.
properties:
allowed_tracing_urls:
- $ref: "#/components/schemas/RumSdkConfigAllowedTracingUrlList"
+ $ref: '#/components/schemas/RumSdkConfigAllowedTracingUrlList'
allowed_tracking_origins:
- $ref: "#/components/schemas/RumSdkConfigAllowedTrackingOriginList"
+ $ref: '#/components/schemas/RumSdkConfigAllowedTrackingOriginList'
context:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionPairList"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionPairList'
default_privacy_level:
description: The default privacy masking level applied to all RUM data.
example: "mask"
@@ -95848,9 +95909,9 @@ components:
example: false
type: boolean
user:
- $ref: "#/components/schemas/RumSdkConfigDynamicOptionPairList"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOptionPairList'
version:
- $ref: "#/components/schemas/RumSdkConfigDynamicOption"
+ $ref: '#/components/schemas/RumSdkConfigDynamicOption'
required:
- session_sample_rate
- session_replay_sample_rate
@@ -95861,7 +95922,7 @@ components:
description: A serialized regex used as an extractor in dynamic options.
properties:
rc_serialized_type:
- $ref: "#/components/schemas/RumSdkConfigSerializedRegexType"
+ $ref: '#/components/schemas/RumSdkConfigSerializedRegexType'
value:
description: The regex pattern used for extraction.
example: "^https://app-.*.datadoghq.com"
@@ -95882,14 +95943,14 @@ components:
description: Configuration for a URL that should have distributed tracing enabled.
properties:
match:
- $ref: "#/components/schemas/RumSdkConfigMatchOption"
+ $ref: '#/components/schemas/RumSdkConfigMatchOption'
propagator_types:
description: The list of trace propagator types to use for this URL.
example:
- datadog
- tracecontext
items:
- $ref: "#/components/schemas/RumSdkConfigTracingUrlPropagatorType"
+ $ref: '#/components/schemas/RumSdkConfigTracingUrlPropagatorType'
type: array
required:
- match
@@ -95922,7 +95983,7 @@ components:
description: Attributes of the RUM SDK configuration to update.
properties:
rum:
- $ref: "#/components/schemas/RumSdkConfigRumUpdateAttributes"
+ $ref: '#/components/schemas/RumSdkConfigRumUpdateAttributes'
required:
- rum
type: object
@@ -95930,13 +95991,13 @@ components:
description: The data object for updating a RUM SDK configuration.
properties:
attributes:
- $ref: "#/components/schemas/RumSdkConfigUpdateAttributes"
+ $ref: '#/components/schemas/RumSdkConfigUpdateAttributes'
id:
description: The ID of the RUM SDK configuration to update.
example: "abc12345-1234-5678-abcd-ef1234567890"
type: string
type:
- $ref: "#/components/schemas/RumSdkConfigType"
+ $ref: '#/components/schemas/RumSdkConfigType'
required:
- id
- type
@@ -95946,7 +96007,7 @@ components:
description: Request body for updating a RUM SDK configuration.
properties:
data:
- $ref: "#/components/schemas/RumSdkConfigUpdateData"
+ $ref: '#/components/schemas/RumSdkConfigUpdateData'
required:
- data
type: object
@@ -95954,7 +96015,7 @@ components:
description: The response returned when a data observability monitor run is triggered.
properties:
data:
- $ref: "#/components/schemas/RunDataObservabilityMonitorResponseData"
+ $ref: '#/components/schemas/RunDataObservabilityMonitorResponseData'
required:
- data
type: object
@@ -95966,7 +96027,7 @@ components:
example: "abc123def456"
type: string
type:
- $ref: "#/components/schemas/DataObservabilityMonitorRunType"
+ $ref: '#/components/schemas/DataObservabilityMonitorRunType'
required:
- id
- type
@@ -95975,15 +96036,15 @@ components:
description: Run a historical job request.
properties:
data:
- $ref: "#/components/schemas/RunHistoricalJobRequestData"
+ $ref: '#/components/schemas/RunHistoricalJobRequestData'
type: object
RunHistoricalJobRequestAttributes:
description: Run a historical job request.
properties:
fromRule:
- $ref: "#/components/schemas/JobDefinitionFromRule"
+ $ref: '#/components/schemas/JobDefinitionFromRule'
jobDefinition:
- $ref: "#/components/schemas/JobDefinition"
+ $ref: '#/components/schemas/JobDefinition'
signalOutput:
description: Whether the job outputs signals when results are converted.
type: boolean
@@ -95992,9 +96053,9 @@ components:
description: Data for running a historical job request.
properties:
attributes:
- $ref: "#/components/schemas/RunHistoricalJobRequestAttributes"
+ $ref: '#/components/schemas/RunHistoricalJobRequestAttributes'
type:
- $ref: "#/components/schemas/RunHistoricalJobRequestDataType"
+ $ref: '#/components/schemas/RunHistoricalJobRequestDataType'
type: object
RunHistoricalJobRequestDataType:
description: Type of data.
@@ -96011,13 +96072,13 @@ components:
description: SAML assertion attribute.
properties:
attributes:
- $ref: "#/components/schemas/SAMLAssertionAttributeAttributes"
+ $ref: '#/components/schemas/SAMLAssertionAttributeAttributes'
id:
description: The ID of the SAML assertion attribute.
example: "0"
type: string
type:
- $ref: "#/components/schemas/SAMLAssertionAttributesType"
+ $ref: '#/components/schemas/SAMLAssertionAttributesType'
required:
- id
- type
@@ -96047,15 +96108,15 @@ components:
description: A SAML configuration object.
properties:
attributes:
- $ref: "#/components/schemas/SAMLConfigurationAttributes"
+ $ref: '#/components/schemas/SAMLConfigurationAttributes'
id:
description: The UUID of the SAML configuration.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: string
relationships:
- $ref: "#/components/schemas/SAMLConfigurationRelationships"
+ $ref: '#/components/schemas/SAMLConfigurationRelationships'
type:
- $ref: "#/components/schemas/SAMLConfigurationsType"
+ $ref: '#/components/schemas/SAMLConfigurationsType'
required:
- id
- type
@@ -96119,17 +96180,17 @@ components:
description: Relationships of a SAML configuration.
properties:
default_roles:
- $ref: "#/components/schemas/RelationshipToRoles"
+ $ref: '#/components/schemas/RelationshipToRoles'
type: object
SAMLConfigurationResponse:
description: Response containing a single SAML configuration.
properties:
data:
- $ref: "#/components/schemas/SAMLConfiguration"
+ $ref: '#/components/schemas/SAMLConfiguration'
included:
description: Resources related to the SAML configuration, such as the default roles.
items:
- $ref: "#/components/schemas/Role"
+ $ref: '#/components/schemas/Role'
type: array
required:
- data
@@ -96161,16 +96222,16 @@ components:
description: Data for updating a SAML configuration.
properties:
attributes:
- $ref: "#/components/schemas/SAMLConfigurationUpdateAttributes"
+ $ref: '#/components/schemas/SAMLConfigurationUpdateAttributes'
id:
description: The UUID of the SAML configuration to update. Must match the UUID in the URL path.
example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
maxLength: 39
type: string
relationships:
- $ref: "#/components/schemas/SAMLConfigurationRelationships"
+ $ref: '#/components/schemas/SAMLConfigurationRelationships'
type:
- $ref: "#/components/schemas/SAMLConfigurationsType"
+ $ref: '#/components/schemas/SAMLConfigurationsType'
required:
- id
- type
@@ -96179,7 +96240,7 @@ components:
description: Request to update a SAML configuration.
properties:
data:
- $ref: "#/components/schemas/SAMLConfigurationUpdateData"
+ $ref: '#/components/schemas/SAMLConfigurationUpdateData'
required:
- data
type: object
@@ -96189,12 +96250,12 @@ components:
data:
description: Array of SAML configurations. An organization has at most one SAML configuration.
items:
- $ref: "#/components/schemas/SAMLConfiguration"
+ $ref: '#/components/schemas/SAMLConfiguration'
type: array
included:
description: Resources related to the SAML configurations, such as the default roles.
items:
- $ref: "#/components/schemas/Role"
+ $ref: '#/components/schemas/Role'
type: array
type: object
SAMLConfigurationsType:
@@ -96210,13 +96271,13 @@ components:
description: A single SBOM
properties:
attributes:
- $ref: "#/components/schemas/SBOMAttributes"
+ $ref: '#/components/schemas/SBOMAttributes'
id:
description: The unique ID for this SBOM (it is equivalent to the `asset_name` or `asset_name@repo_digest` (Image)
example: "github.com/datadog/datadog-agent"
type: string
type:
- $ref: "#/components/schemas/SBOMType"
+ $ref: '#/components/schemas/SBOMType'
type: object
SBOMAttributes:
description: The JSON:API attributes of the SBOM.
@@ -96228,21 +96289,21 @@ components:
components:
description: A list of software and hardware components.
items:
- $ref: "#/components/schemas/SBOMComponent"
+ $ref: '#/components/schemas/SBOMComponent'
type: array
dependencies:
description: List of dependencies between components of the SBOM.
items:
- $ref: "#/components/schemas/SBOMComponentDependency"
+ $ref: '#/components/schemas/SBOMComponentDependency'
type: array
metadata:
- $ref: "#/components/schemas/SBOMMetadata"
+ $ref: '#/components/schemas/SBOMMetadata'
serialNumber:
description: Every BOM generated has a unique serial number, even if the contents of the BOM have not changed overt time. The serial number follows [RFC-4122](https://datatracker.ietf.org/doc/html/rfc4122)
example: urn:uuid:f7119d2f-1vgh-24b5-91f0-12010db72da7
type: string
specVersion:
- $ref: "#/components/schemas/SpecVersion"
+ $ref: '#/components/schemas/SpecVersion'
version:
description: It increments when a BOM is modified. The default value is 1.
example: 1
@@ -96267,7 +96328,7 @@ components:
licenses:
description: The software licenses of the SBOM component.
items:
- $ref: "#/components/schemas/SBOMComponentLicense"
+ $ref: '#/components/schemas/SBOMComponentLicense'
type: array
name:
description: The name of the component. This will often be a shortened, single name of the component.
@@ -96276,16 +96337,16 @@ components:
properties:
description: The custom properties of the component of the SBOM.
items:
- $ref: "#/components/schemas/SBOMComponentProperty"
+ $ref: '#/components/schemas/SBOMComponentProperty'
type: array
purl:
description: Specifies the package-url (purl). The purl, if specified, MUST be valid and conform to the [specification](https://github.com/package-url/purl-spec).
example: "pkg:golang/google.golang.org/grpc@1.68.1"
type: string
supplier:
- $ref: "#/components/schemas/SBOMComponentSupplier"
+ $ref: '#/components/schemas/SBOMComponentSupplier'
type:
- $ref: "#/components/schemas/SBOMComponentType"
+ $ref: '#/components/schemas/SBOMComponentType'
version:
description: The component version.
example: "1.68.1"
@@ -96318,7 +96379,7 @@ components:
description: The software license of the component of the SBOM.
properties:
license:
- $ref: "#/components/schemas/SBOMComponentLicenseLicense"
+ $ref: '#/components/schemas/SBOMComponentLicenseLicense'
required:
- license
type: object
@@ -96425,10 +96486,10 @@ components:
authors:
description: List of authors of the SBOM.
items:
- $ref: "#/components/schemas/SBOMMetadataAuthor"
+ $ref: '#/components/schemas/SBOMMetadataAuthor'
type: array
component:
- $ref: "#/components/schemas/SBOMMetadataComponent"
+ $ref: '#/components/schemas/SBOMMetadataComponent'
timestamp:
description: The timestamp of the SBOM creation.
example: "2025-07-08T07:24:53Z"
@@ -96478,7 +96539,7 @@ components:
example: User
type: string
meta:
- $ref: "#/components/schemas/SCIMResourceTypeMeta"
+ $ref: '#/components/schemas/SCIMResourceTypeMeta'
name:
description: The resource type name.
example: User
@@ -96514,7 +96575,7 @@ components:
attributes:
description: A list of attributes that make up the schema.
items:
- $ref: "#/components/schemas/SCIMSchemaAttribute"
+ $ref: '#/components/schemas/SCIMSchemaAttribute'
type: array
description:
description: Human-readable description of the schema.
@@ -96525,7 +96586,7 @@ components:
example: urn:ietf:params:scim:schemas:core:2.0:User
type: string
meta:
- $ref: "#/components/schemas/SCIMSchemaMeta"
+ $ref: '#/components/schemas/SCIMSchemaMeta'
name:
description: The human-readable name of the schema.
example: User
@@ -96573,7 +96634,7 @@ components:
subAttributes:
description: A list of sub-attributes for complex attributes.
items:
- $ref: "#/components/schemas/SCIMSchemaAttributeSubAttribute"
+ $ref: '#/components/schemas/SCIMSchemaAttributeSubAttribute'
type: array
type:
description: The data type of the attribute.
@@ -96661,7 +96722,7 @@ components:
description: The SLO report response.
properties:
data:
- $ref: "#/components/schemas/SLOReportPostResponseData"
+ $ref: '#/components/schemas/SLOReportPostResponseData'
type: object
SLOReportPostResponseData:
description: The data portion of the SLO report response.
@@ -96693,19 +96754,19 @@ components:
description: The SLO report status response.
properties:
data:
- $ref: "#/components/schemas/SLOReportStatusGetResponseData"
+ $ref: '#/components/schemas/SLOReportStatusGetResponseData'
type: object
SLOReportStatusGetResponseAttributes:
description: The attributes portion of the SLO report status response.
properties:
status:
- $ref: "#/components/schemas/SLOReportStatus"
+ $ref: '#/components/schemas/SLOReportStatus'
type: object
SLOReportStatusGetResponseData:
description: The data portion of the SLO report status response.
properties:
attributes:
- $ref: "#/components/schemas/SLOReportStatusGetResponseAttributes"
+ $ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
id:
description: The ID of the report job.
example: "dc8d92aa-e0af-11ee-af21-1feeaccaa3a3"
@@ -96736,12 +96797,12 @@ components:
type: indicator
valid_from: "2026-07-22T12:00:00Z"
items:
- $ref: "#/components/schemas/STIXObject"
+ $ref: '#/components/schemas/STIXObject'
type: array
spec_version:
- $ref: "#/components/schemas/STIXSpecVersion"
+ $ref: '#/components/schemas/STIXSpecVersion'
type:
- $ref: "#/components/schemas/STIXBundleType"
+ $ref: '#/components/schemas/STIXBundleType'
required:
- type
- id
@@ -96767,7 +96828,7 @@ components:
description: The response from a completed STIX ingestion request.
properties:
data:
- $ref: "#/components/schemas/STIXIngestResponseData"
+ $ref: '#/components/schemas/STIXIngestResponseData'
required:
- data
type: object
@@ -96802,13 +96863,13 @@ components:
description: The JSON:API resource describing the completed STIX ingestion request.
properties:
attributes:
- $ref: "#/components/schemas/STIXIngestResponseAttributes"
+ $ref: '#/components/schemas/STIXIngestResponseAttributes'
id:
description: The normalized vendor identifier.
example: acme
type: string
type:
- $ref: "#/components/schemas/STIXIngestResponseType"
+ $ref: '#/components/schemas/STIXIngestResponseType'
required:
- type
- id
@@ -96846,7 +96907,7 @@ components:
external_references:
description: Optional external reference metadata preserved with the indicator but not interpreted during ingestion.
items:
- $ref: "#/components/schemas/STIXMetadataObject"
+ $ref: '#/components/schemas/STIXMetadataObject'
type: array
id:
description: The STIX object identifier.
@@ -96862,7 +96923,7 @@ components:
kill_chain_phases:
description: Optional kill chain metadata preserved with the indicator but not interpreted during ingestion.
items:
- $ref: "#/components/schemas/STIXMetadataObject"
+ $ref: '#/components/schemas/STIXMetadataObject'
type: array
labels:
description: Labels associated with the indicator.
@@ -96888,7 +96949,7 @@ components:
example: "[ipv4-addr:value = '198.51.100.42']"
type: string
pattern_type:
- $ref: "#/components/schemas/STIXPatternType"
+ $ref: '#/components/schemas/STIXPatternType'
revoked:
description: Whether the indicator has been revoked.
example: false
@@ -96955,7 +97016,7 @@ components:
description: Salesforce organization data from a response.
properties:
attributes:
- $ref: "#/components/schemas/SalesforceIncidentsOrganizationResponseAttributes"
+ $ref: '#/components/schemas/SalesforceIncidentsOrganizationResponseAttributes'
id:
description: The Datadog-assigned ID of the connected Salesforce organization.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -96963,7 +97024,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/SalesforceIncidentsOrganizationType"
+ $ref: '#/components/schemas/SalesforceIncidentsOrganizationType'
required:
- id
- type
@@ -96986,7 +97047,7 @@ components:
data:
description: An array of Salesforce organizations.
items:
- $ref: "#/components/schemas/SalesforceIncidentsOrganizationResponseData"
+ $ref: '#/components/schemas/SalesforceIncidentsOrganizationResponseData'
type: array
required:
- data
@@ -97013,7 +97074,7 @@ components:
minLength: 1
type: string
priority:
- $ref: "#/components/schemas/SalesforceIncidentsTemplatePriority"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplatePriority'
salesforce_org_id:
description: The Datadog-assigned ID of the Salesforce organization this template belongs to.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -97037,9 +97098,9 @@ components:
description: Salesforce incident template data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateCreateAttributes"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateCreateAttributes'
type:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateType"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateType'
required:
- type
- attributes
@@ -97048,7 +97109,7 @@ components:
description: Create request for a Salesforce incident template.
properties:
data:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateCreateData"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateCreateData'
required:
- data
type: object
@@ -97070,7 +97131,7 @@ components:
description: Response containing a Salesforce incident template.
properties:
data:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateResponseData"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateResponseData'
required:
- data
type: object
@@ -97090,7 +97151,7 @@ components:
example: "005000000000000"
type: string
priority:
- $ref: "#/components/schemas/SalesforceIncidentsTemplatePriority"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplatePriority'
salesforce_org_id:
description: The Datadog-assigned ID of the Salesforce organization this template belongs to.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -97105,7 +97166,7 @@ components:
description: Salesforce incident template data from a response.
properties:
attributes:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateResponseAttributes"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateResponseAttributes'
id:
description: The ID of the Salesforce incident template.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -97113,7 +97174,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateType"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateType'
required:
- id
- type
@@ -97150,7 +97211,7 @@ components:
minLength: 1
type: string
priority:
- $ref: "#/components/schemas/SalesforceIncidentsTemplatePriority"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplatePriority'
salesforce_org_id:
description: The Datadog-assigned ID of the Salesforce organization this template belongs to.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -97167,7 +97228,7 @@ components:
description: Salesforce incident template data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateUpdateAttributes"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateUpdateAttributes'
id:
description: The ID of the Salesforce incident template being updated. Must match the path parameter.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -97175,7 +97236,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateType"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateType'
required:
- id
- type
@@ -97185,7 +97246,7 @@ components:
description: Update request for a Salesforce incident template.
properties:
data:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateUpdateData"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateUpdateData'
required:
- data
type: object
@@ -97195,7 +97256,7 @@ components:
data:
description: An array of Salesforce incident templates.
items:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateResponseData"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateResponseData'
type: array
required:
- data
@@ -97213,7 +97274,7 @@ components:
maxItems: 5
type: array
duration:
- $ref: "#/components/schemas/SampleLogGenerationDuration"
+ $ref: '#/components/schemas/SampleLogGenerationDuration'
required:
- content_pack_ids
type: object
@@ -97221,9 +97282,9 @@ components:
description: The bulk subscription request body.
properties:
attributes:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionAttributes"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionAttributes'
type:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionRequestType"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionRequestType'
required:
- type
- attributes
@@ -97248,7 +97309,7 @@ components:
description: Request body to create sample log generation subscriptions for multiple content packs at once.
properties:
data:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionData"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionData'
required:
- data
type: object
@@ -97267,7 +97328,7 @@ components:
data:
description: The list of bulk subscription results, one per requested content pack.
items:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionResultItem"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionResultItem'
type: array
required:
- data
@@ -97276,15 +97337,15 @@ components:
description: A single result entry returned by the bulk subscription endpoint.
properties:
attributes:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionAttributes"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionAttributes'
id:
description: The unique identifier of the subscription, when one was created.
example: "123"
type: string
meta:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionItemMeta"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionItemMeta'
type:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionResourceType"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionResourceType'
required:
- id
- type
@@ -97328,7 +97389,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionStatus"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionStatus'
required:
- content_pack_id
- status
@@ -97344,7 +97405,7 @@ components:
example: aws-cloudtrail
type: string
duration:
- $ref: "#/components/schemas/SampleLogGenerationDuration"
+ $ref: '#/components/schemas/SampleLogGenerationDuration'
required:
- content_pack_id
type: object
@@ -97352,9 +97413,9 @@ components:
description: The subscription request body.
properties:
attributes:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionCreateAttributes"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionCreateAttributes'
type:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionRequestType"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionRequestType'
required:
- type
- attributes
@@ -97363,7 +97424,7 @@ components:
description: Request body to create a sample log generation subscription for a single content pack.
properties:
data:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionCreateData"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionCreateData'
required:
- data
type: object
@@ -97371,13 +97432,13 @@ components:
description: A sample log generation subscription.
properties:
attributes:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionAttributes"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionAttributes'
id:
description: The unique identifier of the subscription.
example: "789"
type: string
type:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionResourceType"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionResourceType'
required:
- id
- type
@@ -97405,7 +97466,7 @@ components:
description: Response containing a single sample log generation subscription.
properties:
data:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionData"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionData'
required:
- data
type: object
@@ -97435,10 +97496,10 @@ components:
data:
description: The list of sample log generation subscriptions.
items:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionData"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionData'
type: array
meta:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionsResponseMeta"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionsResponseMeta'
required:
- data
- meta
@@ -97470,13 +97531,13 @@ components:
description: The primary data object representing a SAST ruleset.
properties:
attributes:
- $ref: "#/components/schemas/SastRulesetDataAttributes"
+ $ref: '#/components/schemas/SastRulesetDataAttributes'
id:
description: The unique identifier of the ruleset resource.
example: python-best-practices
type: string
type:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType'
required:
- id
- type
@@ -97496,7 +97557,7 @@ components:
rules:
description: The list of static analysis rules included in this ruleset.
items:
- $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems'
type: array
short_description:
description: A brief summary of the ruleset, suitable for display in listings.
@@ -97512,7 +97573,7 @@ components:
description: The response payload containing a single SAST ruleset and its rules.
properties:
data:
- $ref: "#/components/schemas/SastRulesetData"
+ $ref: '#/components/schemas/SastRulesetData'
required:
- data
type: object
@@ -97522,7 +97583,7 @@ components:
data:
description: The list of SAST rulesets returned in the response.
items:
- $ref: "#/components/schemas/SastRulesetData"
+ $ref: '#/components/schemas/SastRulesetData'
type: array
required:
- data
@@ -97531,18 +97592,18 @@ components:
description: The top-level request object for submitting a Software Composition Analysis (SCA) scan result.
properties:
data:
- $ref: "#/components/schemas/ScaRequestData"
+ $ref: '#/components/schemas/ScaRequestData'
type: object
ScaRequestData:
description: The data object in an SCA request, containing the dependency graph attributes and request type.
properties:
attributes:
- $ref: "#/components/schemas/ScaRequestDataAttributes"
+ $ref: '#/components/schemas/ScaRequestDataAttributes'
id:
description: An optional identifier for this SCA request data object.
type: string
type:
- $ref: "#/components/schemas/ScaRequestDataType"
+ $ref: '#/components/schemas/ScaRequestDataType'
required:
- type
type: object
@@ -97551,11 +97612,11 @@ components:
The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context.
properties:
commit:
- $ref: "#/components/schemas/ScaRequestDataAttributesCommit"
+ $ref: '#/components/schemas/ScaRequestDataAttributesCommit'
dependencies:
description: The list of dependencies discovered in the repository.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItems'
type: array
env:
description: The environment context in which the SCA scan was performed (e.g., production, staging).
@@ -97563,26 +97624,26 @@ components:
files:
description: The list of dependency manifest files found in the repository.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesFilesItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesFilesItems'
type: array
relations:
description: The dependency relations describing the inter-component dependency graph.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesRelationsItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesRelationsItems'
type: array
repository:
- $ref: "#/components/schemas/ScaRequestDataAttributesRepository"
+ $ref: '#/components/schemas/ScaRequestDataAttributesRepository'
scan_start_timestamp:
- $ref: "#/components/schemas/ScaRequestDataAttributesScanStartTimestamp"
+ $ref: '#/components/schemas/ScaRequestDataAttributesScanStartTimestamp'
service:
description: The name of the service or application being analyzed.
type: string
tags:
- $ref: "#/components/schemas/ScaRequestDataAttributesTags"
+ $ref: '#/components/schemas/ScaRequestDataAttributesTags'
vulnerabilities:
description: The list of vulnerabilities identified in the dependency graph.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems'
type: array
type: object
ScaRequestDataAttributesCommit:
@@ -97635,7 +97696,7 @@ components:
description: The programming language ecosystem of this dependency (e.g., java, python, javascript).
type: string
locations:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocations"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocations'
name:
description: The name of the dependency package.
type: string
@@ -97651,7 +97712,7 @@ components:
reachable_symbol_properties:
description: Properties describing symbols from this dependency that are reachable in the application code.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems'
type: array
requires_transitive_enrichment:
description: Indicates whether this dependency requires transitive dependency enrichment.
@@ -97676,7 +97737,7 @@ components:
ScaRequestDataAttributesDependenciesItemsLocations:
description: The list of source file locations where this dependency is declared.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems'
nullable: true
type: array
ScaRequestDataAttributesDependenciesItemsLocationsItems:
@@ -97684,19 +97745,19 @@ components:
The source code location where a dependency is declared, including block, name, namespace, and version positions within the file.
properties:
block:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition'
name:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition'
namespace:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition'
version:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition'
type: object
ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition:
description: A range within a file defined by a start and end position, along with the file name.
properties:
end:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
file_name:
description: The name or path of the file containing this location.
type: string
@@ -97704,14 +97765,14 @@ components:
description: The semantic role associated with this file location.
type: string
start:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
type: object
ScaRequestDataAttributesDependenciesItemsLocationsItemsNullableFilePosition:
description: A nullable range within a file defined by a start and end position, along with the file name.
nullable: true
properties:
end:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
file_name:
description: The name or path of the file containing this location.
type: string
@@ -97719,7 +97780,7 @@ components:
description: The semantic role associated with this file location.
type: string
start:
- $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition"
+ $ref: '#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition'
type: object
ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition:
description: A specific position (line and column) within a source file.
@@ -97797,14 +97858,14 @@ components:
description: A map of tags providing additional metadata for the SCA scan.
properties:
tool:
- $ref: "#/components/schemas/ScaRequestDataAttributesTagsTool"
+ $ref: '#/components/schemas/ScaRequestDataAttributesTagsTool'
type: object
ScaRequestDataAttributesTagsTool:
additionalProperties: false
description: Tool metadata included in SCA tags.
properties:
generator:
- $ref: "#/components/schemas/ScaRequestDataAttributesTagsToolGenerator"
+ $ref: '#/components/schemas/ScaRequestDataAttributesTagsToolGenerator'
type: object
ScaRequestDataAttributesTagsToolGenerator:
additionalProperties: false
@@ -97824,7 +97885,7 @@ components:
affects:
description: The list of components affected by this vulnerability.
items:
- $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems"
+ $ref: '#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems'
type: array
bom_ref:
description: The unique BOM reference identifier for this vulnerability entry.
@@ -97852,8 +97913,8 @@ components:
ScalarColumn:
description: A single column in a scalar query response.
oneOf:
- - $ref: "#/components/schemas/GroupScalarColumn"
- - $ref: "#/components/schemas/DataScalarColumn"
+ - $ref: '#/components/schemas/GroupScalarColumn'
+ - $ref: '#/components/schemas/DataScalarColumn'
ScalarColumnTypeGroup:
default: group
description: The type of column present for groups.
@@ -97876,7 +97937,7 @@ components:
description: A wrapper request around one scalar query to be executed.
properties:
data:
- $ref: "#/components/schemas/ScalarFormulaRequest"
+ $ref: '#/components/schemas/ScalarFormulaRequest'
required:
- data
type: object
@@ -97884,7 +97945,7 @@ components:
description: A message containing one or more responses to scalar queries.
properties:
data:
- $ref: "#/components/schemas/ScalarResponse"
+ $ref: '#/components/schemas/ScalarResponse'
errors:
description: An error generated when processing a request.
type: string
@@ -97893,9 +97954,9 @@ components:
description: A single scalar query to be executed.
properties:
attributes:
- $ref: "#/components/schemas/ScalarFormulaRequestAttributes"
+ $ref: '#/components/schemas/ScalarFormulaRequestAttributes'
type:
- $ref: "#/components/schemas/ScalarFormulaRequestType"
+ $ref: '#/components/schemas/ScalarFormulaRequestType'
required:
- type
- attributes
@@ -97906,7 +97967,7 @@ components:
formulas:
description: List of formulas to be calculated and returned as responses.
items:
- $ref: "#/components/schemas/QueryFormula"
+ $ref: '#/components/schemas/QueryFormula'
type: array
from:
description: Start date (inclusive) of the query in milliseconds since the Unix epoch.
@@ -97914,7 +97975,7 @@ components:
format: int64
type: integer
queries:
- $ref: "#/components/schemas/ScalarFormulaRequestQueries"
+ $ref: '#/components/schemas/ScalarFormulaRequestQueries'
to:
description: End date (exclusive) of the query in milliseconds since the Unix epoch.
example: 1568923200000
@@ -97932,7 +97993,7 @@ components:
data_source: metrics
query: "avg:system.cpu.user{*} by {env}"
items:
- $ref: "#/components/schemas/ScalarQuery"
+ $ref: '#/components/schemas/ScalarQuery'
type: array
ScalarFormulaRequestType:
default: "scalar_request"
@@ -97947,7 +98008,7 @@ components:
columns:
description: List of response columns, each corresponding to an individual formula or query in the request and with values in parallel arrays matching the series list.
items:
- $ref: "#/components/schemas/ScalarColumn"
+ $ref: '#/components/schemas/ScalarColumn'
type: array
type: object
ScalarFormulaResponseType:
@@ -97967,7 +98028,7 @@ components:
The second element describes the "per unit" (for example, `second` in `bytes per second`).
If the second element is not present, the API returns null.
items:
- $ref: "#/components/schemas/Unit"
+ $ref: '#/components/schemas/Unit'
nullable: true
type: array
type: object
@@ -97978,21 +98039,21 @@ components:
data_source: metrics
query: "avg:system.cpu.user{*} by {env}"
oneOf:
- - $ref: "#/components/schemas/MetricsScalarQuery"
- - $ref: "#/components/schemas/EventsScalarQuery"
- - $ref: "#/components/schemas/ApmResourceStatsQuery"
- - $ref: "#/components/schemas/ApmMetricsQuery"
- - $ref: "#/components/schemas/ApmDependencyStatsQuery"
- - $ref: "#/components/schemas/SloQuery"
- - $ref: "#/components/schemas/ProcessScalarQuery"
- - $ref: "#/components/schemas/ContainerScalarQuery"
+ - $ref: '#/components/schemas/MetricsScalarQuery'
+ - $ref: '#/components/schemas/EventsScalarQuery'
+ - $ref: '#/components/schemas/ApmResourceStatsQuery'
+ - $ref: '#/components/schemas/ApmMetricsQuery'
+ - $ref: '#/components/schemas/ApmDependencyStatsQuery'
+ - $ref: '#/components/schemas/SloQuery'
+ - $ref: '#/components/schemas/ProcessScalarQuery'
+ - $ref: '#/components/schemas/ContainerScalarQuery'
ScalarResponse:
description: A message containing the response to a scalar query.
properties:
attributes:
- $ref: "#/components/schemas/ScalarFormulaResponseAtrributes"
+ $ref: '#/components/schemas/ScalarFormulaResponseAtrributes'
type:
- $ref: "#/components/schemas/ScalarFormulaResponseType"
+ $ref: '#/components/schemas/ScalarFormulaResponseType'
type: object
ScanResultResponse:
description: |-
@@ -98000,18 +98061,18 @@ components:
The contents reflect the vulnerabilities and metadata produced for the libraries
submitted in the original scan request.
oneOf:
- - $ref: "#/components/schemas/AnyValueObject"
+ - $ref: '#/components/schemas/AnyValueObject'
ScannedAssetMetadata:
description: The metadata of a scanned asset.
properties:
attributes:
- $ref: "#/components/schemas/ScannedAssetMetadataAttributes"
+ $ref: '#/components/schemas/ScannedAssetMetadataAttributes'
id:
description: The ID of the scanned asset metadata.
example: "Host|i-0fc7edef1ab26d7ef"
type: string
type:
- $ref: "#/components/schemas/ScannedAssetMetadataType"
+ $ref: '#/components/schemas/ScannedAssetMetadataType'
required:
- id
- type
@@ -98025,7 +98086,7 @@ components:
example: "i-0fc7edef1ab26d7ef"
type: string
type:
- $ref: "#/components/schemas/CloudAssetType"
+ $ref: '#/components/schemas/CloudAssetType'
required:
- type
- name
@@ -98034,13 +98095,13 @@ components:
description: The attributes of a scanned asset metadata.
properties:
asset:
- $ref: "#/components/schemas/ScannedAssetMetadataAsset"
+ $ref: '#/components/schemas/ScannedAssetMetadataAsset'
first_success_timestamp:
description: The timestamp when the scan of the asset was performed for the first time.
example: "2025-07-08T07:24:53Z"
type: string
last_success:
- $ref: "#/components/schemas/ScannedAssetMetadataLastSuccess"
+ $ref: '#/components/schemas/ScannedAssetMetadataLastSuccess'
required:
- asset
- last_success
@@ -98083,12 +98144,12 @@ components:
data:
description: List of scanned assets metadata.
items:
- $ref: "#/components/schemas/ScannedAssetMetadata"
+ $ref: '#/components/schemas/ScannedAssetMetadata'
type: array
links:
- $ref: "#/components/schemas/Links"
+ $ref: '#/components/schemas/Links'
meta:
- $ref: "#/components/schemas/Metadata"
+ $ref: '#/components/schemas/Metadata'
required:
- data
type: object
@@ -98151,11 +98212,11 @@ components:
type: users
properties:
data:
- $ref: "#/components/schemas/ScheduleData"
+ $ref: '#/components/schemas/ScheduleData'
included:
description: Any additional resources related to this schedule, such as teams and layers.
items:
- $ref: "#/components/schemas/ScheduleDataIncludedItem"
+ $ref: '#/components/schemas/ScheduleDataIncludedItem'
type: array
type: object
ScheduleCreateRequest:
@@ -98188,7 +98249,7 @@ components:
type: schedules
properties:
data:
- $ref: "#/components/schemas/ScheduleCreateRequestData"
+ $ref: '#/components/schemas/ScheduleCreateRequestData'
required:
- data
type: object
@@ -98196,11 +98257,11 @@ components:
description: The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleCreateRequestDataAttributes"
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributes'
relationships:
- $ref: "#/components/schemas/ScheduleCreateRequestDataRelationships"
+ $ref: '#/components/schemas/ScheduleCreateRequestDataRelationships'
type:
- $ref: "#/components/schemas/ScheduleCreateRequestDataType"
+ $ref: '#/components/schemas/ScheduleCreateRequestDataType'
required:
- type
- attributes
@@ -98211,7 +98272,7 @@ components:
layers:
description: The layers of On-Call coverage that define rotation intervals and restrictions.
items:
- $ref: "#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems"
+ $ref: '#/components/schemas/ScheduleCreateRequestDataAttributesLayersItems'
type: array
name:
description: A human-readable name for the new schedule.
@@ -98240,11 +98301,11 @@ components:
format: date-time
type: string
interval:
- $ref: "#/components/schemas/LayerAttributesInterval"
+ $ref: '#/components/schemas/LayerAttributesInterval'
members:
description: A list of members who participate in this layer's rotation.
items:
- $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems"
+ $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems'
type: array
name:
description: The name of this layer.
@@ -98253,7 +98314,7 @@ components:
restrictions:
description: Zero or more time-based restrictions (for example, only weekdays, during business hours).
items:
- $ref: "#/components/schemas/TimeRestriction"
+ $ref: '#/components/schemas/TimeRestriction'
type: array
rotation_start:
description: The date/time when the rotation for this layer starts (in ISO 8601).
@@ -98275,7 +98336,7 @@ components:
description: Gathers relationship objects for the schedule creation request, including the teams to associate.
properties:
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
type: object
ScheduleCreateRequestDataType:
default: schedules
@@ -98291,15 +98352,15 @@ components:
description: Represents the primary data object for a schedule, linking attributes and relationships.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleDataAttributes"
+ $ref: '#/components/schemas/ScheduleDataAttributes'
id:
description: The schedule's unique identifier.
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
relationships:
- $ref: "#/components/schemas/ScheduleDataRelationships"
+ $ref: '#/components/schemas/ScheduleDataRelationships'
type:
- $ref: "#/components/schemas/ScheduleDataType"
+ $ref: '#/components/schemas/ScheduleDataType'
required:
- type
type: object
@@ -98323,17 +98384,17 @@ components:
ScheduleDataIncludedItem:
description: Any additional resources related to this schedule, such as teams and layers.
oneOf:
- - $ref: "#/components/schemas/TeamReference"
- - $ref: "#/components/schemas/Layer"
- - $ref: "#/components/schemas/ScheduleMember"
- - $ref: "#/components/schemas/ScheduleUser"
+ - $ref: '#/components/schemas/TeamReference'
+ - $ref: '#/components/schemas/Layer'
+ - $ref: '#/components/schemas/ScheduleMember'
+ - $ref: '#/components/schemas/ScheduleUser'
ScheduleDataRelationships:
description: Groups the relationships for a schedule object, referencing layers and teams.
properties:
layers:
- $ref: "#/components/schemas/ScheduleDataRelationshipsLayers"
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayers'
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
type: object
ScheduleDataRelationshipsLayers:
description: Associates layers with this schedule in a data structure.
@@ -98341,7 +98402,7 @@ components:
data:
description: An array of layer references for this schedule.
items:
- $ref: "#/components/schemas/ScheduleDataRelationshipsLayersDataItems"
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItems'
type: array
type: object
ScheduleDataRelationshipsLayersDataItems:
@@ -98353,7 +98414,7 @@ components:
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType"
+ $ref: '#/components/schemas/ScheduleDataRelationshipsLayersDataItemsType'
required:
- type
- id
@@ -98385,9 +98446,9 @@ components:
description: The unique identifier for this schedule member.
type: string
relationships:
- $ref: "#/components/schemas/ScheduleMemberRelationships"
+ $ref: '#/components/schemas/ScheduleMemberRelationships'
type:
- $ref: "#/components/schemas/ScheduleMemberType"
+ $ref: '#/components/schemas/ScheduleMemberType'
required:
- type
type: object
@@ -98395,13 +98456,13 @@ components:
description: Defines relationships for a schedule member, primarily referencing a single user.
properties:
user:
- $ref: "#/components/schemas/ScheduleMemberRelationshipsUser"
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUser'
type: object
ScheduleMemberRelationshipsUser:
description: Wraps the user data reference for a schedule member.
properties:
data:
- $ref: "#/components/schemas/ScheduleMemberRelationshipsUserData"
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUserData'
required:
- data
type: object
@@ -98413,7 +98474,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/ScheduleMemberRelationshipsUserDataType"
+ $ref: '#/components/schemas/ScheduleMemberRelationshipsUserDataType'
required:
- type
- id
@@ -98442,14 +98503,14 @@ components:
description: Represents one position's (previous, current, or next) group of on-call responder shifts. Positions with no matching shift are omitted entirely from the response.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataAttributes"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataAttributes'
id:
description: Unique identifier of this responder group.
type: string
relationships:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataRelationships"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataRelationships'
type:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataType"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataType'
required:
- type
type: object
@@ -98457,13 +98518,13 @@ components:
description: Attributes for one position's (previous, current, or next) group of on-call responder shifts.
properties:
position:
- $ref: "#/components/schemas/ScheduleTargetPosition"
+ $ref: '#/components/schemas/ScheduleTargetPosition'
type: object
ScheduleOnCallResponderDataRelationships:
description: Relationships for a single position's (previous, current, or next) responder group.
properties:
shifts:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataRelationshipsShifts"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataRelationshipsShifts'
type: object
ScheduleOnCallResponderDataRelationshipsShifts:
description: Defines the list of shifts satisfying this responder group's position. Multiple shifts occur when a schedule has multiple concurrent on-call responders at that position.
@@ -98471,7 +98532,7 @@ components:
data:
description: Array of references to the shifts included in the response.
items:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataRelationshipsShiftsDataItems"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataRelationshipsShiftsDataItems'
type: array
type: object
ScheduleOnCallResponderDataRelationshipsShiftsDataItems:
@@ -98482,7 +98543,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/ScheduleOnCallResponderDataRelationshipsShiftsDataItemsType"
+ $ref: '#/components/schemas/ScheduleOnCallResponderDataRelationshipsShiftsDataItemsType'
required:
- type
- id
@@ -98550,25 +98611,25 @@ components:
type: users
properties:
data:
- $ref: "#/components/schemas/ScheduleOnCallRespondersData"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersData'
included:
description: Related resources referenced in the responder groups' relationships, such as shifts, schedules, and users.
items:
- $ref: "#/components/schemas/ScheduleOnCallRespondersIncluded"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersIncluded'
type: array
type: object
ScheduleOnCallRespondersData:
description: The main data object representing a schedule's on-call responders lookup, including relationships and metadata.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataAttributes"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataAttributes'
id:
description: Unique identifier of this on-call responders lookup.
type: string
relationships:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationships"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationships'
type:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataType"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataType'
required:
- type
type: object
@@ -98584,9 +98645,9 @@ components:
description: Relationships for a schedule's on-call responders lookup, including the schedule and its responder groups.
properties:
responders:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsResponders"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsResponders'
schedule:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsSchedule"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsSchedule'
type: object
ScheduleOnCallRespondersDataRelationshipsResponders:
description: Defines the list of per-position (previous, current, next) responder groups for the schedule.
@@ -98594,7 +98655,7 @@ components:
data:
description: Array of references to the responder groups included in the response.
items:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsRespondersDataItems"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsRespondersDataItems'
type: array
type: object
ScheduleOnCallRespondersDataRelationshipsRespondersDataItems:
@@ -98605,7 +98666,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsRespondersDataItemsType"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsRespondersDataItemsType'
required:
- type
- id
@@ -98623,7 +98684,7 @@ components:
description: Defines the relationship to the schedule this on-call responders lookup was performed for.
properties:
data:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsScheduleData"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsScheduleData'
type: object
ScheduleOnCallRespondersDataRelationshipsScheduleData:
description: Represents a reference to the schedule this on-call responders lookup was performed for.
@@ -98633,7 +98694,7 @@ components:
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
type:
- $ref: "#/components/schemas/ScheduleOnCallRespondersDataRelationshipsScheduleDataType"
+ $ref: '#/components/schemas/ScheduleOnCallRespondersDataRelationshipsScheduleDataType'
required:
- type
- id
@@ -98659,16 +98720,16 @@ components:
ScheduleOnCallRespondersIncluded:
description: Represents a union of related resources included in the response, such as responder groups, shifts, schedules, and users.
oneOf:
- - $ref: "#/components/schemas/ScheduleOnCallResponderData"
- - $ref: "#/components/schemas/ShiftData"
- - $ref: "#/components/schemas/ScheduleData"
- - $ref: "#/components/schemas/User"
+ - $ref: '#/components/schemas/ScheduleOnCallResponderData'
+ - $ref: '#/components/schemas/ShiftData'
+ - $ref: '#/components/schemas/ScheduleData'
+ - $ref: '#/components/schemas/User'
ScheduleRequestDataAttributesLayersItemsMembersItems:
description: |-
Defines a single member within a schedule layer, including the reference to the underlying user.
properties:
user:
- $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItemsUser"
+ $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItemsUser'
type: object
ScheduleRequestDataAttributesLayersItemsMembersItemsUser:
description: Identifies the user participating in this layer as a single object with an `id`.
@@ -98686,7 +98747,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/ScheduleTargetType"
+ $ref: '#/components/schemas/ScheduleTargetType'
required:
- type
- id
@@ -98716,7 +98777,7 @@ components:
description: "Trigger a workflow from a Schedule. The workflow must be published."
properties:
overlapBehavior:
- $ref: "#/components/schemas/ScheduleTriggerOverlapBehavior"
+ $ref: '#/components/schemas/ScheduleTriggerOverlapBehavior'
rruleExpression:
description: "Recurrence rule expression for scheduling."
example: ""
@@ -98739,9 +98800,9 @@ components:
description: "Schema for a Schedule-based trigger."
properties:
scheduleTrigger:
- $ref: "#/components/schemas/ScheduleTrigger"
+ $ref: '#/components/schemas/ScheduleTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- scheduleTrigger
type: object
@@ -98776,7 +98837,7 @@ components:
type: schedules
properties:
data:
- $ref: "#/components/schemas/ScheduleUpdateRequestData"
+ $ref: '#/components/schemas/ScheduleUpdateRequestData'
required:
- data
type: object
@@ -98784,15 +98845,15 @@ components:
description: Contains all data needed to update an existing schedule, including its attributes (such as name and time zone) and any relationships to teams.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleUpdateRequestDataAttributes"
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributes'
id:
description: The ID of the schedule to be updated.
example: "3653d3c6-0c75-11ea-ad28-fb5701eabc7d"
type: string
relationships:
- $ref: "#/components/schemas/ScheduleUpdateRequestDataRelationships"
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataRelationships'
type:
- $ref: "#/components/schemas/ScheduleUpdateRequestDataType"
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataType'
required:
- type
- id
@@ -98805,7 +98866,7 @@ components:
layers:
description: The updated list of layers (rotations) for this schedule.
items:
- $ref: "#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItems"
+ $ref: '#/components/schemas/ScheduleUpdateRequestDataAttributesLayersItems'
type: array
name:
description: A short name for the schedule.
@@ -98840,11 +98901,11 @@ components:
example: "00000000-0000-0000-0000-000000000001"
type: string
interval:
- $ref: "#/components/schemas/LayerAttributesInterval"
+ $ref: '#/components/schemas/LayerAttributesInterval'
members:
description: The members assigned to this layer.
items:
- $ref: "#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems"
+ $ref: '#/components/schemas/ScheduleRequestDataAttributesLayersItemsMembersItems'
type: array
name:
description: The name for this layer (for example, "Secondary Coverage").
@@ -98853,7 +98914,7 @@ components:
restrictions:
description: Any time restrictions that define when this layer is active.
items:
- $ref: "#/components/schemas/TimeRestriction"
+ $ref: '#/components/schemas/TimeRestriction'
type: array
rotation_start:
description: The date/time at which the rotation begins (ISO 8601 format).
@@ -98876,7 +98937,7 @@ components:
Houses relationships for the schedule update, typically referencing teams.
properties:
teams:
- $ref: "#/components/schemas/DataRelationshipsTeams"
+ $ref: '#/components/schemas/DataRelationshipsTeams'
type: object
ScheduleUpdateRequestDataType:
default: schedules
@@ -98892,12 +98953,12 @@ components:
description: Represents a user object in the context of a schedule, including their `id`, type, and basic attributes.
properties:
attributes:
- $ref: "#/components/schemas/ScheduleUserAttributes"
+ $ref: '#/components/schemas/ScheduleUserAttributes'
id:
description: The unique user identifier.
type: string
type:
- $ref: "#/components/schemas/ScheduleUserType"
+ $ref: '#/components/schemas/ScheduleUserType'
required:
- type
type: object
@@ -98913,7 +98974,7 @@ components:
example: "Jane Doe"
type: string
status:
- $ref: "#/components/schemas/UserAttributesStatus"
+ $ref: '#/components/schemas/UserAttributesStatus'
type: object
ScheduleUserType:
default: users
@@ -98955,13 +99016,13 @@ components:
description: Scorecard data.
properties:
attributes:
- $ref: "#/components/schemas/ScorecardListResponseAttributes"
+ $ref: '#/components/schemas/ScorecardListResponseAttributes'
id:
description: The unique ID of the scorecard.
example: q8MQxk8TCqrHnWkx
type: string
type:
- $ref: "#/components/schemas/ScorecardListType"
+ $ref: '#/components/schemas/ScorecardListType'
required:
- id
- type
@@ -98979,7 +99040,7 @@ components:
description: Attributes of a scorecard score.
properties:
aggregation:
- $ref: "#/components/schemas/ScorecardScoresAggregation"
+ $ref: '#/components/schemas/ScorecardScoresAggregation'
denominator:
description: The denominator used to compute the score ratio.
format: int64
@@ -99021,15 +99082,15 @@ components:
description: A scorecard score object for a single entity, rule, scorecard, service, or team.
properties:
attributes:
- $ref: "#/components/schemas/ScorecardScoreAttributes"
+ $ref: '#/components/schemas/ScorecardScoreAttributes'
id:
description: The ID of the entity or resource being scored.
example: ""
type: string
relationships:
- $ref: "#/components/schemas/ScorecardScoreRelationships"
+ $ref: '#/components/schemas/ScorecardScoreRelationships'
type:
- $ref: "#/components/schemas/ScorecardScoreDataType"
+ $ref: '#/components/schemas/ScorecardScoreDataType'
required:
- id
- type
@@ -99061,21 +99122,21 @@ components:
description: A relationship item for a score.
properties:
data:
- $ref: "#/components/schemas/ScorecardScoreRelationshipData"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipData'
type: object
ScorecardScoreRelationships:
description: Relationships for a scorecard score, depending on the aggregation type.
properties:
entity:
- $ref: "#/components/schemas/ScorecardScoreRelationshipItem"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipItem'
rule:
- $ref: "#/components/schemas/ScorecardScoreRelationshipItem"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipItem'
scorecard:
- $ref: "#/components/schemas/ScorecardScoreRelationshipItem"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipItem'
service:
- $ref: "#/components/schemas/ScorecardScoreRelationshipItem"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipItem'
team:
- $ref: "#/components/schemas/ScorecardScoreRelationshipItem"
+ $ref: '#/components/schemas/ScorecardScoreRelationshipItem'
type: object
ScorecardScoresAggregation:
description: Dimension to group scores by.
@@ -99132,7 +99193,7 @@ components:
nullable: true
type: string
type:
- $ref: "#/components/schemas/SeatUserDataType"
+ $ref: '#/components/schemas/SeatUserDataType'
type: object
SeatUserDataArray:
description: A paginated list of seat user resources with associated pagination metadata.
@@ -99140,7 +99201,7 @@ components:
data:
description: The list of seat users.
items:
- $ref: "#/components/schemas/SeatUserData"
+ $ref: '#/components/schemas/SeatUserData'
type: array
meta:
$ref: "#/components/schemas/SeatUserMeta"
@@ -99195,7 +99256,7 @@ components:
data:
description: The list of secret detection rules.
items:
- $ref: "#/components/schemas/SecretRuleData"
+ $ref: '#/components/schemas/SecretRuleData'
type: array
required:
- data
@@ -99204,12 +99265,12 @@ components:
description: The data object representing a secret detection rule, including its attributes and resource type.
properties:
attributes:
- $ref: "#/components/schemas/SecretRuleDataAttributes"
+ $ref: '#/components/schemas/SecretRuleDataAttributes'
id:
description: The unique identifier of the secret rule resource.
type: string
type:
- $ref: "#/components/schemas/SecretRuleDataType"
+ $ref: '#/components/schemas/SecretRuleDataType'
required:
- type
type: object
@@ -99229,7 +99290,7 @@ components:
description: The license under which this secret rule is distributed.
type: string
match_validation:
- $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidation"
+ $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidation'
name:
description: The unique name of the secret detection rule.
type: string
@@ -99267,7 +99328,7 @@ components:
invalid_http_status_code:
description: The HTTP status code ranges that indicate the detected secret is invalid or inactive.
items:
- $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems"
+ $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems'
type: array
request_headers:
additionalProperties:
@@ -99286,7 +99347,7 @@ components:
valid_http_status_code:
description: The HTTP status code ranges that indicate the detected secret is valid and active.
items:
- $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems"
+ $ref: '#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems'
type: array
type: object
SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems:
@@ -99334,7 +99395,7 @@ components:
description: Request to create a secure embed shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SecureEmbedCreateRequestData"
+ $ref: '#/components/schemas/SecureEmbedCreateRequestData'
required:
- data
type: object
@@ -99342,7 +99403,7 @@ components:
description: Attributes for creating a secure embed shared dashboard.
properties:
global_time:
- $ref: "#/components/schemas/SecureEmbedGlobalTime"
+ $ref: '#/components/schemas/SecureEmbedGlobalTime'
global_time_selectable:
description: Whether viewers can change the time range.
example: true
@@ -99350,16 +99411,16 @@ components:
selectable_template_vars:
description: Template variables viewers can modify.
items:
- $ref: "#/components/schemas/SecureEmbedSelectableTemplateVariable"
+ $ref: '#/components/schemas/SecureEmbedSelectableTemplateVariable'
type: array
status:
- $ref: "#/components/schemas/SecureEmbedStatus"
+ $ref: '#/components/schemas/SecureEmbedStatus'
title:
description: Display title for the shared dashboard.
example: "Q1 Metrics Dashboard"
type: string
viewing_preferences:
- $ref: "#/components/schemas/SecureEmbedViewingPreferences"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferences'
required:
- status
- title
@@ -99372,9 +99433,9 @@ components:
description: Data object for creating a secure embed.
properties:
attributes:
- $ref: "#/components/schemas/SecureEmbedCreateRequestAttributes"
+ $ref: '#/components/schemas/SecureEmbedCreateRequestAttributes'
type:
- $ref: "#/components/schemas/SecureEmbedRequestType"
+ $ref: '#/components/schemas/SecureEmbedRequestType'
required:
- type
- attributes
@@ -99383,7 +99444,7 @@ components:
description: Response for creating a secure embed shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SecureEmbedCreateResponseData"
+ $ref: '#/components/schemas/SecureEmbedCreateResponseData'
required:
- data
type: object
@@ -99407,7 +99468,7 @@ components:
readOnly: true
type: string
global_time:
- $ref: "#/components/schemas/SecureEmbedGlobalTime"
+ $ref: '#/components/schemas/SecureEmbedGlobalTime'
global_time_selectable:
description: Whether time range is viewer-selectable.
example: true
@@ -99420,12 +99481,12 @@ components:
selectable_template_vars:
description: Template variables with their configuration.
items:
- $ref: "#/components/schemas/SecureEmbedSelectableTemplateVariable"
+ $ref: '#/components/schemas/SecureEmbedSelectableTemplateVariable'
type: array
share_type:
- $ref: "#/components/schemas/SecureEmbedShareType"
+ $ref: '#/components/schemas/SecureEmbedShareType'
status:
- $ref: "#/components/schemas/SecureEmbedStatus"
+ $ref: '#/components/schemas/SecureEmbedStatus'
title:
description: Display title.
example: "Q1 Metrics Dashboard"
@@ -99441,19 +99502,19 @@ components:
readOnly: true
type: string
viewing_preferences:
- $ref: "#/components/schemas/SecureEmbedViewingPreferences"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferences'
type: object
SecureEmbedCreateResponseData:
description: Data object for a secure embed create response.
properties:
attributes:
- $ref: "#/components/schemas/SecureEmbedCreateResponseAttributes"
+ $ref: '#/components/schemas/SecureEmbedCreateResponseAttributes'
id:
description: Internal share ID.
example: "12345"
type: string
type:
- $ref: "#/components/schemas/SecureEmbedCreateResponseType"
+ $ref: '#/components/schemas/SecureEmbedCreateResponseType'
required:
- type
- id
@@ -99471,7 +99532,7 @@ components:
description: Response for getting a secure embed shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SecureEmbedGetResponseData"
+ $ref: '#/components/schemas/SecureEmbedGetResponseData'
required:
- data
type: object
@@ -99494,7 +99555,7 @@ components:
readOnly: true
type: string
global_time:
- $ref: "#/components/schemas/SecureEmbedGlobalTime"
+ $ref: '#/components/schemas/SecureEmbedGlobalTime'
global_time_selectable:
description: Whether time range is viewer-selectable.
example: true
@@ -99507,12 +99568,12 @@ components:
selectable_template_vars:
description: Template variables with their configuration.
items:
- $ref: "#/components/schemas/SecureEmbedSelectableTemplateVariable"
+ $ref: '#/components/schemas/SecureEmbedSelectableTemplateVariable'
type: array
share_type:
- $ref: "#/components/schemas/SecureEmbedShareType"
+ $ref: '#/components/schemas/SecureEmbedShareType'
status:
- $ref: "#/components/schemas/SecureEmbedStatus"
+ $ref: '#/components/schemas/SecureEmbedStatus'
title:
description: Display title.
example: "Q1 Metrics Dashboard"
@@ -99528,19 +99589,19 @@ components:
readOnly: true
type: string
viewing_preferences:
- $ref: "#/components/schemas/SecureEmbedViewingPreferences"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferences'
type: object
SecureEmbedGetResponseData:
description: Data object for a secure embed get response.
properties:
attributes:
- $ref: "#/components/schemas/SecureEmbedGetResponseAttributes"
+ $ref: '#/components/schemas/SecureEmbedGetResponseAttributes'
id:
description: Internal share ID.
example: "12345"
type: string
type:
- $ref: "#/components/schemas/SecureEmbedGetResponseType"
+ $ref: '#/components/schemas/SecureEmbedGetResponseType'
required:
- type
- id
@@ -99558,7 +99619,7 @@ components:
description: Default time range configuration for the secure embed.
properties:
live_span:
- $ref: "#/components/schemas/SecureEmbedGlobalTimeLiveSpan"
+ $ref: '#/components/schemas/SecureEmbedGlobalTimeLiveSpan'
type: object
SecureEmbedGlobalTimeLiveSpan:
description: Dashboard global time live_span selection.
@@ -99638,7 +99699,7 @@ components:
description: Request to update a secure embed shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SecureEmbedUpdateRequestData"
+ $ref: '#/components/schemas/SecureEmbedUpdateRequestData'
required:
- data
type: object
@@ -99646,7 +99707,7 @@ components:
description: Attributes for updating a secure embed shared dashboard. All fields are optional.
properties:
global_time:
- $ref: "#/components/schemas/SecureEmbedGlobalTime"
+ $ref: '#/components/schemas/SecureEmbedGlobalTime'
global_time_selectable:
description: Updated time selectability.
example: true
@@ -99654,24 +99715,24 @@ components:
selectable_template_vars:
description: Updated template variables.
items:
- $ref: "#/components/schemas/SecureEmbedSelectableTemplateVariable"
+ $ref: '#/components/schemas/SecureEmbedSelectableTemplateVariable'
type: array
status:
- $ref: "#/components/schemas/SecureEmbedStatus"
+ $ref: '#/components/schemas/SecureEmbedStatus'
title:
description: Updated title.
example: "Q1 Metrics Dashboard (Updated)"
type: string
viewing_preferences:
- $ref: "#/components/schemas/SecureEmbedViewingPreferences"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferences'
type: object
SecureEmbedUpdateRequestData:
description: Data object for updating a secure embed.
properties:
attributes:
- $ref: "#/components/schemas/SecureEmbedUpdateRequestAttributes"
+ $ref: '#/components/schemas/SecureEmbedUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/SecureEmbedUpdateRequestType"
+ $ref: '#/components/schemas/SecureEmbedUpdateRequestType'
required:
- type
- attributes
@@ -99688,7 +99749,7 @@ components:
description: Response for updating a secure embed shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SecureEmbedUpdateResponseData"
+ $ref: '#/components/schemas/SecureEmbedUpdateResponseData'
required:
- data
type: object
@@ -99711,7 +99772,7 @@ components:
readOnly: true
type: string
global_time:
- $ref: "#/components/schemas/SecureEmbedGlobalTime"
+ $ref: '#/components/schemas/SecureEmbedGlobalTime'
global_time_selectable:
description: Whether time range is viewer-selectable.
example: true
@@ -99724,12 +99785,12 @@ components:
selectable_template_vars:
description: Template variables with their configuration.
items:
- $ref: "#/components/schemas/SecureEmbedSelectableTemplateVariable"
+ $ref: '#/components/schemas/SecureEmbedSelectableTemplateVariable'
type: array
share_type:
- $ref: "#/components/schemas/SecureEmbedShareType"
+ $ref: '#/components/schemas/SecureEmbedShareType'
status:
- $ref: "#/components/schemas/SecureEmbedStatus"
+ $ref: '#/components/schemas/SecureEmbedStatus'
title:
description: Display title.
example: "Q1 Metrics Dashboard (Updated)"
@@ -99745,19 +99806,19 @@ components:
readOnly: true
type: string
viewing_preferences:
- $ref: "#/components/schemas/SecureEmbedViewingPreferences"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferences'
type: object
SecureEmbedUpdateResponseData:
description: Data object for a secure embed update response.
properties:
attributes:
- $ref: "#/components/schemas/SecureEmbedUpdateResponseAttributes"
+ $ref: '#/components/schemas/SecureEmbedUpdateResponseAttributes'
id:
description: Internal share ID.
example: "12345"
type: string
type:
- $ref: "#/components/schemas/SecureEmbedUpdateResponseType"
+ $ref: '#/components/schemas/SecureEmbedUpdateResponseType'
required:
- type
- id
@@ -99779,7 +99840,7 @@ components:
example: false
type: boolean
theme:
- $ref: "#/components/schemas/SecureEmbedViewingPreferencesTheme"
+ $ref: '#/components/schemas/SecureEmbedViewingPreferencesTheme'
type: object
SecureEmbedViewingPreferencesTheme:
description: The theme of the shared dashboard view. `system` follows the viewer's system default.
@@ -99820,7 +99881,7 @@ components:
description: Metadata for the list of automation rules.
properties:
page:
- $ref: "#/components/schemas/SecurityAutomationRulesPageInfo"
+ $ref: '#/components/schemas/SecurityAutomationRulesPageInfo'
required:
- page
type: object
@@ -99931,13 +99992,13 @@ components:
description: An entity risk score containing security risk assessment information
properties:
attributes:
- $ref: "#/components/schemas/SecurityEntityRiskScoreAttributes"
+ $ref: '#/components/schemas/SecurityEntityRiskScoreAttributes'
id:
description: Unique identifier for the entity
example: "arn:aws:iam::123456789012:user/john.doe"
type: string
type:
- $ref: "#/components/schemas/SecurityEntityRiskScoreType"
+ $ref: '#/components/schemas/SecurityEntityRiskScoreType'
required:
- id
- type
@@ -99954,9 +100015,9 @@ components:
type: string
type: array
configRisks:
- $ref: "#/components/schemas/SecurityEntityConfigRisks"
+ $ref: '#/components/schemas/SecurityEntityConfigRisks'
entityMetadata:
- $ref: "#/components/schemas/SecurityEntityMetadata"
+ $ref: '#/components/schemas/SecurityEntityMetadata'
entityName:
description: Human-readable name of the entity.
example: "john.doe"
@@ -100018,7 +100079,7 @@ components:
format: int64
type: integer
severity:
- $ref: "#/components/schemas/SecurityEntityRiskScoreAttributesSeverity"
+ $ref: '#/components/schemas/SecurityEntityRiskScoreAttributesSeverity'
signalsDetected:
description: Number of security signals detected for this entity.
example: 15
@@ -100058,7 +100119,7 @@ components:
description: Response containing a single entity risk score
properties:
data:
- $ref: "#/components/schemas/SecurityEntityRiskScore"
+ $ref: '#/components/schemas/SecurityEntityRiskScore'
required:
- data
type: object
@@ -100104,10 +100165,10 @@ components:
data:
description: Array of entity risk score objects.
items:
- $ref: "#/components/schemas/SecurityEntityRiskScore"
+ $ref: '#/components/schemas/SecurityEntityRiskScore'
type: array
meta:
- $ref: "#/components/schemas/SecurityEntityRiskScoresMeta"
+ $ref: '#/components/schemas/SecurityEntityRiskScoresMeta'
required:
- data
- meta
@@ -100116,11 +100177,11 @@ components:
description: The security filter's properties.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFilterAttributes"
+ $ref: '#/components/schemas/SecurityFilterAttributes'
id:
- $ref: "#/components/schemas/SecurityFilterID"
+ $ref: '#/components/schemas/SecurityFilterID'
type:
- $ref: "#/components/schemas/SecurityFilterType"
+ $ref: '#/components/schemas/SecurityFilterType'
type: object
SecurityFilterAttributes:
description: The object describing a security filter.
@@ -100128,10 +100189,10 @@ components:
exclusion_filters:
description: The list of exclusion filters applied in this security filter.
items:
- $ref: "#/components/schemas/SecurityFilterExclusionFilterResponse"
+ $ref: '#/components/schemas/SecurityFilterExclusionFilterResponse'
type: array
filtered_data_type:
- $ref: "#/components/schemas/SecurityFilterFilteredDataType"
+ $ref: '#/components/schemas/SecurityFilterFilteredDataType'
is_builtin:
description: Whether the security filter is the built-in filter.
example: false
@@ -100164,10 +100225,10 @@ components:
- name: Exclude staging
query: source:staging
items:
- $ref: "#/components/schemas/SecurityFilterExclusionFilter"
+ $ref: '#/components/schemas/SecurityFilterExclusionFilter'
type: array
filtered_data_type:
- $ref: "#/components/schemas/SecurityFilterFilteredDataType"
+ $ref: '#/components/schemas/SecurityFilterFilteredDataType'
is_enabled:
description: Whether the security filter is enabled.
example: true
@@ -100191,9 +100252,9 @@ components:
description: Object for a single security filter.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFilterCreateAttributes"
+ $ref: '#/components/schemas/SecurityFilterCreateAttributes'
type:
- $ref: "#/components/schemas/SecurityFilterType"
+ $ref: '#/components/schemas/SecurityFilterType'
required:
- type
- attributes
@@ -100202,7 +100263,7 @@ components:
description: Request object that includes the security filter that you would like to create.
properties:
data:
- $ref: "#/components/schemas/SecurityFilterCreateData"
+ $ref: '#/components/schemas/SecurityFilterCreateData'
required:
- data
type: object
@@ -100260,9 +100321,9 @@ components:
description: Response object which includes a single security filter.
properties:
data:
- $ref: "#/components/schemas/SecurityFilter"
+ $ref: '#/components/schemas/SecurityFilter'
meta:
- $ref: "#/components/schemas/SecurityFilterMeta"
+ $ref: '#/components/schemas/SecurityFilterMeta'
type: object
SecurityFilterType:
default: security_filters
@@ -100280,10 +100341,10 @@ components:
description: Exclusion filters to exclude some logs from the security filter.
example: []
items:
- $ref: "#/components/schemas/SecurityFilterExclusionFilter"
+ $ref: '#/components/schemas/SecurityFilterExclusionFilter'
type: array
filtered_data_type:
- $ref: "#/components/schemas/SecurityFilterFilteredDataType"
+ $ref: '#/components/schemas/SecurityFilterFilteredDataType'
is_enabled:
description: Whether the security filter is enabled.
example: true
@@ -100307,9 +100368,9 @@ components:
description: The new security filter properties.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFilterUpdateAttributes"
+ $ref: '#/components/schemas/SecurityFilterUpdateAttributes'
type:
- $ref: "#/components/schemas/SecurityFilterType"
+ $ref: '#/components/schemas/SecurityFilterType'
required:
- type
- attributes
@@ -100318,7 +100379,7 @@ components:
description: The new security filter body.
properties:
data:
- $ref: "#/components/schemas/SecurityFilterUpdateData"
+ $ref: '#/components/schemas/SecurityFilterUpdateData'
required:
- data
type: object
@@ -100326,13 +100387,13 @@ components:
description: A snapshot of all security filters at a specific configuration version.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFilterVersionAttributes"
+ $ref: '#/components/schemas/SecurityFilterVersionAttributes'
id:
description: The identifier of the configuration version.
example: "1"
type: string
type:
- $ref: "#/components/schemas/SecurityFilterVersionType"
+ $ref: '#/components/schemas/SecurityFilterVersionType'
required:
- id
- type
@@ -100349,7 +100410,7 @@ components:
filters:
description: The set of security filters at this configuration version.
items:
- $ref: "#/components/schemas/SecurityFilterVersionEntry"
+ $ref: '#/components/schemas/SecurityFilterVersionEntry'
type: array
version:
description: The configuration version number.
@@ -100368,10 +100429,10 @@ components:
exclusion_filters:
description: The list of exclusion filters applied in this security filter.
items:
- $ref: "#/components/schemas/SecurityFilterExclusionFilterResponse"
+ $ref: '#/components/schemas/SecurityFilterExclusionFilterResponse'
type: array
filtered_data_type:
- $ref: "#/components/schemas/SecurityFilterFilteredDataType"
+ $ref: '#/components/schemas/SecurityFilterFilteredDataType'
id:
description: The ID of the security filter.
example: "123"
@@ -100423,7 +100484,7 @@ components:
data:
description: A list of historical security filter configurations, ordered from the most recent to the oldest.
items:
- $ref: "#/components/schemas/SecurityFilterVersion"
+ $ref: '#/components/schemas/SecurityFilterVersion'
type: array
required:
- data
@@ -100434,10 +100495,10 @@ components:
data:
description: A list of security filters objects.
items:
- $ref: "#/components/schemas/SecurityFilter"
+ $ref: '#/components/schemas/SecurityFilter'
type: array
meta:
- $ref: "#/components/schemas/SecurityFilterMeta"
+ $ref: '#/components/schemas/SecurityFilterMeta'
type: object
SecurityFindingType:
description: The type of security finding that the automation rule applies to.
@@ -100472,7 +100533,7 @@ components:
example:
- misconfiguration
items:
- $ref: "#/components/schemas/SecurityFindingType"
+ $ref: '#/components/schemas/SecurityFindingType'
minItems: 1
type: array
SecurityFindingsAttributes:
@@ -100502,13 +100563,13 @@ components:
description: A single security finding.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFindingsAttributes"
+ $ref: '#/components/schemas/SecurityFindingsAttributes'
id:
description: The unique ID of the security finding.
example: "ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw=="
type: string
type:
- $ref: "#/components/schemas/SecurityFindingsDataType"
+ $ref: '#/components/schemas/SecurityFindingsDataType'
type: object
SecurityFindingsDataType:
default: finding
@@ -100536,13 +100597,13 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/SecurityFindingsPage"
+ $ref: '#/components/schemas/SecurityFindingsPage'
request_id:
description: The identifier of the request.
example: "pddv1ChZwVlMxMUdYRFRMQ1lyb3B4MGNYbFlnIi0KHQu35LDbucx"
type: string
status:
- $ref: "#/components/schemas/SecurityFindingsStatus"
+ $ref: '#/components/schemas/SecurityFindingsStatus'
type: object
SecurityFindingsPage:
description: Pagination information.
@@ -100556,13 +100617,13 @@ components:
description: The request body for searching security findings.
properties:
data:
- $ref: "#/components/schemas/SecurityFindingsSearchRequestData"
+ $ref: '#/components/schemas/SecurityFindingsSearchRequestData'
type: object
SecurityFindingsSearchRequestData:
description: Request data for searching security findings.
properties:
attributes:
- $ref: "#/components/schemas/SecurityFindingsSearchRequestDataAttributes"
+ $ref: '#/components/schemas/SecurityFindingsSearchRequestDataAttributes'
type: object
SecurityFindingsSearchRequestDataAttributes:
description: Request attributes for searching security findings.
@@ -100573,9 +100634,9 @@ components:
example: "@severity:(critical OR high) @status:open team:platform"
type: string
page:
- $ref: "#/components/schemas/SecurityFindingsSearchRequestPage"
+ $ref: '#/components/schemas/SecurityFindingsSearchRequestPage'
sort:
- $ref: "#/components/schemas/SecurityFindingsSort"
+ $ref: '#/components/schemas/SecurityFindingsSort'
type: object
SecurityFindingsSearchRequestPage:
description: Pagination attributes for the search request.
@@ -100665,7 +100726,7 @@ components:
description: Details for an Application Security content pack.
properties:
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackAppSecDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackAppSecDetailsType'
required:
- type
type: object
@@ -100681,7 +100742,7 @@ components:
description: Details for an audit trail content pack.
properties:
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackAuditDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackAuditDetailsType'
required:
- type
type: object
@@ -100697,9 +100758,9 @@ components:
description: Details for an entity or identity content pack.
properties:
cp_activation:
- $ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackActivation'
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackEntityDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackEntityDetailsType'
required:
- type
- cp_activation
@@ -100738,9 +100799,9 @@ components:
description: Details for a logs-based content pack.
properties:
cp_activation:
- $ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackActivation'
data_last_seen:
- $ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackTimestampBucket'
filters_configured:
description: |-
Whether filters (Security Filters or Index Query depending on the pricing model) are
@@ -100748,7 +100809,7 @@ components:
example: true
type: boolean
integration_installed_status:
- $ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackIntegrationStatus'
logs_seen_from_any_index:
description: Whether logs for this content pack have been seen in any Datadog index in the last 72 hours.
example: true
@@ -100758,7 +100819,7 @@ components:
example: false
type: boolean
type:
- $ref: "#/components/schemas/SecurityFilterFilteredDataType"
+ $ref: '#/components/schemas/SecurityFilterFilteredDataType'
required:
- type
- cp_activation
@@ -100773,13 +100834,13 @@ components:
Content pack details returned when Cloud SIEM is inactive for the requesting organization.
properties:
integration_installed_status:
- $ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackIntegrationStatus'
logs_seen_from_any_index:
description: Whether logs for this content pack have been seen in any Datadog index in the last 72 hours.
example: true
type: boolean
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackOnboardingDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackOnboardingDetailsType'
required:
- type
- logs_seen_from_any_index
@@ -100796,9 +100857,9 @@ components:
description: Attributes of a content pack state.
properties:
details:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStateDetails"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStateDetails'
status:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStatus"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStatus'
required:
- status
- details
@@ -100807,13 +100868,13 @@ components:
description: Content pack state data.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStateAttributes'
id:
description: The content pack identifier.
example: aws-cloudtrail
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStateType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStateType'
required:
- id
- type
@@ -100834,13 +100895,13 @@ components:
vulnerability: "#/components/schemas/SecurityMonitoringContentPackVulnerabilityDetails"
propertyName: type
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringContentPackLogsDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackThreatIntelDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackEntityDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackAuditDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackAppSecDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackVulnerabilityDetails"
- - $ref: "#/components/schemas/SecurityMonitoringContentPackOnboardingDetails"
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackLogsDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackThreatIntelDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackEntityDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackAuditDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackAppSecDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackVulnerabilityDetails'
+ - $ref: '#/components/schemas/SecurityMonitoringContentPackOnboardingDetails'
SecurityMonitoringContentPackStateMeta:
description: Metadata for content pack states.
properties:
@@ -100856,7 +100917,7 @@ components:
maximum: 60
type: integer
sku:
- $ref: "#/components/schemas/SecurityMonitoringSKU"
+ $ref: '#/components/schemas/SecurityMonitoringSKU'
required:
- cloud_siem_index_incorrect
- sku
@@ -100875,10 +100936,10 @@ components:
data:
description: Array of content pack states.
items:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStateData"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStateData'
type: array
meta:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStateMeta"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStateMeta'
required:
- data
- meta
@@ -100915,13 +100976,13 @@ components:
description: Details for a threat intelligence content pack.
properties:
cp_activation:
- $ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackActivation'
data_last_seen:
- $ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackTimestampBucket'
integration_installed_status:
- $ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackIntegrationStatus'
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackThreatIntelDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackThreatIntelDetailsType'
required:
- type
- cp_activation
@@ -100962,13 +101023,13 @@ components:
description: Details for a vulnerability content pack.
properties:
cp_activation:
- $ref: "#/components/schemas/SecurityMonitoringContentPackActivation"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackActivation'
data_last_seen:
- $ref: "#/components/schemas/SecurityMonitoringContentPackTimestampBucket"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackTimestampBucket'
integration_installed_status:
- $ref: "#/components/schemas/SecurityMonitoringContentPackIntegrationStatus"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackIntegrationStatus'
type:
- $ref: "#/components/schemas/SecurityMonitoringContentPackVulnerabilityDetailsType"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackVulnerabilityDetailsType'
required:
- type
- cp_activation
@@ -100987,11 +101048,11 @@ components:
description: The critical asset's properties.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetAttributes'
id:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetID"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetID'
type:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
type: object
SecurityMonitoringCriticalAssetAttributes:
description: The attributes of the critical asset.
@@ -101006,7 +101067,7 @@ components:
format: int64
type: integer
creator:
- $ref: "#/components/schemas/SecurityMonitoringUser"
+ $ref: '#/components/schemas/SecurityMonitoringUser'
description:
description: A description of the critical asset.
example: Production database servers handling PII
@@ -101028,7 +101089,7 @@ components:
example: type:log_detection source:cloudtrail
type: string
severity:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
tags:
description: List of tags associated with the critical asset.
example:
@@ -101048,7 +101109,7 @@ components:
format: int64
type: integer
updater:
- $ref: "#/components/schemas/SecurityMonitoringUser"
+ $ref: '#/components/schemas/SecurityMonitoringUser'
version:
description: The version of the critical asset; it starts at 1, and is incremented at each update.
example: 2
@@ -101077,7 +101138,7 @@ components:
example: type:(log_detection OR signal_correlation OR workload_security OR application_security) source:cloudtrail
type: string
severity:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
tags:
description: List of tags associated with the critical asset.
example:
@@ -101096,9 +101157,9 @@ components:
description: Object for a single critical asset.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
required:
- type
- attributes
@@ -101107,7 +101168,7 @@ components:
description: Request object that includes the critical asset that you would like to create.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateData"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateData'
required:
- data
type: object
@@ -101119,7 +101180,7 @@ components:
description: Response object containing a single critical asset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAsset"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAsset'
type: object
SecurityMonitoringCriticalAssetSeverity:
description: Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op).
@@ -101172,7 +101233,7 @@ components:
example: type:log_detection source:cloudtrail
type: string
severity:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetSeverity'
tags:
description: List of tags associated with the critical asset.
example:
@@ -101193,9 +101254,9 @@ components:
description: The new critical asset properties; partial updates are supported.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetType"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetType'
required:
- type
- attributes
@@ -101204,7 +101265,7 @@ components:
description: Request object containing the fields to update on the critical asset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateData'
required:
- data
type: object
@@ -101214,7 +101275,7 @@ components:
data:
description: A list of critical assets objects.
items:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAsset"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAsset'
type: array
type: object
SecurityMonitoringCrowdStrikeIntegrationConfigCreateAttributes:
@@ -101225,15 +101286,15 @@ components:
example: api.crowdstrike.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike'
name:
description: The display name for the entity context sync configuration.
example: My CrowdStrike Integration
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
- domain
@@ -101252,15 +101313,15 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike'
name:
description: The new display name for the entity context sync configuration.
example: My CrowdStrike Integration (renamed)
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
type: object
@@ -101272,9 +101333,9 @@ components:
example: api.crowdstrike.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeCrowdStrike'
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCrowdStrikeSecrets'
required:
- integration_type
- domain
@@ -101284,7 +101345,7 @@ components:
description: The attributes of a dataset create or update request.
properties:
definition:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDefinition"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDefinition'
description:
description: The description of the dataset. Maximum 255 characters.
example: A sample dataset used for detection rules.
@@ -101315,7 +101376,7 @@ components:
example: Bruce Lee
type: string
definition:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDefinition"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDefinition'
description:
description: The description of the dataset.
example: A sample dataset used for detection rules.
@@ -101389,9 +101450,9 @@ components:
description: The data wrapper of a dataset create request.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetAttributesRequest"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetAttributesRequest'
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetCreateType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetCreateType'
required:
- type
- attributes
@@ -101400,7 +101461,7 @@ components:
description: Request body for creating a Cloud SIEM dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetCreateData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetCreateData'
required:
- data
type: object
@@ -101408,7 +101469,7 @@ components:
description: Response returned after creating a dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetCreateResponseData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetCreateResponseData'
required:
- data
type: object
@@ -101420,7 +101481,7 @@ components:
example: 123e4567-e89b-12d3-a456-426614174000
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetType'
required:
- id
- type
@@ -101437,13 +101498,13 @@ components:
description: The data wrapper of a dataset response.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetAttributesResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetAttributesResponse'
id:
description: The UUID of the dataset.
example: 123e4567-e89b-12d3-a456-426614174000
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetType'
required:
- id
- type
@@ -101459,7 +101520,7 @@ components:
columns:
description: For event platform datasets, the list of columns exposed by the dataset.
items:
- $ref: "#/components/schemas/SecurityMonitoringDatasetColumn"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetColumn'
type: array
data_source:
description: The data source backing this dataset definition.
@@ -101479,7 +101540,7 @@ components:
example: status = 'active'
type: string
search:
- $ref: "#/components/schemas/SecurityMonitoringDatasetSearch"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetSearch'
storage:
description: Storage tier the dataset reads from. Applies to event platform datasets.
example: hot
@@ -101489,7 +101550,7 @@ components:
example: my_reference_table
type: string
time_window:
- $ref: "#/components/schemas/SecurityMonitoringDatasetTimeWindow"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetTimeWindow'
required:
- data_source
- name
@@ -101498,7 +101559,7 @@ components:
description: Request body for retrieving dependencies of a batch of datasets.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependenciesRequestData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependenciesRequestData'
required:
- data
type: object
@@ -101519,7 +101580,7 @@ components:
description: The data wrapper of a dataset dependencies request.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependenciesRequestAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependenciesRequestAttributes'
required:
- attributes
type: object
@@ -101527,14 +101588,14 @@ components:
description: Response listing the dependents of each requested dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependenciesResponseData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependenciesResponseData'
required:
- data
type: object
SecurityMonitoringDatasetDependenciesResponseData:
description: The list of dataset dependents entries.
items:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependentsData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependentsData'
type: array
SecurityMonitoringDatasetDependentsAttributes:
description: The attributes of a dataset dependents entry.
@@ -101549,7 +101610,7 @@ components:
example: 123e4567-e89b-12d3-a456-426614174000
type: string
ids:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependentsIds"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependentsIds'
resource_type:
description: The type of resource that depends on the dataset.
example: security_detection_rule
@@ -101564,13 +101625,13 @@ components:
description: A single entry describing the dependents of one dataset.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependentsAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependentsAttributes'
id:
description: The UUID of the dataset.
example: 123e4567-e89b-12d3-a456-426614174000
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependentsType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependentsType'
required:
- id
- type
@@ -101594,7 +101655,7 @@ components:
description: Response containing a single Cloud SIEM dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetData'
required:
- data
type: object
@@ -101634,9 +101695,9 @@ components:
description: The data wrapper of a dataset update request.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetAttributesRequest"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetAttributesRequest'
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetUpdateType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetUpdateType'
required:
- type
- attributes
@@ -101645,7 +101706,7 @@ components:
description: Request body for updating a Cloud SIEM dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetUpdateData'
required:
- data
type: object
@@ -101660,15 +101721,15 @@ components:
SecurityMonitoringDatasetVersionChanges:
description: The list of field changes between this version of the dataset and the previous one.
items:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionFieldChange"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionFieldChange'
type: array
SecurityMonitoringDatasetVersionEntry:
description: A single entry in the version history of a dataset.
properties:
changes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionChanges"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionChanges'
dataset:
- $ref: "#/components/schemas/SecurityMonitoringDatasetAttributesResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetAttributesResponse'
required:
- dataset
- changes
@@ -101700,7 +101761,7 @@ components:
format: int64
type: integer
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionHistoryEntries"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionHistoryEntries'
required:
- data
- count
@@ -101709,13 +101770,13 @@ components:
description: The data wrapper of a dataset version history response.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionHistoryAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionHistoryAttributes'
id:
description: The UUID of the dataset.
example: 123e4567-e89b-12d3-a456-426614174000
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionHistoryType"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionHistoryType'
required:
- id
- type
@@ -101723,14 +101784,14 @@ components:
type: object
SecurityMonitoringDatasetVersionHistoryEntries:
additionalProperties:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionEntry"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionEntry'
description: A map from version number (as a string) to the dataset state at that version.
type: object
SecurityMonitoringDatasetVersionHistoryResponse:
description: Response containing the version history of a Cloud SIEM dataset.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionHistoryData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionHistoryData'
required:
- data
type: object
@@ -101745,7 +101806,7 @@ components:
SecurityMonitoringDatasetsListData:
description: A list of dataset data items.
items:
- $ref: "#/components/schemas/SecurityMonitoringDatasetData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetData'
type: array
SecurityMonitoringDatasetsListMeta:
description: Metadata returned with a list of datasets.
@@ -101762,9 +101823,9 @@ components:
description: Response containing a paginated list of Cloud SIEM datasets.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringDatasetsListData"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetsListData'
meta:
- $ref: "#/components/schemas/SecurityMonitoringDatasetsListMeta"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetsListMeta'
required:
- data
- meta
@@ -101782,7 +101843,7 @@ components:
azure_app_registrations:
description: The Azure App Registrations discovered for the organization.
items:
- $ref: "#/components/schemas/SecurityMonitoringAzureAppRegistration"
+ $ref: '#/components/schemas/SecurityMonitoringAzureAppRegistration'
type: array
has_valid_prerequisite:
description: Whether at least one Azure App Registration has resource collection enabled.
@@ -101809,13 +101870,13 @@ components:
description: The Azure App Registration prerequisites for the Entra ID integration.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsAttributes'
id:
description: The ID of the organization the Azure App Registrations belong to.
example: "123456"
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsResourceType'
required:
- id
- type
@@ -101834,7 +101895,7 @@ components:
description: Response containing the Azure App Registration prerequisites for the Entra ID integration.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsData"
+ $ref: '#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsData'
required:
- data
type: object
@@ -101846,13 +101907,13 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeEntraId"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeEntraId'
name:
description: The display name for the entity context sync configuration.
example: My Entra ID Integration
type: string
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
- domain
@@ -101870,13 +101931,13 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeEntraId"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeEntraId'
name:
description: The new display name for the entity context sync configuration.
example: My Entra ID Integration (renamed)
type: string
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
type: object
@@ -101888,7 +101949,7 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeEntraId"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeEntraId'
required:
- integration_type
- domain
@@ -101897,7 +101958,7 @@ components:
description: The rule's suppression filter.
properties:
action:
- $ref: "#/components/schemas/SecurityMonitoringFilterAction"
+ $ref: '#/components/schemas/SecurityMonitoringFilterAction'
query:
description: Query for selecting logs to apply the filtering action.
type: string
@@ -101919,15 +101980,15 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace'
name:
description: The display name for the entity context sync configuration.
example: My GWS Integration
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
- domain
@@ -101946,15 +102007,15 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace'
name:
description: The new display name for the entity context sync configuration.
example: My GWS Integration (renamed)
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
type: object
@@ -101966,9 +102027,9 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeGoogleWorkspace'
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceSecrets'
required:
- integration_type
- domain
@@ -101986,21 +102047,21 @@ components:
example: My Entra ID Integration
type: string
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
type: object
SecurityMonitoringIntegrationActivateData:
description: The configuration overrides for the integration to activate.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationActivateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationActivateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationActivateResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationActivateResourceType'
type: object
SecurityMonitoringIntegrationActivateRequest:
description: Request body to activate an entity context sync integration for a source type that does not require secrets.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationActivateData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationActivateData'
type: object
SecurityMonitoringIntegrationActivateResourceType:
default: activate_entra_id_request
@@ -102028,7 +102089,7 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationType'
modified_at:
description: The time at which the entity context sync configuration was last modified.
example: "2026-05-01T12:00:00Z"
@@ -102039,9 +102100,9 @@ components:
example: My GWS Integration
type: string
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
state:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigState"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigState'
required:
- enabled
- domain
@@ -102058,18 +102119,18 @@ components:
SENTINELONE: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigCreateAttributes"
propertyName: integration_type
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationConfigCreateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringOktaIntegrationConfigCreateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringEntraIdIntegrationConfigCreateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationConfigCreateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigCreateAttributes"
+ - $ref: '#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationConfigCreateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringOktaIntegrationConfigCreateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringEntraIdIntegrationConfigCreateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationConfigCreateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigCreateAttributes'
SecurityMonitoringIntegrationConfigCreateData:
description: The entity context sync configuration to create.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCreateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCreateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResourceType'
required:
- type
- attributes
@@ -102078,7 +102139,7 @@ components:
description: Request body to create an entity context sync configuration.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCreateData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCreateData'
required:
- data
type: object
@@ -102101,13 +102162,13 @@ components:
description: An entity context sync configuration.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigAttributes'
id:
description: The unique identifier of the integration configuration.
example: 11111111-2222-3333-4444-555555555555
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResourceType'
required:
- id
- type
@@ -102121,7 +102182,7 @@ components:
example: admin@example.com
type: string
service_account_json:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceServiceAccount"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigGoogleWorkspaceServiceAccount'
required:
- service_account_json
type: object
@@ -102174,7 +102235,7 @@ components:
description: Response containing a single entity context sync configuration.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigData'
required:
- data
type: object
@@ -102217,18 +102278,18 @@ components:
SENTINELONE: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigUpdateAttributes"
propertyName: integration_type
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationConfigUpdateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringOktaIntegrationConfigUpdateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringEntraIdIntegrationConfigUpdateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationConfigUpdateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigUpdateAttributes"
+ - $ref: '#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationConfigUpdateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringOktaIntegrationConfigUpdateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringEntraIdIntegrationConfigUpdateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationConfigUpdateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringSentinelOneIntegrationConfigUpdateAttributes'
SecurityMonitoringIntegrationConfigUpdateData:
description: The entity context sync configuration fields to update.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigUpdateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResourceType'
required:
- type
- attributes
@@ -102237,7 +102298,7 @@ components:
description: Request body to update an entity context sync configuration. Supports partial updates.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigUpdateData'
required:
- data
type: object
@@ -102247,7 +102308,7 @@ components:
data:
description: The list of integration configurations.
items:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigData'
type: array
required:
- data
@@ -102263,18 +102324,18 @@ components:
SENTINELONE: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationCredentialsValidateAttributes"
propertyName: integration_type
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationCredentialsValidateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringOktaIntegrationCredentialsValidateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringEntraIdIntegrationCredentialsValidateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationCredentialsValidateAttributes"
- - $ref: "#/components/schemas/SecurityMonitoringSentinelOneIntegrationCredentialsValidateAttributes"
+ - $ref: '#/components/schemas/SecurityMonitoringGoogleWorkspaceIntegrationCredentialsValidateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringOktaIntegrationCredentialsValidateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringEntraIdIntegrationCredentialsValidateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringCrowdStrikeIntegrationCredentialsValidateAttributes'
+ - $ref: '#/components/schemas/SecurityMonitoringSentinelOneIntegrationCredentialsValidateAttributes'
SecurityMonitoringIntegrationCredentialsValidateData:
description: The credentials to validate.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResourceType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResourceType'
required:
- type
- attributes
@@ -102283,7 +102344,7 @@ components:
description: Request body to validate credentials against an external entity source before creating a sync configuration.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateData"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateData'
required:
- data
type: object
@@ -102349,10 +102410,10 @@ components:
data:
description: Array containing the list of rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
type: array
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
type: object
SecurityMonitoringOktaIntegrationConfigCreateAttributes:
description: The attributes of an Okta entity context sync configuration to create.
@@ -102362,15 +102423,15 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeOkta"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeOkta'
name:
description: The display name for the entity context sync configuration.
example: My Okta Integration
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
- domain
@@ -102389,15 +102450,15 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeOkta"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeOkta'
name:
description: The new display name for the entity context sync configuration.
example: My Okta Integration (renamed)
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
type: object
@@ -102409,9 +102470,9 @@ components:
example: siem-test.com
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeOkta"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeOkta'
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigOktaSecrets'
required:
- integration_type
- domain
@@ -102423,10 +102484,10 @@ components:
data:
description: A list of suppressions objects.
items:
- $ref: "#/components/schemas/SecurityMonitoringSuppression"
+ $ref: '#/components/schemas/SecurityMonitoringSuppression'
type: array
meta:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionsMeta"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsMeta'
type: object
SecurityMonitoringReferenceTable:
description: Reference tables used in the queries.
@@ -102452,13 +102513,13 @@ components:
description: Options on anomaly detection method.
properties:
bucketDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsBucketDuration'
detectionTolerance:
- $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance"
+ $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsDetectionTolerance'
instantaneousBaseline:
- $ref: "#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline"
+ $ref: '#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline'
learningDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptionsLearningDuration'
learningPeriodBaseline:
description: An optional override baseline to apply while the rule is in the learning period. Must be greater than or equal to 0.
format: int64
@@ -102541,13 +102602,13 @@ components:
description: Data for bulk deleting security monitoring rules.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteAttributes'
id:
description: Request ID. This value is echoed back as the response's resource ID.
example: bulk_delete
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteRequestDataType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteRequestDataType'
required:
- attributes
- type
@@ -102556,7 +102617,7 @@ components:
description: Payload for bulk deleting security monitoring rules.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteData"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteData'
required:
- data
type: object
@@ -102572,7 +102633,7 @@ components:
description: Response for bulk deleting security monitoring rules.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseData"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseData'
type: object
SecurityMonitoringRuleBulkDeleteResponseAttributes:
description: Attributes for the bulk delete response.
@@ -102592,12 +102653,12 @@ components:
description: Data for the bulk delete response.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseAttributes'
id:
description: The identifier of the bulk delete response.
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseDataType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteResponseDataType'
type: object
SecurityMonitoringRuleBulkDeleteResponseDataType:
description: The resource type for a bulk delete response.
@@ -102627,13 +102688,13 @@ components:
description: Data for bulk exporting security monitoring rules.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportAttributes'
id:
description: Request ID.
example: bulk_export
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportDataType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportDataType'
required:
- attributes
- type
@@ -102650,7 +102711,7 @@ components:
description: Payload for bulk exporting security monitoring rules.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportData"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportData'
required:
- data
type: object
@@ -102660,13 +102721,13 @@ components:
actions:
description: Action to perform for each rule case.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseAction"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
type: array
condition:
description: "A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries."
type: string
customStatus:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
name:
description: Name of the case.
type: string
@@ -102677,15 +102738,15 @@ components:
type: string
type: array
status:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
type: object
SecurityMonitoringRuleCaseAction:
description: Action to perform when a signal is triggered. Only available for Application Security rule type.
properties:
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptions'
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionType'
type: object
SecurityMonitoringRuleCaseActionOptions:
additionalProperties: {}
@@ -102698,9 +102759,9 @@ components:
minimum: 0
type: integer
flaggedIPType:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptionsFlaggedIPType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptionsFlaggedIPType'
userBehaviorName:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseActionOptionsUserBehaviorName"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseActionOptionsUserBehaviorName'
type: object
SecurityMonitoringRuleCaseActionOptionsFlaggedIPType:
description: Used with the case action of type 'flag_ip'. The value specified in this field is applied as a flag to the IP addresses.
@@ -102734,7 +102795,7 @@ components:
actions:
description: Action to perform for each rule case.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseAction"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseAction'
type: array
condition:
description: "A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated\nbased on the event counts in the previously defined queries."
@@ -102749,7 +102810,7 @@ components:
type: string
type: array
status:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
required:
- status
type: object
@@ -102773,13 +102834,13 @@ components:
description: Data for bulk converting security monitoring rules to Terraform.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertBulkAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertBulkAttributes'
id:
description: Request ID.
example: convert_bulk
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertBulkDataType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertBulkDataType'
required:
- attributes
- type
@@ -102796,15 +102857,15 @@ components:
description: Payload for bulk converting security monitoring rules to Terraform.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertBulkData"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertBulkData'
required:
- data
type: object
SecurityMonitoringRuleConvertPayload:
description: Convert a rule from JSON to Terraform.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRulePayload"
- - $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload'
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload'
SecurityMonitoringRuleConvertResponse:
description: Result of the convert rule request containing Terraform content.
properties:
@@ -102818,9 +102879,9 @@ components:
SecurityMonitoringRuleCreatePayload:
description: Create a new rule.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRuleCreatePayload"
- - $ref: "#/components/schemas/SecurityMonitoringSignalRuleCreatePayload"
- - $ref: "#/components/schemas/CloudConfigurationRuleCreatePayload"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleCreatePayload'
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleCreatePayload'
+ - $ref: '#/components/schemas/CloudConfigurationRuleCreatePayload'
SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv:
description: "If true, signals in non-production environments have a lower severity than what is defined by the rule case, which can reduce signal noise.\nThe severity is decreased by one level: `CRITICAL` in production becomes `HIGH` in non-production, `HIGH` becomes `MEDIUM` and so on. `INFO` remains `INFO`.\nThe decrement is applied when the environment tag of the signal starts with `staging`, `test` or `dev`."
example: false
@@ -102887,9 +102948,9 @@ components:
description: Options on impossible travel detection method.
properties:
baselineUserLocations:
- $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations"
+ $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations'
baselineUserLocationsDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocationsDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocationsDuration'
type: object
SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations:
description: "If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular\naccess locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access."
@@ -102974,15 +103035,15 @@ components:
description: Options on new value detection method.
properties:
forgetAfter:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter'
instantaneousBaseline:
- $ref: "#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline"
+ $ref: '#/components/schemas/SecurityMonitoringRuleInstantaneousBaseline'
learningDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningDuration'
learningMethod:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningMethod'
learningThreshold:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsLearningThreshold'
type: object
SecurityMonitoringRuleNewValueOptionsForgetAfter:
description: The duration in days after which a learned value is forgotten.
@@ -103022,35 +103083,35 @@ components:
description: Options.
properties:
anomalyDetectionOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleAnomalyDetectionOptions'
complianceRuleOptions:
- $ref: "#/components/schemas/CloudConfigurationComplianceRuleOptions"
+ $ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions'
decreaseCriticalityBasedOnEnv:
- $ref: "#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv"
+ $ref: '#/components/schemas/SecurityMonitoringRuleDecreaseCriticalityBasedOnEnv'
detectionMethod:
- $ref: "#/components/schemas/SecurityMonitoringRuleDetectionMethod"
+ $ref: '#/components/schemas/SecurityMonitoringRuleDetectionMethod'
evaluationWindow:
- $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow"
+ $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
hardcodedEvaluatorType:
- $ref: "#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType"
+ $ref: '#/components/schemas/SecurityMonitoringRuleHardcodedEvaluatorType'
impossibleTravelOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptions'
keepAlive:
- $ref: "#/components/schemas/SecurityMonitoringRuleKeepAlive"
+ $ref: '#/components/schemas/SecurityMonitoringRuleKeepAlive'
maxSignalDuration:
- $ref: "#/components/schemas/SecurityMonitoringRuleMaxSignalDuration"
+ $ref: '#/components/schemas/SecurityMonitoringRuleMaxSignalDuration'
newValueOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleNewValueOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptions'
sequenceDetectionOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionOptions'
thirdPartyRuleOptions:
- $ref: "#/components/schemas/SecurityMonitoringRuleThirdPartyOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleThirdPartyOptions'
type: object
SecurityMonitoringRuleQuery:
description: Query for matching rule.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery"
- - $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
SecurityMonitoringRuleQueryAggregation:
description: The aggregation type.
enum:
@@ -103086,7 +103147,7 @@ components:
minimum: 0
type: integer
payload:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryPayloadData"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayloadData'
type: object
SecurityMonitoringRuleQueryPayloadData:
additionalProperties: {}
@@ -103116,20 +103177,20 @@ components:
SecurityMonitoringRuleResponse:
description: Create a new rule.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRuleResponse"
- - $ref: "#/components/schemas/SecurityMonitoringSignalRuleResponse"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleResponse'
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponse'
SecurityMonitoringRuleSequenceDetectionOptions:
description: Options on sequence detection method.
properties:
stepTransitions:
description: Transitions defining the allowed order of steps and their evaluation windows.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionStepTransition"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionStepTransition'
type: array
steps:
description: Steps that define the conditions to be matched in sequence.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleSequenceDetectionStep"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSequenceDetectionStep'
type: array
type: object
SecurityMonitoringRuleSequenceDetectionStep:
@@ -103139,7 +103200,7 @@ components:
description: Condition referencing rule queries (e.g., `a > 0`).
type: string
evaluationWindow:
- $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow"
+ $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
name:
description: Unique name identifying the step.
type: string
@@ -103151,7 +103212,7 @@ components:
description: Name of the child step.
type: string
evaluationWindow:
- $ref: "#/components/schemas/SecurityMonitoringRuleEvaluationWindow"
+ $ref: '#/components/schemas/SecurityMonitoringRuleEvaluationWindow'
parent:
description: Name of the parent step.
type: string
@@ -103208,16 +103269,16 @@ components:
SecurityMonitoringRuleTestPayload:
description: Test a rule.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRuleTestPayload"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRuleTestPayload'
SecurityMonitoringRuleTestRequest:
description: Test the rule queries of a rule (rule property is ignored when applied to an existing rule)
properties:
rule:
- $ref: "#/components/schemas/SecurityMonitoringRuleTestPayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestPayload'
ruleQueryPayloads:
description: Data payloads used to test rules query with the expected result.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryPayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryPayload'
type: array
type: object
SecurityMonitoringRuleTestResponse:
@@ -103240,11 +103301,11 @@ components:
type: string
type: array
defaultStatus:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
rootQueries:
description: Queries to be combined with third party case queries. Each of them can have different group by fields, to aggregate differently based on the type of alert.
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRootQuery"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRootQuery'
type: array
signalTitleTemplate:
description: A template for the signal title; if omitted, the title is generated based on the case name.
@@ -103297,15 +103358,15 @@ components:
calculatedFields:
description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases for generating signals.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCase"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCase'
type: array
complianceSignalOptions:
- $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
customMessage:
description: Custom/Overridden Message for generated signals (used in case of Default rule update).
type: string
@@ -103315,7 +103376,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
groupSignalsBy:
description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
@@ -103339,19 +103400,19 @@ components:
description: Name of the rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
schedulingOptions:
- $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions"
+ $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions'
tags:
description: Tags for generated signals.
items:
@@ -103362,7 +103423,7 @@ components:
description: Cases for generating signals from third-party rules. Only available for third-party rules.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCase"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
type: array
version:
description: The version of the rule being updated.
@@ -103374,9 +103435,9 @@ components:
SecurityMonitoringRuleValidatePayload:
description: Validate a rule.
oneOf:
- - $ref: "#/components/schemas/SecurityMonitoringStandardRulePayload"
- - $ref: "#/components/schemas/SecurityMonitoringSignalRulePayload"
- - $ref: "#/components/schemas/CloudConfigurationRulePayload"
+ - $ref: '#/components/schemas/SecurityMonitoringStandardRulePayload'
+ - $ref: '#/components/schemas/SecurityMonitoringSignalRulePayload'
+ - $ref: '#/components/schemas/CloudConfigurationRulePayload'
SecurityMonitoringSKU:
description: The Cloud SIEM pricing model (SKU) for the organization.
enum:
@@ -103418,15 +103479,15 @@ components:
example: acme.sentinelone.net
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne'
name:
description: The display name for the entity context sync configuration.
example: My SentinelOne Integration
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
- domain
@@ -103445,15 +103506,15 @@ components:
example: true
type: boolean
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne'
name:
description: The new display name for the entity context sync configuration.
example: My SentinelOne Integration (renamed)
type: string
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets'
settings:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSettings"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSettings'
required:
- integration_type
type: object
@@ -103465,9 +103526,9 @@ components:
example: acme.sentinelone.net
type: string
integration_type:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationTypeSentinelOne'
secrets:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigSentinelOneSecrets'
required:
- integration_type
- domain
@@ -103477,13 +103538,13 @@ components:
description: Object description of a security signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalAttributes'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalType'
type: object
SecurityMonitoringSignalArchiveComment:
description: Optional comment to display on archived signals.
@@ -103513,9 +103574,9 @@ components:
description: Attributes describing the new assignee of a security signal.
properties:
assignee:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
version:
- $ref: "#/components/schemas/SecurityMonitoringSignalVersion"
+ $ref: '#/components/schemas/SecurityMonitoringSignalVersion'
required:
- assignee
type: object
@@ -103523,7 +103584,7 @@ components:
description: Data containing the patch for changing the assignee of a signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateAttributes'
required:
- attributes
type: object
@@ -103531,7 +103592,7 @@ components:
description: Request body for changing the assignee of a given security monitoring signal.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateData'
required:
- data
type: object
@@ -103584,9 +103645,9 @@ components:
description: Attributes describing the new list of related signals for a security signal.
properties:
incident_ids:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentIds"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
version:
- $ref: "#/components/schemas/SecurityMonitoringSignalVersion"
+ $ref: '#/components/schemas/SecurityMonitoringSignalVersion'
required:
- incident_ids
type: object
@@ -103594,7 +103655,7 @@ components:
description: Data containing the patch for changing the related incidents of a signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateAttributes'
required:
- attributes
type: object
@@ -103602,7 +103663,7 @@ components:
description: Request body for changing the related incidents of a given security monitoring signal.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateData'
required:
- data
type: object
@@ -103621,11 +103682,11 @@ components:
description: The request for a security signal list.
properties:
filter:
- $ref: "#/components/schemas/SecurityMonitoringSignalListRequestFilter"
+ $ref: '#/components/schemas/SecurityMonitoringSignalListRequestFilter'
page:
- $ref: "#/components/schemas/SecurityMonitoringSignalListRequestPage"
+ $ref: '#/components/schemas/SecurityMonitoringSignalListRequestPage'
sort:
- $ref: "#/components/schemas/SecurityMonitoringSignalsSort"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsSort'
type: object
SecurityMonitoringSignalListRequestFilter:
description: Search filters for listing security signals.
@@ -103673,7 +103734,7 @@ components:
description: Security Signal response data object.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignal"
+ $ref: '#/components/schemas/SecurityMonitoringSignal'
type: object
SecurityMonitoringSignalRuleCreatePayload:
description: Create a new signal correlation rule.
@@ -103682,12 +103743,12 @@ components:
description: Cases for generating signals.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values in their title.
@@ -103706,12 +103767,12 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting signals which are part of the rule.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
type: array
tags:
description: Tags for generated signals.
@@ -103723,7 +103784,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
required:
- name
- isEnabled
@@ -103739,7 +103800,7 @@ components:
description: Cases for generating signals.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
customMessage:
description: Custom/Overridden message for generated signals (used in case of Default rule update).
@@ -103750,7 +103811,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values in their title.
@@ -103769,12 +103830,12 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting signals which are part of the rule.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleQuery'
type: array
tags:
description: Tags for generated signals.
@@ -103786,7 +103847,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
required:
- name
- isEnabled
@@ -103799,7 +103860,7 @@ components:
description: Query for matching rule on signals.
properties:
aggregation:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
correlatedByFields:
description: Fields to group by.
items:
@@ -103833,7 +103894,7 @@ components:
cases:
description: Cases for generating signals.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCase"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCase'
type: array
createdAt:
description: When the rule was created, timestamp in milliseconds.
@@ -103856,7 +103917,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
hasExtendedTitle:
description: Whether the notifications include the triggering group-by values in their title.
@@ -103880,11 +103941,11 @@ components:
description: The name of the rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleResponseQuery"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleResponseQuery'
type: array
tags:
description: Tags for generated signals.
@@ -103893,7 +103954,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalRuleType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalRuleType'
updateAuthorId:
description: User ID of the user who updated the rule.
format: int64
@@ -103907,7 +103968,7 @@ components:
description: Query for matching rule on signals.
properties:
aggregation:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
correlatedByFields:
description: Fields to correlate by.
items:
@@ -103972,13 +104033,13 @@ components:
description: Attributes describing the change of state of a security signal.
properties:
archive_comment:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_reason:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
state:
- $ref: "#/components/schemas/SecurityMonitoringSignalState"
+ $ref: '#/components/schemas/SecurityMonitoringSignalState'
version:
- $ref: "#/components/schemas/SecurityMonitoringSignalVersion"
+ $ref: '#/components/schemas/SecurityMonitoringSignalVersion'
required:
- state
type: object
@@ -103986,11 +104047,11 @@ components:
description: Data containing the patch for changing the state of a signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
id:
description: The unique ID of the security signal.
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalMetadataType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
required:
- attributes
type: object
@@ -103998,7 +104059,7 @@ components:
description: Request body for changing the state of a given security monitoring signal.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateData'
required:
- data
type: object
@@ -104006,13 +104067,13 @@ components:
description: A suggested action for a security signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedActionAttributes'
id:
description: The unique ID of the suggested action.
example: w00-t10-992
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedActionType'
required:
- id
- type
@@ -104030,7 +104091,7 @@ components:
example: 'source:cloudtrail @userIdentity.arn:"foo"'
type: string
template_variables:
- $ref: "#/components/schemas/SecurityMonitoringSignalInvestigationQueryTemplateVariables"
+ $ref: '#/components/schemas/SecurityMonitoringSignalInvestigationQueryTemplateVariables'
title:
description: The title of the recommended blog post.
example: Monitor Okta logs to track system access and unusual activity
@@ -104058,7 +104119,7 @@ components:
id: bxy-o8v-i1a
type: recommended_blog_posts
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedAction"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedAction'
type: array
SecurityMonitoringSignalSuggestedActionType:
description: The type of the suggested action resource.
@@ -104074,7 +104135,7 @@ components:
description: Response with suggested actions for a security signal.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionList"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedActionList'
required:
- data
type: object
@@ -104082,29 +104143,29 @@ components:
description: Attributes describing a triage state update operation over a security signal.
properties:
archive_comment:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_comment_timestamp:
description: Timestamp of the last edit to the comment.
format: int64
minimum: 0
type: integer
archive_comment_user:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
archive_reason:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
assignee:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
incident_ids:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentIds"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
state:
- $ref: "#/components/schemas/SecurityMonitoringSignalState"
+ $ref: '#/components/schemas/SecurityMonitoringSignalState'
state_update_timestamp:
description: Timestamp of the last update to the signal state.
format: int64
minimum: 0
type: integer
state_update_user:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
required:
- assignee
- state
@@ -104114,18 +104175,18 @@ components:
description: Data containing the updated triage attributes of the signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
id:
description: The unique ID of the security signal.
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalMetadataType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
type: object
SecurityMonitoringSignalTriageUpdateResponse:
description: The response returned after all triage operations, containing the updated signal triage data.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateData'
required:
- data
type: object
@@ -104142,23 +104203,23 @@ components:
description: Attributes for updating the triage state or assignee of a security signal.
properties:
archive_comment:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_reason:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
assignee:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
state:
- $ref: "#/components/schemas/SecurityMonitoringSignalState"
+ $ref: '#/components/schemas/SecurityMonitoringSignalState'
version:
- $ref: "#/components/schemas/SecurityMonitoringSignalVersion"
+ $ref: '#/components/schemas/SecurityMonitoringSignalVersion'
type: object
SecurityMonitoringSignalUpdateData:
description: Data containing the triage state or assignee update for a security signal.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalUpdateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalMetadataType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
required:
- attributes
type: object
@@ -104166,7 +104227,7 @@ components:
description: Request body for updating the triage state or assignee of a security signal.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSignalUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalUpdateData'
required:
- data
type: object
@@ -104182,7 +104243,7 @@ components:
example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
type: string
version:
- $ref: "#/components/schemas/SecurityMonitoringSignalVersion"
+ $ref: '#/components/schemas/SecurityMonitoringSignalVersion'
required:
- assignee
type: object
@@ -104190,13 +104251,13 @@ components:
description: Data for updating the assignees for multiple security signals.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateAttributes'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalType'
required:
- id
- attributes
@@ -104207,7 +104268,7 @@ components:
data:
description: An array of signal assignee updates.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateData'
maxItems: 199
type: array
required:
@@ -104217,13 +104278,13 @@ components:
description: Data for updating the state for multiple security signals.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalType'
required:
- id
- attributes
@@ -104234,7 +104295,7 @@ components:
data:
description: An array of signal state updates.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkStateUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkStateUpdateData'
maxItems: 199
type: array
required:
@@ -104244,7 +104305,7 @@ components:
description: A single signal event entry in a bulk triage update response.
properties:
event:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageEventAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageEventAttributes'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
@@ -104257,31 +104318,31 @@ components:
description: Triage attributes of a security signal returned in a bulk update response.
properties:
archive_comment:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveComment"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveComment'
archive_comment_timestamp:
description: Timestamp of the last edit to the archive comment.
format: int64
type: integer
archive_comment_user:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
archive_reason:
- $ref: "#/components/schemas/SecurityMonitoringSignalArchiveReason"
+ $ref: '#/components/schemas/SecurityMonitoringSignalArchiveReason'
assignee:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
incident_ids:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentIds"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentIds'
state:
- $ref: "#/components/schemas/SecurityMonitoringSignalState"
+ $ref: '#/components/schemas/SecurityMonitoringSignalState'
state_update_timestamp:
description: Timestamp of the last state update.
format: int64
type: integer
state_update_user:
- $ref: "#/components/schemas/SecurityMonitoringTriageUser"
+ $ref: '#/components/schemas/SecurityMonitoringTriageUser'
required:
- id
- state
@@ -104292,7 +104353,7 @@ components:
description: Response for a bulk triage update of security signals.
properties:
result:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResult"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResult'
status:
description: The status of the bulk operation.
example: done
@@ -104317,7 +104378,7 @@ components:
events:
description: The list of updated signals.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageEvent"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageEvent'
type: array
required:
- count
@@ -104327,13 +104388,13 @@ components:
description: Data for updating a single security signal in a bulk update operation.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSignalUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSignalUpdateAttributes'
id:
description: The unique ID of the security signal.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
- $ref: "#/components/schemas/SecurityMonitoringSignalType"
+ $ref: '#/components/schemas/SecurityMonitoringSignalType'
required:
- id
- attributes
@@ -104344,7 +104405,7 @@ components:
data:
description: An array of signal updates.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkUpdateData'
maxItems: 199
type: array
required:
@@ -104356,12 +104417,12 @@ components:
data:
description: An array of security signals matching the request.
items:
- $ref: "#/components/schemas/SecurityMonitoringSignal"
+ $ref: '#/components/schemas/SecurityMonitoringSignal'
type: array
links:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseLinks"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseLinks'
meta:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseMeta"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMeta'
type: object
SecurityMonitoringSignalsListResponseLinks:
description: Links attributes.
@@ -104375,7 +104436,7 @@ components:
description: Meta attributes.
properties:
page:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponseMetaPage'
type: object
SecurityMonitoringSignalsListResponseMetaPage:
description: Paging attributes.
@@ -104423,18 +104484,18 @@ components:
calculatedFields:
description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases for generating signals.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
groupSignalsBy:
description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
@@ -104461,20 +104522,20 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
schedulingOptions:
- $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions"
+ $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions'
tags:
description: Tags for generated signals.
example:
@@ -104488,10 +104549,10 @@ components:
description: Cases for generating signals from third-party rules. Only available for third-party rules.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleTypeCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
required:
- name
- isEnabled
@@ -104506,13 +104567,13 @@ components:
calculatedFields:
description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases for generating signals.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
customMessage:
description: Custom/Overridden message for generated signals (used in case of Default rule update).
@@ -104523,7 +104584,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
groupSignalsBy:
description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
@@ -104550,20 +104611,20 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
schedulingOptions:
- $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions"
+ $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions'
tags:
description: Tags for generated signals.
example:
@@ -104577,10 +104638,10 @@ components:
description: Cases for generating signals from third-party rules. Only available for third-party rules.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleTypeCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeCreate'
required:
- name
- isEnabled
@@ -104593,13 +104654,13 @@ components:
description: Query for matching rule.
properties:
aggregation:
- $ref: "#/components/schemas/SecurityMonitoringRuleQueryAggregation"
+ $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
customQueryExtension:
description: Query extension to append to the logs query.
example: a > 3
type: string
dataSource:
- $ref: "#/components/schemas/SecurityMonitoringStandardDataSource"
+ $ref: '#/components/schemas/SecurityMonitoringStandardDataSource'
distinctFields:
description: Field for which the cardinality is measured. Sent as an array.
items:
@@ -104650,15 +104711,15 @@ components:
calculatedFields:
description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases for generating signals.
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCase"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCase'
type: array
complianceSignalOptions:
- $ref: "#/components/schemas/CloudConfigurationRuleComplianceSignalOptions"
+ $ref: '#/components/schemas/CloudConfigurationRuleComplianceSignalOptions'
createdAt:
description: When the rule was created, timestamp in milliseconds.
format: int64
@@ -104688,7 +104749,7 @@ components:
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
groupSignalsBy:
description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
@@ -104720,19 +104781,19 @@ components:
description: The name of the rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
schedulingOptions:
- $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions"
+ $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions'
tags:
description: Tags for generated signals.
items:
@@ -104743,10 +104804,10 @@ components:
description: Cases for generating signals from third-party rules. Only available for third-party rules.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCase"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCase'
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleTypeRead"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeRead'
updateAuthorId:
description: User ID of the user who updated the rule.
format: int64
@@ -104766,18 +104827,18 @@ components:
calculatedFields:
description: Calculated fields. Only allowed for scheduled rules - in other words, when schedulingOptions is also defined.
items:
- $ref: "#/components/schemas/CalculatedField"
+ $ref: '#/components/schemas/CalculatedField'
type: array
cases:
description: Cases for generating signals.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
type: array
filters:
description: Additional queries to filter matched events before they are processed. This field is deprecated for log detection, signal correlation, and workload security rules.
items:
- $ref: "#/components/schemas/SecurityMonitoringFilter"
+ $ref: '#/components/schemas/SecurityMonitoringFilter'
type: array
groupSignalsBy:
description: Additional grouping to perform on top of the existing groups in the query section. Must be a subset of the existing groups.
@@ -104804,20 +104865,20 @@ components:
example: My security monitoring rule.
type: string
options:
- $ref: "#/components/schemas/SecurityMonitoringRuleOptions"
+ $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
queries:
description: Queries for selecting logs which are part of the rule.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringStandardRuleQuery"
+ $ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
items:
- $ref: "#/components/schemas/SecurityMonitoringReferenceTable"
+ $ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
schedulingOptions:
- $ref: "#/components/schemas/SecurityMonitoringSchedulingOptions"
+ $ref: '#/components/schemas/SecurityMonitoringSchedulingOptions'
tags:
description: Tags for generated signals.
example:
@@ -104831,10 +104892,10 @@ components:
description: Cases for generating signals from third-party rules. Only available for third-party rules.
example: []
items:
- $ref: "#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate"
+ $ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
type: array
type:
- $ref: "#/components/schemas/SecurityMonitoringRuleTypeTest"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTypeTest'
required:
- name
- isEnabled
@@ -104847,11 +104908,11 @@ components:
description: The suppression rule's properties.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
id:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionID"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionID'
type:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionType"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
type: object
SecurityMonitoringSuppressionAttributes:
description: The attributes of the suppression rule.
@@ -104861,7 +104922,7 @@ components:
format: int64
type: integer
creator:
- $ref: "#/components/schemas/SecurityMonitoringUser"
+ $ref: '#/components/schemas/SecurityMonitoringUser'
data_exclusion_query:
description: An exclusion query on the input data of the security rules, which could be logs, Agent events, or other types of data based on the security rule. Events matching this query are ignored by any detection rules referenced in the suppression rule.
example: source:cloudtrail account_id:12345
@@ -104914,7 +104975,7 @@ components:
format: int64
type: integer
updater:
- $ref: "#/components/schemas/SecurityMonitoringUser"
+ $ref: '#/components/schemas/SecurityMonitoringUser'
version:
description: The version of the suppression rule; it starts at 1, and is incremented at each update.
example: 42
@@ -104977,9 +105038,9 @@ components:
description: Object for a single suppression rule.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionType"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
required:
- type
- attributes
@@ -104988,7 +105049,7 @@ components:
description: Request object that includes the suppression rule that you would like to create.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateData"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateData'
required:
- data
type: object
@@ -105000,7 +105061,7 @@ components:
description: Response object containing a single suppression rule.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSuppression"
+ $ref: '#/components/schemas/SecurityMonitoringSuppression'
type: object
SecurityMonitoringSuppressionSort:
description: The sort parameters used for querying suppression rules.
@@ -105096,9 +105157,9 @@ components:
description: The new suppression properties; partial updates are supported.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateAttributes'
type:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionType"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionType'
required:
- type
- attributes
@@ -105107,7 +105168,7 @@ components:
description: Request object containing the fields to update on the suppression rule.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateData"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateData'
required:
- data
type: object
@@ -105115,7 +105176,7 @@ components:
description: Metadata for the suppression list response.
properties:
page:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionsPageMeta"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsPageMeta'
type: object
SecurityMonitoringSuppressionsPageMeta:
description: Pagination metadata.
@@ -105142,7 +105203,7 @@ components:
data:
description: A list of suppressions objects.
items:
- $ref: "#/components/schemas/SecurityMonitoringSuppression"
+ $ref: '#/components/schemas/SecurityMonitoringSuppression'
type: array
type: object
SecurityMonitoringTerraformBulkExportAttributes:
@@ -105164,7 +105225,7 @@ components:
description: The bulk export request data object.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringTerraformBulkExportAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformBulkExportAttributes'
type:
description: The JSON:API type. Always `bulk_export_resources`.
example: bulk_export_resources
@@ -105177,7 +105238,7 @@ components:
description: Request body for bulk exporting security monitoring resources to Terraform.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringTerraformBulkExportData"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformBulkExportData'
required:
- data
type: object
@@ -105200,7 +105261,7 @@ components:
description: The convert request data object.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringTerraformConvertAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformConvertAttributes'
id:
description: The ID of the resource being converted.
example: abc-123
@@ -105218,7 +105279,7 @@ components:
description: Request body for converting a security monitoring resource JSON to Terraform.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringTerraformConvertData"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformConvertData'
required:
- data
type: object
@@ -105244,7 +105305,7 @@ components:
description: The Terraform export data object.
properties:
attributes:
- $ref: "#/components/schemas/SecurityMonitoringTerraformExportAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformExportAttributes'
id:
description: The resource identifier composed of the Terraform type name and the resource ID separated by `|`.
example: datadog_security_monitoring_suppression|abc-123
@@ -105262,7 +105323,7 @@ components:
description: Response containing the Terraform configuration for a security monitoring resource.
properties:
data:
- $ref: "#/components/schemas/SecurityMonitoringTerraformExportData"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformExportData'
type: object
SecurityMonitoringTerraformResourceType:
description: The type of security monitoring resource to export to Terraform.
@@ -105295,7 +105356,7 @@ components:
description: Case when signal is generated by a third party rule.
properties:
customStatus:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
name:
description: Name of the case.
type: string
@@ -105309,7 +105370,7 @@ components:
description: A query to map a third party event to this case.
type: string
status:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
type: object
SecurityMonitoringThirdPartyRuleCaseCreate:
description: Case when a signal is generated by a third party rule.
@@ -105327,7 +105388,7 @@ components:
description: A query to map a third party event to this case.
type: string
status:
- $ref: "#/components/schemas/SecurityMonitoringRuleSeverity"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
required:
- status
type: object
@@ -105374,15 +105435,15 @@ components:
description: "Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published."
properties:
rateLimit:
- $ref: "#/components/schemas/TriggerRateLimit"
+ $ref: '#/components/schemas/TriggerRateLimit'
type: object
SecurityTriggerWrapper:
description: "Schema for a Security-based trigger."
properties:
securityTrigger:
- $ref: "#/components/schemas/SecurityTrigger"
+ $ref: '#/components/schemas/SecurityTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- securityTrigger
type: object
@@ -105393,16 +105454,16 @@ components:
Only the trigger_source field is required.
properties:
query:
- $ref: "#/components/schemas/NotificationRuleQuery"
+ $ref: '#/components/schemas/NotificationRuleQuery'
rule_types:
- $ref: "#/components/schemas/RuleTypes"
+ $ref: '#/components/schemas/RuleTypes'
severities:
description: The security rules severities to consider.
items:
- $ref: "#/components/schemas/RuleSeverity"
+ $ref: '#/components/schemas/RuleSeverity'
type: array
trigger_source:
- $ref: "#/components/schemas/TriggerSource"
+ $ref: '#/components/schemas/TriggerSource'
required:
- trigger_source
type: object
@@ -105413,7 +105474,7 @@ components:
description: "Trigger a workflow from Self Service."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- selfServiceTrigger
type: object
@@ -105425,7 +105486,7 @@ components:
example: CHANNEL
type: string
type:
- $ref: "#/components/schemas/SendSlackMessageActionType"
+ $ref: '#/components/schemas/SendSlackMessageActionType'
workspace:
description: "The workspace ID."
example: WORKSPACE
@@ -105460,7 +105521,7 @@ components:
example: TENANT
type: string
type:
- $ref: "#/components/schemas/SendTeamsMessageActionType"
+ $ref: '#/components/schemas/SendTeamsMessageActionType'
required:
- type
- channel
@@ -105480,9 +105541,9 @@ components:
description: Group reorder request.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerReorderConfig"
+ $ref: '#/components/schemas/SensitiveDataScannerReorderConfig'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- data
- meta
@@ -105494,19 +105555,19 @@ components:
description: ID of the configuration.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationType"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationType'
type: object
SensitiveDataScannerConfigurationData:
description: A Sensitive Data Scanner configuration data.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerConfiguration"
+ $ref: '#/components/schemas/SensitiveDataScannerConfiguration'
type: object
SensitiveDataScannerConfigurationRelationships:
description: Relationships of the configuration.
properties:
groups:
- $ref: "#/components/schemas/SensitiveDataScannerGroupList"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupList'
type: object
SensitiveDataScannerConfigurationType:
default: sensitive_data_scanner_configuration
@@ -105521,17 +105582,17 @@ components:
description: Create group response.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerGroupResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupResponse'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerCreateRuleResponse:
description: Create rule response.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerRuleResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleResponse'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerFilter:
description: Filter for the Scanning Group.
@@ -105543,22 +105604,22 @@ components:
SensitiveDataScannerGetConfigIncludedArray:
description: Included objects from relationships.
items:
- $ref: "#/components/schemas/SensitiveDataScannerGetConfigIncludedItem"
+ $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedItem'
type: array
SensitiveDataScannerGetConfigIncludedItem:
description: An object related to the configuration.
oneOf:
- - $ref: "#/components/schemas/SensitiveDataScannerRuleIncludedItem"
- - $ref: "#/components/schemas/SensitiveDataScannerGroupIncludedItem"
+ - $ref: '#/components/schemas/SensitiveDataScannerRuleIncludedItem'
+ - $ref: '#/components/schemas/SensitiveDataScannerGroupIncludedItem'
SensitiveDataScannerGetConfigResponse:
description: Get all groups response.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponseData"
+ $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponseData'
included:
- $ref: "#/components/schemas/SensitiveDataScannerGetConfigIncludedArray"
+ $ref: '#/components/schemas/SensitiveDataScannerGetConfigIncludedArray'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMeta"
+ $ref: '#/components/schemas/SensitiveDataScannerMeta'
type: object
SensitiveDataScannerGetConfigResponseData:
description: Response data related to the scanning groups.
@@ -105571,9 +105632,9 @@ components:
description: ID of the configuration.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationType"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationType'
type: object
SensitiveDataScannerGroup:
description: A scanning group.
@@ -105582,7 +105643,7 @@ components:
description: ID of the group.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
type: object
SensitiveDataScannerGroupAttributes:
description: Attributes of the Sensitive Data Scanner group.
@@ -105591,7 +105652,7 @@ components:
description: Description of the group.
type: string
filter:
- $ref: "#/components/schemas/SensitiveDataScannerFilter"
+ $ref: '#/components/schemas/SensitiveDataScannerFilter'
is_enabled:
description: Whether or not the group is enabled.
type: boolean
@@ -105601,23 +105662,23 @@ components:
product_list:
description: List of products the scanning group applies.
items:
- $ref: "#/components/schemas/SensitiveDataScannerProduct"
+ $ref: '#/components/schemas/SensitiveDataScannerProduct'
type: array
samplings:
description: List of sampling rates per product type.
items:
- $ref: "#/components/schemas/SensitiveDataScannerSamplings"
+ $ref: '#/components/schemas/SensitiveDataScannerSamplings'
type: array
type: object
SensitiveDataScannerGroupCreate:
description: Data related to the creation of a group.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes'
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
required:
- type
- attributes
@@ -105626,21 +105687,21 @@ components:
description: Create group request.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerGroupCreate"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupCreate'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerGroupData:
description: A scanning group data.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerGroup"
+ $ref: '#/components/schemas/SensitiveDataScannerGroup'
type: object
SensitiveDataScannerGroupDeleteRequest:
description: Delete group request.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- meta
type: object
@@ -105648,20 +105709,20 @@ components:
description: Delete group response.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerGroupIncludedItem:
description: A Scanning Group included item.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes'
id:
description: ID of the group.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
type: object
SensitiveDataScannerGroupItem:
description: Data related to a Sensitive Data Scanner Group.
@@ -105670,7 +105731,7 @@ components:
description: ID of the group.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
type: object
SensitiveDataScannerGroupList:
description: List of groups, ordered.
@@ -105678,29 +105739,29 @@ components:
data:
description: List of groups. The order is important.
items:
- $ref: "#/components/schemas/SensitiveDataScannerGroupItem"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupItem'
type: array
type: object
SensitiveDataScannerGroupRelationships:
description: Relationships of the group.
properties:
configuration:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationData"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationData'
rules:
- $ref: "#/components/schemas/SensitiveDataScannerRuleData"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleData'
type: object
SensitiveDataScannerGroupResponse:
description: Response data related to the creation of a group.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes'
id:
description: ID of the group.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
type: object
SensitiveDataScannerGroupType:
default: sensitive_data_scanner_group
@@ -105715,22 +105776,22 @@ components:
description: Data related to the update of a group.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerGroupAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupAttributes'
id:
description: ID of the group.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerGroupRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerGroupType"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupType'
type: object
SensitiveDataScannerGroupUpdateRequest:
description: Update group request.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerGroupUpdate"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupUpdate'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- data
- meta
@@ -105739,7 +105800,7 @@ components:
description: Update group response.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerIncludedKeywordConfiguration:
description: |-
@@ -105836,15 +105897,15 @@ components:
description: ID of the configuration.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerConfigurationType"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigurationType'
type: object
SensitiveDataScannerReorderGroupsResponse:
description: Group reorder response.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMeta"
+ $ref: '#/components/schemas/SensitiveDataScannerMeta'
type: object
SensitiveDataScannerRule:
description: Rule item included in the group.
@@ -105853,7 +105914,7 @@ components:
description: ID of the rule.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerRuleType"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleType'
type: object
SensitiveDataScannerRuleAttributes:
description: Attributes of the Sensitive Data Scanner rule.
@@ -105869,7 +105930,7 @@ components:
type: string
type: array
included_keyword_configuration:
- $ref: "#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration"
+ $ref: '#/components/schemas/SensitiveDataScannerIncludedKeywordConfiguration'
is_enabled:
description: Whether or not the rule is enabled.
type: boolean
@@ -105895,7 +105956,7 @@ components:
minimum: 1
type: integer
suppressions:
- $ref: "#/components/schemas/SensitiveDataScannerSuppressions"
+ $ref: '#/components/schemas/SensitiveDataScannerSuppressions'
tags:
description: List of tags.
items:
@@ -105903,17 +105964,17 @@ components:
type: string
type: array
text_replacement:
- $ref: "#/components/schemas/SensitiveDataScannerTextReplacement"
+ $ref: '#/components/schemas/SensitiveDataScannerTextReplacement'
type: object
SensitiveDataScannerRuleCreate:
description: Data related to the creation of a rule.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes'
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerRuleType"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleType'
required:
- type
- attributes
@@ -105923,9 +105984,9 @@ components:
description: Create rule request.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerRuleCreate"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleCreate'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- data
- meta
@@ -105936,14 +105997,14 @@ components:
data:
description: Rules included in the group. The order is important.
items:
- $ref: "#/components/schemas/SensitiveDataScannerRule"
+ $ref: '#/components/schemas/SensitiveDataScannerRule'
type: array
type: object
SensitiveDataScannerRuleDeleteRequest:
description: Delete rule request.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- meta
type: object
@@ -105951,41 +106012,41 @@ components:
description: Delete rule response.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerRuleIncludedItem:
description: A Scanning Rule included item.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes'
id:
description: ID of the rule.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerRuleType"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleType'
type: object
SensitiveDataScannerRuleRelationships:
description: Relationships of a scanning rule.
properties:
group:
- $ref: "#/components/schemas/SensitiveDataScannerGroupData"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupData'
standard_pattern:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternData"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternData'
type: object
SensitiveDataScannerRuleResponse:
description: Response data related to the creation of a rule.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes'
id:
description: ID of the rule.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerRuleType"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleType'
type: object
SensitiveDataScannerRuleType:
default: sensitive_data_scanner_rule
@@ -106000,22 +106061,22 @@ components:
description: Data related to the update of a rule.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerRuleAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleAttributes'
id:
description: ID of the rule.
type: string
relationships:
- $ref: "#/components/schemas/SensitiveDataScannerRuleRelationships"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleRelationships'
type:
- $ref: "#/components/schemas/SensitiveDataScannerRuleType"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleType'
type: object
SensitiveDataScannerRuleUpdateRequest:
description: Update rule request.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerRuleUpdate"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleUpdate'
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
required:
- data
- meta
@@ -106024,13 +106085,13 @@ components:
description: Update rule response.
properties:
meta:
- $ref: "#/components/schemas/SensitiveDataScannerMetaVersionOnly"
+ $ref: '#/components/schemas/SensitiveDataScannerMetaVersionOnly'
type: object
SensitiveDataScannerSamplings:
description: Sampling configurations for the Scanning Group.
properties:
product:
- $ref: "#/components/schemas/SensitiveDataScannerProduct"
+ $ref: '#/components/schemas/SensitiveDataScannerProduct'
rate:
description: Rate at which data in product type will be scanned, as a percentage.
example: 100.0
@@ -106046,7 +106107,7 @@ components:
description: ID of the standard pattern.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternType"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType'
type: object
SensitiveDataScannerStandardPatternAttributes:
description: Attributes of the Sensitive Data Scanner standard pattern.
@@ -106084,7 +106145,7 @@ components:
description: A standard pattern.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPattern"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPattern'
type: object
SensitiveDataScannerStandardPatternType:
default: sensitive_data_scanner_standard_pattern
@@ -106098,24 +106159,24 @@ components:
SensitiveDataScannerStandardPatternsResponse:
description: List Standard patterns response.
items:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseItem"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseItem'
type: array
SensitiveDataScannerStandardPatternsResponseData:
description: List Standard patterns response data.
properties:
data:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponse'
type: object
SensitiveDataScannerStandardPatternsResponseItem:
description: Standard pattern item.
properties:
attributes:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternAttributes"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternAttributes'
id:
description: ID of the standard pattern.
type: string
type:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternType"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternType'
type: object
SensitiveDataScannerSuppressions:
description: |-
@@ -106161,7 +106222,7 @@ components:
description: Only valid when type == `replacement_string`. When enabled, matches can be unmasked in logs by users with ‘Data Scanner Unmask’ permission. As a security best practice, avoid masking for highly-sensitive, long-lived data.
type: boolean
type:
- $ref: "#/components/schemas/SensitiveDataScannerTextReplacementType"
+ $ref: '#/components/schemas/SensitiveDataScannerTextReplacementType'
type: object
SensitiveDataScannerTextReplacementType:
default: none
@@ -106199,14 +106260,14 @@ components:
description: Datadog access token.
properties:
attributes:
- $ref: "#/components/schemas/ServiceAccessTokenAttributes"
+ $ref: '#/components/schemas/ServiceAccessTokenAttributes'
id:
description: ID of the access token.
type: string
relationships:
- $ref: "#/components/schemas/ServiceAccessTokenRelationships"
+ $ref: '#/components/schemas/ServiceAccessTokenRelationships'
type:
- $ref: "#/components/schemas/ServiceAccessTokensType"
+ $ref: '#/components/schemas/ServiceAccessTokensType'
type: object
ServiceAccessTokenAttributes:
description: Attributes of an access token.
@@ -106261,25 +106322,25 @@ components:
description: Response for creating an access token. Includes the token key.
properties:
data:
- $ref: "#/components/schemas/FullServiceAccessToken"
+ $ref: '#/components/schemas/FullServiceAccessToken'
type: object
ServiceAccessTokenRelationships:
description: Resources related to the access token.
properties:
owned_by:
- $ref: "#/components/schemas/RelationshipToServiceAccount"
+ $ref: '#/components/schemas/RelationshipToServiceAccount'
type: object
ServiceAccessTokenResponse:
description: Response for retrieving an access token.
properties:
data:
- $ref: "#/components/schemas/ServiceAccessToken"
+ $ref: '#/components/schemas/ServiceAccessToken'
type: object
ServiceAccessTokenResponseMeta:
description: Additional information related to the access token response.
properties:
page:
- $ref: "#/components/schemas/ServiceAccessTokenResponseMetaPage"
+ $ref: '#/components/schemas/ServiceAccessTokenResponseMetaPage'
type: object
ServiceAccessTokenResponseMetaPage:
description: Pagination information.
@@ -106327,9 +106388,9 @@ components:
description: Object used to create a service account access token.
properties:
attributes:
- $ref: "#/components/schemas/ServiceAccountAccessTokenCreateAttributes"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenCreateAttributes'
type:
- $ref: "#/components/schemas/ServiceAccessTokensType"
+ $ref: '#/components/schemas/ServiceAccessTokensType'
required:
- attributes
- type
@@ -106338,7 +106399,7 @@ components:
description: Request used to create a service account access token.
properties:
data:
- $ref: "#/components/schemas/ServiceAccountAccessTokenCreateData"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenCreateData'
required:
- data
type: object
@@ -106363,13 +106424,13 @@ components:
description: Object used to update a service account access token.
properties:
attributes:
- $ref: "#/components/schemas/ServiceAccountAccessTokenUpdateAttributes"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenUpdateAttributes'
id:
description: ID of the access token.
example: "00112233-4455-6677-8899-aabbccddeeff"
type: string
type:
- $ref: "#/components/schemas/ServiceAccessTokensType"
+ $ref: '#/components/schemas/ServiceAccessTokensType'
required:
- attributes
- id
@@ -106379,7 +106440,7 @@ components:
description: Request used to update a service account access token.
properties:
data:
- $ref: "#/components/schemas/ServiceAccountAccessTokenUpdateData"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenUpdateData'
required:
- data
type: object
@@ -106408,11 +106469,11 @@ components:
description: Object to create a service account User.
properties:
attributes:
- $ref: "#/components/schemas/ServiceAccountCreateAttributes"
+ $ref: '#/components/schemas/ServiceAccountCreateAttributes'
relationships:
- $ref: "#/components/schemas/UserRelationships"
+ $ref: '#/components/schemas/UserRelationships'
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
required:
- attributes
- type
@@ -106421,7 +106482,7 @@ components:
description: Create a service account.
properties:
data:
- $ref: "#/components/schemas/ServiceAccountCreateData"
+ $ref: '#/components/schemas/ServiceAccountCreateData'
required:
- data
type: object
@@ -106439,14 +106500,14 @@ components:
data:
description: Create service definitions response payload.
items:
- $ref: "#/components/schemas/ServiceDefinitionData"
+ $ref: '#/components/schemas/ServiceDefinitionData'
type: array
type: object
ServiceDefinitionData:
description: Service definition data.
properties:
attributes:
- $ref: "#/components/schemas/ServiceDefinitionDataAttributes"
+ $ref: '#/components/schemas/ServiceDefinitionDataAttributes'
id:
description: Service definition id.
type: string
@@ -106458,15 +106519,15 @@ components:
description: Service definition attributes.
properties:
meta:
- $ref: "#/components/schemas/ServiceDefinitionMeta"
+ $ref: '#/components/schemas/ServiceDefinitionMeta'
schema:
- $ref: "#/components/schemas/ServiceDefinitionSchema"
+ $ref: '#/components/schemas/ServiceDefinitionSchema'
type: object
ServiceDefinitionGetResponse:
description: Get service definition response.
properties:
data:
- $ref: "#/components/schemas/ServiceDefinitionData"
+ $ref: '#/components/schemas/ServiceDefinitionData'
type: object
ServiceDefinitionMeta:
description: Metadata about a service definition.
@@ -106492,7 +106553,7 @@ components:
warnings:
description: A list of schema validation warnings.
items:
- $ref: "#/components/schemas/ServiceDefinitionMetaWarnings"
+ $ref: '#/components/schemas/ServiceDefinitionMetaWarnings'
type: array
type: object
ServiceDefinitionMetaWarnings:
@@ -106518,10 +106579,10 @@ components:
ServiceDefinitionSchema:
description: Service definition schema.
oneOf:
- - $ref: "#/components/schemas/ServiceDefinitionV1"
- - $ref: "#/components/schemas/ServiceDefinitionV2"
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot1"
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot2"
+ - $ref: '#/components/schemas/ServiceDefinitionV1'
+ - $ref: '#/components/schemas/ServiceDefinitionV2'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
ServiceDefinitionSchemaVersions:
description: Schema versions
enum:
@@ -106540,7 +106601,7 @@ components:
description: Deprecated - Service definition V1 for providing additional service metadata and integrations.
properties:
contact:
- $ref: "#/components/schemas/ServiceDefinitionV1Contact"
+ $ref: '#/components/schemas/ServiceDefinitionV1Contact'
extensions:
additionalProperties: {}
description: Extensions to V1 schema.
@@ -106549,16 +106610,16 @@ components:
external-resources:
description: A list of external links related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV1Resource"
+ $ref: '#/components/schemas/ServiceDefinitionV1Resource'
type: array
info:
- $ref: "#/components/schemas/ServiceDefinitionV1Info"
+ $ref: '#/components/schemas/ServiceDefinitionV1Info'
integrations:
- $ref: "#/components/schemas/ServiceDefinitionV1Integrations"
+ $ref: '#/components/schemas/ServiceDefinitionV1Integrations'
org:
- $ref: "#/components/schemas/ServiceDefinitionV1Org"
+ $ref: '#/components/schemas/ServiceDefinitionV1Org'
schema-version:
- $ref: "#/components/schemas/ServiceDefinitionV1Version"
+ $ref: '#/components/schemas/ServiceDefinitionV1Version'
tags:
description: A set of custom tags.
example: ["my:tag", "service:tag"]
@@ -106607,7 +106668,7 @@ components:
description: Third party integrations that Datadog supports.
properties:
pagerduty:
- $ref: "#/components/schemas/ServiceDefinitionV1Pagerduty"
+ $ref: '#/components/schemas/ServiceDefinitionV1Pagerduty'
type: object
ServiceDefinitionV1Org:
description: Org related information about the service.
@@ -106633,7 +106694,7 @@ components:
example: Runbook
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV1ResourceType"
+ $ref: '#/components/schemas/ServiceDefinitionV1ResourceType'
url:
description: Link URL.
example: https://my-runbook
@@ -106682,7 +106743,7 @@ components:
contacts:
description: A list of contacts related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Contact"
+ $ref: '#/components/schemas/ServiceDefinitionV2Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
@@ -106695,7 +106756,7 @@ components:
docs:
description: A list of documentation related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Doc"
+ $ref: '#/components/schemas/ServiceDefinitionV2Doc'
type: array
extensions:
additionalProperties: {}
@@ -106703,19 +106764,19 @@ components:
example: {"myorg/extension": "extensionValue"}
type: object
integrations:
- $ref: "#/components/schemas/ServiceDefinitionV2Integrations"
+ $ref: '#/components/schemas/ServiceDefinitionV2Integrations'
links:
description: A list of links related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Link"
+ $ref: '#/components/schemas/ServiceDefinitionV2Link'
type: array
repos:
description: A list of code repositories related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Repo"
+ $ref: '#/components/schemas/ServiceDefinitionV2Repo'
type: array
schema-version:
- $ref: "#/components/schemas/ServiceDefinitionV2Version"
+ $ref: '#/components/schemas/ServiceDefinitionV2Version'
tags:
description: A set of custom tags.
example: ["my:tag", "service:tag"]
@@ -106734,9 +106795,9 @@ components:
ServiceDefinitionV2Contact:
description: Service owner's contacts information.
oneOf:
- - $ref: "#/components/schemas/ServiceDefinitionV2Email"
- - $ref: "#/components/schemas/ServiceDefinitionV2Slack"
- - $ref: "#/components/schemas/ServiceDefinitionV2MSTeams"
+ - $ref: '#/components/schemas/ServiceDefinitionV2Email'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Slack'
+ - $ref: '#/components/schemas/ServiceDefinitionV2MSTeams'
ServiceDefinitionV2Doc:
description: Service documents.
properties:
@@ -106766,7 +106827,7 @@ components:
contacts:
description: A list of contacts related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Contact"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
@@ -106782,7 +106843,7 @@ components:
example: {"myorg/extension": "extensionValue"}
type: object
integrations:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Integrations"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Integrations'
lifecycle:
description: The current life cycle phase of the service.
example: sandbox
@@ -106790,10 +106851,10 @@ components:
links:
description: A list of links related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Link"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Link'
type: array
schema-version:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Version"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Version'
tags:
description: A set of custom tags.
example: ["my:tag", "service:tag"]
@@ -106816,9 +106877,9 @@ components:
ServiceDefinitionV2Dot1Contact:
description: Service owner's contacts information.
oneOf:
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot1Email"
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot1Slack"
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot1MSTeams"
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Email'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot1Slack'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeams'
ServiceDefinitionV2Dot1Email:
description: Service owner's email.
properties:
@@ -106831,7 +106892,7 @@ components:
example: Team Email
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1EmailType"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1EmailType'
required:
- type
- contact
@@ -106848,9 +106909,9 @@ components:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Opsgenie"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Opsgenie'
pagerduty:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1Pagerduty"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1Pagerduty'
type: object
ServiceDefinitionV2Dot1Link:
description: Service's external links.
@@ -106864,7 +106925,7 @@ components:
example: Github
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1LinkType"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1LinkType'
url:
description: Link URL.
example: https://my-runbook
@@ -106902,7 +106963,7 @@ components:
example: My team channel
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1MSTeamsType'
required:
- type
- contact
@@ -106919,7 +106980,7 @@ components:
description: Opsgenie integration for the service.
properties:
region:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"
@@ -106952,7 +107013,7 @@ components:
example: Team Slack
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot1SlackType"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot1SlackType'
required:
- type
- contact
@@ -106991,7 +107052,7 @@ components:
contacts:
description: A list of contacts related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Contact"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Contact'
type: array
dd-service:
description: Unique identifier of the service. Must be unique across all services and is used to match with a service in Datadog.
@@ -107007,7 +107068,7 @@ components:
example: {"myorg/extension": "extensionValue"}
type: object
integrations:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Integrations"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Integrations'
languages:
description: "The service's programming language. Datadog recognizes the following languages: `dotnet`, `go`, `java`, `js`, `php`, `python`, `ruby`, and `c++`."
example: ["dotnet", "go", "java", "js", "php", "python", "ruby", "c++"]
@@ -107022,10 +107083,10 @@ components:
links:
description: A list of links related to the services.
items:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Link"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Link'
type: array
schema-version:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Version"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Version'
tags:
description: A set of custom tags.
example: ["my:tag", "service:tag"]
@@ -107042,7 +107103,7 @@ components:
example: High
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Type"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Type'
required:
- schema-version
- dd-service
@@ -107070,9 +107131,9 @@ components:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Opsgenie"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Opsgenie'
pagerduty:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2Pagerduty"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2Pagerduty'
type: object
ServiceDefinitionV2Dot2Link:
description: Service's external links.
@@ -107102,7 +107163,7 @@ components:
description: Opsgenie integration for the service.
properties:
region:
- $ref: "#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion"
+ $ref: '#/components/schemas/ServiceDefinitionV2Dot2OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"
@@ -107148,7 +107209,7 @@ components:
example: Team Email
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2EmailType"
+ $ref: '#/components/schemas/ServiceDefinitionV2EmailType'
required:
- type
- contact
@@ -107165,9 +107226,9 @@ components:
description: Third party integrations that Datadog supports.
properties:
opsgenie:
- $ref: "#/components/schemas/ServiceDefinitionV2Opsgenie"
+ $ref: '#/components/schemas/ServiceDefinitionV2Opsgenie'
pagerduty:
- $ref: "#/components/schemas/ServiceDefinitionV2Pagerduty"
+ $ref: '#/components/schemas/ServiceDefinitionV2Pagerduty'
type: object
ServiceDefinitionV2Link:
description: Service's external links.
@@ -107177,7 +107238,7 @@ components:
example: Runbook
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2LinkType"
+ $ref: '#/components/schemas/ServiceDefinitionV2LinkType'
url:
description: Link URL.
example: https://my-runbook
@@ -107223,7 +107284,7 @@ components:
example: My team channel
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2MSTeamsType"
+ $ref: '#/components/schemas/ServiceDefinitionV2MSTeamsType'
required:
- type
- contact
@@ -107240,7 +107301,7 @@ components:
description: Opsgenie integration for the service.
properties:
region:
- $ref: "#/components/schemas/ServiceDefinitionV2OpsgenieRegion"
+ $ref: '#/components/schemas/ServiceDefinitionV2OpsgenieRegion'
service-url:
description: Opsgenie service url.
example: "https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000"
@@ -107288,7 +107349,7 @@ components:
example: Team Slack
type: string
type:
- $ref: "#/components/schemas/ServiceDefinitionV2SlackType"
+ $ref: '#/components/schemas/ServiceDefinitionV2SlackType'
required:
- type
- contact
@@ -107313,35 +107374,35 @@ components:
ServiceDefinitionsCreateRequest:
description: Create service definitions request.
oneOf:
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot2"
- - $ref: "#/components/schemas/ServiceDefinitionV2Dot1"
- - $ref: "#/components/schemas/ServiceDefinitionV2"
- - $ref: "#/components/schemas/ServiceDefinitionRaw"
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot2'
+ - $ref: '#/components/schemas/ServiceDefinitionV2Dot1'
+ - $ref: '#/components/schemas/ServiceDefinitionV2'
+ - $ref: '#/components/schemas/ServiceDefinitionRaw'
ServiceDefinitionsListResponse:
description: Create service definitions response.
properties:
data:
description: Data representing service definitions.
items:
- $ref: "#/components/schemas/ServiceDefinitionData"
+ $ref: '#/components/schemas/ServiceDefinitionData'
type: array
type: object
ServiceList:
description: The response body for the service list endpoint.
properties:
data:
- $ref: "#/components/schemas/ServiceListData"
+ $ref: '#/components/schemas/ServiceListData'
type: object
ServiceListData:
description: A single data item in the service list response.
properties:
attributes:
- $ref: "#/components/schemas/ServiceListDataAttributes"
+ $ref: '#/components/schemas/ServiceListDataAttributes'
id:
description: The unique identifier of the service.
type: string
type:
- $ref: "#/components/schemas/ServiceListDataType"
+ $ref: '#/components/schemas/ServiceListDataType'
required:
- type
type: object
@@ -107351,7 +107412,7 @@ components:
metadata:
description: A list of metadata items associated with the service.
items:
- $ref: "#/components/schemas/ServiceListDataAttributesMetadataItems"
+ $ref: '#/components/schemas/ServiceListDataAttributesMetadataItems'
type: array
services:
description: A list of service names.
@@ -107404,14 +107465,14 @@ components:
description: Data object for a ServiceNow assignment group
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowAssignmentGroupAttributes"
+ $ref: '#/components/schemas/ServiceNowAssignmentGroupAttributes'
id:
description: Unique identifier for the ServiceNow assignment group
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
type:
- $ref: "#/components/schemas/ServiceNowAssignmentGroupType"
+ $ref: '#/components/schemas/ServiceNowAssignmentGroupType'
required:
- id
- type
@@ -107428,7 +107489,7 @@ components:
ServiceNowAssignmentGroupsData:
description: Array of ServiceNow assignment group data objects
items:
- $ref: "#/components/schemas/ServiceNowAssignmentGroupData"
+ $ref: '#/components/schemas/ServiceNowAssignmentGroupData'
type: array
ServiceNowAssignmentGroupsResponse:
description: Response containing ServiceNow assignment groups
@@ -107457,7 +107518,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/ServiceNowBasicAuthType"
+ $ref: '#/components/schemas/ServiceNowBasicAuthType'
username:
description: The `ServiceNowBasicAuth` `username`.
example: ""
@@ -107486,7 +107547,7 @@ components:
description: The `ServiceNowBasicAuthUpdate` `password`.
type: string
type:
- $ref: "#/components/schemas/ServiceNowBasicAuthType"
+ $ref: '#/components/schemas/ServiceNowBasicAuthType'
username:
description: The `ServiceNowBasicAuthUpdate` `username`.
type: string
@@ -107518,14 +107579,14 @@ components:
description: Data object for a ServiceNow business service
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowBusinessServiceAttributes"
+ $ref: '#/components/schemas/ServiceNowBusinessServiceAttributes'
id:
description: Unique identifier for the ServiceNow business service
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
type:
- $ref: "#/components/schemas/ServiceNowBusinessServiceType"
+ $ref: '#/components/schemas/ServiceNowBusinessServiceType'
required:
- id
- type
@@ -107542,7 +107603,7 @@ components:
ServiceNowBusinessServicesData:
description: Array of ServiceNow business service data objects
items:
- $ref: "#/components/schemas/ServiceNowBusinessServiceData"
+ $ref: '#/components/schemas/ServiceNowBusinessServiceData'
type: array
ServiceNowBusinessServicesResponse:
description: Response containing ServiceNow business services
@@ -107562,11 +107623,11 @@ components:
ServiceNowCredentials:
description: The definition of the `ServiceNowCredentials` object.
oneOf:
- - $ref: "#/components/schemas/ServiceNowBasicAuth"
+ - $ref: '#/components/schemas/ServiceNowBasicAuth'
ServiceNowCredentialsUpdate:
description: The definition of the `ServiceNowCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/ServiceNowBasicAuthUpdate"
+ - $ref: '#/components/schemas/ServiceNowBasicAuthUpdate'
ServiceNowInstanceAttributes:
description: Attributes of a ServiceNow instance
properties:
@@ -107581,14 +107642,14 @@ components:
description: Data object for a ServiceNow instance
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowInstanceAttributes"
+ $ref: '#/components/schemas/ServiceNowInstanceAttributes'
id:
description: Unique identifier for the ServiceNow instance
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
type:
- $ref: "#/components/schemas/ServiceNowInstanceType"
+ $ref: '#/components/schemas/ServiceNowInstanceType'
required:
- id
- type
@@ -107605,7 +107666,7 @@ components:
ServiceNowInstancesData:
description: Array of ServiceNow instance data objects
items:
- $ref: "#/components/schemas/ServiceNowInstanceData"
+ $ref: '#/components/schemas/ServiceNowInstanceData'
type: array
ServiceNowInstancesResponse:
description: Response containing ServiceNow instances
@@ -107624,9 +107685,9 @@ components:
description: The definition of the `ServiceNowIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/ServiceNowCredentials"
+ $ref: '#/components/schemas/ServiceNowCredentials'
type:
- $ref: "#/components/schemas/ServiceNowIntegrationType"
+ $ref: '#/components/schemas/ServiceNowIntegrationType'
required:
- type
- credentials
@@ -107643,9 +107704,9 @@ components:
description: The definition of the `ServiceNowIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/ServiceNowCredentialsUpdate"
+ $ref: '#/components/schemas/ServiceNowCredentialsUpdate'
type:
- $ref: "#/components/schemas/ServiceNowIntegrationType"
+ $ref: '#/components/schemas/ServiceNowIntegrationType'
required:
- type
type: object
@@ -107697,7 +107758,7 @@ components:
description: Request to create a ServiceNow template
properties:
data:
- $ref: "#/components/schemas/ServiceNowTemplateCreateRequestData"
+ $ref: '#/components/schemas/ServiceNowTemplateCreateRequestData'
required:
- data
type: object
@@ -107749,9 +107810,9 @@ components:
description: Data object for creating a ServiceNow template
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowTemplateCreateRequestAttributes"
+ $ref: '#/components/schemas/ServiceNowTemplateCreateRequestAttributes'
type:
- $ref: "#/components/schemas/ServiceNowTemplateType"
+ $ref: '#/components/schemas/ServiceNowTemplateType'
required:
- type
- attributes
@@ -107760,14 +107821,14 @@ components:
description: Data object for a ServiceNow template
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowTemplateAttributes"
+ $ref: '#/components/schemas/ServiceNowTemplateAttributes'
id:
description: Unique identifier for the ServiceNow template
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
type:
- $ref: "#/components/schemas/ServiceNowTemplateType"
+ $ref: '#/components/schemas/ServiceNowTemplateType'
required:
- id
- type
@@ -107777,7 +107838,7 @@ components:
description: Response containing a single ServiceNow template
properties:
data:
- $ref: "#/components/schemas/ServiceNowTemplateData"
+ $ref: '#/components/schemas/ServiceNowTemplateData'
required:
- data
type: object
@@ -107793,7 +107854,7 @@ components:
description: Request to update a ServiceNow template
properties:
data:
- $ref: "#/components/schemas/ServiceNowTemplateUpdateRequestData"
+ $ref: '#/components/schemas/ServiceNowTemplateUpdateRequestData'
required:
- data
type: object
@@ -107845,9 +107906,9 @@ components:
description: Data object for updating a ServiceNow template
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowTemplateUpdateRequestAttributes"
+ $ref: '#/components/schemas/ServiceNowTemplateUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/ServiceNowTemplateType"
+ $ref: '#/components/schemas/ServiceNowTemplateType'
required:
- type
- attributes
@@ -107855,7 +107916,7 @@ components:
ServiceNowTemplatesData:
description: Array of ServiceNow template data objects
items:
- $ref: "#/components/schemas/ServiceNowTemplateData"
+ $ref: '#/components/schemas/ServiceNowTemplateData'
type: array
ServiceNowTemplatesResponse:
description: Response containing ServiceNow templates
@@ -107877,9 +107938,9 @@ components:
nullable: true
properties:
result:
- $ref: "#/components/schemas/ServiceNowTicketResult"
+ $ref: '#/components/schemas/ServiceNowTicketResult'
status:
- $ref: "#/components/schemas/Case3rdPartyTicketStatus"
+ $ref: '#/components/schemas/Case3rdPartyTicketStatus'
readOnly: true
type: object
ServiceNowTicketCreateAttributes:
@@ -107900,9 +107961,9 @@ components:
description: ServiceNow ticket creation data
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowTicketCreateAttributes"
+ $ref: '#/components/schemas/ServiceNowTicketCreateAttributes'
type:
- $ref: "#/components/schemas/ServiceNowTicketResourceType"
+ $ref: '#/components/schemas/ServiceNowTicketResourceType'
required:
- type
- attributes
@@ -107911,7 +107972,7 @@ components:
description: ServiceNow ticket creation request
properties:
data:
- $ref: "#/components/schemas/ServiceNowTicketCreateData"
+ $ref: '#/components/schemas/ServiceNowTicketCreateData'
required:
- data
type: object
@@ -107973,14 +108034,14 @@ components:
description: Data object for a ServiceNow user
properties:
attributes:
- $ref: "#/components/schemas/ServiceNowUserAttributes"
+ $ref: '#/components/schemas/ServiceNowUserAttributes'
id:
description: Unique identifier for the ServiceNow user
example: "65b3341b-0680-47f9-a6d4-134db45c603e"
format: uuid
type: string
type:
- $ref: "#/components/schemas/ServiceNowUserType"
+ $ref: '#/components/schemas/ServiceNowUserType'
required:
- id
- type
@@ -107997,7 +108058,7 @@ components:
ServiceNowUsersData:
description: Array of ServiceNow user data objects
items:
- $ref: "#/components/schemas/ServiceNowUserData"
+ $ref: '#/components/schemas/ServiceNowUserData'
type: array
ServiceNowUsersResponse:
description: Response containing ServiceNow users
@@ -108027,7 +108088,7 @@ components:
description: Request body for retrieving service repository information.
properties:
data:
- $ref: "#/components/schemas/ServiceRepositoryInfoRequestData"
+ $ref: '#/components/schemas/ServiceRepositoryInfoRequestData'
required:
- data
type: object
@@ -108050,9 +108111,9 @@ components:
description: Data object for the service repository info request.
properties:
attributes:
- $ref: "#/components/schemas/ServiceRepositoryInfoRequestAttributes"
+ $ref: '#/components/schemas/ServiceRepositoryInfoRequestAttributes'
type:
- $ref: "#/components/schemas/ServiceRepositoryInfoDataType"
+ $ref: '#/components/schemas/ServiceRepositoryInfoDataType'
required:
- type
- attributes
@@ -108061,7 +108122,7 @@ components:
description: Response containing service repository information.
properties:
data:
- $ref: "#/components/schemas/ServiceRepositoryInfoResponseData"
+ $ref: '#/components/schemas/ServiceRepositoryInfoResponseData'
required:
- data
type: object
@@ -108077,7 +108138,7 @@ components:
example: https://github.com/my-org/my-repo
type: string
status:
- $ref: "#/components/schemas/ServiceRepositoryInfoStatus"
+ $ref: '#/components/schemas/ServiceRepositoryInfoStatus'
required:
- status
type: object
@@ -108085,13 +108146,13 @@ components:
description: Data object for the service repository info response.
properties:
attributes:
- $ref: "#/components/schemas/ServiceRepositoryInfoResponseAttributes"
+ $ref: '#/components/schemas/ServiceRepositoryInfoResponseAttributes'
id:
description: The identifier composed of the service name and version.
example: my-web-service:1.0.0
type: string
type:
- $ref: "#/components/schemas/ServiceRepositoryInfoDataType"
+ $ref: '#/components/schemas/ServiceRepositoryInfoDataType'
required:
- id
- type
@@ -108119,7 +108180,7 @@ components:
data:
description: Array of session identifier data objects.
items:
- $ref: "#/components/schemas/SessionIdData"
+ $ref: '#/components/schemas/SessionIdData'
type: array
required:
- data
@@ -108132,7 +108193,7 @@ components:
example: 00000000-0000-0000-0000-000000000001
type: string
type:
- $ref: "#/components/schemas/ViewershipHistorySessionDataType"
+ $ref: '#/components/schemas/ViewershipHistorySessionDataType'
required:
- type
type: object
@@ -108144,13 +108205,13 @@ components:
Use `@severity_details.adjusted.value` instead, which reflects the severity before user-defined adjustments.
oneOf:
- - $ref: "#/components/schemas/SeverityModifierRuleSetAction"
- - $ref: "#/components/schemas/SeverityModifierRuleShiftAction"
+ - $ref: '#/components/schemas/SeverityModifierRuleSetAction'
+ - $ref: '#/components/schemas/SeverityModifierRuleShiftAction'
SeverityModifierRuleAttributesCreate:
description: Attributes for creating or updating a severity modifier rule.
properties:
action:
- $ref: "#/components/schemas/SeverityModifierRuleAction"
+ $ref: '#/components/schemas/SeverityModifierRuleAction'
enabled:
description: Whether the severity modifier rule is enabled.
example: true
@@ -108162,7 +108223,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- rule
@@ -108172,14 +108233,14 @@ components:
description: Attributes of a severity modifier rule as returned by the API.
properties:
action:
- $ref: "#/components/schemas/SeverityModifierRuleAction"
+ $ref: '#/components/schemas/SeverityModifierRuleAction'
created_at:
description: The Unix timestamp in milliseconds when the rule was created.
example: 1722439510282
format: int64
type: integer
created_by:
- $ref: "#/components/schemas/AutomationRuleCreatedBy"
+ $ref: '#/components/schemas/AutomationRuleCreatedBy'
enabled:
description: Whether the severity modifier rule is enabled.
example: true
@@ -108190,7 +108251,7 @@ components:
format: int64
type: integer
modified_by:
- $ref: "#/components/schemas/AutomationRuleModifiedBy"
+ $ref: '#/components/schemas/AutomationRuleModifiedBy'
name:
description: The name of the severity modifier rule.
example: "Downgrade misconfigurations in dev"
@@ -108198,7 +108259,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- enabled
@@ -108213,7 +108274,7 @@ components:
description: The body of a severity modifier rule create request.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRuleDataCreate"
+ $ref: '#/components/schemas/SeverityModifierRuleDataCreate'
required:
- data
type: object
@@ -108221,9 +108282,9 @@ components:
description: The data object for a severity modifier rule create or update request.
properties:
attributes:
- $ref: "#/components/schemas/SeverityModifierRuleAttributesCreate"
+ $ref: '#/components/schemas/SeverityModifierRuleAttributesCreate'
type:
- $ref: "#/components/schemas/SeverityModifierRuleType"
+ $ref: '#/components/schemas/SeverityModifierRuleType'
required:
- type
- attributes
@@ -108232,14 +108293,14 @@ components:
description: The data object for a severity modifier rule as returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/SeverityModifierRuleAttributesResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleAttributesResponse'
id:
description: The ID of the severity modifier rule.
example: "00000000-0000-0000-0000-000000000000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/SeverityModifierRuleType"
+ $ref: '#/components/schemas/SeverityModifierRuleType'
required:
- id
- type
@@ -108248,7 +108309,7 @@ components:
SeverityModifierRuleReorderData:
description: The ordered list of severity modifier rules; every rule must be included.
items:
- $ref: "#/components/schemas/SeverityModifierRuleReorderItem"
+ $ref: '#/components/schemas/SeverityModifierRuleReorderItem'
type: array
SeverityModifierRuleReorderItem:
description: A reference to a severity modifier rule used for reordering.
@@ -108259,7 +108320,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/SeverityModifierRuleType"
+ $ref: '#/components/schemas/SeverityModifierRuleType'
required:
- type
- id
@@ -108268,7 +108329,7 @@ components:
description: The body of a severity modifier rule reorder request.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRuleReorderData"
+ $ref: '#/components/schemas/SeverityModifierRuleReorderData'
required:
- data
type: object
@@ -108276,7 +108337,7 @@ components:
description: The response of a severity modifier rule reorder request.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRuleReorderData"
+ $ref: '#/components/schemas/SeverityModifierRuleReorderData'
required:
- data
type: object
@@ -108284,7 +108345,7 @@ components:
description: A single severity modifier rule response.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRuleDataResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleDataResponse'
required:
- data
type: object
@@ -108297,9 +108358,9 @@ components:
maxLength: 20000
type: string
severity:
- $ref: "#/components/schemas/SeverityModifierSeverity"
+ $ref: '#/components/schemas/SeverityModifierSeverity'
type:
- $ref: "#/components/schemas/SeverityModifierRuleSetActionType"
+ $ref: '#/components/schemas/SeverityModifierRuleSetActionType'
required:
- type
- severity
@@ -108321,9 +108382,9 @@ components:
maxLength: 20000
type: string
severity_delta:
- $ref: "#/components/schemas/SeverityModifierSeverityDelta"
+ $ref: '#/components/schemas/SeverityModifierSeverityDelta'
type:
- $ref: "#/components/schemas/SeverityModifierRuleShiftActionType"
+ $ref: '#/components/schemas/SeverityModifierRuleShiftActionType'
required:
- type
- severity_delta
@@ -108348,24 +108409,24 @@ components:
description: The body of a severity modifier rule update request.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRuleDataCreate"
+ $ref: '#/components/schemas/SeverityModifierRuleDataCreate'
required:
- data
type: object
SeverityModifierRulesDataList:
description: A list of severity modifier rule data objects.
items:
- $ref: "#/components/schemas/SeverityModifierRuleDataResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleDataResponse'
type: array
SeverityModifierRulesResponse:
description: A list of severity modifier rules with pagination metadata.
properties:
data:
- $ref: "#/components/schemas/SeverityModifierRulesDataList"
+ $ref: '#/components/schemas/SeverityModifierRulesDataList'
links:
- $ref: "#/components/schemas/SecurityAutomationRulesLinks"
+ $ref: '#/components/schemas/SecurityAutomationRulesLinks'
meta:
- $ref: "#/components/schemas/SecurityAutomationRulesMeta"
+ $ref: '#/components/schemas/SecurityAutomationRulesMeta'
required:
- data
- meta
@@ -108407,19 +108468,19 @@ components:
SharedDashboardIncluded:
description: Resource included with a shared dashboard.
oneOf:
- - $ref: "#/components/schemas/SharedDashboardIncludedDashboard"
- - $ref: "#/components/schemas/SharedDashboardIncludedUser"
+ - $ref: '#/components/schemas/SharedDashboardIncludedDashboard'
+ - $ref: '#/components/schemas/SharedDashboardIncludedUser'
SharedDashboardIncludedDashboard:
description: Included dashboard resource.
properties:
attributes:
- $ref: "#/components/schemas/SharedDashboardIncludedDashboardAttributes"
+ $ref: '#/components/schemas/SharedDashboardIncludedDashboardAttributes'
id:
description: ID of the dashboard.
example: abc-def-ghi
type: string
type:
- $ref: "#/components/schemas/SharedDashboardIncludedDashboardType"
+ $ref: '#/components/schemas/SharedDashboardIncludedDashboardType'
required:
- id
- type
@@ -108448,13 +108509,13 @@ components:
description: Included user resource.
properties:
attributes:
- $ref: "#/components/schemas/SharedDashboardIncludedUserAttributes"
+ $ref: '#/components/schemas/SharedDashboardIncludedUserAttributes'
id:
description: ID of the user.
example: 00000000-0000-0000-0000-000000000000
type: string
type:
- $ref: "#/components/schemas/UserResourceType"
+ $ref: '#/components/schemas/UserResourceType'
required:
- id
- type
@@ -108502,7 +108563,7 @@ components:
description: Dashboard associated with the shared dashboard.
properties:
data:
- $ref: "#/components/schemas/SharedDashboardRelationshipDashboardData"
+ $ref: '#/components/schemas/SharedDashboardRelationshipDashboardData'
required:
- data
type: object
@@ -108514,7 +108575,7 @@ components:
example: abc-def-ghi
type: string
type:
- $ref: "#/components/schemas/SharedDashboardIncludedDashboardType"
+ $ref: '#/components/schemas/SharedDashboardIncludedDashboardType'
required:
- id
- type
@@ -108523,7 +108584,7 @@ components:
description: User who shared the dashboard.
properties:
data:
- $ref: "#/components/schemas/UserRelationshipData"
+ $ref: '#/components/schemas/UserRelationshipData'
required:
- data
type: object
@@ -108531,9 +108592,9 @@ components:
description: Relationships of a shared dashboard.
properties:
dashboard:
- $ref: "#/components/schemas/SharedDashboardRelationshipDashboard"
+ $ref: '#/components/schemas/SharedDashboardRelationshipDashboard'
sharer:
- $ref: "#/components/schemas/SharedDashboardRelationshipSharer"
+ $ref: '#/components/schemas/SharedDashboardRelationshipSharer'
required:
- dashboard
- sharer
@@ -108542,15 +108603,15 @@ components:
description: A shared dashboard response resource.
properties:
attributes:
- $ref: "#/components/schemas/SharedDashboardResponseAttributes"
+ $ref: '#/components/schemas/SharedDashboardResponseAttributes'
id:
description: ID of the shared dashboard.
example: "12345"
type: string
relationships:
- $ref: "#/components/schemas/SharedDashboardRelationships"
+ $ref: '#/components/schemas/SharedDashboardRelationships'
type:
- $ref: "#/components/schemas/SharedDashboardType"
+ $ref: '#/components/schemas/SharedDashboardType'
required:
- id
- type
@@ -108579,7 +108640,7 @@ components:
nullable: true
type: string
global_time:
- $ref: "#/components/schemas/SharedDashboardGlobalTime"
+ $ref: '#/components/schemas/SharedDashboardGlobalTime'
global_time_selectable:
description: Whether viewers can select a different global time setting.
example: false
@@ -108587,7 +108648,7 @@ components:
invitees:
description: Invitees for invite-only shared dashboards.
items:
- $ref: "#/components/schemas/SharedDashboardInvitee"
+ $ref: '#/components/schemas/SharedDashboardInvitee'
type: array
last_accessed:
description: Time when the shared dashboard was last accessed.
@@ -108598,16 +108659,16 @@ components:
selectable_template_vars:
description: Template variables that viewers can modify.
items:
- $ref: "#/components/schemas/SharedDashboardSelectableTemplateVariable"
+ $ref: '#/components/schemas/SharedDashboardSelectableTemplateVariable'
type: array
share_type:
- $ref: "#/components/schemas/SharedDashboardShareType"
+ $ref: '#/components/schemas/SharedDashboardShareType'
sharer_disabled:
description: Whether the user who shared the dashboard is disabled.
example: false
type: boolean
status:
- $ref: "#/components/schemas/SharedDashboardStatus"
+ $ref: '#/components/schemas/SharedDashboardStatus'
title:
description: Display title for the shared dashboard.
example: Q1 Metrics Dashboard
@@ -108621,7 +108682,7 @@ components:
example: https://p.datadoghq.com/sb/abc-123-token
type: string
viewing_preferences:
- $ref: "#/components/schemas/SharedDashboardViewingPreferences"
+ $ref: '#/components/schemas/SharedDashboardViewingPreferences'
required:
- token
- title
@@ -108721,7 +108782,7 @@ components:
example: false
type: boolean
theme:
- $ref: "#/components/schemas/SharedDashboardViewingPreferencesTheme"
+ $ref: '#/components/schemas/SharedDashboardViewingPreferencesTheme'
required:
- high_density
- theme
@@ -108766,21 +108827,21 @@ components:
included:
description: The `Shift` `included`.
items:
- $ref: "#/components/schemas/ShiftIncluded"
+ $ref: '#/components/schemas/ShiftIncluded'
type: array
type: object
ShiftData:
description: Data for an on-call shift.
properties:
attributes:
- $ref: "#/components/schemas/ShiftDataAttributes"
+ $ref: '#/components/schemas/ShiftDataAttributes'
id:
description: The `ShiftData` `id`.
type: string
relationships:
- $ref: "#/components/schemas/ShiftDataRelationships"
+ $ref: '#/components/schemas/ShiftDataRelationships'
type:
- $ref: "#/components/schemas/ShiftDataType"
+ $ref: '#/components/schemas/ShiftDataType'
required:
- type
type: object
@@ -108800,13 +108861,13 @@ components:
description: Relationships for an on-call shift.
properties:
user:
- $ref: "#/components/schemas/ShiftDataRelationshipsUser"
+ $ref: '#/components/schemas/ShiftDataRelationshipsUser'
type: object
ShiftDataRelationshipsUser:
description: "Defines the relationship between a shift and the user who is working that shift."
properties:
data:
- $ref: "#/components/schemas/ShiftDataRelationshipsUserData"
+ $ref: '#/components/schemas/ShiftDataRelationshipsUserData'
required:
- data
type: object
@@ -108818,7 +108879,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/ShiftDataRelationshipsUserDataType"
+ $ref: '#/components/schemas/ShiftDataRelationshipsUserDataType'
required:
- type
- id
@@ -108844,7 +108905,7 @@ components:
ShiftIncluded:
description: Included data for shift operations.
oneOf:
- - $ref: "#/components/schemas/ScheduleUser"
+ - $ref: '#/components/schemas/ScheduleUser'
SignalEntitiesAttributes:
description: Attributes containing the entities related to the signal.
properties:
@@ -108854,7 +108915,7 @@ components:
- display_name: Test User
principal_id: user@example.com
items:
- $ref: "#/components/schemas/SignalEntityIdentity"
+ $ref: '#/components/schemas/SignalEntityIdentity'
type: array
required:
- identities
@@ -108863,13 +108924,13 @@ components:
description: Entities related to a security signal.
properties:
attributes:
- $ref: "#/components/schemas/SignalEntitiesAttributes"
+ $ref: '#/components/schemas/SignalEntitiesAttributes'
id:
description: The signal ID the entities are associated with.
example: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: string
type:
- $ref: "#/components/schemas/SignalEntitiesType"
+ $ref: '#/components/schemas/SignalEntitiesType'
required:
- id
- type
@@ -108879,7 +108940,7 @@ components:
description: Response containing entities related to a security signal.
properties:
data:
- $ref: "#/components/schemas/SignalEntitiesData"
+ $ref: '#/components/schemas/SignalEntitiesData'
required:
- data
type: object
@@ -108905,37 +108966,37 @@ components:
high_frozen_frame_rates:
description: Detected high frozen frame rate issues.
items:
- $ref: "#/components/schemas/AggregatedHighFrozenFrameRate"
+ $ref: '#/components/schemas/AggregatedHighFrozenFrameRate'
type: array
high_script_evaluations:
description: Detected high script evaluation issues.
items:
- $ref: "#/components/schemas/AggregatedHighScriptEval"
+ $ref: '#/components/schemas/AggregatedHighScriptEval'
type: array
low_cache_hit_rates:
description: Detected low cache hit rate issues.
items:
- $ref: "#/components/schemas/AggregatedLowCacheHitRate"
+ $ref: '#/components/schemas/AggregatedLowCacheHitRate'
type: array
mobile_scroll_frictions:
description: Detected mobile scroll friction issues.
items:
- $ref: "#/components/schemas/AggregatedMobileScrollFriction"
+ $ref: '#/components/schemas/AggregatedMobileScrollFriction'
type: array
slow_fcp_high_bytes:
description: Detected slow first contentful paint with high byte count issues.
items:
- $ref: "#/components/schemas/AggregatedSlowFCPHighBytes"
+ $ref: '#/components/schemas/AggregatedSlowFCPHighBytes'
type: array
slow_interaction_long_tasks:
description: Detected slow interaction with long task issues.
items:
- $ref: "#/components/schemas/AggregatedSlowInteractionLongTask"
+ $ref: '#/components/schemas/AggregatedSlowInteractionLongTask'
type: array
uncompressed_resources:
description: Detected uncompressed resource issues.
items:
- $ref: "#/components/schemas/AggregatedUncompressedResource"
+ $ref: '#/components/schemas/AggregatedUncompressedResource'
type: array
type: object
SignalsProblemsSampleMetadata:
@@ -108982,9 +109043,9 @@ components:
description: A simplified version of a monitor user template.
properties:
created:
- $ref: "#/components/schemas/MonitorUserTemplateCreated"
+ $ref: '#/components/schemas/MonitorUserTemplateCreated'
description:
- $ref: "#/components/schemas/MonitorUserTemplateDescription"
+ $ref: '#/components/schemas/MonitorUserTemplateDescription'
id:
description: The unique identifier. The initial version will match the template ID.
example: "00000000-0000-1234-0000-000000000000"
@@ -108995,13 +109056,13 @@ components:
example: {"message": "You may need to add web hosts if this is consistently high.", "name": "Bytes received on host0", "query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", "type": "query alert"}
type: object
tags:
- $ref: "#/components/schemas/MonitorUserTemplateTags"
+ $ref: '#/components/schemas/MonitorUserTemplateTags'
template_variables:
- $ref: "#/components/schemas/MonitorUserTemplateTemplateVariables"
+ $ref: '#/components/schemas/MonitorUserTemplateTemplateVariables'
title:
- $ref: "#/components/schemas/MonitorUserTemplateTitle"
+ $ref: '#/components/schemas/MonitorUserTemplateTitle'
version:
- $ref: "#/components/schemas/MonitorUserTemplateVersion"
+ $ref: '#/components/schemas/MonitorUserTemplateVersion'
type: object
SingleAggregatedConnectionResponseArray:
description: List of aggregated connections.
@@ -109036,19 +109097,19 @@ components:
data:
description: Array of aggregated connection objects.
items:
- $ref: "#/components/schemas/SingleAggregatedConnectionResponseData"
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseData'
type: array
type: object
SingleAggregatedConnectionResponseData:
description: Object describing an aggregated connection.
properties:
attributes:
- $ref: "#/components/schemas/SingleAggregatedConnectionResponseDataAttributes"
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataAttributes'
id:
description: A unique identifier for the aggregated connection based on the group by values.
type: string
type:
- $ref: "#/components/schemas/SingleAggregatedConnectionResponseDataType"
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseDataType'
type: object
SingleAggregatedConnectionResponseDataAttributes:
description: Attributes for an aggregated connection.
@@ -109177,19 +109238,19 @@ components:
data:
description: Array of aggregated DNS objects.
items:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseData"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseData'
type: array
type: object
SingleAggregatedDnsResponseData:
description: Object describing an aggregated DNS flow.
properties:
attributes:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributes"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributes'
id:
description: A unique identifier for the aggregated DNS traffic based on the group by values.
type: string
type:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseDataType"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseDataType'
type: object
SingleAggregatedDnsResponseDataAttributes:
description: Attributes for an aggregated DNS flow.
@@ -109197,12 +109258,12 @@ components:
group_bys:
description: The key, value pairs for each group by.
items:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributesGroupByItems"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributesGroupByItems'
type: array
metrics:
description: Metrics associated with an aggregated DNS flow.
items:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseDataAttributesMetricsItems"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseDataAttributesMetricsItems'
type: array
type: object
SingleAggregatedDnsResponseDataAttributesGroupByItems:
@@ -109219,7 +109280,7 @@ components:
description: Metrics associated with an aggregated DNS flow.
properties:
key:
- $ref: "#/components/schemas/DnsMetricKey"
+ $ref: '#/components/schemas/DnsMetricKey'
value:
description: The metric value.
format: int64
@@ -109238,7 +109299,7 @@ components:
description: Response from the single entity context endpoint, containing the matching entity.
properties:
data:
- $ref: "#/components/schemas/EntityContextEntity"
+ $ref: '#/components/schemas/EntityContextEntity'
required:
- data
type: object
@@ -109249,7 +109310,7 @@ components:
description: Array of Slack channels in this integration metadata.
example: []
items:
- $ref: "#/components/schemas/SlackIntegrationMetadataChannelItem"
+ $ref: '#/components/schemas/SlackIntegrationMetadataChannelItem'
type: array
required:
- channels
@@ -109301,7 +109362,7 @@ components:
reactionTriggers:
description: "Slack emoji reactions that trigger the workflow."
items:
- $ref: "#/components/schemas/SlackReactionConfig"
+ $ref: '#/components/schemas/SlackReactionConfig'
type: array
uniqueItems: true
type: object
@@ -109309,9 +109370,9 @@ components:
description: "Schema for a Slack-based trigger."
properties:
slackTrigger:
- $ref: "#/components/schemas/SlackTrigger"
+ $ref: '#/components/schemas/SlackTrigger'
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- slackTrigger
type: object
@@ -109323,7 +109384,7 @@ components:
example: "T01234567"
type: string
type:
- $ref: "#/components/schemas/SlackUserBindingType"
+ $ref: '#/components/schemas/SlackUserBindingType'
type: object
SlackUserBindingType:
default: team_id
@@ -109341,7 +109402,7 @@ components:
description: An array of Slack user bindings.
example: [{"id": "T01234567", "type": "team_id"}, {"id": "T09876543", "type": "team_id"}]
items:
- $ref: "#/components/schemas/SlackUserBindingData"
+ $ref: '#/components/schemas/SlackUserBindingData'
type: array
required:
- data
@@ -109371,13 +109432,13 @@ components:
example: "host:host_a,env:prod"
type: string
cross_org_uuids:
- $ref: "#/components/schemas/CrossOrgUuids"
+ $ref: '#/components/schemas/CrossOrgUuids'
data_source:
- $ref: "#/components/schemas/SloDataSource"
+ $ref: '#/components/schemas/SloDataSource'
group_mode:
- $ref: "#/components/schemas/SlosGroupMode"
+ $ref: '#/components/schemas/SlosGroupMode'
measure:
- $ref: "#/components/schemas/SlosMeasure"
+ $ref: '#/components/schemas/SlosMeasure'
name:
description: The variable name for use in formulas.
example: query1
@@ -109387,7 +109448,7 @@ components:
example: "a]b123c45de6f78g90h"
type: string
slo_query_type:
- $ref: "#/components/schemas/SlosQueryType"
+ $ref: '#/components/schemas/SlosQueryType'
required:
- data_source
- slo_id
@@ -109397,7 +109458,7 @@ components:
description: The SLO report request body.
properties:
data:
- $ref: "#/components/schemas/SloReportCreateRequestData"
+ $ref: '#/components/schemas/SloReportCreateRequestData'
required:
- data
type: object
@@ -109410,7 +109471,7 @@ components:
format: int64
type: integer
interval:
- $ref: "#/components/schemas/SLOReportInterval"
+ $ref: '#/components/schemas/SLOReportInterval'
query:
description: The query string used to filter SLO results. Some examples of queries include `service:` and `slo-name`.
example: "slo_type:metric"
@@ -109433,7 +109494,7 @@ components:
description: The data portion of the SLO report request.
properties:
attributes:
- $ref: "#/components/schemas/SloReportCreateRequestAttributes"
+ $ref: '#/components/schemas/SloReportCreateRequestAttributes'
required:
- attributes
type: object
@@ -109441,13 +109502,13 @@ components:
description: The data portion of the SLO status response.
properties:
attributes:
- $ref: "#/components/schemas/SloStatusDataAttributes"
+ $ref: '#/components/schemas/SloStatusDataAttributes'
id:
description: The ID of the SLO.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/SloStatusType"
+ $ref: '#/components/schemas/SloStatusType'
required:
- id
- type
@@ -109462,7 +109523,7 @@ components:
format: double
type: number
raw_error_budget_remaining:
- $ref: "#/components/schemas/RawErrorBudgetRemaining"
+ $ref: '#/components/schemas/RawErrorBudgetRemaining'
sli:
description: The current Service Level Indicator (SLI) value as a percentage.
example: 99.95
@@ -109488,7 +109549,7 @@ components:
description: The SLO status response.
properties:
data:
- $ref: "#/components/schemas/SloStatusData"
+ $ref: '#/components/schemas/SloStatusData'
required:
- data
type: object
@@ -109552,7 +109613,7 @@ components:
description: A single heatmap snapshot resource returned by create or update operations.
properties:
data:
- $ref: "#/components/schemas/SnapshotData"
+ $ref: '#/components/schemas/SnapshotData'
type: object
SnapshotArray:
description: A list of heatmap snapshots returned by a list operation.
@@ -109560,7 +109621,7 @@ components:
data:
description: Array of heatmap snapshot data objects.
items:
- $ref: "#/components/schemas/SnapshotData"
+ $ref: '#/components/schemas/SnapshotData'
type: array
required:
- data
@@ -109569,7 +109630,7 @@ components:
description: Request body for creating a heatmap snapshot.
properties:
data:
- $ref: "#/components/schemas/SnapshotCreateRequestData"
+ $ref: '#/components/schemas/SnapshotCreateRequestData'
required:
- data
type: object
@@ -109577,9 +109638,9 @@ components:
description: Data object for a heatmap snapshot creation request, containing the resource type and attributes.
properties:
attributes:
- $ref: "#/components/schemas/SnapshotCreateRequestDataAttributes"
+ $ref: '#/components/schemas/SnapshotCreateRequestDataAttributes'
type:
- $ref: "#/components/schemas/SnapshotUpdateRequestDataType"
+ $ref: '#/components/schemas/SnapshotUpdateRequestDataType'
required:
- type
type: object
@@ -109634,13 +109695,13 @@ components:
description: Data object representing a heatmap snapshot, including its identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/SnapshotDataAttributes"
+ $ref: '#/components/schemas/SnapshotDataAttributes'
id:
description: Unique identifier of the heatmap snapshot.
readOnly: true
type: string
type:
- $ref: "#/components/schemas/SnapshotUpdateRequestDataType"
+ $ref: '#/components/schemas/SnapshotUpdateRequestDataType'
required:
- type
type: object
@@ -109708,7 +109769,7 @@ components:
description: Request body for updating a heatmap snapshot.
properties:
data:
- $ref: "#/components/schemas/SnapshotUpdateRequestData"
+ $ref: '#/components/schemas/SnapshotUpdateRequestData'
required:
- data
type: object
@@ -109716,13 +109777,13 @@ components:
description: Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/SnapshotUpdateRequestDataAttributes"
+ $ref: '#/components/schemas/SnapshotUpdateRequestDataAttributes'
id:
description: Unique identifier of the heatmap snapshot to update.
example: 00000000-0000-0000-0000-000000000001
type: string
type:
- $ref: "#/components/schemas/SnapshotUpdateRequestDataType"
+ $ref: '#/components/schemas/SnapshotUpdateRequestDataType'
required:
- type
type: object
@@ -109769,7 +109830,7 @@ components:
description: "Trigger a workflow from Software Catalog."
type: object
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
required:
- softwareCatalogTrigger
type: object
@@ -109808,7 +109869,7 @@ components:
description: Response for source map upload.
properties:
data:
- $ref: "#/components/schemas/SourceMapUploadResponseData"
+ $ref: '#/components/schemas/SourceMapUploadResponseData'
type: object
SourceMapUploadResponseData:
description: Data envelope for source map upload response.
@@ -109818,7 +109879,7 @@ components:
example: sourcemap-upload-id
type: string
type:
- $ref: "#/components/schemas/SourceMapUploadResponseType"
+ $ref: '#/components/schemas/SourceMapUploadResponseType'
type: object
SourceMapUploadResponseType:
description: Type of the response.
@@ -109904,13 +109965,13 @@ components:
description: JavaScript source map file data object.
properties:
attributes:
- $ref: "#/components/schemas/SourcemapFileAttributes"
+ $ref: '#/components/schemas/SourcemapFileAttributes'
id:
description: The unique identifier of the source map file, typically the path to the file.
example: path/to/sourcemap.js.map
type: string
type:
- $ref: "#/components/schemas/SourcemapFileDataType"
+ $ref: '#/components/schemas/SourcemapFileDataType'
required:
- id
- type
@@ -109928,21 +109989,21 @@ components:
description: Response containing a JavaScript source map file.
properties:
data:
- $ref: "#/components/schemas/SourcemapFileData"
+ $ref: '#/components/schemas/SourcemapFileData'
required:
- data
type: object
SourcemapItem:
description: A source map data object representing one of the supported map kinds.
oneOf:
- - $ref: "#/components/schemas/JSSourcemapData"
- - $ref: "#/components/schemas/ReactNativeSourcemapData"
- - $ref: "#/components/schemas/IOSSourcemapData"
- - $ref: "#/components/schemas/JVMSourcemapData"
- - $ref: "#/components/schemas/FlutterSourcemapData"
- - $ref: "#/components/schemas/ELFSourcemapData"
- - $ref: "#/components/schemas/NDKSourcemapData"
- - $ref: "#/components/schemas/IL2CPPSourcemapData"
+ - $ref: '#/components/schemas/JSSourcemapData'
+ - $ref: '#/components/schemas/ReactNativeSourcemapData'
+ - $ref: '#/components/schemas/IOSSourcemapData'
+ - $ref: '#/components/schemas/JVMSourcemapData'
+ - $ref: '#/components/schemas/FlutterSourcemapData'
+ - $ref: '#/components/schemas/ELFSourcemapData'
+ - $ref: '#/components/schemas/NDKSourcemapData'
+ - $ref: '#/components/schemas/IL2CPPSourcemapData'
SourcemapMapKind:
description: The type of source map.
enum:
@@ -109968,13 +110029,13 @@ components:
SourcemapsData:
description: List of source map data objects.
items:
- $ref: "#/components/schemas/SourcemapItem"
+ $ref: '#/components/schemas/SourcemapItem'
type: array
SourcemapsListMeta:
description: Pagination metadata for the source maps list response.
properties:
page:
- $ref: "#/components/schemas/SourcemapsListMetaPage"
+ $ref: '#/components/schemas/SourcemapsListMetaPage'
required:
- page
type: object
@@ -109998,7 +110059,7 @@ components:
description: Response containing a list of affected source maps.
properties:
data:
- $ref: "#/components/schemas/SourcemapsData"
+ $ref: '#/components/schemas/SourcemapsData'
required:
- data
type: object
@@ -110006,24 +110067,24 @@ components:
description: Object description of a spans after being processed and stored by Datadog.
properties:
attributes:
- $ref: "#/components/schemas/SpansAttributes"
+ $ref: '#/components/schemas/SpansAttributes'
id:
description: Unique ID of the Span.
example: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA"
type: string
type:
- $ref: "#/components/schemas/SpansType"
+ $ref: '#/components/schemas/SpansType'
type: object
SpansAggregateBucket:
description: Spans aggregate.
properties:
attributes:
- $ref: "#/components/schemas/SpansAggregateBucketAttributes"
+ $ref: '#/components/schemas/SpansAggregateBucketAttributes'
id:
description: ID of the spans aggregate.
type: string
type:
- $ref: "#/components/schemas/SpansAggregateBucketType"
+ $ref: '#/components/schemas/SpansAggregateBucketType'
type: object
SpansAggregateBucketAttributes:
description: A bucket values.
@@ -110039,7 +110100,7 @@ components:
type: object
computes:
additionalProperties:
- $ref: "#/components/schemas/SpansAggregateBucketValue"
+ $ref: '#/components/schemas/SpansAggregateBucketValue'
description: A map of the metric name -> value for regular compute or list of values for a timeseries.
type: object
type: object
@@ -110052,9 +110113,9 @@ components:
SpansAggregateBucketValue:
description: A bucket value, can be either a timeseries or a single value.
oneOf:
- - $ref: "#/components/schemas/SpansAggregateBucketValueSingleString"
- - $ref: "#/components/schemas/SpansAggregateBucketValueSingleNumber"
- - $ref: "#/components/schemas/SpansAggregateBucketValueTimeseries"
+ - $ref: '#/components/schemas/SpansAggregateBucketValueSingleString'
+ - $ref: '#/components/schemas/SpansAggregateBucketValueSingleNumber'
+ - $ref: '#/components/schemas/SpansAggregateBucketValueTimeseries'
SpansAggregateBucketValueSingleNumber:
description: A single number value.
format: double
@@ -110065,7 +110126,7 @@ components:
SpansAggregateBucketValueTimeseries:
description: A timeseries array.
items:
- $ref: "#/components/schemas/SpansAggregateBucketValueTimeseriesPoint"
+ $ref: '#/components/schemas/SpansAggregateBucketValueTimeseriesPoint'
type: array
x-generate-alias-as-model: true
SpansAggregateBucketValueTimeseriesPoint:
@@ -110085,15 +110146,15 @@ components:
description: The object containing the query content.
properties:
attributes:
- $ref: "#/components/schemas/SpansAggregateRequestAttributes"
+ $ref: '#/components/schemas/SpansAggregateRequestAttributes'
type:
- $ref: "#/components/schemas/SpansAggregateRequestType"
+ $ref: '#/components/schemas/SpansAggregateRequestType'
type: object
SpansAggregateRequest:
description: The object sent with the request to retrieve a list of aggregated spans from your organization.
properties:
data:
- $ref: "#/components/schemas/SpansAggregateData"
+ $ref: '#/components/schemas/SpansAggregateData'
type: object
SpansAggregateRequestAttributes:
description: The object containing all the query parameters.
@@ -110101,17 +110162,17 @@ components:
compute:
description: The list of metrics or timeseries to compute for the retrieved buckets.
items:
- $ref: "#/components/schemas/SpansCompute"
+ $ref: '#/components/schemas/SpansCompute'
type: array
filter:
- $ref: "#/components/schemas/SpansQueryFilter"
+ $ref: '#/components/schemas/SpansQueryFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/SpansGroupBy"
+ $ref: '#/components/schemas/SpansGroupBy'
type: array
options:
- $ref: "#/components/schemas/SpansQueryOptions"
+ $ref: '#/components/schemas/SpansQueryOptions'
type: object
SpansAggregateRequestType:
default: aggregate_request
@@ -110127,10 +110188,10 @@ components:
data:
description: The list of matching buckets, one item per bucket.
items:
- $ref: "#/components/schemas/SpansAggregateBucket"
+ $ref: '#/components/schemas/SpansAggregateBucket'
type: array
meta:
- $ref: "#/components/schemas/SpansAggregateResponseMetadata"
+ $ref: '#/components/schemas/SpansAggregateResponseMetadata'
type: object
SpansAggregateResponseMetadata:
description: The metadata associated with a request.
@@ -110145,13 +110206,13 @@ components:
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/SpansAggregateResponseStatus"
+ $ref: '#/components/schemas/SpansAggregateResponseStatus'
warnings:
description: |-
A list of warnings (non fatal errors) encountered, partial results might be returned if
warnings are present in the response.
items:
- $ref: "#/components/schemas/SpansWarning"
+ $ref: '#/components/schemas/SpansWarning'
type: array
type: object
SpansAggregateResponseStatus:
@@ -110165,15 +110226,15 @@ components:
example: {"aggregation": "count", "order": "asc"}
properties:
aggregation:
- $ref: "#/components/schemas/SpansAggregationFunction"
+ $ref: '#/components/schemas/SpansAggregationFunction'
metric:
description: The metric to sort by (only used for `type=measure`).
example: "@duration"
type: string
order:
- $ref: "#/components/schemas/SpansSortOrder"
+ $ref: '#/components/schemas/SpansSortOrder'
type:
- $ref: "#/components/schemas/SpansAggregateSortType"
+ $ref: '#/components/schemas/SpansAggregateSortType'
type: object
SpansAggregateSortType:
default: "alphabetical"
@@ -110275,7 +110336,7 @@ components:
description: A compute rule to compute metrics or timeseries.
properties:
aggregation:
- $ref: "#/components/schemas/SpansAggregationFunction"
+ $ref: '#/components/schemas/SpansAggregationFunction'
interval:
description: |-
The time buckets' size (only used for type=timeseries)
@@ -110287,7 +110348,7 @@ components:
example: "@duration"
type: string
type:
- $ref: "#/components/schemas/SpansComputeType"
+ $ref: '#/components/schemas/SpansComputeType'
required:
- aggregation
type: object
@@ -110323,18 +110384,18 @@ components:
example: "host"
type: string
histogram:
- $ref: "#/components/schemas/SpansGroupByHistogram"
+ $ref: '#/components/schemas/SpansGroupByHistogram'
limit:
default: 10
description: The maximum buckets to return for this group by.
format: int64
type: integer
missing:
- $ref: "#/components/schemas/SpansGroupByMissing"
+ $ref: '#/components/schemas/SpansGroupByMissing'
sort:
- $ref: "#/components/schemas/SpansAggregateSort"
+ $ref: '#/components/schemas/SpansAggregateSort'
total:
- $ref: "#/components/schemas/SpansGroupByTotal"
+ $ref: '#/components/schemas/SpansGroupByTotal'
required:
- facet
type: object
@@ -110370,8 +110431,8 @@ components:
SpansGroupByMissing:
description: The value to use for spans that don't have the facet used to group by.
oneOf:
- - $ref: "#/components/schemas/SpansGroupByMissingString"
- - $ref: "#/components/schemas/SpansGroupByMissingNumber"
+ - $ref: '#/components/schemas/SpansGroupByMissingString'
+ - $ref: '#/components/schemas/SpansGroupByMissingNumber'
SpansGroupByMissingNumber:
description: The missing value to use if there is a number valued facet.
format: double
@@ -110384,9 +110445,9 @@ components:
description: |-
A resulting object to put the given computes in over all the matching records.
oneOf:
- - $ref: "#/components/schemas/SpansGroupByTotalBoolean"
- - $ref: "#/components/schemas/SpansGroupByTotalString"
- - $ref: "#/components/schemas/SpansGroupByTotalNumber"
+ - $ref: '#/components/schemas/SpansGroupByTotalBoolean'
+ - $ref: '#/components/schemas/SpansGroupByTotalString'
+ - $ref: '#/components/schemas/SpansGroupByTotalNumber'
SpansGroupByTotalBoolean:
description: If set to true, creates an additional bucket labeled "$facet_total".
type: boolean
@@ -110401,27 +110462,27 @@ components:
description: The request for a spans list.
properties:
data:
- $ref: "#/components/schemas/SpansListRequestData"
+ $ref: '#/components/schemas/SpansListRequestData'
type: object
SpansListRequestAttributes:
description: The object containing all the query parameters.
properties:
filter:
- $ref: "#/components/schemas/SpansQueryFilter"
+ $ref: '#/components/schemas/SpansQueryFilter'
options:
- $ref: "#/components/schemas/SpansQueryOptions"
+ $ref: '#/components/schemas/SpansQueryOptions'
page:
- $ref: "#/components/schemas/SpansListRequestPage"
+ $ref: '#/components/schemas/SpansListRequestPage'
sort:
- $ref: "#/components/schemas/SpansSort"
+ $ref: '#/components/schemas/SpansSort'
type: object
SpansListRequestData:
description: The object containing the query content.
properties:
attributes:
- $ref: "#/components/schemas/SpansListRequestAttributes"
+ $ref: '#/components/schemas/SpansListRequestAttributes'
type:
- $ref: "#/components/schemas/SpansListRequestType"
+ $ref: '#/components/schemas/SpansListRequestType'
type: object
SpansListRequestPage:
description: Paging attributes for listing spans.
@@ -110453,12 +110514,12 @@ components:
data:
description: Array of spans matching the request.
items:
- $ref: "#/components/schemas/Span"
+ $ref: '#/components/schemas/Span'
type: array
links:
- $ref: "#/components/schemas/SpansListResponseLinks"
+ $ref: '#/components/schemas/SpansListResponseLinks'
meta:
- $ref: "#/components/schemas/SpansListResponseMetadata"
+ $ref: '#/components/schemas/SpansListResponseMetadata'
type: object
SpansListResponseLinks:
description: Links attributes.
@@ -110479,28 +110540,28 @@ components:
format: int64
type: integer
page:
- $ref: "#/components/schemas/SpansResponseMetadataPage"
+ $ref: '#/components/schemas/SpansResponseMetadataPage'
request_id:
description: The identifier of the request.
example: "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR"
type: string
status:
- $ref: "#/components/schemas/SpansAggregateResponseStatus"
+ $ref: '#/components/schemas/SpansAggregateResponseStatus'
warnings:
description: |-
A list of warnings (non fatal errors) encountered, partial results might be returned if
warnings are present in the response.
items:
- $ref: "#/components/schemas/SpansWarning"
+ $ref: '#/components/schemas/SpansWarning'
type: array
type: object
SpansMetricCompute:
description: The compute rule to compute the span-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/SpansMetricComputeAggregationType"
+ $ref: '#/components/schemas/SpansMetricComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles'
path:
description: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: "@duration"
@@ -110524,13 +110585,13 @@ components:
description: The object describing the Datadog span-based metric to create.
properties:
compute:
- $ref: "#/components/schemas/SpansMetricCompute"
+ $ref: '#/components/schemas/SpansMetricCompute'
filter:
- $ref: "#/components/schemas/SpansMetricFilter"
+ $ref: '#/components/schemas/SpansMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/SpansMetricGroupBy"
+ $ref: '#/components/schemas/SpansMetricGroupBy'
type: array
required:
- compute
@@ -110539,11 +110600,11 @@ components:
description: The new span-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/SpansMetricCreateAttributes"
+ $ref: '#/components/schemas/SpansMetricCreateAttributes'
id:
- $ref: "#/components/schemas/SpansMetricID"
+ $ref: '#/components/schemas/SpansMetricID'
type:
- $ref: "#/components/schemas/SpansMetricType"
+ $ref: '#/components/schemas/SpansMetricType'
required:
- id
- type
@@ -110553,7 +110614,7 @@ components:
description: The new span-based metric body.
properties:
data:
- $ref: "#/components/schemas/SpansMetricCreateData"
+ $ref: '#/components/schemas/SpansMetricCreateData'
required:
- data
type: object
@@ -110588,28 +110649,28 @@ components:
description: The span-based metric object.
properties:
data:
- $ref: "#/components/schemas/SpansMetricResponseData"
+ $ref: '#/components/schemas/SpansMetricResponseData'
type: object
SpansMetricResponseAttributes:
description: The object describing a Datadog span-based metric.
properties:
compute:
- $ref: "#/components/schemas/SpansMetricResponseCompute"
+ $ref: '#/components/schemas/SpansMetricResponseCompute'
filter:
- $ref: "#/components/schemas/SpansMetricResponseFilter"
+ $ref: '#/components/schemas/SpansMetricResponseFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/SpansMetricResponseGroupBy"
+ $ref: '#/components/schemas/SpansMetricResponseGroupBy'
type: array
type: object
SpansMetricResponseCompute:
description: The compute rule to compute the span-based metric.
properties:
aggregation_type:
- $ref: "#/components/schemas/SpansMetricComputeAggregationType"
+ $ref: '#/components/schemas/SpansMetricComputeAggregationType'
include_percentiles:
- $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles'
path:
description: The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
example: "@duration"
@@ -110619,11 +110680,11 @@ components:
description: The span-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/SpansMetricResponseAttributes"
+ $ref: '#/components/schemas/SpansMetricResponseAttributes'
id:
- $ref: "#/components/schemas/SpansMetricID"
+ $ref: '#/components/schemas/SpansMetricID'
type:
- $ref: "#/components/schemas/SpansMetricType"
+ $ref: '#/components/schemas/SpansMetricType'
type: object
SpansMetricResponseFilter:
description: The span-based metric filter. Spans matching this filter will be aggregated in this metric.
@@ -110657,28 +110718,28 @@ components:
description: The span-based metric properties that will be updated.
properties:
compute:
- $ref: "#/components/schemas/SpansMetricUpdateCompute"
+ $ref: '#/components/schemas/SpansMetricUpdateCompute'
filter:
- $ref: "#/components/schemas/SpansMetricFilter"
+ $ref: '#/components/schemas/SpansMetricFilter'
group_by:
description: The rules for the group by.
items:
- $ref: "#/components/schemas/SpansMetricGroupBy"
+ $ref: '#/components/schemas/SpansMetricGroupBy'
type: array
type: object
SpansMetricUpdateCompute:
description: The compute rule to compute the span-based metric.
properties:
include_percentiles:
- $ref: "#/components/schemas/SpansMetricComputeIncludePercentiles"
+ $ref: '#/components/schemas/SpansMetricComputeIncludePercentiles'
type: object
SpansMetricUpdateData:
description: The new span-based metric properties.
properties:
attributes:
- $ref: "#/components/schemas/SpansMetricUpdateAttributes"
+ $ref: '#/components/schemas/SpansMetricUpdateAttributes'
type:
- $ref: "#/components/schemas/SpansMetricType"
+ $ref: '#/components/schemas/SpansMetricType'
required:
- type
- attributes
@@ -110687,7 +110748,7 @@ components:
description: The new span-based metric body.
properties:
data:
- $ref: "#/components/schemas/SpansMetricUpdateData"
+ $ref: '#/components/schemas/SpansMetricUpdateData'
required:
- data
type: object
@@ -110697,7 +110758,7 @@ components:
data:
description: A list of span-based metric objects.
items:
- $ref: "#/components/schemas/SpansMetricResponseData"
+ $ref: '#/components/schemas/SpansMetricResponseData'
type: array
type: object
SpansQueryFilter:
@@ -110795,30 +110856,30 @@ components:
annotations:
description: Up to 100 text annotations displayed on the workflow canvas.
items:
- $ref: "#/components/schemas/Annotation"
+ $ref: '#/components/schemas/Annotation'
maxItems: 100
type: array
connectionEnvs:
description: A list of connections or connection groups used in the workflow.
items:
- $ref: "#/components/schemas/ConnectionEnv"
+ $ref: '#/components/schemas/ConnectionEnv'
type: array
handle:
description: Unique identifier used to trigger workflows automatically in Datadog.
type: string
inputSchema:
- $ref: "#/components/schemas/InputSchema"
+ $ref: '#/components/schemas/InputSchema'
outputSchema:
- $ref: "#/components/schemas/OutputSchema"
+ $ref: '#/components/schemas/OutputSchema'
steps:
description: A `Step` is a sub-component of a workflow. Each `Step` performs an action.
items:
- $ref: "#/components/schemas/Step"
+ $ref: '#/components/schemas/Step'
type: array
triggers:
description: The list of triggers that activate this workflow. At least one trigger is required, and each trigger type may appear at most once.
items:
- $ref: "#/components/schemas/Trigger"
+ $ref: '#/components/schemas/Trigger'
type: array
type: object
SpecVersion:
@@ -110849,7 +110910,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/SplitAPIKeyType"
+ $ref: '#/components/schemas/SplitAPIKeyType'
required:
- type
- api_key
@@ -110869,25 +110930,25 @@ components:
description: The `SplitAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/SplitAPIKeyType"
+ $ref: '#/components/schemas/SplitAPIKeyType'
required:
- type
type: object
SplitCredentials:
description: The definition of the `SplitCredentials` object.
oneOf:
- - $ref: "#/components/schemas/SplitAPIKey"
+ - $ref: '#/components/schemas/SplitAPIKey'
SplitCredentialsUpdate:
description: The definition of the `SplitCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/SplitAPIKeyUpdate"
+ - $ref: '#/components/schemas/SplitAPIKeyUpdate'
SplitIntegration:
description: The definition of the `SplitIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/SplitCredentials"
+ $ref: '#/components/schemas/SplitCredentials'
type:
- $ref: "#/components/schemas/SplitIntegrationType"
+ $ref: '#/components/schemas/SplitIntegrationType'
required:
- type
- credentials
@@ -110904,9 +110965,9 @@ components:
description: The definition of the `SplitIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/SplitCredentialsUpdate"
+ $ref: '#/components/schemas/SplitCredentialsUpdate'
type:
- $ref: "#/components/schemas/SplitIntegrationType"
+ $ref: '#/components/schemas/SplitIntegrationType'
required:
- type
type: object
@@ -110938,9 +110999,9 @@ components:
example: "ordersToSubmit"
type: string
properties:
- $ref: "#/components/schemas/StateVariableProperties"
+ $ref: '#/components/schemas/StateVariableProperties'
type:
- $ref: "#/components/schemas/StateVariableType"
+ $ref: '#/components/schemas/StateVariableType'
required:
- id
- name
@@ -110971,7 +111032,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatsigAPIKeyType"
+ $ref: '#/components/schemas/StatsigAPIKeyType'
required:
- type
- api_key
@@ -110991,25 +111052,25 @@ components:
description: The `StatsigAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/StatsigAPIKeyType"
+ $ref: '#/components/schemas/StatsigAPIKeyType'
required:
- type
type: object
StatsigCredentials:
description: The definition of the `StatsigCredentials` object.
oneOf:
- - $ref: "#/components/schemas/StatsigAPIKey"
+ - $ref: '#/components/schemas/StatsigAPIKey'
StatsigCredentialsUpdate:
description: The definition of the `StatsigCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/StatsigAPIKeyUpdate"
+ - $ref: '#/components/schemas/StatsigAPIKeyUpdate'
StatsigIntegration:
description: The definition of the `StatsigIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/StatsigCredentials"
+ $ref: '#/components/schemas/StatsigCredentials'
type:
- $ref: "#/components/schemas/StatsigIntegrationType"
+ $ref: '#/components/schemas/StatsigIntegrationType'
required:
- type
- credentials
@@ -111026,9 +111087,9 @@ components:
description: The definition of the `StatsigIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/StatsigCredentialsUpdate"
+ $ref: '#/components/schemas/StatsigCredentialsUpdate'
type:
- $ref: "#/components/schemas/StatsigIntegrationType"
+ $ref: '#/components/schemas/StatsigIntegrationType'
required:
- type
type: object
@@ -111036,11 +111097,11 @@ components:
description: Response object for a single status page.
properties:
data:
- $ref: "#/components/schemas/StatusPageData"
+ $ref: '#/components/schemas/StatusPageData'
included:
description: The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/StatusPageArrayIncluded"
+ $ref: '#/components/schemas/StatusPageArrayIncluded'
type: array
type: object
StatusPageArray:
@@ -111049,35 +111110,35 @@ components:
data:
description: A list of status page data objects.
items:
- $ref: "#/components/schemas/StatusPageData"
+ $ref: '#/components/schemas/StatusPageData'
type: array
included:
description: The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/StatusPageArrayIncluded"
+ $ref: '#/components/schemas/StatusPageArrayIncluded'
type: array
meta:
- $ref: "#/components/schemas/PaginationMeta"
+ $ref: '#/components/schemas/PaginationMeta'
required:
- data
type: object
StatusPageArrayIncluded:
description: An included resource related to a status page.
oneOf:
- - $ref: "#/components/schemas/StatusPagesUser"
+ - $ref: '#/components/schemas/StatusPagesUser'
StatusPageAsIncluded:
description: The included status page resource.
properties:
attributes:
- $ref: "#/components/schemas/StatusPageAsIncludedAttributes"
+ $ref: '#/components/schemas/StatusPageAsIncludedAttributes'
id:
description: The ID of the status page.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/StatusPageAsIncludedRelationships"
+ $ref: '#/components/schemas/StatusPageAsIncludedRelationships'
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
type: object
@@ -111090,7 +111151,7 @@ components:
components:
description: Components displayed on the status page.
items:
- $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItems"
+ $ref: '#/components/schemas/StatusPageAsIncludedAttributesComponentsItems'
type: array
created_at:
description: Timestamp of when the status page was created.
@@ -111134,9 +111195,9 @@ components:
description: Whether users can subscribe to the status page.
type: boolean
type:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType'
visualization_type:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType'
type: object
StatusPageAsIncludedAttributesComponentsItems:
description: A component displayed on an included status page.
@@ -111144,7 +111205,7 @@ components:
components:
description: If the component is of type `group`, the components within the group.
items:
- $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems"
+ $ref: '#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems'
type: array
id:
description: The ID of the component.
@@ -111159,9 +111220,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesType'
type: object
StatusPageAsIncludedAttributesComponentsItemsComponentsItems:
description: A grouped component within a status page component group.
@@ -111179,9 +111240,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
type: object
StatusPageAsIncludedRelationships:
description: The relationships of a status page.
@@ -111197,7 +111258,7 @@ components:
description: The Datadog user who created the status page.
properties:
data:
- $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -111209,7 +111270,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111218,7 +111279,7 @@ components:
description: The Datadog user who last modified the status page.
properties:
data:
- $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -111230,7 +111291,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111239,15 +111300,15 @@ components:
description: The data object for a status page.
properties:
attributes:
- $ref: "#/components/schemas/StatusPageDataAttributes"
+ $ref: '#/components/schemas/StatusPageDataAttributes'
id:
description: The ID of the status page.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/StatusPageDataRelationships"
+ $ref: '#/components/schemas/StatusPageDataRelationships'
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
type: object
@@ -111261,7 +111322,7 @@ components:
components:
description: Components displayed on the status page.
items:
- $ref: "#/components/schemas/StatusPageDataAttributesComponentsItems"
+ $ref: '#/components/schemas/StatusPageDataAttributesComponentsItems'
type: array
created_at:
description: Timestamp of when the status page was created.
@@ -111308,9 +111369,9 @@ components:
description: Whether users can subscribe to the status page.
type: boolean
type:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesType'
visualization_type:
- $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType"
+ $ref: '#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType'
type: object
StatusPageDataAttributesComponentsItems:
description: A component displayed on a status page.
@@ -111318,7 +111379,7 @@ components:
components:
description: If the component is of type `group`, the components within the group.
items:
- $ref: "#/components/schemas/StatusPageDataAttributesComponentsItemsComponentsItems"
+ $ref: '#/components/schemas/StatusPageDataAttributesComponentsItemsComponentsItems'
type: array
id:
description: The ID of the component.
@@ -111332,9 +111393,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesType'
type: object
StatusPageDataAttributesComponentsItemsComponentsItems:
description: A grouped component within a status page component group.
@@ -111351,9 +111412,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
type: object
StatusPageDataRelationships:
description: The relationships of a status page.
@@ -111369,7 +111430,7 @@ components:
description: The Datadog user who created the status page.
properties:
data:
- $ref: "#/components/schemas/StatusPageDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/StatusPageDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -111381,7 +111442,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111390,7 +111451,7 @@ components:
description: The Datadog user who last modified the status page.
properties:
data:
- $ref: "#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -111402,7 +111463,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111420,11 +111481,11 @@ components:
description: Response object for a single component.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentData"
+ $ref: '#/components/schemas/StatusPagesComponentData'
included:
description: The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/StatusPagesComponentArrayIncluded"
+ $ref: '#/components/schemas/StatusPagesComponentArrayIncluded'
type: array
type: object
StatusPagesComponentArray:
@@ -111433,12 +111494,12 @@ components:
data:
description: A list of component data objects.
items:
- $ref: "#/components/schemas/StatusPagesComponentData"
+ $ref: '#/components/schemas/StatusPagesComponentData'
type: array
included:
description: The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter.
items:
- $ref: "#/components/schemas/StatusPagesComponentArrayIncluded"
+ $ref: '#/components/schemas/StatusPagesComponentArrayIncluded'
type: array
required:
- data
@@ -111446,22 +111507,22 @@ components:
StatusPagesComponentArrayIncluded:
description: An included resource related to a component.
oneOf:
- - $ref: "#/components/schemas/StatusPagesUser"
- - $ref: "#/components/schemas/StatusPageAsIncluded"
- - $ref: "#/components/schemas/StatusPagesComponentGroup"
+ - $ref: '#/components/schemas/StatusPagesUser'
+ - $ref: '#/components/schemas/StatusPageAsIncluded'
+ - $ref: '#/components/schemas/StatusPagesComponentGroup'
StatusPagesComponentData:
description: The data object for a component.
properties:
attributes:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributes"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributes'
id:
description: The ID of the component.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/StatusPagesComponentDataRelationships"
+ $ref: '#/components/schemas/StatusPagesComponentDataRelationships'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- type
type: object
@@ -111471,7 +111532,7 @@ components:
components:
description: If the component is of type `group`, the components within the group.
items:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesComponentsItems"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesComponentsItems'
type: array
created_at:
description: Timestamp of when the component was created.
@@ -111489,9 +111550,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
type:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesType'
required:
- type
type: object
@@ -111511,9 +111572,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
type: object
StatusPagesComponentDataAttributesStatus:
description: The status of the component.
@@ -111551,7 +111612,7 @@ components:
description: The Datadog user who created the component.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -111563,7 +111624,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111572,7 +111633,7 @@ components:
description: The group the component belongs to.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsGroupData"
+ $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsGroupData'
required:
- data
type: object
@@ -111586,7 +111647,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- type
- id
@@ -111595,7 +111656,7 @@ components:
description: The Datadog user who last modified the component.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -111607,7 +111668,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111616,7 +111677,7 @@ components:
description: The status page the component belongs to.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData"
+ $ref: '#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData'
required:
- data
type: object
@@ -111629,7 +111690,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -111638,15 +111699,15 @@ components:
description: The included component group resource.
properties:
attributes:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributes"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributes'
id:
description: The ID of the component.
format: uuid
type: string
relationships:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationships"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationships'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- type
type: object
@@ -111656,7 +111717,7 @@ components:
components:
description: If the component is of type `group`, the components within the group.
items:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItems"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItems'
type: array
created_at:
description: Timestamp of when the component was created.
@@ -111674,9 +111735,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentDataAttributesStatus"
+ $ref: '#/components/schemas/StatusPagesComponentDataAttributesStatus'
type:
- $ref: "#/components/schemas/CreateComponentRequestDataAttributesType"
+ $ref: '#/components/schemas/CreateComponentRequestDataAttributesType'
required:
- type
type: object
@@ -111696,9 +111757,9 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsStatus'
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupAttributesComponentsItemsType'
type: object
StatusPagesComponentGroupAttributesComponentsItemsStatus:
description: The status of the component.
@@ -111728,19 +111789,19 @@ components:
description: The relationships of a component group.
properties:
created_by_user:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUser"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUser'
group:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsGroup"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsGroup'
last_modified_by_user:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUser"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUser'
status_page:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPage"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPage'
type: object
StatusPagesComponentGroupRelationshipsCreatedByUser:
description: The Datadog user who created the component group.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUserData"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsCreatedByUserData'
required:
- data
type: object
@@ -111752,7 +111813,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111761,7 +111822,7 @@ components:
description: The group the component group belongs to.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsGroupData"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsGroupData'
required:
- data
type: object
@@ -111775,7 +111836,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesComponentGroupType"
+ $ref: '#/components/schemas/StatusPagesComponentGroupType'
required:
- type
- id
@@ -111784,7 +111845,7 @@ components:
description: The Datadog user who last modified the component group.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUserData"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsLastModifiedByUserData'
required:
- data
type: object
@@ -111796,7 +111857,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
- id
@@ -111805,7 +111866,7 @@ components:
description: The status page the component group belongs to.
properties:
data:
- $ref: "#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPageData"
+ $ref: '#/components/schemas/StatusPagesComponentGroupRelationshipsStatusPageData'
required:
- data
type: object
@@ -111818,7 +111879,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPageDataType"
+ $ref: '#/components/schemas/StatusPageDataType'
required:
- type
- id
@@ -111836,13 +111897,13 @@ components:
description: The included Datadog user resource.
properties:
attributes:
- $ref: "#/components/schemas/StatusPagesUserAttributes"
+ $ref: '#/components/schemas/StatusPagesUserAttributes'
id:
description: The ID of the Datadog user.
format: uuid
type: string
type:
- $ref: "#/components/schemas/StatusPagesUserType"
+ $ref: '#/components/schemas/StatusPagesUserType'
required:
- type
type: object
@@ -111889,9 +111950,9 @@ components:
description: Statuspage account data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageAccountCreateAttributes"
+ $ref: '#/components/schemas/StatuspageAccountCreateAttributes'
type:
- $ref: "#/components/schemas/StatuspageAccountType"
+ $ref: '#/components/schemas/StatuspageAccountType'
required:
- type
- attributes
@@ -111900,7 +111961,7 @@ components:
description: Create request for a Statuspage account.
properties:
data:
- $ref: "#/components/schemas/StatuspageAccountCreateData"
+ $ref: '#/components/schemas/StatuspageAccountCreateData'
required:
- data
type: object
@@ -111908,7 +111969,7 @@ components:
description: Response containing a Statuspage account.
properties:
data:
- $ref: "#/components/schemas/StatuspageAccountResponseData"
+ $ref: '#/components/schemas/StatuspageAccountResponseData'
required:
- data
type: object
@@ -111924,9 +111985,9 @@ components:
description: Statuspage account data from a response.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageAccountResponseAttributes"
+ $ref: '#/components/schemas/StatuspageAccountResponseAttributes'
type:
- $ref: "#/components/schemas/StatuspageAccountType"
+ $ref: '#/components/schemas/StatuspageAccountType'
required:
- type
- attributes
@@ -111953,9 +112014,9 @@ components:
description: Statuspage account data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageAccountUpdateAttributes"
+ $ref: '#/components/schemas/StatuspageAccountUpdateAttributes'
type:
- $ref: "#/components/schemas/StatuspageAccountType"
+ $ref: '#/components/schemas/StatuspageAccountType'
required:
- type
- attributes
@@ -111964,7 +112025,7 @@ components:
description: Update request for a Statuspage account.
properties:
data:
- $ref: "#/components/schemas/StatuspageAccountUpdateData"
+ $ref: '#/components/schemas/StatuspageAccountUpdateData'
required:
- data
type: object
@@ -111989,9 +112050,9 @@ components:
description: Statuspage URL setting data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageUrlSettingCreateAttributes"
+ $ref: '#/components/schemas/StatuspageUrlSettingCreateAttributes'
type:
- $ref: "#/components/schemas/StatuspageUrlSettingType"
+ $ref: '#/components/schemas/StatuspageUrlSettingType'
required:
- type
- attributes
@@ -112000,7 +112061,7 @@ components:
description: Create request for a Statuspage URL setting.
properties:
data:
- $ref: "#/components/schemas/StatuspageUrlSettingCreateData"
+ $ref: '#/components/schemas/StatuspageUrlSettingCreateData'
required:
- data
type: object
@@ -112008,7 +112069,7 @@ components:
description: Response containing a Statuspage URL setting.
properties:
data:
- $ref: "#/components/schemas/StatuspageUrlSettingResponseData"
+ $ref: '#/components/schemas/StatuspageUrlSettingResponseData'
required:
- data
type: object
@@ -112028,7 +112089,7 @@ components:
description: Statuspage URL setting data from a response.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageUrlSettingResponseAttributes"
+ $ref: '#/components/schemas/StatuspageUrlSettingResponseAttributes'
id:
description: The ID of the Statuspage URL setting.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -112036,7 +112097,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/StatuspageUrlSettingType"
+ $ref: '#/components/schemas/StatuspageUrlSettingType'
required:
- id
- type
@@ -112069,7 +112130,7 @@ components:
description: Statuspage URL setting data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/StatuspageUrlSettingUpdateAttributes"
+ $ref: '#/components/schemas/StatuspageUrlSettingUpdateAttributes'
id:
description: The ID of the Statuspage URL setting.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
@@ -112077,7 +112138,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/StatuspageUrlSettingType"
+ $ref: '#/components/schemas/StatuspageUrlSettingType'
required:
- id
- type
@@ -112087,7 +112148,7 @@ components:
description: Update request for a Statuspage URL setting.
properties:
data:
- $ref: "#/components/schemas/StatuspageUrlSettingUpdateData"
+ $ref: '#/components/schemas/StatuspageUrlSettingUpdateData'
required:
- data
type: object
@@ -112098,7 +112159,7 @@ components:
description: An array of Statuspage URL settings.
example: [{"attributes": {"custom_tags": "team:collaboration-integrations", "url": "https://example.statuspage.io"}, "id": "596da4af-0563-4097-90ff-07230c3f9db3", "type": "statuspage-url-setting"}]
items:
- $ref: "#/components/schemas/StatuspageUrlSettingResponseData"
+ $ref: '#/components/schemas/StatuspageUrlSettingResponseData'
type: array
required:
- data
@@ -112118,7 +112179,7 @@ components:
description: Response containing watermarked widgets recovered from an image.
properties:
data:
- $ref: "#/components/schemas/StegadographyWidgetItems"
+ $ref: '#/components/schemas/StegadographyWidgetItems'
required:
- data
type: object
@@ -112126,13 +112187,13 @@ components:
description: A single watermarked widget resource recovered from an image.
properties:
attributes:
- $ref: "#/components/schemas/StegadographyWidgetAttributes"
+ $ref: '#/components/schemas/StegadographyWidgetAttributes'
id:
description: Composite identifier formed from the organization ID and watermark, separated by a colon.
example: "abc123:0123456789abcdef"
type: string
type:
- $ref: "#/components/schemas/StegadographyWidgetType"
+ $ref: '#/components/schemas/StegadographyWidgetType'
required:
- id
- type
@@ -112176,7 +112237,7 @@ components:
id: "abc123:0123456789abcdef"
type: widget
items:
- $ref: "#/components/schemas/StegadographyWidget"
+ $ref: '#/components/schemas/StegadographyWidget'
type: array
StegadographyWidgetType:
description: Stegadography widget resource type.
@@ -112195,16 +112256,16 @@ components:
minLength: 1
type: string
completionGate:
- $ref: "#/components/schemas/CompletionGate"
+ $ref: '#/components/schemas/CompletionGate'
connectionLabel:
description: The unique identifier of a connection defined in the spec.
type: string
display:
- $ref: "#/components/schemas/StepDisplay"
+ $ref: '#/components/schemas/StepDisplay'
errorHandlers:
description: The `Step` `errorHandlers`.
items:
- $ref: "#/components/schemas/ErrorHandler"
+ $ref: '#/components/schemas/ErrorHandler'
type: array
name:
description: Name of the step.
@@ -112214,15 +112275,15 @@ components:
outboundEdges:
description: A list of subsequent actions to run. This list is empty for a terminal step.
items:
- $ref: "#/components/schemas/OutboundEdge"
+ $ref: '#/components/schemas/OutboundEdge'
type: array
parameters:
description: A list of inputs for an action.
items:
- $ref: "#/components/schemas/Parameter"
+ $ref: '#/components/schemas/Parameter'
type: array
readinessGate:
- $ref: "#/components/schemas/ReadinessGate"
+ $ref: '#/components/schemas/ReadinessGate'
required:
- name
- actionId
@@ -112233,7 +112294,7 @@ components:
automatic layout, or provide it for every step to preserve a manual layout.
properties:
bounds:
- $ref: "#/components/schemas/StepDisplayBounds"
+ $ref: '#/components/schemas/StepDisplayBounds'
type: object
StepDisplayBounds:
description: The definition of `StepDisplayBounds` object.
@@ -112251,9 +112312,9 @@ components:
description: Data object for creating or editing a Synthetic test suite.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsSuite"
+ $ref: '#/components/schemas/SyntheticsSuite'
type:
- $ref: "#/components/schemas/SyntheticsSuiteTypes"
+ $ref: '#/components/schemas/SyntheticsSuiteTypes'
required:
- attributes
- type
@@ -112262,7 +112323,7 @@ components:
description: Request body for creating or editing a Synthetic test suite.
properties:
data:
- $ref: "#/components/schemas/SuiteCreateEdit"
+ $ref: '#/components/schemas/SuiteCreateEdit'
required:
- data
type: object
@@ -112270,7 +112331,7 @@ components:
description: JSON Patch request for a Synthetic test suite.
properties:
data:
- $ref: "#/components/schemas/SuiteJsonPatchRequestData"
+ $ref: '#/components/schemas/SuiteJsonPatchRequestData'
required:
- data
type: object
@@ -112278,9 +112339,9 @@ components:
description: Data object for a JSON Patch request on a Synthetic test suite.
properties:
attributes:
- $ref: "#/components/schemas/SuiteJsonPatchRequestDataAttributes"
+ $ref: '#/components/schemas/SuiteJsonPatchRequestDataAttributes'
type:
- $ref: "#/components/schemas/SuiteJsonPatchType"
+ $ref: '#/components/schemas/SuiteJsonPatchType'
type: object
SuiteJsonPatchRequestDataAttributes:
description: Attributes for a JSON Patch request on a Synthetic test suite.
@@ -112288,7 +112349,7 @@ components:
json_patch:
description: JSON Patch operations following RFC 6902.
items:
- $ref: "#/components/schemas/JsonPatchOperation"
+ $ref: '#/components/schemas/JsonPatchOperation'
type: array
type: object
SuiteJsonPatchType:
@@ -112316,7 +112377,7 @@ components:
description: The child spans of this node in the pruned tree.
example: []
items:
- $ref: "#/components/schemas/SummarizedSpan"
+ $ref: '#/components/schemas/SummarizedSpan'
type: array
durationSeconds:
description: The duration of the span, in seconds.
@@ -112329,7 +112390,7 @@ components:
format: date-time
type: string
error:
- $ref: "#/components/schemas/APMSpanErrorFlag"
+ $ref: '#/components/schemas/APMSpanErrorFlag'
hidden_child_spans_count:
description: The number of child spans that were pruned from this node when summarizing the trace.
example: 0
@@ -112404,7 +112465,7 @@ components:
description: A summarized, hierarchical view of a trace.
properties:
root:
- $ref: "#/components/schemas/SummarizedSpan"
+ $ref: '#/components/schemas/SummarizedSpan'
traceId:
description: The full 128-bit trace ID, encoded as a 32-character hexadecimal string.
example: "0000000000000000abc1230000000000"
@@ -112434,10 +112495,10 @@ components:
changes:
description: A list of changes.
items:
- $ref: "#/components/schemas/VersionHistoryUpdate"
+ $ref: '#/components/schemas/VersionHistoryUpdate'
type: array
suppression:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionAttributes'
type: object
SyncProperty:
description: Sync property configuration.
@@ -112501,13 +112562,13 @@ components:
description: Data object for a parent API multistep test.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsApiMultistepParentTestAttributes"
+ $ref: '#/components/schemas/SyntheticsApiMultistepParentTestAttributes'
id:
description: The public ID of the parent test.
example: abc-def-123
type: string
type:
- $ref: "#/components/schemas/SyntheticsApiMultistepParentTestType"
+ $ref: '#/components/schemas/SyntheticsApiMultistepParentTestType'
type: object
SyntheticsApiMultistepParentTestType:
default: parent_test
@@ -112525,7 +112586,7 @@ components:
data:
description: List of parent tests that include this subtest.
items:
- $ref: "#/components/schemas/SyntheticsApiMultistepParentTestData"
+ $ref: '#/components/schemas/SyntheticsApiMultistepParentTestData'
type: array
type: object
SyntheticsApiMultistepSubtestAttributes:
@@ -112544,13 +112605,13 @@ components:
description: Data object for a Synthetic API multistep subtest.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsApiMultistepSubtestAttributes"
+ $ref: '#/components/schemas/SyntheticsApiMultistepSubtestAttributes'
id:
description: The public ID of the subtest.
example: abc-def-123
type: string
type:
- $ref: "#/components/schemas/SyntheticsApiMultistepSubtestType"
+ $ref: '#/components/schemas/SyntheticsApiMultistepSubtestType'
type: object
SyntheticsApiMultistepSubtestType:
default: subtest
@@ -112568,20 +112629,20 @@ components:
data:
description: List of API tests that can be added as subtests.
items:
- $ref: "#/components/schemas/SyntheticsApiMultistepSubtestData"
+ $ref: '#/components/schemas/SyntheticsApiMultistepSubtestData'
type: array
type: object
SyntheticsDowntimeData:
description: A Synthetics downtime object.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsDowntimeDataAttributesResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeDataAttributesResponse'
id:
description: The unique identifier of the downtime.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/SyntheticsDowntimeResourceType"
+ $ref: '#/components/schemas/SyntheticsDowntimeResourceType'
required:
- id
- type
@@ -112603,11 +112664,11 @@ components:
example: Weekly maintenance
type: string
tags:
- $ref: "#/components/schemas/SyntheticsDowntimeTags"
+ $ref: '#/components/schemas/SyntheticsDowntimeTags'
testIds:
- $ref: "#/components/schemas/SyntheticsDowntimeTestIds"
+ $ref: '#/components/schemas/SyntheticsDowntimeTestIds'
timeSlots:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotRequests"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotRequests'
required:
- name
- isEnabled
@@ -112643,11 +112704,11 @@ components:
example: Weekly maintenance
type: string
tags:
- $ref: "#/components/schemas/SyntheticsDowntimeTags"
+ $ref: '#/components/schemas/SyntheticsDowntimeTags'
testIds:
- $ref: "#/components/schemas/SyntheticsDowntimeTestIds"
+ $ref: '#/components/schemas/SyntheticsDowntimeTestIds'
timeSlots:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotResponses"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotResponses'
updatedAt:
description: The timestamp when the downtime was last updated.
example: "2024-01-15T10:30:00Z"
@@ -112704,7 +112765,7 @@ components:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
items:
- $ref: "#/components/schemas/SyntheticsDowntimeData"
+ $ref: '#/components/schemas/SyntheticsDowntimeData'
type: array
SyntheticsDowntimeDataRequest:
description: The data object for a Synthetics downtime create or update request.
@@ -112726,9 +112787,9 @@ components:
type: downtime
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsDowntimeDataAttributesRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeDataAttributesRequest'
type:
- $ref: "#/components/schemas/SyntheticsDowntimeResourceType"
+ $ref: '#/components/schemas/SyntheticsDowntimeResourceType'
required:
- type
- attributes
@@ -112751,7 +112812,7 @@ components:
description: Request body for creating or updating a Synthetics downtime.
properties:
data:
- $ref: "#/components/schemas/SyntheticsDowntimeDataRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeDataRequest'
required:
- data
type: object
@@ -112767,7 +112828,7 @@ components:
description: Response containing a single Synthetics downtime.
properties:
data:
- $ref: "#/components/schemas/SyntheticsDowntimeData"
+ $ref: '#/components/schemas/SyntheticsDowntimeData'
required:
- data
type: object
@@ -112828,18 +112889,18 @@ components:
description: Recurrence settings for a Synthetics downtime time slot.
properties:
end:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotDate"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotDate'
frequency:
- $ref: "#/components/schemas/SyntheticsDowntimeFrequency"
+ $ref: '#/components/schemas/SyntheticsDowntimeFrequency'
interval:
description: The interval between recurrences, relative to the frequency.
example: 1
format: int64
type: integer
weekdayPositions:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekdayPositions"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekdayPositions'
weekdays:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekdays"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekdays'
required:
- frequency
type: object
@@ -112847,18 +112908,18 @@ components:
description: Recurrence settings returned in a Synthetics downtime time slot response.
properties:
frequency:
- $ref: "#/components/schemas/SyntheticsDowntimeFrequency"
+ $ref: '#/components/schemas/SyntheticsDowntimeFrequency'
interval:
description: The interval between recurrences, relative to the frequency.
example: 1
format: int64
type: integer
until:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotDate"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotDate'
weekdayPositions:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekdayPositions"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekdayPositions'
weekdays:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekdays"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekdays'
required:
- frequency
- interval
@@ -112877,9 +112938,9 @@ components:
example: Weekly maintenance window
type: string
recurrence:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotRecurrenceRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotRecurrenceRequest'
start:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotDate"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotDate'
timezone:
description: The IANA timezone name for the time slot.
example: Europe/Paris
@@ -112901,7 +112962,7 @@ components:
year: 2024
timezone: Europe/Paris
items:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotRequest'
type: array
SyntheticsDowntimeTimeSlotResponse:
description: A time slot returned in a Synthetics downtime response.
@@ -112920,9 +112981,9 @@ components:
example: Weekly maintenance window
type: string
recurrence:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotRecurrenceResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotRecurrenceResponse'
start:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotDate"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotDate'
timezone:
description: The IANA timezone name for the time slot.
example: Europe/Paris
@@ -112946,7 +113007,7 @@ components:
year: 2024
timezone: Europe/Paris
items:
- $ref: "#/components/schemas/SyntheticsDowntimeTimeSlotResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeTimeSlotResponse'
type: array
SyntheticsDowntimeWeekday:
description: A day of the week for a Synthetics downtime recurrence.
@@ -112992,7 +113053,7 @@ components:
example:
- 1
items:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekdayPosition"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekdayPosition'
type: array
SyntheticsDowntimeWeekdays:
description: Days of the week for a Synthetics downtime recurrence schedule.
@@ -113001,13 +113062,13 @@ components:
- WE
- FR
items:
- $ref: "#/components/schemas/SyntheticsDowntimeWeekday"
+ $ref: '#/components/schemas/SyntheticsDowntimeWeekday'
type: array
SyntheticsDowntimesResponse:
description: Response containing a list of Synthetics downtimes.
properties:
data:
- $ref: "#/components/schemas/SyntheticsDowntimeDataList"
+ $ref: '#/components/schemas/SyntheticsDowntimeDataList'
required:
- data
type: object
@@ -113018,21 +113079,21 @@ components:
nullable: true
properties:
data:
- $ref: "#/components/schemas/SyntheticsFastTestResultData"
+ $ref: '#/components/schemas/SyntheticsFastTestResultData'
type: object
SyntheticsFastTestResultAttributes:
description: Attributes of the fast test result.
properties:
device:
- $ref: "#/components/schemas/SyntheticsTestResultDevice"
+ $ref: '#/components/schemas/SyntheticsTestResultDevice'
location:
- $ref: "#/components/schemas/SyntheticsTestResultLocation"
+ $ref: '#/components/schemas/SyntheticsTestResultLocation'
result:
- $ref: "#/components/schemas/SyntheticsFastTestResultDetail"
+ $ref: '#/components/schemas/SyntheticsFastTestResultDetail'
test_sub_type:
- $ref: "#/components/schemas/SyntheticsFastTestSubType"
+ $ref: '#/components/schemas/SyntheticsFastTestSubType'
test_type:
- $ref: "#/components/schemas/SyntheticsFastTestType"
+ $ref: '#/components/schemas/SyntheticsFastTestType'
test_version:
description: Version of the test at the time the fast test was triggered.
example: 1
@@ -113043,13 +113104,13 @@ components:
description: Fast test result data object (JSON:API format).
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsFastTestResultAttributes"
+ $ref: '#/components/schemas/SyntheticsFastTestResultAttributes'
id:
description: The UUID of the fast test, used as the result identifier.
example: abc12345-1234-1234-1234-abc123456789
type: string
type:
- $ref: "#/components/schemas/SyntheticsFastTestResultType"
+ $ref: '#/components/schemas/SyntheticsFastTestResultType'
type: object
SyntheticsFastTestResultDetail:
description: |-
@@ -113059,21 +113120,21 @@ components:
assertions:
description: Results of each assertion evaluated during the test.
items:
- $ref: "#/components/schemas/SyntheticsTestResultAssertionResult"
+ $ref: '#/components/schemas/SyntheticsTestResultAssertionResult'
type: array
call_type:
description: gRPC call type (for example, `unary`, `healthCheck`, or `reflection`).
example: unary
type: string
cert:
- $ref: "#/components/schemas/SyntheticsTestResultCertificate"
+ $ref: '#/components/schemas/SyntheticsTestResultCertificate'
duration:
description: Total duration of the test in milliseconds.
example: 150.5
format: double
type: number
failure:
- $ref: "#/components/schemas/SyntheticsTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsTestResultFailure'
finished_at:
description: Unix timestamp (ms) of when the test finished.
example: 1679328001000
@@ -113088,15 +113149,15 @@ components:
example: false
type: boolean
request:
- $ref: "#/components/schemas/SyntheticsTestResultRequestInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultRequestInfo'
resolved_ip:
description: IP address resolved for the target host.
example: "1.2.3.4"
type: string
response:
- $ref: "#/components/schemas/SyntheticsTestResultResponseInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultResponseInfo'
run_type:
- $ref: "#/components/schemas/SyntheticsTestResultRunType"
+ $ref: '#/components/schemas/SyntheticsTestResultRunType'
started_at:
description: Unix timestamp (ms) of when the test started.
example: 1679328000000
@@ -113109,7 +113170,7 @@ components:
steps:
description: Step results for multistep API tests.
items:
- $ref: "#/components/schemas/SyntheticsTestResultStep"
+ $ref: '#/components/schemas/SyntheticsTestResultStep'
type: array
timings:
additionalProperties: {}
@@ -113125,7 +113186,7 @@ components:
traceroute:
description: Traceroute hop results, present for ICMP and TCP tests.
items:
- $ref: "#/components/schemas/SyntheticsTestResultTracerouteHop"
+ $ref: '#/components/schemas/SyntheticsTestResultTracerouteHop'
type: array
triggered_at:
description: Unix timestamp (ms) of when the test was triggered.
@@ -113186,7 +113247,7 @@ components:
description: Synthetic global variable.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsGlobalVariableAttributes"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableAttributes'
description:
description: Description of the global variable.
example: "Example description"
@@ -113206,7 +113267,7 @@ components:
example: "MY_VARIABLE"
type: string
parse_test_options:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptions"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptions'
parse_test_public_id:
description: A Synthetic test ID to use as a test to generate the variable value.
example: "abc-def-123"
@@ -113219,7 +113280,7 @@ components:
type: string
type: array
value:
- $ref: "#/components/schemas/SyntheticsGlobalVariableValue"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableValue'
required:
- description
- name
@@ -113230,13 +113291,13 @@ components:
description: Attributes of the global variable.
properties:
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
type: object
SyntheticsGlobalVariableOptions:
description: Options for the Global Variable for MFA.
properties:
totp_parameters:
- $ref: "#/components/schemas/SyntheticsGlobalVariableTOTPParameters"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableTOTPParameters'
type: object
SyntheticsGlobalVariableParseTestOptions:
description: Parser options to use for retrieving a Synthetic global variable from a Synthetic test. Used in conjunction with `parse_test_public_id`.
@@ -113250,9 +113311,9 @@ components:
example: "LOCAL_VARIABLE"
type: string
parser:
- $ref: "#/components/schemas/SyntheticsVariableParser"
+ $ref: '#/components/schemas/SyntheticsVariableParser'
type:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
required:
- type
type: object
@@ -113309,7 +113370,7 @@ components:
value: value
properties:
options:
- $ref: "#/components/schemas/SyntheticsGlobalVariableOptions"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableOptions'
secure:
description: Determines if the value of the variable is hidden.
type: boolean
@@ -113323,22 +113384,22 @@ components:
SyntheticsNetworkAssertion:
description: Object describing an assertion for a Network Path test.
oneOf:
- - $ref: "#/components/schemas/SyntheticsNetworkAssertionLatency"
- - $ref: "#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHop"
- - $ref: "#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentage"
- - $ref: "#/components/schemas/SyntheticsNetworkAssertionJitter"
+ - $ref: '#/components/schemas/SyntheticsNetworkAssertionLatency'
+ - $ref: '#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHop'
+ - $ref: '#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentage'
+ - $ref: '#/components/schemas/SyntheticsNetworkAssertionJitter'
SyntheticsNetworkAssertionJitter:
description: Jitter assertion for a Network Path test.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator'
target:
description: Target value in milliseconds.
example: 5
format: double
type: number
type:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionJitterType"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionJitterType'
required:
- operator
- target
@@ -113357,16 +113418,16 @@ components:
description: Network latency assertion for a Network Path test.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator'
property:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionProperty"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionProperty'
target:
description: Target value in milliseconds.
example: 500
format: double
type: number
type:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionLatencyType"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionLatencyType'
required:
- operator
- property
@@ -113386,16 +113447,16 @@ components:
description: Multi-network hop assertion for a Network Path test.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator'
property:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionProperty"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionProperty'
target:
description: Target value in number of hops.
example: 3
format: double
type: number
type:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHopType"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionMultiNetworkHopType'
required:
- operator
- property
@@ -113433,7 +113494,7 @@ components:
description: Packet loss percentage assertion for a Network Path test.
properties:
operator:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionOperator"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionOperator'
target:
description: Target value as a percentage (0 to 1).
example: 0.05
@@ -113442,7 +113503,7 @@ components:
minimum: 0
type: number
type:
- $ref: "#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentageType"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertionPacketLossPercentageType'
required:
- operator
- target
@@ -113473,7 +113534,7 @@ components:
description: Object containing details about a Network Path test.
properties:
config:
- $ref: "#/components/schemas/SyntheticsNetworkTestConfig"
+ $ref: '#/components/schemas/SyntheticsNetworkTestConfig'
locations:
description: |-
Array of locations used to run the test. Network Path tests can be run from managed locations to test public endpoints,
@@ -113498,16 +113559,16 @@ components:
example: "Example Network Path test"
type: string
options:
- $ref: "#/components/schemas/SyntheticsTestOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptions'
public_id:
description: The public ID for the test.
example: abc-def-123
readOnly: true
type: string
status:
- $ref: "#/components/schemas/SyntheticsTestPauseStatus"
+ $ref: '#/components/schemas/SyntheticsTestPauseStatus'
subtype:
- $ref: "#/components/schemas/SyntheticsNetworkTestSubType"
+ $ref: '#/components/schemas/SyntheticsNetworkTestSubType'
tags:
description: Array of tags attached to the test.
example: ["env:production"]
@@ -113516,7 +113577,7 @@ components:
type: string
type: array
type:
- $ref: "#/components/schemas/SyntheticsNetworkTestType"
+ $ref: '#/components/schemas/SyntheticsNetworkTestType'
required:
- name
- config
@@ -113533,18 +113594,18 @@ components:
description: Array of assertions used for the test.
example: [{"operator": "lessThan", "property": "avg", "target": 500, "type": "latency"}]
items:
- $ref: "#/components/schemas/SyntheticsNetworkAssertion"
+ $ref: '#/components/schemas/SyntheticsNetworkAssertion'
type: array
request:
- $ref: "#/components/schemas/SyntheticsNetworkTestRequest"
+ $ref: '#/components/schemas/SyntheticsNetworkTestRequest'
type: object
SyntheticsNetworkTestEdit:
description: Data object for creating or editing a Network Path test.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsNetworkTest"
+ $ref: '#/components/schemas/SyntheticsNetworkTest'
type:
- $ref: "#/components/schemas/SyntheticsNetworkTestType"
+ $ref: '#/components/schemas/SyntheticsNetworkTestType'
required:
- attributes
- type
@@ -113553,7 +113614,7 @@ components:
description: Network Path test request.
properties:
data:
- $ref: "#/components/schemas/SyntheticsNetworkTestEdit"
+ $ref: '#/components/schemas/SyntheticsNetworkTestEdit'
required:
- data
type: object
@@ -113588,7 +113649,7 @@ components:
description: An optional label displayed for the source host in the Network Path visualization.
type: string
tcp_method:
- $ref: "#/components/schemas/SyntheticsNetworkTestRequestTCPMethod"
+ $ref: '#/components/schemas/SyntheticsNetworkTestRequestTCPMethod'
timeout:
description: Timeout in seconds.
format: int64
@@ -113620,20 +113681,20 @@ components:
description: Network Path test response.
properties:
data:
- $ref: "#/components/schemas/SyntheticsNetworkTestResponseData"
+ $ref: '#/components/schemas/SyntheticsNetworkTestResponseData'
type: object
SyntheticsNetworkTestResponseData:
description: Network Path test response data.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsNetworkTest"
+ $ref: '#/components/schemas/SyntheticsNetworkTest'
id:
description: The public ID of the Network Path test.
example: abc-def-123
readOnly: true
type: string
type:
- $ref: "#/components/schemas/SyntheticsNetworkTestResponseType"
+ $ref: '#/components/schemas/SyntheticsNetworkTestResponseType'
type: object
SyntheticsNetworkTestResponseType:
default: "network_test"
@@ -113672,12 +113733,12 @@ components:
data:
description: Array of Synthetic test results.
items:
- $ref: "#/components/schemas/SyntheticsTestResultData"
+ $ref: '#/components/schemas/SyntheticsTestResultData'
type: array
included:
description: Array of included related resources, such as the test definition.
items:
- $ref: "#/components/schemas/SyntheticsTestResultIncludedItem"
+ $ref: '#/components/schemas/SyntheticsTestResultIncludedItem'
type: array
type: object
SyntheticsRestrictedRoles:
@@ -113707,7 +113768,7 @@ components:
example: "Example suite name"
type: string
options:
- $ref: "#/components/schemas/SyntheticsSuiteOptions"
+ $ref: '#/components/schemas/SyntheticsSuiteOptions'
public_id:
description: The public ID for the test.
example: 123-abc-456
@@ -113723,10 +113784,10 @@ components:
tests:
description: Array of Synthetic tests included in the suite.
items:
- $ref: "#/components/schemas/SyntheticsSuiteTest"
+ $ref: '#/components/schemas/SyntheticsSuiteTest'
type: array
type:
- $ref: "#/components/schemas/SyntheticsSuiteType"
+ $ref: '#/components/schemas/SyntheticsSuiteType'
required:
- name
- type
@@ -113747,38 +113808,38 @@ components:
description: Synthetics suite response
properties:
data:
- $ref: "#/components/schemas/SyntheticsSuiteResponseData"
+ $ref: '#/components/schemas/SyntheticsSuiteResponseData'
type: object
SyntheticsSuiteResponseData:
description: Synthetics suite response data
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsSuite"
+ $ref: '#/components/schemas/SyntheticsSuite'
id:
description: The public ID for the suite.
example: 123-abc-456
readOnly: true
type: string
type:
- $ref: "#/components/schemas/SyntheticsSuiteTypes"
+ $ref: '#/components/schemas/SyntheticsSuiteTypes'
type: object
SyntheticsSuiteSearchResponse:
description: Synthetics suite search response
properties:
data:
- $ref: "#/components/schemas/SyntheticsSuiteSearchResponseData"
+ $ref: '#/components/schemas/SyntheticsSuiteSearchResponseData'
type: object
SyntheticsSuiteSearchResponseData:
description: Synthetics suite search response data
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes"
+ $ref: '#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes'
id:
description: The unique identifier of the suite search response data.
format: uuid
type: string
type:
- $ref: "#/components/schemas/SuiteSearchResponseType"
+ $ref: '#/components/schemas/SuiteSearchResponseType'
type: object
SyntheticsSuiteSearchResponseDataAttributes:
description: Synthetics suite search response data attributes
@@ -113786,7 +113847,7 @@ components:
suites:
description: List of Synthetic suites matching the search query.
items:
- $ref: "#/components/schemas/SyntheticsSuite"
+ $ref: '#/components/schemas/SyntheticsSuite'
type: array
total:
description: Total number of Synthetic suites matching the search query.
@@ -113798,7 +113859,7 @@ components:
description: Object containing details about a Synthetic test included in a Synthetic suite.
properties:
alerting_criticality:
- $ref: "#/components/schemas/SyntheticsSuiteTestAlertingCriticality"
+ $ref: '#/components/schemas/SyntheticsSuiteTestAlertingCriticality'
public_id:
description: The public ID of the Synthetic test included in the suite.
example: ""
@@ -113875,7 +113936,7 @@ components:
parts:
description: Array of completed parts with their ETags.
items:
- $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadPart"
+ $ref: '#/components/schemas/SyntheticsTestFileCompleteMultipartUploadPart'
type: array
uploadId:
description: The upload ID returned when the multipart upload was initiated.
@@ -113947,11 +114008,11 @@ components:
description: Request body for getting presigned URLs for a multipart file upload.
properties:
bucketKeyPrefix:
- $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix"
+ $ref: '#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequestBucketKeyPrefix'
parts:
description: Array of part descriptors for the multipart upload.
items:
- $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsPart"
+ $ref: '#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsPart'
type: array
required:
- bucketKeyPrefix
@@ -113975,7 +114036,7 @@ components:
example: "api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json"
type: string
multipart_presigned_urls_params:
- $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsParams"
+ $ref: '#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsParams'
type: object
SyntheticsTestLatestResultsResponse:
description: Response object for a Synthetic test's latest result summaries.
@@ -113983,12 +114044,12 @@ components:
data:
description: Array of Synthetic test result summaries.
items:
- $ref: "#/components/schemas/SyntheticsTestResultSummaryData"
+ $ref: '#/components/schemas/SyntheticsTestResultSummaryData'
type: array
included:
description: Array of included related resources, such as the test definition.
items:
- $ref: "#/components/schemas/SyntheticsTestResultIncludedItem"
+ $ref: '#/components/schemas/SyntheticsTestResultIncludedItem'
type: array
type: object
SyntheticsTestOptions:
@@ -114008,7 +114069,7 @@ components:
description: The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.
type: string
monitor_options:
- $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptions"
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptions'
monitor_priority:
description: Integer from 1 (high) to 5 (low) indicating alert severity.
format: int32
@@ -114016,11 +114077,11 @@ components:
minimum: 1
type: integer
restricted_roles:
- $ref: "#/components/schemas/SyntheticsRestrictedRoles"
+ $ref: '#/components/schemas/SyntheticsRestrictedRoles'
retry:
- $ref: "#/components/schemas/SyntheticsTestOptionsRetry"
+ $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
scheduling:
- $ref: "#/components/schemas/SyntheticsTestOptionsScheduling"
+ $ref: '#/components/schemas/SyntheticsTestOptionsScheduling'
tick_every:
description: The frequency at which to run the Synthetic test (in seconds).
format: int64
@@ -114037,7 +114098,7 @@ components:
description: Message to include in the escalation notification.
type: string
notification_preset_name:
- $ref: "#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName"
+ $ref: '#/components/schemas/SyntheticsTestOptionsMonitorOptionsNotificationPresetName'
renotify_interval:
description: |-
Time interval before renotifying if the test is still failing
@@ -114092,7 +114153,7 @@ components:
description: Array containing objects describing the scheduling pattern to apply to each day.
example: [{"day": 1, "from": "07:00", "to": "16:00"}, {"day": 3, "from": "07:00", "to": "16:00"}]
items:
- $ref: "#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe"
+ $ref: '#/components/schemas/SyntheticsTestOptionsSchedulingTimeframe'
type: array
timezone:
description: Timezone in which the timeframe is based.
@@ -114163,13 +114224,13 @@ components:
description: Data object for a parent suite.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsTestParentSuiteAttributes"
+ $ref: '#/components/schemas/SyntheticsTestParentSuiteAttributes'
id:
description: The public ID of the parent suite.
example: abc-def-123
type: string
type:
- $ref: "#/components/schemas/SyntheticsTestParentSuiteType"
+ $ref: '#/components/schemas/SyntheticsTestParentSuiteType'
type: object
SyntheticsTestParentSuiteType:
default: parent_suite
@@ -114186,7 +114247,7 @@ components:
data:
description: List of parent suites for the given test.
items:
- $ref: "#/components/schemas/SyntheticsTestParentSuiteData"
+ $ref: '#/components/schemas/SyntheticsTestParentSuiteData'
type: array
type: object
SyntheticsTestPauseStatus:
@@ -114246,21 +114307,21 @@ components:
description: Attributes of a Synthetic test result.
properties:
batch:
- $ref: "#/components/schemas/SyntheticsTestResultBatch"
+ $ref: '#/components/schemas/SyntheticsTestResultBatch'
ci:
- $ref: "#/components/schemas/SyntheticsTestResultCI"
+ $ref: '#/components/schemas/SyntheticsTestResultCI'
device:
- $ref: "#/components/schemas/SyntheticsTestResultDevice"
+ $ref: '#/components/schemas/SyntheticsTestResultDevice'
git:
- $ref: "#/components/schemas/SyntheticsTestResultGit"
+ $ref: '#/components/schemas/SyntheticsTestResultGit'
location:
- $ref: "#/components/schemas/SyntheticsTestResultLocation"
+ $ref: '#/components/schemas/SyntheticsTestResultLocation'
result:
- $ref: "#/components/schemas/SyntheticsTestResultDetail"
+ $ref: '#/components/schemas/SyntheticsTestResultDetail'
test_sub_type:
- $ref: "#/components/schemas/SyntheticsTestSubType"
+ $ref: '#/components/schemas/SyntheticsTestSubType'
test_type:
- $ref: "#/components/schemas/SyntheticsTestType"
+ $ref: '#/components/schemas/SyntheticsTestType'
type: object
SyntheticsTestResultBatch:
description: Batch information for the test result.
@@ -114377,11 +114438,11 @@ components:
description: CI information associated with the test result.
properties:
pipeline:
- $ref: "#/components/schemas/SyntheticsTestResultCIPipeline"
+ $ref: '#/components/schemas/SyntheticsTestResultCIPipeline'
provider:
- $ref: "#/components/schemas/SyntheticsTestResultCIProvider"
+ $ref: '#/components/schemas/SyntheticsTestResultCIProvider'
stage:
- $ref: "#/components/schemas/SyntheticsTestResultCIStage"
+ $ref: '#/components/schemas/SyntheticsTestResultCIStage'
workspace_path:
description: Path of the workspace that ran the CI job.
example: /home/runner/work/example
@@ -114440,7 +114501,7 @@ components:
description: CDN provider details inferred from response headers.
properties:
cache:
- $ref: "#/components/schemas/SyntheticsTestResultCdnCacheStatus"
+ $ref: '#/components/schemas/SyntheticsTestResultCdnCacheStatus'
provider:
description: Name of the CDN provider.
example: google_cloud
@@ -114450,7 +114511,7 @@ components:
description: A CDN resource encountered while executing a browser step.
properties:
cdn:
- $ref: "#/components/schemas/SyntheticsTestResultCdnProviderInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultCdnProviderInfo'
resolved_ip:
description: Resolved IP address for the CDN resource.
example: 34.95.79.70
@@ -114531,7 +114592,7 @@ components:
format: double
type: number
valid:
- $ref: "#/components/schemas/SyntheticsTestResultCertificateValidity"
+ $ref: '#/components/schemas/SyntheticsTestResultCertificateValidity'
type: object
SyntheticsTestResultCertificateValidity:
description: Validity window of a certificate.
@@ -114551,15 +114612,15 @@ components:
description: Wrapper object for a Synthetic test result.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsTestResultAttributes"
+ $ref: '#/components/schemas/SyntheticsTestResultAttributes'
id:
description: The result ID.
example: "5158904793181869365"
type: string
relationships:
- $ref: "#/components/schemas/SyntheticsTestResultRelationships"
+ $ref: '#/components/schemas/SyntheticsTestResultRelationships'
type:
- $ref: "#/components/schemas/SyntheticsTestResultType"
+ $ref: '#/components/schemas/SyntheticsTestResultType'
type: object
SyntheticsTestResultDetail:
description: Full result details for a Synthetic test execution.
@@ -114567,16 +114628,16 @@ components:
assertions:
description: Assertion results produced by the test.
items:
- $ref: "#/components/schemas/SyntheticsTestResultAssertionResult"
+ $ref: '#/components/schemas/SyntheticsTestResultAssertionResult'
type: array
bucket_keys:
- $ref: "#/components/schemas/SyntheticsTestResultBucketKeys"
+ $ref: '#/components/schemas/SyntheticsTestResultBucketKeys'
call_type:
description: gRPC call type (for example, `unary`, `healthCheck`, or `reflection`).
example: unary
type: string
cert:
- $ref: "#/components/schemas/SyntheticsTestResultCertificate"
+ $ref: '#/components/schemas/SyntheticsTestResultCertificate'
compressed_json_descriptor:
description: Compressed JSON descriptor for the test (internal format).
example: compressedJsonDescriptorValue
@@ -114590,7 +114651,7 @@ components:
example: established
type: string
dns_resolution:
- $ref: "#/components/schemas/SyntheticsTestResultDnsResolution"
+ $ref: '#/components/schemas/SyntheticsTestResultDnsResolution'
duration:
description: Duration of the test execution (in milliseconds).
example: 380.7
@@ -114601,14 +114662,14 @@ components:
example: false
type: boolean
failure:
- $ref: "#/components/schemas/SyntheticsTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsTestResultFailure'
finished_at:
description: Timestamp of when the test finished (in milliseconds).
example: 1723782422760
format: int64
type: integer
handshake:
- $ref: "#/components/schemas/SyntheticsTestResultHandshake"
+ $ref: '#/components/schemas/SyntheticsTestResultHandshake'
id:
description: The unique identifier for this result.
example: "5158904793181869365"
@@ -114626,13 +114687,13 @@ components:
example: true
type: boolean
netpath:
- $ref: "#/components/schemas/SyntheticsTestResultNetpath"
+ $ref: '#/components/schemas/SyntheticsTestResultNetpath'
netstats:
- $ref: "#/components/schemas/SyntheticsTestResultNetstats"
+ $ref: '#/components/schemas/SyntheticsTestResultNetstats'
ocsp:
- $ref: "#/components/schemas/SyntheticsTestResultOCSPResponse"
+ $ref: '#/components/schemas/SyntheticsTestResultOCSPResponse'
ping:
- $ref: "#/components/schemas/SyntheticsTestResultTracerouteHop"
+ $ref: '#/components/schemas/SyntheticsTestResultTracerouteHop'
received_email_count:
description: Number of emails received during the test (email tests).
example: 1
@@ -114643,15 +114704,15 @@ components:
example: "UDP echo: b'Test message'"
type: string
request:
- $ref: "#/components/schemas/SyntheticsTestResultRequestInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultRequestInfo'
resolved_ip:
description: IP address resolved for the target host.
example: "54.243.255.141"
type: string
response:
- $ref: "#/components/schemas/SyntheticsTestResultResponseInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultResponseInfo'
run_type:
- $ref: "#/components/schemas/SyntheticsTestResultRunType"
+ $ref: '#/components/schemas/SyntheticsTestResultRunType'
sent_message:
description: Message sent to the target (for WebSocket/TCP/UDP tests).
example: udp mess
@@ -114666,11 +114727,11 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/SyntheticsTestResultStatus"
+ $ref: '#/components/schemas/SyntheticsTestResultStatus'
steps:
description: Step results (for browser, mobile, and multistep API tests).
items:
- $ref: "#/components/schemas/SyntheticsTestResultStep"
+ $ref: '#/components/schemas/SyntheticsTestResultStep'
type: array
time_to_interactive:
description: Time to interactive in milliseconds (browser tests).
@@ -114689,11 +114750,11 @@ components:
total: 380.7
type: object
trace:
- $ref: "#/components/schemas/SyntheticsTestResultTrace"
+ $ref: '#/components/schemas/SyntheticsTestResultTrace'
traceroute:
description: Traceroute hop results (for network tests).
items:
- $ref: "#/components/schemas/SyntheticsTestResultTracerouteHop"
+ $ref: '#/components/schemas/SyntheticsTestResultTracerouteHop'
type: array
triggered_at:
description: Timestamp of when the test was triggered (in milliseconds).
@@ -114707,20 +114768,20 @@ components:
turns:
description: Turns executed by a goal-based browser test.
items:
- $ref: "#/components/schemas/SyntheticsTestResultTurn"
+ $ref: '#/components/schemas/SyntheticsTestResultTurn'
type: array
unhealthy:
description: Whether the test runner was unhealthy at the time of execution.
example: false
type: boolean
variables:
- $ref: "#/components/schemas/SyntheticsTestResultVariables"
+ $ref: '#/components/schemas/SyntheticsTestResultVariables'
type: object
SyntheticsTestResultDevice:
description: Device information for the test result (browser and mobile tests).
properties:
browser:
- $ref: "#/components/schemas/SyntheticsTestResultDeviceBrowser"
+ $ref: '#/components/schemas/SyntheticsTestResultDeviceBrowser'
id:
description: Device identifier.
example: chrome.laptop_large
@@ -114730,9 +114791,9 @@ components:
example: "Chrome - Laptop Large"
type: string
platform:
- $ref: "#/components/schemas/SyntheticsTestResultDevicePlatform"
+ $ref: '#/components/schemas/SyntheticsTestResultDevicePlatform'
resolution:
- $ref: "#/components/schemas/SyntheticsTestResultDeviceResolution"
+ $ref: '#/components/schemas/SyntheticsTestResultDeviceResolution'
type:
description: Device type.
example: browser
@@ -114807,7 +114868,7 @@ components:
attempts:
description: DNS resolution attempts made during the test.
items:
- $ref: "#/components/schemas/SyntheticsTestResultDnsResolutionAttempt"
+ $ref: '#/components/schemas/SyntheticsTestResultDnsResolutionAttempt'
type: array
resolved_ip:
description: Resolved IP address for the target host.
@@ -114844,7 +114905,7 @@ components:
description: Execution details for a Synthetic test result.
properties:
duration:
- $ref: "#/components/schemas/SyntheticsTestResultDuration"
+ $ref: '#/components/schemas/SyntheticsTestResultDuration'
error_message:
description: Error message if the execution encountered an issue.
example: Connection timed out
@@ -114926,7 +114987,7 @@ components:
example: main
type: string
commit:
- $ref: "#/components/schemas/SyntheticsTestResultGitCommit"
+ $ref: '#/components/schemas/SyntheticsTestResultGitCommit'
repository_url:
description: Git repository URL.
example: https://github.com/DataDog/example
@@ -114936,9 +114997,9 @@ components:
description: Details of the Git commit associated with the test result.
properties:
author:
- $ref: "#/components/schemas/SyntheticsTestResultGitUser"
+ $ref: '#/components/schemas/SyntheticsTestResultGitUser'
committer:
- $ref: "#/components/schemas/SyntheticsTestResultGitUser"
+ $ref: '#/components/schemas/SyntheticsTestResultGitUser'
message:
description: Commit message.
example: Fix bug in login flow
@@ -114972,9 +115033,9 @@ components:
description: Handshake request and response for protocol-level tests.
properties:
request:
- $ref: "#/components/schemas/SyntheticsTestResultRequestInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultRequestInfo'
response:
- $ref: "#/components/schemas/SyntheticsTestResultResponseInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultResponseInfo'
type: object
SyntheticsTestResultHealthCheck:
description: Health check information returned from a gRPC health check call.
@@ -115030,11 +115091,11 @@ components:
description: Network Path test result capturing the path between source and destination.
properties:
destination:
- $ref: "#/components/schemas/SyntheticsTestResultNetpathDestination"
+ $ref: '#/components/schemas/SyntheticsTestResultNetpathDestination'
hops:
description: Hops along the network path.
items:
- $ref: "#/components/schemas/SyntheticsTestResultNetpathHop"
+ $ref: '#/components/schemas/SyntheticsTestResultNetpathHop'
type: array
origin:
description: Origin of the network path (for example, probe source).
@@ -115049,7 +115110,7 @@ components:
example: TCP
type: string
source:
- $ref: "#/components/schemas/SyntheticsTestResultNetpathEndpoint"
+ $ref: '#/components/schemas/SyntheticsTestResultNetpathEndpoint'
tags:
description: Tags associated with the network path measurement.
example:
@@ -115119,14 +115180,14 @@ components:
description: Aggregated network statistics from the test execution.
properties:
hops:
- $ref: "#/components/schemas/SyntheticsTestResultNetstatsHops"
+ $ref: '#/components/schemas/SyntheticsTestResultNetstatsHops'
jitter:
description: Network jitter in milliseconds.
example: 0.08
format: double
type: number
latency:
- $ref: "#/components/schemas/SyntheticsTestResultNetworkLatency"
+ $ref: '#/components/schemas/SyntheticsTestResultNetworkLatency'
packet_loss_percentage:
description: Percentage of probe packets lost.
example: 0.0
@@ -115202,13 +115263,13 @@ components:
description: OCSP response received while validating a certificate.
properties:
certificate:
- $ref: "#/components/schemas/SyntheticsTestResultOCSPCertificate"
+ $ref: '#/components/schemas/SyntheticsTestResultOCSPCertificate'
status:
description: OCSP response status (for example, `good`, `revoked`, `unknown`).
example: good
type: string
updates:
- $ref: "#/components/schemas/SyntheticsTestResultOCSPUpdates"
+ $ref: '#/components/schemas/SyntheticsTestResultOCSPUpdates'
type: object
SyntheticsTestResultOCSPUpdates:
description: OCSP response update timestamps.
@@ -115262,7 +115323,7 @@ components:
description: Relationship to the Synthetic test.
properties:
data:
- $ref: "#/components/schemas/SyntheticsTestResultRelationshipTestData"
+ $ref: '#/components/schemas/SyntheticsTestResultRelationshipTestData'
type: object
SyntheticsTestResultRelationshipTestData:
description: Data for the test relationship.
@@ -115280,7 +115341,7 @@ components:
description: Relationships for a Synthetic test result.
properties:
test:
- $ref: "#/components/schemas/SyntheticsTestResultRelationshipTest"
+ $ref: '#/components/schemas/SyntheticsTestResultRelationshipTest'
type: object
SyntheticsTestResultRequestInfo:
description: Details of the outgoing request made during the test execution.
@@ -115318,7 +115379,7 @@ components:
files:
description: Files attached to the request.
items:
- $ref: "#/components/schemas/SyntheticsTestResultFileRef"
+ $ref: '#/components/schemas/SyntheticsTestResultFileRef'
type: array
headers:
additionalProperties: {}
@@ -115381,11 +115442,11 @@ components:
description: Response object for a Synthetic test result.
properties:
data:
- $ref: "#/components/schemas/SyntheticsTestResultData"
+ $ref: '#/components/schemas/SyntheticsTestResultData'
included:
description: Array of included related resources, such as the test definition.
items:
- $ref: "#/components/schemas/SyntheticsTestResultIncludedItem"
+ $ref: '#/components/schemas/SyntheticsTestResultIncludedItem'
type: array
type: object
SyntheticsTestResultResponseInfo:
@@ -115416,9 +115477,9 @@ components:
server: gunicorn/19.9.0
type: object
cdn:
- $ref: "#/components/schemas/SyntheticsTestResultCdnProviderInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultCdnProviderInfo'
close:
- $ref: "#/components/schemas/SyntheticsTestResultWebSocketClose"
+ $ref: '#/components/schemas/SyntheticsTestResultWebSocketClose'
compressed_message:
description: Compressed representation of the response message.
example: eJzLSM3JyQcABiwCFQ==
@@ -115430,7 +115491,7 @@ components:
content-type: application/json
type: object
healthcheck:
- $ref: "#/components/schemas/SyntheticsTestResultHealthCheck"
+ $ref: '#/components/schemas/SyntheticsTestResultHealthCheck'
http_version:
description: HTTP version of the response.
example: "2.0"
@@ -115455,12 +115516,12 @@ components:
records:
description: DNS records returned in the response (DNS tests only).
items:
- $ref: "#/components/schemas/SyntheticsTestResultDnsRecord"
+ $ref: '#/components/schemas/SyntheticsTestResultDnsRecord'
type: array
redirects:
description: Redirect hops encountered while performing the request.
items:
- $ref: "#/components/schemas/SyntheticsTestResultRedirect"
+ $ref: '#/components/schemas/SyntheticsTestResultRedirect'
type: array
status_code:
description: HTTP status code of the response.
@@ -115534,11 +115595,11 @@ components:
description: Inner API test definition for browser `runApiTest` steps.
type: object
assertion_result:
- $ref: "#/components/schemas/SyntheticsTestResultStepAssertionResult"
+ $ref: '#/components/schemas/SyntheticsTestResultStepAssertionResult'
assertions:
description: Assertion results produced by the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultAssertionResult"
+ $ref: '#/components/schemas/SyntheticsTestResultAssertionResult'
type: array
blocked_requests_urls:
description: URLs of requests blocked during the step.
@@ -115547,18 +115608,18 @@ components:
type: string
type: array
bounds:
- $ref: "#/components/schemas/SyntheticsTestResultBounds"
+ $ref: '#/components/schemas/SyntheticsTestResultBounds'
browser_errors:
description: Browser errors captured during the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultBrowserError"
+ $ref: '#/components/schemas/SyntheticsTestResultBrowserError'
type: array
bucket_keys:
- $ref: "#/components/schemas/SyntheticsTestResultBucketKeys"
+ $ref: '#/components/schemas/SyntheticsTestResultBucketKeys'
cdn_resources:
description: CDN resources encountered during the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultCdnResource"
+ $ref: '#/components/schemas/SyntheticsTestResultCdnResource'
type: array
click_type:
description: Click type performed in a browser step.
@@ -115586,15 +115647,15 @@ components:
example: ''
type: string
element_updates:
- $ref: "#/components/schemas/SyntheticsTestResultStepElementUpdates"
+ $ref: '#/components/schemas/SyntheticsTestResultStepElementUpdates'
extracted_value:
- $ref: "#/components/schemas/SyntheticsTestResultVariable"
+ $ref: '#/components/schemas/SyntheticsTestResultVariable'
failure:
- $ref: "#/components/schemas/SyntheticsTestResultFailure"
+ $ref: '#/components/schemas/SyntheticsTestResultFailure'
http_results:
description: HTTP results produced by an MCP step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultAssertionResult"
+ $ref: '#/components/schemas/SyntheticsTestResultAssertionResult'
type: array
id:
description: Identifier of the step.
@@ -115618,13 +115679,13 @@ components:
example: Extract variable from body
type: string
request:
- $ref: "#/components/schemas/SyntheticsTestResultRequestInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultRequestInfo'
response:
- $ref: "#/components/schemas/SyntheticsTestResultResponseInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultResponseInfo'
retries:
description: Retry results for the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultStep"
+ $ref: '#/components/schemas/SyntheticsTestResultStep'
type: array
retry_count:
description: Number of times this step was retried.
@@ -115632,7 +115693,7 @@ components:
format: int64
type: integer
rum_context:
- $ref: "#/components/schemas/SyntheticsTestResultRumContext"
+ $ref: '#/components/schemas/SyntheticsTestResultRumContext'
started_at:
description: Unix timestamp (ms) of when the step started.
example: 1724445283308
@@ -115643,9 +115704,9 @@ components:
example: passed
type: string
sub_step:
- $ref: "#/components/schemas/SyntheticsTestResultSubStep"
+ $ref: '#/components/schemas/SyntheticsTestResultSubStep'
sub_test:
- $ref: "#/components/schemas/SyntheticsTestResultSubTest"
+ $ref: '#/components/schemas/SyntheticsTestResultSubTest'
subtype:
description: Subtype of the step.
example: http
@@ -115653,7 +115714,7 @@ components:
tabs:
description: Browser tabs involved in the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultTab"
+ $ref: '#/components/schemas/SyntheticsTestResultTab'
type: array
timings:
additionalProperties: {}
@@ -115675,16 +115736,16 @@ components:
description: Step value. Its type depends on the step type.
example: http://34.95.79.70/prototype
variables:
- $ref: "#/components/schemas/SyntheticsTestResultVariables"
+ $ref: '#/components/schemas/SyntheticsTestResultVariables'
vitals_metrics:
description: Web vitals metrics captured during the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultVitalsMetrics"
+ $ref: '#/components/schemas/SyntheticsTestResultVitalsMetrics'
type: array
warnings:
description: Warnings emitted during the step.
items:
- $ref: "#/components/schemas/SyntheticsTestResultWarning"
+ $ref: '#/components/schemas/SyntheticsTestResultWarning'
type: array
type: object
SyntheticsTestResultStepAssertionResult:
@@ -115751,9 +115812,9 @@ components:
format: int64
type: integer
parent_step:
- $ref: "#/components/schemas/SyntheticsTestResultParentStep"
+ $ref: '#/components/schemas/SyntheticsTestResultParentStep'
parent_test:
- $ref: "#/components/schemas/SyntheticsTestResultParentTest"
+ $ref: '#/components/schemas/SyntheticsTestResultParentTest'
type: object
SyntheticsTestResultSubTest:
description: Information about a sub-test played from a parent browser test.
@@ -115768,49 +115829,49 @@ components:
format: int64
type: integer
rum_context:
- $ref: "#/components/schemas/SyntheticsTestResultRumContext"
+ $ref: '#/components/schemas/SyntheticsTestResultRumContext'
type: object
SyntheticsTestResultSummaryAttributes:
description: Attributes of a Synthetic test result summary.
properties:
device:
- $ref: "#/components/schemas/SyntheticsTestResultDevice"
+ $ref: '#/components/schemas/SyntheticsTestResultDevice'
execution_info:
- $ref: "#/components/schemas/SyntheticsTestResultExecutionInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultExecutionInfo'
finished_at:
description: Timestamp of when the test finished (in milliseconds).
format: int64
type: integer
location:
- $ref: "#/components/schemas/SyntheticsTestResultLocation"
+ $ref: '#/components/schemas/SyntheticsTestResultLocation'
run_type:
- $ref: "#/components/schemas/SyntheticsTestResultRunType"
+ $ref: '#/components/schemas/SyntheticsTestResultRunType'
started_at:
description: Timestamp of when the test started (in milliseconds).
format: int64
type: integer
status:
- $ref: "#/components/schemas/SyntheticsTestResultStatus"
+ $ref: '#/components/schemas/SyntheticsTestResultStatus'
steps_info:
- $ref: "#/components/schemas/SyntheticsTestResultStepsInfo"
+ $ref: '#/components/schemas/SyntheticsTestResultStepsInfo'
test_sub_type:
- $ref: "#/components/schemas/SyntheticsTestSubType"
+ $ref: '#/components/schemas/SyntheticsTestSubType'
test_type:
- $ref: "#/components/schemas/SyntheticsTestType"
+ $ref: '#/components/schemas/SyntheticsTestType'
type: object
SyntheticsTestResultSummaryData:
description: Wrapper object for a Synthetic test result summary.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsTestResultSummaryAttributes"
+ $ref: '#/components/schemas/SyntheticsTestResultSummaryAttributes'
id:
description: The result ID.
example: "5158904793181869365"
type: string
relationships:
- $ref: "#/components/schemas/SyntheticsTestResultRelationships"
+ $ref: '#/components/schemas/SyntheticsTestResultRelationships'
type:
- $ref: "#/components/schemas/SyntheticsTestResultSummaryType"
+ $ref: '#/components/schemas/SyntheticsTestResultSummaryType'
type: object
SyntheticsTestResultSummaryType:
default: "result_summary"
@@ -115857,7 +115918,7 @@ components:
example: 34.95.79.70
type: string
latency:
- $ref: "#/components/schemas/SyntheticsTestResultNetworkLatency"
+ $ref: '#/components/schemas/SyntheticsTestResultNetworkLatency'
packet_loss_percentage:
description: Percentage of probe packets lost.
example: 0.0
@@ -115885,14 +115946,14 @@ components:
routers:
description: List of intermediate routers for the traceroute.
items:
- $ref: "#/components/schemas/SyntheticsTestResultRouter"
+ $ref: '#/components/schemas/SyntheticsTestResultRouter'
type: array
type: object
SyntheticsTestResultTurn:
description: A turn in a goal-based browser test, grouping steps and reasoning.
properties:
bucket_keys:
- $ref: "#/components/schemas/SyntheticsTestResultBucketKeys"
+ $ref: '#/components/schemas/SyntheticsTestResultBucketKeys'
name:
description: Name of the turn.
example: Turn 1
@@ -115908,7 +115969,7 @@ components:
steps:
description: Steps executed during the turn.
items:
- $ref: "#/components/schemas/SyntheticsTestResultTurnStep"
+ $ref: '#/components/schemas/SyntheticsTestResultTurnStep'
type: array
turn_finished_at:
description: Unix timestamp (ms) of when the turn finished.
@@ -115925,7 +115986,7 @@ components:
description: A step executed during a goal-based browser test turn.
properties:
bucket_keys:
- $ref: "#/components/schemas/SyntheticsTestResultBucketKeys"
+ $ref: '#/components/schemas/SyntheticsTestResultBucketKeys'
config:
additionalProperties: {}
description: Browser step configuration for this turn step.
@@ -115994,12 +116055,12 @@ components:
config:
description: Variables defined in the test configuration.
items:
- $ref: "#/components/schemas/SyntheticsTestResultVariable"
+ $ref: '#/components/schemas/SyntheticsTestResultVariable'
type: array
extracted:
description: Variables extracted during the test execution.
items:
- $ref: "#/components/schemas/SyntheticsTestResultVariable"
+ $ref: '#/components/schemas/SyntheticsTestResultVariable'
type: array
type: object
SyntheticsTestResultVitalsMetrics:
@@ -116041,7 +116102,7 @@ components:
element_bounds:
description: Bounds of elements related to the warning.
items:
- $ref: "#/components/schemas/SyntheticsTestResultBounds"
+ $ref: '#/components/schemas/SyntheticsTestResultBounds'
type: array
message:
description: Warning message.
@@ -116115,7 +116176,7 @@ components:
diff_patches:
description: List of diff patches for text changes.
items:
- $ref: "#/components/schemas/SyntheticsTestVersionDiffPatches"
+ $ref: '#/components/schemas/SyntheticsTestVersionDiffPatches'
nullable: true
type: array
property_path:
@@ -116126,13 +116187,13 @@ components:
description: Attributes of a specific Synthetic test version.
properties:
author:
- $ref: "#/components/schemas/SyntheticsTestVersionAuthor"
+ $ref: '#/components/schemas/SyntheticsTestVersionAuthor'
change_metadata:
description: |-
List of metadata describing individual changes in this version.
Only returned when the `include_change_metadata` query parameter is `true`.
items:
- $ref: "#/components/schemas/SyntheticsTestVersionChangeMetadataItem"
+ $ref: '#/components/schemas/SyntheticsTestVersionChangeMetadataItem'
type: array
payload:
additionalProperties: {}
@@ -116174,7 +116235,7 @@ components:
change_metadata:
description: List of metadata describing individual changes in this version.
items:
- $ref: "#/components/schemas/SyntheticsTestVersionChangeMetadataItem"
+ $ref: '#/components/schemas/SyntheticsTestVersionChangeMetadataItem'
type: array
version_number:
description: The sequential version number.
@@ -116191,13 +116252,13 @@ components:
description: Data object for a version change record.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsTestVersionChangeAttributes"
+ $ref: '#/components/schemas/SyntheticsTestVersionChangeAttributes'
id:
description: UUID of the version change record.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/SyntheticsTestVersionChangeType"
+ $ref: '#/components/schemas/SyntheticsTestVersionChangeType'
type: object
SyntheticsTestVersionChangeMetadataItem:
description: Object describing a single change within a version.
@@ -116206,7 +116267,7 @@ components:
description: The action that was performed (for example, `updated` or `created`).
type: string
action_metadata:
- $ref: "#/components/schemas/SyntheticsTestVersionActionMetadata"
+ $ref: '#/components/schemas/SyntheticsTestVersionActionMetadata'
type: object
SyntheticsTestVersionChangeType:
default: version_metadata
@@ -116221,13 +116282,13 @@ components:
description: Data object for a specific Synthetic test version.
properties:
attributes:
- $ref: "#/components/schemas/SyntheticsTestVersionAttributes"
+ $ref: '#/components/schemas/SyntheticsTestVersionAttributes'
id:
description: UUID of the version record.
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/SyntheticsTestVersionType"
+ $ref: '#/components/schemas/SyntheticsTestVersionType'
type: object
SyntheticsTestVersionDiffPatchDiff:
description: Object describing a single text diff operation.
@@ -116245,7 +116306,7 @@ components:
diffs:
description: List of individual diff operations.
items:
- $ref: "#/components/schemas/SyntheticsTestVersionDiffPatchDiff"
+ $ref: '#/components/schemas/SyntheticsTestVersionDiffPatchDiff'
type: array
length1:
description: Length of the original text segment.
@@ -116287,16 +116348,16 @@ components:
data:
description: List of version change records.
items:
- $ref: "#/components/schemas/SyntheticsTestVersionChangeData"
+ $ref: '#/components/schemas/SyntheticsTestVersionChangeData'
type: array
meta:
- $ref: "#/components/schemas/SyntheticsTestVersionHistoryMeta"
+ $ref: '#/components/schemas/SyntheticsTestVersionHistoryMeta'
type: object
SyntheticsTestVersionResponse:
description: Response containing a specific version of a Synthetic test.
properties:
data:
- $ref: "#/components/schemas/SyntheticsTestVersionData"
+ $ref: '#/components/schemas/SyntheticsTestVersionData'
type: object
SyntheticsTestVersionType:
default: version
@@ -116314,7 +116375,7 @@ components:
value: .*
properties:
type:
- $ref: "#/components/schemas/SyntheticsGlobalVariableParserType"
+ $ref: '#/components/schemas/SyntheticsGlobalVariableParserType'
value:
description: Regex or JSON path used for the parser. Not used with type `raw`.
type: string
@@ -116356,7 +116417,7 @@ components:
type: reference_table
properties:
data:
- $ref: "#/components/schemas/TableResultV2Data"
+ $ref: '#/components/schemas/TableResultV2Data'
type: object
TableResultV2Array:
description: List of reference tables.
@@ -116425,7 +116486,7 @@ components:
data:
description: The reference tables.
items:
- $ref: "#/components/schemas/TableResultV2Data"
+ $ref: '#/components/schemas/TableResultV2Data'
type: array
required:
- data
@@ -116435,12 +116496,12 @@ components:
description: The data object containing the reference table configuration and state.
properties:
attributes:
- $ref: "#/components/schemas/TableResultV2DataAttributes"
+ $ref: '#/components/schemas/TableResultV2DataAttributes'
id:
description: Unique identifier for the reference table.
type: string
type:
- $ref: "#/components/schemas/TableResultV2DataType"
+ $ref: '#/components/schemas/TableResultV2DataType'
required:
- type
type: object
@@ -116456,7 +116517,7 @@ components:
example: "example description"
type: string
file_metadata:
- $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadata"
+ $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadata'
last_updated_by:
description: UUID of the user who last updated the reference table.
example: "00000000-0000-0000-0000-000000000000"
@@ -116467,9 +116528,9 @@ components:
format: int64
type: integer
schema:
- $ref: "#/components/schemas/TableResultV2DataAttributesSchema"
+ $ref: '#/components/schemas/TableResultV2DataAttributesSchema'
source:
- $ref: "#/components/schemas/ReferenceTableSourceType"
+ $ref: '#/components/schemas/ReferenceTableSourceType'
status:
description: The processing status of the table.
example: "DONE"
@@ -116550,11 +116611,11 @@ components:
description: Cloud storage access configuration for the reference table data file.
properties:
aws_detail:
- $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail"
+ $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail'
azure_detail:
- $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail"
+ $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAzureDetail'
gcp_detail:
- $ref: "#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail"
+ $ref: '#/components/schemas/TableResultV2DataAttributesFileMetadataOneOfAccessDetailsGcpDetail'
type: object
TableResultV2DataAttributesFileMetadataOneOfAccessDetailsAwsDetail:
description: Amazon Web Services S3 storage access configuration.
@@ -116628,7 +116689,7 @@ components:
fields:
description: The schema fields. Maximum of 200 columns.
items:
- $ref: "#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems"
+ $ref: '#/components/schemas/TableResultV2DataAttributesSchemaFieldsItems'
maxItems: 200
minItems: 1
type: array
@@ -116652,7 +116713,7 @@ components:
example: "field_1"
type: string
type:
- $ref: "#/components/schemas/ReferenceTableSchemaFieldType"
+ $ref: '#/components/schemas/ReferenceTableSchemaFieldType'
required:
- name
- type
@@ -116672,7 +116733,7 @@ components:
data:
description: The rows.
items:
- $ref: "#/components/schemas/TableRowResourceData"
+ $ref: '#/components/schemas/TableRowResourceData'
type: array
required:
- data
@@ -116682,12 +116743,12 @@ components:
description: The data object containing the row column names and values.
properties:
attributes:
- $ref: "#/components/schemas/TableRowResourceDataAttributes"
+ $ref: '#/components/schemas/TableRowResourceDataAttributes'
id:
description: Row identifier, corresponding to the primary key value.
type: string
type:
- $ref: "#/components/schemas/TableRowResourceDataType"
+ $ref: '#/components/schemas/TableRowResourceDataType'
required:
- type
type: object
@@ -116716,7 +116777,7 @@ components:
example: "primary_key_value"
type: string
type:
- $ref: "#/components/schemas/TableRowResourceDataType"
+ $ref: '#/components/schemas/TableRowResourceDataType'
required:
- type
- id
@@ -116729,7 +116790,7 @@ components:
example: production
type: string
type:
- $ref: "#/components/schemas/TagDataType"
+ $ref: '#/components/schemas/TagDataType'
required:
- id
- type
@@ -116792,7 +116853,7 @@ components:
example: my-indexing-rule
type: string
options:
- $ref: "#/components/schemas/TagIndexingRuleOptions"
+ $ref: '#/components/schemas/TagIndexingRuleOptions'
rule_order:
description: >-
Evaluation order within the org. Lower values are evaluated first. Assigned server-side on create (max+1); pass on update to change the rule's position.
@@ -116834,7 +116895,7 @@ components:
example: my-indexing-rule
type: string
options:
- $ref: "#/components/schemas/TagIndexingRuleOptions"
+ $ref: '#/components/schemas/TagIndexingRuleOptions'
tags:
description: Tag keys managed by this rule.
example:
@@ -116851,9 +116912,9 @@ components:
description: Data object for creating a tag indexing rule.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleCreateAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleCreateAttributes'
type:
- $ref: "#/components/schemas/TagIndexingRuleType"
+ $ref: '#/components/schemas/TagIndexingRuleType'
required:
- type
- attributes
@@ -116862,7 +116923,7 @@ components:
description: Request body for creating a tag indexing rule.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleCreateData"
+ $ref: '#/components/schemas/TagIndexingRuleCreateData'
required:
- data
type: object
@@ -116870,13 +116931,13 @@ components:
description: A tag indexing rule resource object.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleAttributes'
id:
description: The unique identifier (UUID) of the tag indexing rule.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/TagIndexingRuleType"
+ $ref: '#/components/schemas/TagIndexingRuleType'
type: object
TagIndexingRuleDynamicTags:
description: |-
@@ -116950,9 +117011,9 @@ components:
description: Data object for creating a tag indexing rule exemption.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleExemptionCreateAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionCreateAttributes'
type:
- $ref: "#/components/schemas/TagIndexingRuleExemptionType"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionType'
required:
- type
- attributes
@@ -116961,7 +117022,7 @@ components:
description: Request body for creating a tag indexing rule exemption.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleExemptionCreateData"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionCreateData'
required:
- data
type: object
@@ -116969,19 +117030,19 @@ components:
description: A tag indexing rule exemption resource object.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleExemptionAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionAttributes'
id:
description: The metric name, used as the resource ID.
example: dd.test.metric
type: string
type:
- $ref: "#/components/schemas/TagIndexingRuleExemptionType"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionType'
type: object
TagIndexingRuleExemptionResponse:
description: Response containing a tag indexing rule exemption.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleExemptionData"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionData'
readOnly: true
type: object
TagIndexingRuleExemptionType:
@@ -117018,7 +117079,7 @@ components:
description: Versioned configuration options for a tag indexing rule.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleOptionsData"
+ $ref: '#/components/schemas/TagIndexingRuleOptionsData'
version:
description: Options schema version. Only `1` is supported.
example: 1
@@ -117029,14 +117090,14 @@ components:
description: Data payload for tag indexing rule options.
properties:
dynamic_tags:
- $ref: "#/components/schemas/TagIndexingRuleDynamicTags"
+ $ref: '#/components/schemas/TagIndexingRuleDynamicTags'
manage_preexisting_metrics:
description: >-
When true, the rule applies to metrics that were ingested before the rule was created.
example: true
type: boolean
metric_match:
- $ref: "#/components/schemas/TagIndexingRuleMetricMatch"
+ $ref: '#/components/schemas/TagIndexingRuleMetricMatch'
override_previous_rules:
description: >-
When true, this rule's tag list overrides tags configured by earlier rules for the same metric. When false (default), tags from all matching rules are combined.
@@ -117060,9 +117121,9 @@ components:
description: Data object for the reorder operation.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleOrderAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleOrderAttributes'
type:
- $ref: "#/components/schemas/TagIndexingRuleType"
+ $ref: '#/components/schemas/TagIndexingRuleType'
required:
- type
- attributes
@@ -117071,7 +117132,7 @@ components:
description: Request body for reordering tag indexing rules.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleOrderData"
+ $ref: '#/components/schemas/TagIndexingRuleOrderData'
required:
- data
type: object
@@ -117079,7 +117140,7 @@ components:
description: Response containing a single tag indexing rule.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleData"
+ $ref: '#/components/schemas/TagIndexingRuleData'
readOnly: true
type: object
TagIndexingRuleType:
@@ -117115,7 +117176,7 @@ components:
example: my-indexing-rule
type: string
options:
- $ref: "#/components/schemas/TagIndexingRuleOptions"
+ $ref: '#/components/schemas/TagIndexingRuleOptions'
rule_order:
description: >-
Desired evaluation order. Returns 409 if the value conflicts with another rule; use POST /api/v2/metrics/tag-indexing-rules/order for atomic re-sequencing.
@@ -117135,9 +117196,9 @@ components:
description: Data object for updating a tag indexing rule.
properties:
attributes:
- $ref: "#/components/schemas/TagIndexingRuleUpdateAttributes"
+ $ref: '#/components/schemas/TagIndexingRuleUpdateAttributes'
type:
- $ref: "#/components/schemas/TagIndexingRuleType"
+ $ref: '#/components/schemas/TagIndexingRuleType'
required:
- type
type: object
@@ -117145,7 +117206,7 @@ components:
description: Request body for updating a tag indexing rule.
properties:
data:
- $ref: "#/components/schemas/TagIndexingRuleUpdateData"
+ $ref: '#/components/schemas/TagIndexingRuleUpdateData'
required:
- data
type: object
@@ -117155,12 +117216,12 @@ components:
data:
description: Array of tag indexing rule objects.
items:
- $ref: "#/components/schemas/TagIndexingRuleData"
+ $ref: '#/components/schemas/TagIndexingRuleData'
type: array
links:
- $ref: "#/components/schemas/MetricsListResponseLinks"
+ $ref: '#/components/schemas/MetricsListResponseLinks'
meta:
- $ref: "#/components/schemas/TagIndexingRulesResponseMeta"
+ $ref: '#/components/schemas/TagIndexingRulesResponseMeta'
readOnly: true
type: object
TagIndexingRulesResponseMeta:
@@ -117219,13 +117280,13 @@ components:
example: true
type: boolean
rule_type:
- $ref: "#/components/schemas/TagRuleType"
+ $ref: '#/components/schemas/TagRuleType'
scope:
description: The scope the rule applies within.
example: "env"
type: string
source:
- $ref: "#/components/schemas/TagRuleSource"
+ $ref: '#/components/schemas/TagRuleSource'
tag_key:
description: The tag key that the rule governs.
example: "service"
@@ -117280,7 +117341,7 @@ components:
example: true
type: boolean
rule_type:
- $ref: "#/components/schemas/TagRuleCreateType"
+ $ref: '#/components/schemas/TagRuleCreateType'
scope:
description: |-
The scope the rule applies within. Typically an environment, team, or
@@ -117288,7 +117349,7 @@ components:
example: "env"
type: string
source:
- $ref: "#/components/schemas/TagRuleSource"
+ $ref: '#/components/schemas/TagRuleSource'
tag_key:
description: The tag key that the rule governs (for example, `service`).
example: "service"
@@ -117317,9 +117378,9 @@ components:
description: Data object for creating a tag rule.
properties:
attributes:
- $ref: "#/components/schemas/TagRuleCreateAttributes"
+ $ref: '#/components/schemas/TagRuleCreateAttributes'
type:
- $ref: "#/components/schemas/TagRuleResourceType"
+ $ref: '#/components/schemas/TagRuleResourceType'
required:
- type
- attributes
@@ -117328,7 +117389,7 @@ components:
description: Payload for creating a new tag rule.
properties:
data:
- $ref: "#/components/schemas/TagRuleCreateData"
+ $ref: '#/components/schemas/TagRuleCreateData'
required:
- data
type: object
@@ -117346,15 +117407,15 @@ components:
description: A tag rule resource.
properties:
attributes:
- $ref: "#/components/schemas/TagRuleAttributes"
+ $ref: '#/components/schemas/TagRuleAttributes'
id:
description: The unique identifier of the tag rule.
example: "123"
type: string
relationships:
- $ref: "#/components/schemas/TagRuleRelationships"
+ $ref: '#/components/schemas/TagRuleRelationships'
type:
- $ref: "#/components/schemas/TagRuleResourceType"
+ $ref: '#/components/schemas/TagRuleResourceType'
required:
- type
- id
@@ -117363,7 +117424,7 @@ components:
TagRuleDataArray:
description: An array of tag rule data objects.
items:
- $ref: "#/components/schemas/TagRuleData"
+ $ref: '#/components/schemas/TagRuleData'
type: array
TagRuleInclude:
description: A related resource to include alongside a tag rule in the response. Currently the only supported value is `score`.
@@ -117376,13 +117437,13 @@ components:
TagRuleIncludedResources:
description: Related resources fetched alongside the primary tag rules. Populated when an `include` query parameter is supplied.
items:
- $ref: "#/components/schemas/TagRuleScoreData"
+ $ref: '#/components/schemas/TagRuleScoreData'
type: array
TagRuleRelationships:
description: Related resources for a tag rule. Only present when the corresponding `include` query parameter is supplied.
properties:
score:
- $ref: "#/components/schemas/TagRuleScoreRelationship"
+ $ref: '#/components/schemas/TagRuleScoreRelationship'
type: object
TagRuleResourceType:
description: JSON:API resource type for a tag rule.
@@ -117396,9 +117457,9 @@ components:
description: A single tag rule.
properties:
data:
- $ref: "#/components/schemas/TagRuleData"
+ $ref: '#/components/schemas/TagRuleData'
included:
- $ref: "#/components/schemas/TagRuleIncludedResources"
+ $ref: '#/components/schemas/TagRuleIncludedResources'
required:
- data
type: object
@@ -117438,13 +117499,13 @@ components:
description: A compliance score resource for a tag rule.
properties:
attributes:
- $ref: "#/components/schemas/TagRuleScoreAttributes"
+ $ref: '#/components/schemas/TagRuleScoreAttributes'
id:
description: The unique identifier of the compliance score resource.
example: "123-v1-1779315066097-1779401466097"
type: string
type:
- $ref: "#/components/schemas/TagRuleScoreResourceType"
+ $ref: '#/components/schemas/TagRuleScoreResourceType'
required:
- type
- id
@@ -117454,7 +117515,7 @@ components:
description: A relationship to the compliance score resource for this rule.
properties:
data:
- $ref: "#/components/schemas/TagRuleScoreRelationshipData"
+ $ref: '#/components/schemas/TagRuleScoreRelationshipData'
required:
- data
type: object
@@ -117466,7 +117527,7 @@ components:
example: "123-v1-1779315066097-1779401466097"
type: string
type:
- $ref: "#/components/schemas/TagRuleScoreResourceType"
+ $ref: '#/components/schemas/TagRuleScoreResourceType'
required:
- type
- id
@@ -117483,7 +117544,7 @@ components:
description: A tag rule compliance score.
properties:
data:
- $ref: "#/components/schemas/TagRuleScoreData"
+ $ref: '#/components/schemas/TagRuleScoreData'
required:
- data
type: object
@@ -117533,7 +117594,7 @@ components:
description: When `true`, telemetry without this tag is treated as a violation.
type: boolean
rule_type:
- $ref: "#/components/schemas/TagRuleType"
+ $ref: '#/components/schemas/TagRuleType'
scope:
description: The scope the rule applies within.
type: string
@@ -117551,13 +117612,13 @@ components:
description: Data object for updating a tag rule.
properties:
attributes:
- $ref: "#/components/schemas/TagRuleUpdateAttributes"
+ $ref: '#/components/schemas/TagRuleUpdateAttributes'
id:
description: The unique identifier of the tag rule being updated.
example: "123"
type: string
type:
- $ref: "#/components/schemas/TagRuleResourceType"
+ $ref: '#/components/schemas/TagRuleResourceType'
required:
- type
- id
@@ -117566,7 +117627,7 @@ components:
description: Payload for updating an existing tag rule. Only the supplied fields are modified.
properties:
data:
- $ref: "#/components/schemas/TagRuleUpdateData"
+ $ref: '#/components/schemas/TagRuleUpdateData'
required:
- data
type: object
@@ -117574,9 +117635,9 @@ components:
description: A page of tag rules.
properties:
data:
- $ref: "#/components/schemas/TagRuleDataArray"
+ $ref: '#/components/schemas/TagRuleDataArray'
included:
- $ref: "#/components/schemas/TagRuleIncludedResources"
+ $ref: '#/components/schemas/TagRuleIncludedResources'
required:
- data
type: object
@@ -117593,7 +117654,7 @@ components:
conditions:
description: Conditions evaluated by this targeting rule.
items:
- $ref: "#/components/schemas/Condition"
+ $ref: '#/components/schemas/Condition'
type: array
created_at:
description: The timestamp when the targeting rule was created.
@@ -117622,7 +117683,7 @@ components:
conditions:
description: Conditions that must match for this rule.
items:
- $ref: "#/components/schemas/ConditionRequest"
+ $ref: '#/components/schemas/ConditionRequest'
minItems: 1
type: array
required:
@@ -117642,15 +117703,15 @@ components:
description: A team
properties:
attributes:
- $ref: "#/components/schemas/TeamAttributes"
+ $ref: '#/components/schemas/TeamAttributes'
id:
description: The team's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
relationships:
- $ref: "#/components/schemas/TeamRelationships"
+ $ref: '#/components/schemas/TeamRelationships'
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
required:
- attributes
- id
@@ -117733,15 +117794,15 @@ components:
description: A relationship between a Datadog team and a team from another external system.
properties:
attributes:
- $ref: "#/components/schemas/TeamConnectionAttributes"
+ $ref: '#/components/schemas/TeamConnectionAttributes'
id:
description: The unique identifier of the team connection.
example: "12345678-1234-5678-9abc-123456789012"
type: string
relationships:
- $ref: "#/components/schemas/TeamConnectionRelationships"
+ $ref: '#/components/schemas/TeamConnectionRelationships'
type:
- $ref: "#/components/schemas/TeamConnectionType"
+ $ref: '#/components/schemas/TeamConnectionType'
required:
- id
- type
@@ -117762,11 +117823,11 @@ components:
description: Data for creating a team connection.
properties:
attributes:
- $ref: "#/components/schemas/TeamConnectionAttributes"
+ $ref: '#/components/schemas/TeamConnectionAttributes'
relationships:
- $ref: "#/components/schemas/TeamConnectionRelationships"
+ $ref: '#/components/schemas/TeamConnectionRelationships'
type:
- $ref: "#/components/schemas/TeamConnectionType"
+ $ref: '#/components/schemas/TeamConnectionType'
required:
- type
type: object
@@ -117776,7 +117837,7 @@ components:
data:
description: Array of team connections to create.
items:
- $ref: "#/components/schemas/TeamConnectionCreateData"
+ $ref: '#/components/schemas/TeamConnectionCreateData'
type: array
required:
- data
@@ -117787,7 +117848,7 @@ components:
data:
description: Array of team connection IDs to delete.
items:
- $ref: "#/components/schemas/TeamConnectionDeleteRequestDataItem"
+ $ref: '#/components/schemas/TeamConnectionDeleteRequestDataItem'
type: array
required:
- data
@@ -117800,7 +117861,7 @@ components:
example: "12345678-1234-5678-9abc-123456789012"
type: string
type:
- $ref: "#/components/schemas/TeamConnectionType"
+ $ref: '#/components/schemas/TeamConnectionType'
required:
- id
- type
@@ -117809,9 +117870,9 @@ components:
description: Relationships of the team connection.
properties:
connected_team:
- $ref: "#/components/schemas/ConnectedTeamRef"
+ $ref: '#/components/schemas/ConnectedTeamRef'
team:
- $ref: "#/components/schemas/TeamRef"
+ $ref: '#/components/schemas/TeamRef'
type: object
TeamConnectionType:
default: "team_connection"
@@ -117828,20 +117889,20 @@ components:
data:
description: Array of team connections.
items:
- $ref: "#/components/schemas/TeamConnection"
+ $ref: '#/components/schemas/TeamConnection'
type: array
meta:
- $ref: "#/components/schemas/ConnectionsResponseMeta"
+ $ref: '#/components/schemas/ConnectionsResponseMeta'
type: object
TeamCreate:
description: Team create
properties:
attributes:
- $ref: "#/components/schemas/TeamCreateAttributes"
+ $ref: '#/components/schemas/TeamCreateAttributes'
relationships:
- $ref: "#/components/schemas/TeamCreateRelationships"
+ $ref: '#/components/schemas/TeamCreateRelationships'
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
required:
- attributes
- type
@@ -117892,13 +117953,13 @@ components:
description: Relationships formed with the team on creation
properties:
users:
- $ref: "#/components/schemas/RelationshipToUsers"
+ $ref: '#/components/schemas/RelationshipToUsers'
type: object
TeamCreateRequest:
description: Request to create a team
properties:
data:
- $ref: "#/components/schemas/TeamCreate"
+ $ref: '#/components/schemas/TeamCreate'
required:
- data
type: object
@@ -117906,15 +117967,15 @@ components:
description: Team hierarchy link
properties:
attributes:
- $ref: "#/components/schemas/TeamHierarchyLinkAttributes"
+ $ref: '#/components/schemas/TeamHierarchyLinkAttributes'
id:
description: The team hierarchy link's identifier
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
relationships:
- $ref: "#/components/schemas/TeamHierarchyLinkRelationships"
+ $ref: '#/components/schemas/TeamHierarchyLinkRelationships'
type:
- $ref: "#/components/schemas/TeamHierarchyLinkType"
+ $ref: '#/components/schemas/TeamHierarchyLinkType'
required:
- attributes
- id
@@ -117940,9 +118001,9 @@ components:
description: Data provided when creating a team hierarchy link
properties:
relationships:
- $ref: "#/components/schemas/TeamHierarchyLinkCreateRelationships"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreateRelationships'
type:
- $ref: "#/components/schemas/TeamHierarchyLinkType"
+ $ref: '#/components/schemas/TeamHierarchyLinkType'
required:
- relationships
- type
@@ -117951,9 +118012,9 @@ components:
description: The related teams that will be connected by the team hierarchy link
properties:
parent_team:
- $ref: "#/components/schemas/TeamHierarchyLinkCreateTeamRelationship"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship'
sub_team:
- $ref: "#/components/schemas/TeamHierarchyLinkCreateTeamRelationship"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreateTeamRelationship'
required:
- parent_team
- sub_team
@@ -117962,7 +118023,7 @@ components:
description: Request to create a team hierarchy link
properties:
data:
- $ref: "#/components/schemas/TeamHierarchyLinkCreate"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreate'
required:
- data
type: object
@@ -117974,7 +118035,7 @@ components:
example: 692e8073-12c4-4c71-8408-5090bd44c9c8
type: string
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
required:
- id
- type
@@ -117983,7 +118044,7 @@ components:
description: Data about each team that will be connected by the team hierarchy link
properties:
data:
- $ref: "#/components/schemas/TeamHierarchyLinkCreateTeam"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreateTeam'
required:
- data
type: object
@@ -117991,9 +118052,9 @@ components:
description: Team hierarchy link relationships
properties:
parent_team:
- $ref: "#/components/schemas/TeamHierarchyLinkTeamRelationship"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship'
sub_team:
- $ref: "#/components/schemas/TeamHierarchyLinkTeamRelationship"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeamRelationship'
required:
- parent_team
- sub_team
@@ -118002,26 +118063,26 @@ components:
description: Team hierarchy link response
properties:
data:
- $ref: "#/components/schemas/TeamHierarchyLink"
+ $ref: '#/components/schemas/TeamHierarchyLink'
included:
description: Included teams
items:
- $ref: "#/components/schemas/TeamHierarchyLinkTeam"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeam'
type: array
links:
- $ref: "#/components/schemas/TeamsHierarchyLinksResponseLinks"
+ $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks'
type: object
TeamHierarchyLinkTeam:
description: Team hierarchy links connect different teams. This represents team objects that are connected by the team hierarchy link.
properties:
attributes:
- $ref: "#/components/schemas/TeamHierarchyLinkTeamAttributes"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeamAttributes'
id:
description: The team's identifier
example: 692e8073-12c4-4c71-8408-5090bd44c9c8
type: string
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
required:
- id
- type
@@ -118071,7 +118132,7 @@ components:
description: Team hierarchy link team relationship
properties:
data:
- $ref: "#/components/schemas/TeamHierarchyLinkTeam"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeam'
required:
- data
type: object
@@ -118090,35 +118151,35 @@ components:
data:
description: Team hierarchy links response data
items:
- $ref: "#/components/schemas/TeamHierarchyLink"
+ $ref: '#/components/schemas/TeamHierarchyLink'
type: array
included:
description: Included teams
items:
- $ref: "#/components/schemas/TeamHierarchyLinkTeam"
+ $ref: '#/components/schemas/TeamHierarchyLinkTeam'
type: array
links:
- $ref: "#/components/schemas/TeamsHierarchyLinksResponseLinks"
+ $ref: '#/components/schemas/TeamsHierarchyLinksResponseLinks'
meta:
- $ref: "#/components/schemas/TeamsHierarchyLinksResponseMeta"
+ $ref: '#/components/schemas/TeamsHierarchyLinksResponseMeta'
type: object
TeamIncluded:
description: Included resources related to the team
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/TeamLink"
- - $ref: "#/components/schemas/UserTeamPermission"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/TeamLink'
+ - $ref: '#/components/schemas/UserTeamPermission'
TeamLink:
description: Team link
properties:
attributes:
- $ref: "#/components/schemas/TeamLinkAttributes"
+ $ref: '#/components/schemas/TeamLinkAttributes'
id:
description: The team link's identifier
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TeamLinkType"
+ $ref: '#/components/schemas/TeamLinkType'
required:
- attributes
- id
@@ -118153,9 +118214,9 @@ components:
description: Team link create
properties:
attributes:
- $ref: "#/components/schemas/TeamLinkAttributes"
+ $ref: '#/components/schemas/TeamLinkAttributes'
type:
- $ref: "#/components/schemas/TeamLinkType"
+ $ref: '#/components/schemas/TeamLinkType'
required:
- attributes
- type
@@ -118164,7 +118225,7 @@ components:
description: Team link create request
properties:
data:
- $ref: "#/components/schemas/TeamLinkCreate"
+ $ref: '#/components/schemas/TeamLinkCreate'
required:
- data
type: object
@@ -118172,7 +118233,7 @@ components:
description: Team link response
properties:
data:
- $ref: "#/components/schemas/TeamLink"
+ $ref: '#/components/schemas/TeamLink'
type: object
TeamLinkType:
default: team_links
@@ -118189,20 +118250,20 @@ components:
data:
description: Team links response data
items:
- $ref: "#/components/schemas/TeamLink"
+ $ref: '#/components/schemas/TeamLink'
type: array
type: object
TeamNotificationRule:
description: Team notification rule
properties:
attributes:
- $ref: "#/components/schemas/TeamNotificationRuleAttributes"
+ $ref: '#/components/schemas/TeamNotificationRuleAttributes'
id:
description: The identifier of the team notification rule
example: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TeamNotificationRuleType"
+ $ref: '#/components/schemas/TeamNotificationRuleType'
required:
- attributes
- type
@@ -118211,13 +118272,13 @@ components:
description: Team notification rule attributes
properties:
email:
- $ref: "#/components/schemas/TeamNotificationRuleAttributesEmail"
+ $ref: '#/components/schemas/TeamNotificationRuleAttributesEmail'
ms_teams:
- $ref: "#/components/schemas/TeamNotificationRuleAttributesMsTeams"
+ $ref: '#/components/schemas/TeamNotificationRuleAttributesMsTeams'
pagerduty:
- $ref: "#/components/schemas/TeamNotificationRuleAttributesPagerduty"
+ $ref: '#/components/schemas/TeamNotificationRuleAttributesPagerduty'
slack:
- $ref: "#/components/schemas/TeamNotificationRuleAttributesSlack"
+ $ref: '#/components/schemas/TeamNotificationRuleAttributesSlack'
type: object
TeamNotificationRuleAttributesEmail:
description: Email notification settings for the team
@@ -118254,7 +118315,7 @@ components:
description: Request to create or update a team notification rule
properties:
data:
- $ref: "#/components/schemas/TeamNotificationRule"
+ $ref: '#/components/schemas/TeamNotificationRule'
required:
- data
type: object
@@ -118262,7 +118323,7 @@ components:
description: Team notification rule response
properties:
data:
- $ref: "#/components/schemas/TeamNotificationRule"
+ $ref: '#/components/schemas/TeamNotificationRule'
type: object
TeamNotificationRuleType:
default: team_notification_rules
@@ -118279,16 +118340,16 @@ components:
data:
description: Team notification rules response data
items:
- $ref: "#/components/schemas/TeamNotificationRule"
+ $ref: '#/components/schemas/TeamNotificationRule'
type: array
meta:
- $ref: "#/components/schemas/TeamNotificationRulesResponseMeta"
+ $ref: '#/components/schemas/TeamNotificationRulesResponseMeta'
type: object
TeamNotificationRulesResponseMeta:
description: Metadata that is included in the response when querying the team notification rules
properties:
page:
- $ref: "#/components/schemas/TeamNotificationRulesResponseMetaPage"
+ $ref: '#/components/schemas/TeamNotificationRulesResponseMetaPage'
type: object
TeamNotificationRulesResponseMetaPage:
description: |-
@@ -118359,11 +118420,11 @@ components:
type: escalation_policy_steps
properties:
data:
- $ref: "#/components/schemas/TeamOnCallRespondersData"
+ $ref: '#/components/schemas/TeamOnCallRespondersData'
included:
description: The `TeamOnCallResponders` `included`.
items:
- $ref: "#/components/schemas/TeamOnCallRespondersIncluded"
+ $ref: '#/components/schemas/TeamOnCallRespondersIncluded'
type: array
type: object
TeamOnCallRespondersData:
@@ -118373,9 +118434,9 @@ components:
description: Unique identifier of the on-call responder configuration.
type: string
relationships:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationships"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationships'
type:
- $ref: "#/components/schemas/TeamOnCallRespondersDataType"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataType'
required:
- type
type: object
@@ -118383,9 +118444,9 @@ components:
description: Relationship objects linked to a team's on-call responder configuration, including escalations and responders.
properties:
escalations:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalations'
responders:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsResponders'
type: object
TeamOnCallRespondersDataRelationshipsEscalations:
description: Defines the escalation policy steps linked to the team's on-call configuration.
@@ -118393,7 +118454,7 @@ components:
data:
description: Array of escalation step references.
items:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItems'
type: array
type: object
TeamOnCallRespondersDataRelationshipsEscalationsDataItems:
@@ -118404,7 +118465,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsEscalationsDataItemsType'
required:
- type
- id
@@ -118424,7 +118485,7 @@ components:
data:
description: Array of user references associated as responders.
items:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItems'
type: array
type: object
TeamOnCallRespondersDataRelationshipsRespondersDataItems:
@@ -118435,7 +118496,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType"
+ $ref: '#/components/schemas/TeamOnCallRespondersDataRelationshipsRespondersDataItemsType'
required:
- type
- id
@@ -118461,19 +118522,19 @@ components:
TeamOnCallRespondersIncluded:
description: Represents an union of related resources included in the response, such as users and escalation steps.
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/Escalation"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/Escalation'
TeamPermissionSetting:
description: Team permission setting
properties:
attributes:
- $ref: "#/components/schemas/TeamPermissionSettingAttributes"
+ $ref: '#/components/schemas/TeamPermissionSettingAttributes'
id:
description: The team permission setting's identifier
example: TeamPermission-aeadc05e-98a8-11ec-ac2c-da7ad0900001-edit
type: string
type:
- $ref: "#/components/schemas/TeamPermissionSettingType"
+ $ref: '#/components/schemas/TeamPermissionSettingType'
required:
- id
- type
@@ -118482,25 +118543,25 @@ components:
description: Team permission setting attributes
properties:
action:
- $ref: "#/components/schemas/TeamPermissionSettingSerializerAction"
+ $ref: '#/components/schemas/TeamPermissionSettingSerializerAction'
editable:
description: Whether or not the permission setting is editable by the current user
readOnly: true
type: boolean
options:
- $ref: "#/components/schemas/TeamPermissionSettingValues"
+ $ref: '#/components/schemas/TeamPermissionSettingValues'
title:
description: The team permission name
readOnly: true
type: string
value:
- $ref: "#/components/schemas/TeamPermissionSettingValue"
+ $ref: '#/components/schemas/TeamPermissionSettingValue'
type: object
TeamPermissionSettingResponse:
description: Team permission setting response
properties:
data:
- $ref: "#/components/schemas/TeamPermissionSetting"
+ $ref: '#/components/schemas/TeamPermissionSetting'
type: object
TeamPermissionSettingSerializerAction:
description: The identifier for the action
@@ -118525,9 +118586,9 @@ components:
description: Team permission setting update
properties:
attributes:
- $ref: "#/components/schemas/TeamPermissionSettingUpdateAttributes"
+ $ref: '#/components/schemas/TeamPermissionSettingUpdateAttributes'
type:
- $ref: "#/components/schemas/TeamPermissionSettingType"
+ $ref: '#/components/schemas/TeamPermissionSettingType'
required:
- type
type: object
@@ -118535,13 +118596,13 @@ components:
description: Team permission setting update attributes
properties:
value:
- $ref: "#/components/schemas/TeamPermissionSettingValue"
+ $ref: '#/components/schemas/TeamPermissionSettingValue'
type: object
TeamPermissionSettingUpdateRequest:
description: Team permission setting update request
properties:
data:
- $ref: "#/components/schemas/TeamPermissionSettingUpdate"
+ $ref: '#/components/schemas/TeamPermissionSettingUpdate'
required:
- data
type: object
@@ -118563,7 +118624,7 @@ components:
TeamPermissionSettingValues:
description: Possible values for action
items:
- $ref: "#/components/schemas/TeamPermissionSettingValue"
+ $ref: '#/components/schemas/TeamPermissionSettingValue'
readOnly: true
type: array
TeamPermissionSettingsResponse:
@@ -118572,14 +118633,14 @@ components:
data:
description: Team permission settings response data
items:
- $ref: "#/components/schemas/TeamPermissionSetting"
+ $ref: '#/components/schemas/TeamPermissionSetting'
type: array
type: object
TeamRef:
description: Reference to a Datadog team.
properties:
data:
- $ref: "#/components/schemas/TeamRefData"
+ $ref: '#/components/schemas/TeamRefData'
type: object
TeamRefData:
description: Reference to a Datadog team.
@@ -118589,7 +118650,7 @@ components:
example: "87654321-4321-8765-dcba-210987654321"
type: string
type:
- $ref: "#/components/schemas/TeamRefDataType"
+ $ref: '#/components/schemas/TeamRefDataType'
required:
- id
- type
@@ -118607,12 +118668,12 @@ components:
description: Provides a reference to a team, including ID, type, and basic attributes/relationships.
properties:
attributes:
- $ref: "#/components/schemas/TeamReferenceAttributes"
+ $ref: '#/components/schemas/TeamReferenceAttributes'
id:
description: The team's unique identifier.
type: string
type:
- $ref: "#/components/schemas/TeamReferenceType"
+ $ref: '#/components/schemas/TeamReferenceType'
required:
- type
type: object
@@ -118646,9 +118707,9 @@ components:
description: Resources related to a team
properties:
team_links:
- $ref: "#/components/schemas/RelationshipToTeamLinks"
+ $ref: '#/components/schemas/RelationshipToTeamLinks'
user_team_permissions:
- $ref: "#/components/schemas/RelationshipToUserTeamPermission"
+ $ref: '#/components/schemas/RelationshipToUserTeamPermission'
type: object
TeamRelationshipsLinks:
description: Links attributes.
@@ -118662,7 +118723,7 @@ components:
description: Response with a team
properties:
data:
- $ref: "#/components/schemas/Team"
+ $ref: '#/components/schemas/Team'
type: object
TeamRoutingRules:
description: Represents a complete set of team routing rules, including data and optionally included related resources.
@@ -118700,11 +118761,11 @@ components:
type: team_routing_rules
properties:
data:
- $ref: "#/components/schemas/TeamRoutingRulesData"
+ $ref: '#/components/schemas/TeamRoutingRulesData'
included:
description: Provides related routing rules or other included resources.
items:
- $ref: "#/components/schemas/TeamRoutingRulesIncluded"
+ $ref: '#/components/schemas/TeamRoutingRulesIncluded'
type: array
type: object
TeamRoutingRulesData:
@@ -118714,9 +118775,9 @@ components:
description: Specifies the unique identifier of this team routing rules record.
type: string
relationships:
- $ref: "#/components/schemas/TeamRoutingRulesDataRelationships"
+ $ref: '#/components/schemas/TeamRoutingRulesDataRelationships'
type:
- $ref: "#/components/schemas/TeamRoutingRulesDataType"
+ $ref: '#/components/schemas/TeamRoutingRulesDataType'
required:
- type
type: object
@@ -118724,7 +118785,7 @@ components:
description: Specifies relationships for team routing rules, including rule references.
properties:
rules:
- $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRules"
+ $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRules'
type: object
TeamRoutingRulesDataRelationshipsRules:
description: Holds references to a set of routing rules in a relationship.
@@ -118732,7 +118793,7 @@ components:
data:
description: An array of references to the routing rules associated with this team.
items:
- $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItems"
+ $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItems'
type: array
type: object
TeamRoutingRulesDataRelationshipsRulesDataItems:
@@ -118743,7 +118804,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItemsType"
+ $ref: '#/components/schemas/TeamRoutingRulesDataRelationshipsRulesDataItemsType'
required:
- type
- id
@@ -118769,7 +118830,7 @@ components:
TeamRoutingRulesIncluded:
description: Represents additional included resources for team routing rules, such as associated routing rules.
oneOf:
- - $ref: "#/components/schemas/RoutingRule"
+ - $ref: '#/components/schemas/RoutingRule'
TeamRoutingRulesRequest:
description: Represents a request to create or update team routing rules, including the data payload.
example:
@@ -118803,18 +118864,18 @@ components:
type: team_routing_rules
properties:
data:
- $ref: "#/components/schemas/TeamRoutingRulesRequestData"
+ $ref: '#/components/schemas/TeamRoutingRulesRequestData'
type: object
TeamRoutingRulesRequestData:
description: Holds the data necessary to create or update team routing rules, including attributes, ID, and resource type.
properties:
attributes:
- $ref: "#/components/schemas/TeamRoutingRulesRequestDataAttributes"
+ $ref: '#/components/schemas/TeamRoutingRulesRequestDataAttributes'
id:
description: Specifies the unique identifier for this set of team routing rules.
type: string
type:
- $ref: "#/components/schemas/TeamRoutingRulesRequestDataType"
+ $ref: '#/components/schemas/TeamRoutingRulesRequestDataType'
required:
- type
type: object
@@ -118824,7 +118885,7 @@ components:
rules:
description: A list of routing rule items that define how incoming pages should be handled.
items:
- $ref: "#/components/schemas/TeamRoutingRulesRequestRule"
+ $ref: '#/components/schemas/TeamRoutingRulesRequestRule'
type: array
type: object
TeamRoutingRulesRequestDataType:
@@ -118842,7 +118903,7 @@ components:
actions:
description: Specifies the list of actions to perform when the routing rule is matched.
items:
- $ref: "#/components/schemas/RoutingRuleAction"
+ $ref: '#/components/schemas/RoutingRuleAction'
type: array
policy_id:
description: Identifies the policy to be applied when this routing rule matches.
@@ -118851,23 +118912,23 @@ components:
description: Defines the query or condition that triggers this routing rule.
type: string
time_restriction:
- $ref: "#/components/schemas/TimeRestrictions"
+ $ref: '#/components/schemas/TimeRestrictions'
urgency:
- $ref: "#/components/schemas/Urgency"
+ $ref: '#/components/schemas/Urgency'
type: object
TeamSyncAttributes:
description: Team sync attributes.
properties:
frequency:
- $ref: "#/components/schemas/TeamSyncAttributesFrequency"
+ $ref: '#/components/schemas/TeamSyncAttributesFrequency'
selection_state:
- $ref: "#/components/schemas/TeamSyncAttributesSelectionState"
+ $ref: '#/components/schemas/TeamSyncAttributesSelectionState'
source:
- $ref: "#/components/schemas/TeamSyncAttributesSource"
+ $ref: '#/components/schemas/TeamSyncAttributesSource'
sync_membership:
- $ref: "#/components/schemas/TeamSyncAttributesSyncMembership"
+ $ref: '#/components/schemas/TeamSyncAttributesSyncMembership'
type:
- $ref: "#/components/schemas/TeamSyncAttributesType"
+ $ref: '#/components/schemas/TeamSyncAttributesType'
required:
- source
- type
@@ -118890,7 +118951,7 @@ components:
provided, synchronization is limited to the specified
items and their subtrees.
items:
- $ref: "#/components/schemas/TeamSyncSelectionStateItem"
+ $ref: '#/components/schemas/TeamSyncSelectionStateItem'
type: array
TeamSyncAttributesSource:
description: The external source platform for team synchronization. Only "github" is supported.
@@ -118927,13 +118988,13 @@ components:
description: A configuration governing syncing between Datadog teams and teams from an external system.
properties:
attributes:
- $ref: "#/components/schemas/TeamSyncAttributes"
+ $ref: '#/components/schemas/TeamSyncAttributes'
id:
description: The sync's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TeamSyncBulkType"
+ $ref: '#/components/schemas/TeamSyncBulkType'
required:
- attributes
- type
@@ -118948,7 +119009,7 @@ components:
type: team_sync_bulk
properties:
data:
- $ref: "#/components/schemas/TeamSyncData"
+ $ref: '#/components/schemas/TeamSyncData'
required:
- data
type: object
@@ -118958,16 +119019,16 @@ components:
data:
description: List of team sync configurations
items:
- $ref: "#/components/schemas/TeamSyncData"
+ $ref: '#/components/schemas/TeamSyncData'
type: array
type: object
TeamSyncSelectionStateExternalId:
description: The external identifier for a team or organization in the source platform.
properties:
type:
- $ref: "#/components/schemas/TeamSyncSelectionStateExternalIdType"
+ $ref: '#/components/schemas/TeamSyncSelectionStateExternalIdType'
value:
- $ref: "#/components/schemas/TeamSyncSelectionStateExternalIdValue"
+ $ref: '#/components/schemas/TeamSyncSelectionStateExternalIdValue'
required:
- type
- value
@@ -118997,11 +119058,11 @@ components:
description: Identifies a team or organization hierarchy to include in synchronization.
properties:
external_id:
- $ref: "#/components/schemas/TeamSyncSelectionStateExternalId"
+ $ref: '#/components/schemas/TeamSyncSelectionStateExternalId'
operation:
- $ref: "#/components/schemas/TeamSyncSelectionStateOperation"
+ $ref: '#/components/schemas/TeamSyncSelectionStateOperation'
scope:
- $ref: "#/components/schemas/TeamSyncSelectionStateScope"
+ $ref: '#/components/schemas/TeamSyncSelectionStateScope'
required:
- external_id
type: object
@@ -119035,7 +119096,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/TeamTargetType"
+ $ref: '#/components/schemas/TeamTargetType'
required:
- type
- id
@@ -119062,11 +119123,11 @@ components:
description: Team update request
properties:
attributes:
- $ref: "#/components/schemas/TeamUpdateAttributes"
+ $ref: '#/components/schemas/TeamUpdateAttributes'
relationships:
- $ref: "#/components/schemas/TeamUpdateRelationships"
+ $ref: '#/components/schemas/TeamUpdateRelationships'
type:
- $ref: "#/components/schemas/TeamType"
+ $ref: '#/components/schemas/TeamType'
required:
- attributes
- type
@@ -119117,13 +119178,13 @@ components:
description: Team update relationships
properties:
team_links:
- $ref: "#/components/schemas/RelationshipToTeamLinks"
+ $ref: '#/components/schemas/RelationshipToTeamLinks'
type: object
TeamUpdateRequest:
description: Team update request
properties:
data:
- $ref: "#/components/schemas/TeamUpdate"
+ $ref: '#/components/schemas/TeamUpdate'
required:
- data
type: object
@@ -119189,7 +119250,7 @@ components:
description: Metadata that is included in the response when querying the team hierarchy links
properties:
page:
- $ref: "#/components/schemas/TeamsHierarchyLinksResponseMetaPage"
+ $ref: '#/components/schemas/TeamsHierarchyLinksResponseMetaPage'
type: object
TeamsHierarchyLinksResponseMetaPage:
description: Metadata related to paging information that is included in the response when querying the team hierarchy links
@@ -119252,11 +119313,11 @@ components:
description: A single add or remove operation, applied atomically with every other operation in the request.
properties:
data:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchOperationData"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchOperationData'
op:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchOperationOp"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchOperationOp'
ref:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchOperationRef"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchOperationRef'
required:
- op
type: object
@@ -119264,9 +119325,9 @@ components:
description: The mapping to add. Required when `op` is `add`.
properties:
attributes:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchOperationDataAttributes"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchOperationDataAttributes'
type:
- $ref: "#/components/schemas/TeamsOwnershipMappingType"
+ $ref: '#/components/schemas/TeamsOwnershipMappingType'
required:
- type
- attributes
@@ -119285,7 +119346,7 @@ components:
format: uuid
type: string
match_type:
- $ref: "#/components/schemas/TeamsOwnershipMatchType"
+ $ref: '#/components/schemas/TeamsOwnershipMatchType'
service:
description: The RUM application's service name. For browser applications, this is optional. For mobile applications, this is required and scopes the ownership to a specific service.
example: "web-checkout"
@@ -119315,7 +119376,7 @@ components:
example: "456"
type: string
type:
- $ref: "#/components/schemas/TeamsOwnershipMappingType"
+ $ref: '#/components/schemas/TeamsOwnershipMappingType'
required:
- type
- id
@@ -119326,7 +119387,7 @@ components:
atomic:operations:
description: The list of add and remove operations to apply atomically.
items:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchOperation"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchOperation'
type: array
required:
- atomic:operations
@@ -119344,12 +119405,12 @@ components:
Add operations are processed first, then remove operations, so results may not appear
in the same order as the request. Present only on success.
items:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchResult"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchResult'
type: array
errors:
description: The validation or processing errors encountered. Present only when the request could not be completed.
items:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchError"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchError'
type: array
type: object
TeamsOwnershipMappingBatchResult:
@@ -119359,19 +119420,19 @@ components:
in the same order as the request. Empty for `remove` operations.
properties:
data:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchResultData"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchResultData'
type: object
TeamsOwnershipMappingBatchResultData:
description: The mapping created by an `add` operation.
properties:
attributes:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchResultDataAttributes"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchResultDataAttributes'
id:
description: The unique identifier of the teams ownership mapping.
example: "123"
type: string
type:
- $ref: "#/components/schemas/TeamsOwnershipMappingType"
+ $ref: '#/components/schemas/TeamsOwnershipMappingType'
required:
- type
- id
@@ -119395,7 +119456,7 @@ components:
example: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: string
match_type:
- $ref: "#/components/schemas/TeamsOwnershipMatchType"
+ $ref: '#/components/schemas/TeamsOwnershipMatchType'
org_id:
description: The ID of the organization that owns this mapping.
example: 123456
@@ -119425,9 +119486,9 @@ components:
description: The JSON:API data envelope for a teams ownership mapping create request.
properties:
attributes:
- $ref: "#/components/schemas/TeamsOwnershipMappingCreateDataAttributes"
+ $ref: '#/components/schemas/TeamsOwnershipMappingCreateDataAttributes'
type:
- $ref: "#/components/schemas/TeamsOwnershipMappingType"
+ $ref: '#/components/schemas/TeamsOwnershipMappingType'
required:
- type
- attributes
@@ -119444,7 +119505,7 @@ components:
format: uuid
type: string
match_type:
- $ref: "#/components/schemas/TeamsOwnershipMatchType"
+ $ref: '#/components/schemas/TeamsOwnershipMatchType'
service:
description: The RUM application's service name. For browser applications, this is optional. For mobile applications, this is required and scopes the ownership to a specific service.
example: "web-checkout"
@@ -119465,7 +119526,7 @@ components:
description: The request body for creating a teams ownership mapping.
properties:
data:
- $ref: "#/components/schemas/TeamsOwnershipMappingCreateData"
+ $ref: '#/components/schemas/TeamsOwnershipMappingCreateData'
required:
- data
type: object
@@ -119473,7 +119534,7 @@ components:
description: The response body for a single teams ownership mapping.
properties:
data:
- $ref: "#/components/schemas/TeamsOwnershipMappingResponseData"
+ $ref: '#/components/schemas/TeamsOwnershipMappingResponseData'
required:
- data
type: object
@@ -119497,7 +119558,7 @@ components:
example: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: string
match_type:
- $ref: "#/components/schemas/TeamsOwnershipMatchType"
+ $ref: '#/components/schemas/TeamsOwnershipMatchType'
org_id:
description: The ID of the organization that owns this mapping.
example: 123456
@@ -119529,13 +119590,13 @@ components:
description: The JSON:API data envelope for a teams ownership mapping.
properties:
attributes:
- $ref: "#/components/schemas/TeamsOwnershipMappingResponseAttributes"
+ $ref: '#/components/schemas/TeamsOwnershipMappingResponseAttributes'
id:
description: The unique identifier of the teams ownership mapping.
example: "123"
type: string
type:
- $ref: "#/components/schemas/TeamsOwnershipMappingType"
+ $ref: '#/components/schemas/TeamsOwnershipMappingType'
required:
- id
- type
@@ -119555,7 +119616,7 @@ components:
data:
description: A list of teams ownership mappings.
items:
- $ref: "#/components/schemas/TeamsOwnershipMappingResponseData"
+ $ref: '#/components/schemas/TeamsOwnershipMappingResponseData'
type: array
required:
- data
@@ -119580,7 +119641,7 @@ components:
example: "11111111-2222-3333-4444-555555555555"
type: string
match_type:
- $ref: "#/components/schemas/TeamsOwnershipMatchType"
+ $ref: '#/components/schemas/TeamsOwnershipMatchType'
service:
description: The RUM application's service name. For browser applications, may be empty. For mobile applications, this is the service that scopes the ownership.
example: "web-checkout"
@@ -119588,7 +119649,7 @@ components:
teams:
description: The teams that own the matched views, each paired with the ID of its underlying mapping.
items:
- $ref: "#/components/schemas/TeamsOwnershipRuleTeamMapping"
+ $ref: '#/components/schemas/TeamsOwnershipRuleTeamMapping'
type: array
view_name:
description: The RUM view name to match, or its prefix when `match_type` is `prefix`.
@@ -119605,7 +119666,7 @@ components:
description: The JSON:API data envelope for a teams ownership rule.
properties:
attributes:
- $ref: "#/components/schemas/TeamsOwnershipRuleResponseAttributes"
+ $ref: '#/components/schemas/TeamsOwnershipRuleResponseAttributes'
id:
description: |-
A deterministic identifier derived from the rule's grouping key.
@@ -119614,7 +119675,7 @@ components:
example: "3b1e2f7a9c4d6e8f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f"
type: string
type:
- $ref: "#/components/schemas/TeamsOwnershipRuleType"
+ $ref: '#/components/schemas/TeamsOwnershipRuleType'
required:
- id
- type
@@ -119649,7 +119710,7 @@ components:
data:
description: A list of teams ownership rules.
items:
- $ref: "#/components/schemas/TeamsOwnershipRuleResponseData"
+ $ref: '#/components/schemas/TeamsOwnershipRuleResponseData'
type: array
required:
- data
@@ -119660,17 +119721,17 @@ components:
data:
description: Teams response data
items:
- $ref: "#/components/schemas/Team"
+ $ref: '#/components/schemas/Team'
type: array
included:
description: Resources related to the team
items:
- $ref: "#/components/schemas/TeamIncluded"
+ $ref: '#/components/schemas/TeamIncluded'
type: array
links:
- $ref: "#/components/schemas/TeamsResponseLinks"
+ $ref: '#/components/schemas/TeamsResponseLinks'
meta:
- $ref: "#/components/schemas/TeamsResponseMeta"
+ $ref: '#/components/schemas/TeamsResponseMeta'
type: object
TeamsResponseLinks:
description: Teams response links.
@@ -119697,7 +119758,7 @@ components:
description: Teams response metadata.
properties:
pagination:
- $ref: "#/components/schemas/TeamsResponseMetaPagination"
+ $ref: '#/components/schemas/TeamsResponseMetaPagination'
type: object
TeamsResponseMetaPagination:
description: Teams response metadata.
@@ -119770,18 +119831,18 @@ components:
type: oci_tenancy
properties:
data:
- $ref: "#/components/schemas/TenancyConfigData"
+ $ref: '#/components/schemas/TenancyConfigData'
type: object
TenancyConfigData:
description: A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes.
properties:
attributes:
- $ref: "#/components/schemas/TenancyConfigDataAttributes"
+ $ref: '#/components/schemas/TenancyConfigDataAttributes'
id:
description: The OCID of the OCI tenancy.
type: string
type:
- $ref: "#/components/schemas/UpdateTenancyConfigDataType"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataType'
required:
- type
type: object
@@ -119810,14 +119871,14 @@ components:
description: The home region of the OCI tenancy (for example, us-ashburn-1).
type: string
logs_config:
- $ref: "#/components/schemas/TenancyConfigDataAttributesLogsConfig"
+ $ref: '#/components/schemas/TenancyConfigDataAttributesLogsConfig'
metrics_config:
- $ref: "#/components/schemas/TenancyConfigDataAttributesMetricsConfig"
+ $ref: '#/components/schemas/TenancyConfigDataAttributesMetricsConfig'
parent_tenancy_name:
description: The name of the parent OCI tenancy, if applicable.
type: string
regions_config:
- $ref: "#/components/schemas/TenancyConfigDataAttributesRegionsConfig"
+ $ref: '#/components/schemas/TenancyConfigDataAttributesRegionsConfig'
resource_collection_enabled:
description: Whether resource collection from OCI is enabled for the tenancy.
type: boolean
@@ -119926,7 +119987,7 @@ components:
data:
description: List of OCI tenancy integration configuration objects.
items:
- $ref: "#/components/schemas/TenancyConfigData"
+ $ref: '#/components/schemas/TenancyConfigData'
type: array
required:
- data
@@ -119935,12 +119996,12 @@ components:
description: A single OCI tenancy product resource object containing the tenancy ID, type, and product attributes.
properties:
attributes:
- $ref: "#/components/schemas/TenancyProductsDataAttributes"
+ $ref: '#/components/schemas/TenancyProductsDataAttributes'
id:
description: The OCID of the OCI tenancy.
type: string
type:
- $ref: "#/components/schemas/TenancyProductsDataType"
+ $ref: '#/components/schemas/TenancyProductsDataType'
required:
- type
type: object
@@ -119950,7 +120011,7 @@ components:
products:
description: List of Datadog products and their enablement status for the tenancy.
items:
- $ref: "#/components/schemas/TenancyProductsDataAttributesProductsItems"
+ $ref: '#/components/schemas/TenancyProductsDataAttributesProductsItems'
type: array
type: object
TenancyProductsDataAttributesProductsItems:
@@ -119986,7 +120047,7 @@ components:
data:
description: List of OCI tenancy product resource objects.
items:
- $ref: "#/components/schemas/TenancyProductsData"
+ $ref: '#/components/schemas/TenancyProductsData'
type: array
required:
- data
@@ -119995,7 +120056,7 @@ components:
description: Request object for deleting Test Optimization service settings.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationDeleteServiceSettingsRequestData"
+ $ref: '#/components/schemas/TestOptimizationDeleteServiceSettingsRequestData'
required:
- data
type: object
@@ -120024,9 +120085,9 @@ components:
description: Data object for delete service settings request.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationDeleteServiceSettingsRequestAttributes"
+ $ref: '#/components/schemas/TestOptimizationDeleteServiceSettingsRequestAttributes'
type:
- $ref: "#/components/schemas/TestOptimizationDeleteServiceSettingsRequestDataType"
+ $ref: '#/components/schemas/TestOptimizationDeleteServiceSettingsRequestDataType'
required:
- type
- attributes
@@ -120054,11 +120115,11 @@ components:
description: Attributes of the Flaky Tests Management policies for a repository.
properties:
attempt_to_fix:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttemptToFix"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttemptToFix'
disabled:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabled"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabled'
quarantined:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantined"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantined'
repository_id:
description: The repository identifier.
example: github.com/datadog/shopist
@@ -120072,7 +120133,7 @@ components:
example: false
type: boolean
status:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledStatus"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledStatus'
window_seconds:
description: Time window in seconds over which flakiness is evaluated. Must be greater than 0.
example: 3600
@@ -120126,27 +120187,27 @@ components:
description: Data object for Flaky Tests Management policies response.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttributes"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttributes'
id:
description: The repository identifier used as the resource ID.
example: github.com/datadog/shopist
type: string
type:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesType"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesType'
type: object
TestOptimizationFlakyTestsManagementPoliciesDisabled:
description: Configuration for the disabled Flaky Tests Management policy.
properties:
auto_disable_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAutoDisableRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAutoDisableRule'
branch_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesBranchRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesBranchRule'
enabled:
description: Whether the disabled policy is enabled.
example: false
type: boolean
failure_rate_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledFailureRateRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledFailureRateRule'
type: object
TestOptimizationFlakyTestsManagementPoliciesDisabledFailureRateRule:
description: Failure-rate-based rule for the disabled policy.
@@ -120168,7 +120229,7 @@ components:
format: int64
type: integer
status:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledStatus"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabledStatus'
threshold:
description: Failure rate threshold (0.0–1.0) above which the rule triggers.
example: 0.5
@@ -120191,7 +120252,7 @@ components:
description: Request object for getting Flaky Tests Management policies.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequestData"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequestData'
required:
- data
type: object
@@ -120210,9 +120271,9 @@ components:
description: Data object for get Flaky Tests Management policies request.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequestAttributes'
type:
- $ref: "#/components/schemas/TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType"
+ $ref: '#/components/schemas/TestOptimizationGetFlakyTestsManagementPoliciesRequestDataType'
required:
- type
- attributes
@@ -120221,15 +120282,15 @@ components:
description: Configuration for the quarantined Flaky Tests Management policy.
properties:
auto_quarantine_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAutoQuarantineRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAutoQuarantineRule'
branch_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesBranchRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesBranchRule'
enabled:
description: Whether the quarantined policy is enabled.
example: true
type: boolean
failure_rate_rule:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantinedFailureRateRule"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantinedFailureRateRule'
type: object
TestOptimizationFlakyTestsManagementPoliciesQuarantinedFailureRateRule:
description: Failure-rate-based rule for the quarantined policy.
@@ -120261,7 +120322,7 @@ components:
description: Response object containing Flaky Tests Management policies for a repository.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesData"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesData'
type: object
TestOptimizationFlakyTestsManagementPoliciesType:
description: |-
@@ -120277,7 +120338,7 @@ components:
description: Request object for updating Flaky Tests Management policies.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequestData"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequestData'
required:
- data
type: object
@@ -120287,11 +120348,11 @@ components:
Only provided policy blocks are updated; omitted blocks are left unchanged.
properties:
attempt_to_fix:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttemptToFix"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesAttemptToFix'
disabled:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabled"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesDisabled'
quarantined:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantined"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesQuarantined'
repository_id:
description: The repository identifier.
example: github.com/datadog/shopist
@@ -120304,9 +120365,9 @@ components:
description: Data object for update Flaky Tests Management policies request.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequestAttributes"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequestAttributes'
type:
- $ref: "#/components/schemas/TestOptimizationUpdateFlakyTestsManagementPoliciesRequestDataType"
+ $ref: '#/components/schemas/TestOptimizationUpdateFlakyTestsManagementPoliciesRequestDataType'
required:
- type
- attributes
@@ -120325,7 +120386,7 @@ components:
description: Request object for getting Test Optimization service settings.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationGetServiceSettingsRequestData"
+ $ref: '#/components/schemas/TestOptimizationGetServiceSettingsRequestData'
required:
- data
type: object
@@ -120354,9 +120415,9 @@ components:
description: Data object for get service settings request.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationGetServiceSettingsRequestAttributes"
+ $ref: '#/components/schemas/TestOptimizationGetServiceSettingsRequestAttributes'
type:
- $ref: "#/components/schemas/TestOptimizationGetServiceSettingsRequestDataType"
+ $ref: '#/components/schemas/TestOptimizationGetServiceSettingsRequestDataType'
required:
- type
- attributes
@@ -120435,19 +120496,19 @@ components:
description: Data object for Test Optimization service settings response.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationServiceSettingsAttributes"
+ $ref: '#/components/schemas/TestOptimizationServiceSettingsAttributes'
id:
description: Unique identifier for the service settings.
example: 9b8a7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
type: string
type:
- $ref: "#/components/schemas/TestOptimizationServiceSettingsType"
+ $ref: '#/components/schemas/TestOptimizationServiceSettingsType'
type: object
TestOptimizationServiceSettingsResponse:
description: Response object containing Test Optimization service settings.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationServiceSettingsData"
+ $ref: '#/components/schemas/TestOptimizationServiceSettingsData'
type: object
TestOptimizationServiceSettingsType:
description: |-
@@ -120473,7 +120534,7 @@ components:
description: Request object for updating Test Optimization service settings.
properties:
data:
- $ref: "#/components/schemas/TestOptimizationUpdateServiceSettingsRequestData"
+ $ref: '#/components/schemas/TestOptimizationUpdateServiceSettingsRequestData'
required:
- data
type: object
@@ -120549,9 +120610,9 @@ components:
description: Data object for update service settings request.
properties:
attributes:
- $ref: "#/components/schemas/TestOptimizationUpdateServiceSettingsRequestAttributes"
+ $ref: '#/components/schemas/TestOptimizationUpdateServiceSettingsRequestAttributes'
type:
- $ref: "#/components/schemas/TestOptimizationUpdateServiceSettingsRequestDataType"
+ $ref: '#/components/schemas/TestOptimizationUpdateServiceSettingsRequestDataType'
required:
- type
- attributes
@@ -120593,7 +120654,7 @@ components:
format: uuid
type: string
target:
- $ref: "#/components/schemas/TicketCreationTarget"
+ $ref: '#/components/schemas/TicketCreationTarget'
required:
- project_id
- target
@@ -120630,7 +120691,7 @@ components:
format: uuid
type: string
target:
- $ref: "#/components/schemas/TicketCreationTarget"
+ $ref: '#/components/schemas/TicketCreationTarget'
required:
- project_id
- target
@@ -120640,7 +120701,7 @@ components:
description: Attributes for creating or updating a ticket creation rule.
properties:
action:
- $ref: "#/components/schemas/TicketCreationRuleAction"
+ $ref: '#/components/schemas/TicketCreationRuleAction'
enabled:
description: Whether the ticket creation rule is enabled.
example: true
@@ -120652,7 +120713,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- rule
@@ -120662,14 +120723,14 @@ components:
description: Attributes of a ticket creation rule returned by the API.
properties:
action:
- $ref: "#/components/schemas/TicketCreationRuleActionResponse"
+ $ref: '#/components/schemas/TicketCreationRuleActionResponse'
created_at:
description: The Unix timestamp in milliseconds when the rule was created.
example: 1722439510282
format: int64
type: integer
created_by:
- $ref: "#/components/schemas/AutomationRuleCreatedBy"
+ $ref: '#/components/schemas/AutomationRuleCreatedBy'
enabled:
description: Whether the ticket creation rule is enabled.
example: true
@@ -120680,7 +120741,7 @@ components:
format: int64
type: integer
modified_by:
- $ref: "#/components/schemas/AutomationRuleModifiedBy"
+ $ref: '#/components/schemas/AutomationRuleModifiedBy'
name:
description: The name of the ticket creation rule.
example: "Auto-create Jira tickets for critical findings"
@@ -120688,7 +120749,7 @@ components:
minLength: 1
type: string
rule:
- $ref: "#/components/schemas/AutomationRuleScope"
+ $ref: '#/components/schemas/AutomationRuleScope'
required:
- name
- enabled
@@ -120703,7 +120764,7 @@ components:
description: The body of a ticket creation rule create request.
properties:
data:
- $ref: "#/components/schemas/TicketCreationRuleDataCreate"
+ $ref: '#/components/schemas/TicketCreationRuleDataCreate'
required:
- data
type: object
@@ -120711,9 +120772,9 @@ components:
description: The data object for a ticket creation rule create or update request.
properties:
attributes:
- $ref: "#/components/schemas/TicketCreationRuleAttributesCreate"
+ $ref: '#/components/schemas/TicketCreationRuleAttributesCreate'
type:
- $ref: "#/components/schemas/TicketCreationRuleType"
+ $ref: '#/components/schemas/TicketCreationRuleType'
required:
- type
- attributes
@@ -120722,14 +120783,14 @@ components:
description: The data object for a ticket creation rule returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/TicketCreationRuleAttributesResponse"
+ $ref: '#/components/schemas/TicketCreationRuleAttributesResponse'
id:
description: The ID of the ticket creation rule.
example: "00000000-0000-0000-0000-000000000000"
format: uuid
type: string
type:
- $ref: "#/components/schemas/TicketCreationRuleType"
+ $ref: '#/components/schemas/TicketCreationRuleType'
required:
- id
- type
@@ -120738,7 +120799,7 @@ components:
TicketCreationRuleReorderData:
description: The ordered list of all ticket creation rules; every rule must be included.
items:
- $ref: "#/components/schemas/TicketCreationRuleReorderItem"
+ $ref: '#/components/schemas/TicketCreationRuleReorderItem'
type: array
TicketCreationRuleReorderItem:
description: A reference to a ticket creation rule used for reordering.
@@ -120749,7 +120810,7 @@ components:
format: uuid
type: string
type:
- $ref: "#/components/schemas/TicketCreationRuleType"
+ $ref: '#/components/schemas/TicketCreationRuleType'
required:
- type
- id
@@ -120758,7 +120819,7 @@ components:
description: The body of the ticket creation rule reorder request.
properties:
data:
- $ref: "#/components/schemas/TicketCreationRuleReorderData"
+ $ref: '#/components/schemas/TicketCreationRuleReorderData'
required:
- data
type: object
@@ -120766,7 +120827,7 @@ components:
description: A single ticket creation rule response.
properties:
data:
- $ref: "#/components/schemas/TicketCreationRuleDataResponse"
+ $ref: '#/components/schemas/TicketCreationRuleDataResponse'
required:
- data
type: object
@@ -120782,24 +120843,24 @@ components:
description: The body of a ticket creation rule update request.
properties:
data:
- $ref: "#/components/schemas/TicketCreationRuleDataCreate"
+ $ref: '#/components/schemas/TicketCreationRuleDataCreate'
required:
- data
type: object
TicketCreationRulesDataList:
description: A list of ticket creation rule data objects.
items:
- $ref: "#/components/schemas/TicketCreationRuleDataResponse"
+ $ref: '#/components/schemas/TicketCreationRuleDataResponse'
type: array
TicketCreationRulesResponse:
description: A list of ticket creation rules with pagination metadata.
properties:
data:
- $ref: "#/components/schemas/TicketCreationRulesDataList"
+ $ref: '#/components/schemas/TicketCreationRulesDataList'
links:
- $ref: "#/components/schemas/SecurityAutomationRulesLinks"
+ $ref: '#/components/schemas/SecurityAutomationRulesLinks'
meta:
- $ref: "#/components/schemas/SecurityAutomationRulesMeta"
+ $ref: '#/components/schemas/SecurityAutomationRulesMeta'
required:
- data
- meta
@@ -120829,12 +120890,12 @@ components:
description: Defines a single time restriction rule with start and end times and the applicable weekdays.
properties:
end_day:
- $ref: "#/components/schemas/Weekday"
+ $ref: '#/components/schemas/Weekday'
end_time:
description: Specifies the ending time for this restriction.
type: string
start_day:
- $ref: "#/components/schemas/Weekday"
+ $ref: '#/components/schemas/Weekday'
start_time:
description: Specifies the starting time for this restriction.
type: string
@@ -120845,7 +120906,7 @@ components:
restrictions:
description: Defines the list of time-based restrictions.
items:
- $ref: "#/components/schemas/TimeRestriction"
+ $ref: '#/components/schemas/TimeRestriction'
type: array
time_zone:
description: Specifies the time zone applicable to the restrictions.
@@ -120859,9 +120920,9 @@ components:
description: "Attributes of a timeline cell, representing a single event in a case's chronological activity log (for example, a comment, status change, or assignment update)."
properties:
author:
- $ref: "#/components/schemas/TimelineCellAuthor"
+ $ref: '#/components/schemas/TimelineCellAuthor'
cell_content:
- $ref: "#/components/schemas/TimelineCellContent"
+ $ref: '#/components/schemas/TimelineCellContent'
created_at:
description: Timestamp of when the cell was created
format: date-time
@@ -120878,19 +120939,19 @@ components:
readOnly: true
type: string
type:
- $ref: "#/components/schemas/TimelineCellType"
+ $ref: '#/components/schemas/TimelineCellType'
type: object
TimelineCellAuthor:
description: The author of the timeline cell. Currently only user authors are supported.
oneOf:
- - $ref: "#/components/schemas/TimelineCellAuthorUser"
+ - $ref: '#/components/schemas/TimelineCellAuthorUser'
TimelineCellAuthorUser:
description: A user who authored a timeline cell.
properties:
content:
- $ref: "#/components/schemas/TimelineCellAuthorUserContent"
+ $ref: '#/components/schemas/TimelineCellAuthorUserContent'
type:
- $ref: "#/components/schemas/TimelineCellAuthorUserType"
+ $ref: '#/components/schemas/TimelineCellAuthorUserType'
type: object
TimelineCellAuthorUserContent:
description: Profile information for the user who authored the timeline cell.
@@ -120919,7 +120980,7 @@ components:
TimelineCellContent:
description: The content payload of a timeline cell, varying by cell type.
oneOf:
- - $ref: "#/components/schemas/TimelineCellContentComment"
+ - $ref: '#/components/schemas/TimelineCellContentComment'
TimelineCellContentComment:
description: The content of a comment timeline cell.
properties:
@@ -120931,13 +120992,13 @@ components:
description: A timeline cell resource representing a single entry in a case's activity timeline.
properties:
attributes:
- $ref: "#/components/schemas/TimelineCell"
+ $ref: '#/components/schemas/TimelineCell'
id:
description: Timeline cell's identifier
example: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: string
type:
- $ref: "#/components/schemas/TimelineCellResourceType"
+ $ref: '#/components/schemas/TimelineCellResourceType'
required:
- id
- type
@@ -120966,14 +121027,14 @@ components:
data:
description: The `TimelineResponse` `data`.
items:
- $ref: "#/components/schemas/TimelineCellResource"
+ $ref: '#/components/schemas/TimelineCellResource'
type: array
type: object
TimeseriesFormulaQueryRequest:
description: A request wrapper around a single timeseries query to be executed.
properties:
data:
- $ref: "#/components/schemas/TimeseriesFormulaRequest"
+ $ref: '#/components/schemas/TimeseriesFormulaRequest'
required:
- data
type: object
@@ -120981,7 +121042,7 @@ components:
description: A message containing one response to a timeseries query made with timeseries formula query request.
properties:
data:
- $ref: "#/components/schemas/TimeseriesResponse"
+ $ref: '#/components/schemas/TimeseriesResponse'
errors:
description: The error generated by the request.
type: string
@@ -120990,9 +121051,9 @@ components:
description: A single timeseries query to be executed.
properties:
attributes:
- $ref: "#/components/schemas/TimeseriesFormulaRequestAttributes"
+ $ref: '#/components/schemas/TimeseriesFormulaRequestAttributes'
type:
- $ref: "#/components/schemas/TimeseriesFormulaRequestType"
+ $ref: '#/components/schemas/TimeseriesFormulaRequestType'
required:
- type
- attributes
@@ -121003,7 +121064,7 @@ components:
formulas:
description: List of formulas to be calculated and returned as responses.
items:
- $ref: "#/components/schemas/QueryFormula"
+ $ref: '#/components/schemas/QueryFormula'
type: array
from:
description: Start date (inclusive) of the query in milliseconds since the Unix epoch.
@@ -121020,7 +121081,7 @@ components:
format: int64
type: integer
queries:
- $ref: "#/components/schemas/TimeseriesFormulaRequestQueries"
+ $ref: '#/components/schemas/TimeseriesFormulaRequestQueries'
to:
description: End date (exclusive) of the query in milliseconds since the Unix epoch.
example: 1568923200000
@@ -121037,7 +121098,7 @@ components:
- data_source: metrics
query: "avg:system.cpu.user{*} by {env}"
items:
- $ref: "#/components/schemas/TimeseriesQuery"
+ $ref: '#/components/schemas/TimeseriesQuery'
type: array
TimeseriesFormulaRequestType:
default: "timeseries_request"
@@ -121059,37 +121120,37 @@ components:
data_source: metrics
query: "avg:system.cpu.user{*} by {env}"
oneOf:
- - $ref: "#/components/schemas/MetricsTimeseriesQuery"
- - $ref: "#/components/schemas/EventsTimeseriesQuery"
- - $ref: "#/components/schemas/ApmResourceStatsQuery"
- - $ref: "#/components/schemas/ApmMetricsQuery"
- - $ref: "#/components/schemas/ApmDependencyStatsQuery"
- - $ref: "#/components/schemas/SloQuery"
- - $ref: "#/components/schemas/ProcessTimeseriesQuery"
- - $ref: "#/components/schemas/ContainerTimeseriesQuery"
+ - $ref: '#/components/schemas/MetricsTimeseriesQuery'
+ - $ref: '#/components/schemas/EventsTimeseriesQuery'
+ - $ref: '#/components/schemas/ApmResourceStatsQuery'
+ - $ref: '#/components/schemas/ApmMetricsQuery'
+ - $ref: '#/components/schemas/ApmDependencyStatsQuery'
+ - $ref: '#/components/schemas/SloQuery'
+ - $ref: '#/components/schemas/ProcessTimeseriesQuery'
+ - $ref: '#/components/schemas/ContainerTimeseriesQuery'
TimeseriesResponse:
description: A message containing the response to a timeseries query.
properties:
attributes:
- $ref: "#/components/schemas/TimeseriesResponseAttributes"
+ $ref: '#/components/schemas/TimeseriesResponseAttributes'
type:
- $ref: "#/components/schemas/TimeseriesFormulaResponseType"
+ $ref: '#/components/schemas/TimeseriesFormulaResponseType'
type: object
TimeseriesResponseAttributes:
description: The object describing a timeseries response.
properties:
series:
- $ref: "#/components/schemas/TimeseriesResponseSeriesList"
+ $ref: '#/components/schemas/TimeseriesResponseSeriesList'
times:
- $ref: "#/components/schemas/TimeseriesResponseTimes"
+ $ref: '#/components/schemas/TimeseriesResponseTimes'
values:
- $ref: "#/components/schemas/TimeseriesResponseValuesList"
+ $ref: '#/components/schemas/TimeseriesResponseValuesList'
type: object
TimeseriesResponseSeries:
description: A single series in a timeseries query response, containing the query index, unit information, and group tags.
properties:
group_tags:
- $ref: "#/components/schemas/GroupTags"
+ $ref: '#/components/schemas/GroupTags'
query_index:
description: The index of the query in the "formulas" array (or "queries" array if no "formulas" was specified).
example: 0
@@ -121103,14 +121164,14 @@ components:
The second element describes the "per unit" (for example, `second` in `bytes per second`).
If the second element is not present, the API returns null.
items:
- $ref: "#/components/schemas/Unit"
+ $ref: '#/components/schemas/Unit'
nullable: true
type: array
type: object
TimeseriesResponseSeriesList:
description: Array of response series. The index here corresponds to the index in the `formulas` or `queries` array from the request.
items:
- $ref: "#/components/schemas/TimeseriesResponseSeries"
+ $ref: '#/components/schemas/TimeseriesResponseSeries'
type: array
TimeseriesResponseTimes:
description: Array of times, 1-1 match with individual values arrays.
@@ -121132,7 +121193,7 @@ components:
TimeseriesResponseValuesList:
description: Array of value-arrays. The index here corresponds to the index in the `formulas` or `queries` array from the request.
items:
- $ref: "#/components/schemas/TimeseriesResponseValues"
+ $ref: '#/components/schemas/TimeseriesResponseValues'
type: array
TokenName:
description: Name for tokens.
@@ -121171,7 +121232,7 @@ components:
example: Response.json.then
type: string
stats_per_view:
- $ref: "#/components/schemas/LongTaskStatsPerView"
+ $ref: '#/components/schemas/LongTaskStatsPerView'
view_occurrences:
description: Number of sampled views where this invoker had any long tasks.
example: 68
@@ -121192,7 +121253,7 @@ components:
example: false
type: boolean
spans:
- $ref: "#/components/schemas/APMTraceSpans"
+ $ref: '#/components/schemas/APMTraceSpans'
required:
- is_truncated
- spans
@@ -121201,13 +121262,13 @@ components:
description: A trace resource document.
properties:
attributes:
- $ref: "#/components/schemas/TraceAttributes"
+ $ref: '#/components/schemas/TraceAttributes'
id:
description: The full 128-bit trace ID, encoded as a 32-character hexadecimal string.
example: "0000000000000000abc1230000000000"
type: string
type:
- $ref: "#/components/schemas/TraceType"
+ $ref: '#/components/schemas/TraceType'
required:
- id
- type
@@ -121217,7 +121278,7 @@ components:
description: Response containing a single trace.
properties:
data:
- $ref: "#/components/schemas/TraceData"
+ $ref: '#/components/schemas/TraceData'
required:
- data
type: object
@@ -121232,40 +121293,40 @@ components:
Trigger:
description: "One of the triggers that can start the execution of a workflow."
oneOf:
- - $ref: "#/components/schemas/AgentTriggerWrapper"
- - $ref: "#/components/schemas/APITriggerWrapper"
- - $ref: "#/components/schemas/AppTriggerWrapper"
- - $ref: "#/components/schemas/CaseTriggerWrapper"
- - $ref: "#/components/schemas/ChangeEventTriggerWrapper"
- - $ref: "#/components/schemas/DatabaseMonitoringTriggerWrapper"
- - $ref: "#/components/schemas/DatastoreTriggerWrapper"
- - $ref: "#/components/schemas/DashboardTriggerWrapper"
- - $ref: "#/components/schemas/FormTriggerWrapper"
- - $ref: "#/components/schemas/GithubWebhookTriggerWrapper"
- - $ref: "#/components/schemas/IncidentCreatedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentImpactCreatedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentImpactUpdatedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentPostmortemUpdatedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentResponderCreatedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentSavedTriggerWrapper"
- - $ref: "#/components/schemas/IncidentScheduleTriggerWrapper"
- - $ref: "#/components/schemas/IncidentTriggerWrapper"
- - $ref: "#/components/schemas/MonitorTriggerWrapper"
- - $ref: "#/components/schemas/NotebookTriggerWrapper"
- - $ref: "#/components/schemas/OnCallTriggerWrapper"
- - $ref: "#/components/schemas/ScheduleTriggerWrapper"
- - $ref: "#/components/schemas/SecurityTriggerWrapper"
- - $ref: "#/components/schemas/SelfServiceTriggerWrapper"
- - $ref: "#/components/schemas/SlackTriggerWrapper"
- - $ref: "#/components/schemas/SoftwareCatalogTriggerWrapper"
- - $ref: "#/components/schemas/WorkflowTriggerWrapper"
+ - $ref: '#/components/schemas/AgentTriggerWrapper'
+ - $ref: '#/components/schemas/APITriggerWrapper'
+ - $ref: '#/components/schemas/AppTriggerWrapper'
+ - $ref: '#/components/schemas/CaseTriggerWrapper'
+ - $ref: '#/components/schemas/ChangeEventTriggerWrapper'
+ - $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper'
+ - $ref: '#/components/schemas/DatastoreTriggerWrapper'
+ - $ref: '#/components/schemas/DashboardTriggerWrapper'
+ - $ref: '#/components/schemas/FormTriggerWrapper'
+ - $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentCreatedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentImpactCreatedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentImpactUpdatedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentPostmortemUpdatedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentResponderCreatedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentSavedTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentScheduleTriggerWrapper'
+ - $ref: '#/components/schemas/IncidentTriggerWrapper'
+ - $ref: '#/components/schemas/MonitorTriggerWrapper'
+ - $ref: '#/components/schemas/NotebookTriggerWrapper'
+ - $ref: '#/components/schemas/OnCallTriggerWrapper'
+ - $ref: '#/components/schemas/ScheduleTriggerWrapper'
+ - $ref: '#/components/schemas/SecurityTriggerWrapper'
+ - $ref: '#/components/schemas/SelfServiceTriggerWrapper'
+ - $ref: '#/components/schemas/SlackTriggerWrapper'
+ - $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper'
+ - $ref: '#/components/schemas/WorkflowTriggerWrapper'
TriggerAttributes:
description: The trigger definition for starting an investigation.
properties:
monitor_alert_trigger:
- $ref: "#/components/schemas/MonitorAlertTriggerAttributes"
+ $ref: '#/components/schemas/MonitorAlertTriggerAttributes'
type:
- $ref: "#/components/schemas/TriggerType"
+ $ref: '#/components/schemas/TriggerType'
required:
- type
- monitor_alert_trigger
@@ -121274,7 +121335,7 @@ components:
description: Request to trigger a new investigation.
properties:
data:
- $ref: "#/components/schemas/TriggerInvestigationRequestData"
+ $ref: '#/components/schemas/TriggerInvestigationRequestData'
required:
- data
type: object
@@ -121282,9 +121343,9 @@ components:
description: Data for the trigger investigation request.
properties:
attributes:
- $ref: "#/components/schemas/TriggerInvestigationRequestDataAttributes"
+ $ref: '#/components/schemas/TriggerInvestigationRequestDataAttributes'
type:
- $ref: "#/components/schemas/TriggerInvestigationRequestType"
+ $ref: '#/components/schemas/TriggerInvestigationRequestType'
required:
- type
- attributes
@@ -121293,7 +121354,7 @@ components:
description: Attributes for the trigger investigation request.
properties:
trigger:
- $ref: "#/components/schemas/TriggerAttributes"
+ $ref: '#/components/schemas/TriggerAttributes'
required:
- trigger
type: object
@@ -121309,7 +121370,7 @@ components:
description: Response after triggering an investigation.
properties:
data:
- $ref: "#/components/schemas/TriggerInvestigationResponseData"
+ $ref: '#/components/schemas/TriggerInvestigationResponseData'
required:
- data
type: object
@@ -121317,13 +121378,13 @@ components:
description: Data for the trigger investigation response.
properties:
attributes:
- $ref: "#/components/schemas/TriggerInvestigationResponseDataAttributes"
+ $ref: '#/components/schemas/TriggerInvestigationResponseDataAttributes'
id:
description: Unique identifier for the trigger response.
example: "f5e6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b"
type: string
type:
- $ref: "#/components/schemas/TriggerInvestigationResponseType"
+ $ref: '#/components/schemas/TriggerInvestigationResponseType'
required:
- id
- type
@@ -121386,7 +121447,7 @@ components:
example: my-workflow-handle
type: string
type:
- $ref: "#/components/schemas/TriggerWorkflowAutomationActionType"
+ $ref: '#/components/schemas/TriggerWorkflowAutomationActionType'
required:
- type
- handle
@@ -121416,7 +121477,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
TwilioCallSummariesLogsIntegrationDataflowRequest:
description: The Twilio call summaries logs dataflow.
@@ -121434,7 +121495,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
TwilioCloudCostMetricsIntegrationDataflowRequest:
description: The Twilio cloud cost metrics dataflow.
@@ -121452,7 +121513,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
TwilioEventsLogsIntegrationDataflowRequest:
description: The Twilio events logs dataflow.
@@ -121470,33 +121531,33 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
TwilioIntegrationAccountAuthenticationRequest:
description: Authentication for creating the Twilio integration account. Exactly one method is set.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthRequest"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthRequest'
TwilioIntegrationAccountAuthenticationResponse:
description: Authentication configured on the Twilio integration account.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthResponse"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthResponse'
TwilioIntegrationAccountAuthenticationUpdate:
description: Authentication for updating the Twilio integration account. Exactly one method is set.
oneOf:
- - $ref: "#/components/schemas/IntegrationAccountBasicAuthUpdate"
+ - $ref: '#/components/schemas/IntegrationAccountBasicAuthUpdate'
TwilioIntegrationAccountCreateAttributes:
description: Writable attributes used to create a Twilio integration account.
properties:
authentication:
- $ref: "#/components/schemas/TwilioIntegrationAccountAuthenticationRequest"
+ $ref: '#/components/schemas/TwilioIntegrationAccountAuthenticationRequest'
dataflows:
- $ref: "#/components/schemas/TwilioIntegrationDataflowsRequest"
+ $ref: '#/components/schemas/TwilioIntegrationDataflowsRequest'
name:
description: Human-readable name of the Twilio integration account.
example: twilio-prod
type: string
settings:
- $ref: "#/components/schemas/TwilioIntegrationAccountSettingsRequest"
+ $ref: '#/components/schemas/TwilioIntegrationAccountSettingsRequest'
required:
- name
- authentication
@@ -121506,9 +121567,9 @@ components:
description: Data envelope for creating a Twilio integration account.
properties:
attributes:
- $ref: "#/components/schemas/TwilioIntegrationAccountCreateAttributes"
+ $ref: '#/components/schemas/TwilioIntegrationAccountCreateAttributes'
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- type
- attributes
@@ -121517,7 +121578,7 @@ components:
description: Request payload to create a Twilio integration account.
properties:
data:
- $ref: "#/components/schemas/TwilioIntegrationAccountCreateData"
+ $ref: '#/components/schemas/TwilioIntegrationAccountCreateData'
required:
- data
type: object
@@ -121525,7 +121586,7 @@ components:
description: Response payload for a single Twilio integration account.
properties:
data:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponseData"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponseData'
required:
- data
type: object
@@ -121533,15 +121594,15 @@ components:
description: Attributes of a Twilio integration account returned in responses.
properties:
authentication:
- $ref: "#/components/schemas/TwilioIntegrationAccountAuthenticationResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountAuthenticationResponse'
dataflows:
- $ref: "#/components/schemas/TwilioIntegrationDataflowsResponse"
+ $ref: '#/components/schemas/TwilioIntegrationDataflowsResponse'
name:
description: Human-readable name of the Twilio integration account.
example: twilio-prod
type: string
settings:
- $ref: "#/components/schemas/TwilioIntegrationAccountSettingsResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountSettingsResponse'
required:
- name
- settings
@@ -121550,14 +121611,14 @@ components:
description: Data envelope of a Twilio integration account, including server-assigned identity.
properties:
attributes:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponseAttributes"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponseAttributes'
id:
description: Server-generated unique identifier of the Twilio integration account.
example: 953a0060-81ec-4221-aed4-d4733b59cd96
readOnly: true
type: string
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- id
- attributes
@@ -121608,27 +121669,27 @@ components:
Writable attributes used to update a Twilio integration account. Every field is optional; only the fields provided are changed. When `dataflows` is provided, only the dataflow ids included in the request are modified; dataflows omitted from the map keep their current configuration.
properties:
authentication:
- $ref: "#/components/schemas/TwilioIntegrationAccountAuthenticationUpdate"
+ $ref: '#/components/schemas/TwilioIntegrationAccountAuthenticationUpdate'
dataflows:
- $ref: "#/components/schemas/TwilioIntegrationDataflowsRequest"
+ $ref: '#/components/schemas/TwilioIntegrationDataflowsRequest'
name:
description: Human-readable name of the Twilio integration account.
example: twilio-prod
type: string
settings:
- $ref: "#/components/schemas/TwilioIntegrationAccountSettingsUpdate"
+ $ref: '#/components/schemas/TwilioIntegrationAccountSettingsUpdate'
type: object
TwilioIntegrationAccountUpdateData:
description: Data envelope for updating a Twilio integration account.
properties:
attributes:
- $ref: "#/components/schemas/TwilioIntegrationAccountUpdateAttributes"
+ $ref: '#/components/schemas/TwilioIntegrationAccountUpdateAttributes'
id:
description: Unique identifier of the Twilio integration account to update.
example: 953a0060-81ec-4221-aed4-d4733b59cd96
type: string
type:
- $ref: "#/components/schemas/IntegrationAccountType"
+ $ref: '#/components/schemas/IntegrationAccountType'
required:
- id
- type
@@ -121638,7 +121699,7 @@ components:
description: Request payload to update a Twilio integration account.
properties:
data:
- $ref: "#/components/schemas/TwilioIntegrationAccountUpdateData"
+ $ref: '#/components/schemas/TwilioIntegrationAccountUpdateData'
required:
- data
type: object
@@ -121648,7 +121709,7 @@ components:
data:
description: List of Twilio integration accounts.
items:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponseData"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponseData'
type: array
required:
- data
@@ -121658,29 +121719,29 @@ components:
description: Dataflows to configure on the Twilio integration account, keyed by dataflow id.
properties:
twilio-alerts-logs:
- $ref: "#/components/schemas/TwilioAlertsLogsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/TwilioAlertsLogsIntegrationDataflowRequest'
twilio-call-summaries-logs:
- $ref: "#/components/schemas/TwilioCallSummariesLogsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/TwilioCallSummariesLogsIntegrationDataflowRequest'
twilio-cloud-cost-metrics:
- $ref: "#/components/schemas/TwilioCloudCostMetricsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/TwilioCloudCostMetricsIntegrationDataflowRequest'
twilio-events-logs:
- $ref: "#/components/schemas/TwilioEventsLogsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/TwilioEventsLogsIntegrationDataflowRequest'
twilio-messages-logs:
- $ref: "#/components/schemas/TwilioMessagesLogsIntegrationDataflowRequest"
+ $ref: '#/components/schemas/TwilioMessagesLogsIntegrationDataflowRequest'
type: object
TwilioIntegrationDataflowsResponse:
description: Dataflows configured on the Twilio integration account, keyed by dataflow id.
properties:
twilio-alerts-logs:
- $ref: "#/components/schemas/TwilioAlertsLogsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/TwilioAlertsLogsIntegrationDataflowResponse'
twilio-call-summaries-logs:
- $ref: "#/components/schemas/TwilioCallSummariesLogsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/TwilioCallSummariesLogsIntegrationDataflowResponse'
twilio-cloud-cost-metrics:
- $ref: "#/components/schemas/TwilioCloudCostMetricsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/TwilioCloudCostMetricsIntegrationDataflowResponse'
twilio-events-logs:
- $ref: "#/components/schemas/TwilioEventsLogsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/TwilioEventsLogsIntegrationDataflowResponse'
twilio-messages-logs:
- $ref: "#/components/schemas/TwilioMessagesLogsIntegrationDataflowResponse"
+ $ref: '#/components/schemas/TwilioMessagesLogsIntegrationDataflowResponse'
type: object
TwilioMessagesLogsIntegrationDataflowRequest:
description: The Twilio messages logs dataflow.
@@ -121698,7 +121759,7 @@ components:
example: true
type: boolean
status:
- $ref: "#/components/schemas/IntegrationAccountDataflowStatus"
+ $ref: '#/components/schemas/IntegrationAccountDataflowStatus'
type: object
UCConfigPair:
description: The definition of `UCConfigPair` object.
@@ -121725,18 +121786,18 @@ components:
type: azure_uc_configs
properties:
data:
- $ref: "#/components/schemas/UCConfigPairData"
+ $ref: '#/components/schemas/UCConfigPairData'
type: object
UCConfigPairData:
description: The definition of `UCConfigPairData` object.
properties:
attributes:
- $ref: "#/components/schemas/UCConfigPairDataAttributes"
+ $ref: '#/components/schemas/UCConfigPairDataAttributes'
id:
description: The `UCConfigPairData` `id`.
type: string
type:
- $ref: "#/components/schemas/UCConfigPairDataType"
+ $ref: '#/components/schemas/UCConfigPairDataType'
required:
- type
type: object
@@ -121746,7 +121807,7 @@ components:
configs:
description: The `attributes` `configs`.
items:
- $ref: "#/components/schemas/UCConfigPairDataAttributesConfigsItems"
+ $ref: '#/components/schemas/UCConfigPairDataAttributesConfigsItems'
type: array
type: object
UCConfigPairDataAttributesConfigsItems:
@@ -121884,13 +121945,13 @@ components:
description: The response object after an app is successfully unpublished.
properties:
data:
- $ref: "#/components/schemas/Deployment"
+ $ref: '#/components/schemas/Deployment'
type: object
UpdateActionConnectionRequest:
description: Request used to update an action connection.
properties:
data:
- $ref: "#/components/schemas/ActionConnectionDataUpdate"
+ $ref: '#/components/schemas/ActionConnectionDataUpdate'
required:
- data
type: object
@@ -121898,7 +121959,7 @@ components:
description: The response for an updated connection.
properties:
data:
- $ref: "#/components/schemas/ActionConnectionData"
+ $ref: '#/components/schemas/ActionConnectionData'
type: object
UpdateAppFavoriteRequest:
description: A request to add or remove an app from the current user's favorites.
@@ -121909,15 +121970,15 @@ components:
type: favorites
properties:
data:
- $ref: "#/components/schemas/UpdateAppFavoriteRequestData"
+ $ref: '#/components/schemas/UpdateAppFavoriteRequestData'
type: object
UpdateAppFavoriteRequestData:
description: Data for updating an app's favorite status.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppFavoriteRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppFavoriteRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppFavoriteType"
+ $ref: '#/components/schemas/AppFavoriteType'
type: object
UpdateAppFavoriteRequestDataAttributes:
description: Attributes for updating an app's favorite status.
@@ -121938,21 +121999,21 @@ components:
type: protectionLevel
properties:
data:
- $ref: "#/components/schemas/UpdateAppProtectionLevelRequestData"
+ $ref: '#/components/schemas/UpdateAppProtectionLevelRequestData'
type: object
UpdateAppProtectionLevelRequestData:
description: Data for updating an app's publication protection level.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppProtectionLevelRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppProtectionLevelRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppProtectionLevelType"
+ $ref: '#/components/schemas/AppProtectionLevelType'
type: object
UpdateAppProtectionLevelRequestDataAttributes:
description: Attributes for updating an app's publication protection level.
properties:
protectionLevel:
- $ref: "#/components/schemas/AppProtectionLevel"
+ $ref: '#/components/schemas/AppProtectionLevel'
required:
- protectionLevel
type: object
@@ -121999,20 +122060,20 @@ components:
type: appDefinitions
properties:
data:
- $ref: "#/components/schemas/UpdateAppRequestData"
+ $ref: '#/components/schemas/UpdateAppRequestData'
type: object
UpdateAppRequestData:
description: The data object containing the new app definition. Any fields not included in the request remain unchanged.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppRequestDataAttributes'
id:
description: The ID of the app to update. The app ID must match the ID in the URL path.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- type
type: object
@@ -122022,7 +122083,7 @@ components:
components:
description: The new UI components that make up the app. If this field is set, all existing components are replaced with the new components under this field.
items:
- $ref: "#/components/schemas/ComponentGrid"
+ $ref: '#/components/schemas/ComponentGrid'
type: array
description:
description: The new human-readable description for the app.
@@ -122033,7 +122094,7 @@ components:
queries:
description: The new array of queries, such as external actions and state variables, that the app uses. If this field is set, all existing queries are replaced with the new queries under this field.
items:
- $ref: "#/components/schemas/Query"
+ $ref: '#/components/schemas/Query'
type: array
rootInstanceName:
description: The new name of the root component of the app. This must be a `grid` component that contains all other components.
@@ -122052,29 +122113,29 @@ components:
description: The response object after an app is successfully updated.
properties:
data:
- $ref: "#/components/schemas/UpdateAppResponseData"
+ $ref: '#/components/schemas/UpdateAppResponseData'
included:
description: Data on the version of the app that was published.
items:
- $ref: "#/components/schemas/Deployment"
+ $ref: '#/components/schemas/Deployment'
type: array
meta:
- $ref: "#/components/schemas/AppMeta"
+ $ref: '#/components/schemas/AppMeta'
relationship:
- $ref: "#/components/schemas/AppRelationship"
+ $ref: '#/components/schemas/AppRelationship'
type: object
UpdateAppResponseData:
description: The data object containing the updated app definition.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppResponseDataAttributes"
+ $ref: '#/components/schemas/UpdateAppResponseDataAttributes'
id:
description: The ID of the updated app.
example: 65bb1f25-52e1-4510-9f8d-22d1516ed693
format: uuid
type: string
type:
- $ref: "#/components/schemas/AppDefinitionType"
+ $ref: '#/components/schemas/AppDefinitionType'
required:
- id
- type
@@ -122086,7 +122147,7 @@ components:
components:
description: The UI components that make up the app.
items:
- $ref: "#/components/schemas/ComponentGrid"
+ $ref: '#/components/schemas/ComponentGrid'
type: array
description:
description: The human-readable description for the app.
@@ -122100,7 +122161,7 @@ components:
queries:
description: An array of queries, such as external actions and state variables, that the app uses.
items:
- $ref: "#/components/schemas/Query"
+ $ref: '#/components/schemas/Query'
type: array
rootInstanceName:
description: The name of the root component of the app. This must be a `grid` component that contains all other components.
@@ -122124,15 +122185,15 @@ components:
type: selfService
properties:
data:
- $ref: "#/components/schemas/UpdateAppSelfServiceRequestData"
+ $ref: '#/components/schemas/UpdateAppSelfServiceRequestData'
type: object
UpdateAppSelfServiceRequestData:
description: Data for updating an app's self-service status.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppSelfServiceRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppSelfServiceRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppSelfServiceType"
+ $ref: '#/components/schemas/AppSelfServiceType'
type: object
UpdateAppSelfServiceRequestDataAttributes:
description: Attributes for updating an app's self-service status.
@@ -122155,15 +122216,15 @@ components:
type: tags
properties:
data:
- $ref: "#/components/schemas/UpdateAppTagsRequestData"
+ $ref: '#/components/schemas/UpdateAppTagsRequestData'
type: object
UpdateAppTagsRequestData:
description: Data for replacing an app's tags.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppTagsRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppTagsRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppTagsType"
+ $ref: '#/components/schemas/AppTagsType'
type: object
UpdateAppTagsRequestDataAttributes:
description: Attributes for replacing an app's tags.
@@ -122188,15 +122249,15 @@ components:
type: versionNames
properties:
data:
- $ref: "#/components/schemas/UpdateAppVersionNameRequestData"
+ $ref: '#/components/schemas/UpdateAppVersionNameRequestData'
type: object
UpdateAppVersionNameRequestData:
description: Data for naming a specific app version.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppVersionNameRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppVersionNameRequestDataAttributes'
type:
- $ref: "#/components/schemas/AppVersionNameType"
+ $ref: '#/components/schemas/AppVersionNameType'
type: object
UpdateAppVersionNameRequestDataAttributes:
description: Attributes for naming a specific app version.
@@ -122212,18 +122273,18 @@ components:
description: Request to update specific fields on an existing datastore item.
properties:
data:
- $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestData"
+ $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestData'
type: object
UpdateAppsDatastoreItemRequestData:
description: Data wrapper containing the item identifier and the changes to apply during the update operation.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributes'
id:
description: The unique identifier of the datastore item.
type: string
type:
- $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataType"
+ $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataType'
required:
- type
type: object
@@ -122234,7 +122295,7 @@ components:
description: The unique identifier of the item being updated.
type: string
item_changes:
- $ref: "#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributesItemChanges"
+ $ref: '#/components/schemas/UpdateAppsDatastoreItemRequestDataAttributesItemChanges'
item_key:
description: The primary key that identifies the item to update. Cannot exceed 256 characters.
example: ""
@@ -122265,18 +122326,18 @@ components:
description: Request to update a datastore's configuration such as its name or description.
properties:
data:
- $ref: "#/components/schemas/UpdateAppsDatastoreRequestData"
+ $ref: '#/components/schemas/UpdateAppsDatastoreRequestData'
type: object
UpdateAppsDatastoreRequestData:
description: Data wrapper containing the datastore identifier and the attributes to update.
properties:
attributes:
- $ref: "#/components/schemas/UpdateAppsDatastoreRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateAppsDatastoreRequestDataAttributes'
id:
description: The unique identifier of the datastore to update.
type: string
type:
- $ref: "#/components/schemas/DatastoreDataType"
+ $ref: '#/components/schemas/DatastoreDataType'
required:
- type
type: object
@@ -122294,7 +122355,7 @@ components:
description: Request to update a campaign.
properties:
data:
- $ref: "#/components/schemas/UpdateCampaignRequestData"
+ $ref: '#/components/schemas/UpdateCampaignRequestData'
required:
- data
type: object
@@ -122357,9 +122418,9 @@ components:
description: Data for updating a campaign.
properties:
attributes:
- $ref: "#/components/schemas/UpdateCampaignRequestAttributes"
+ $ref: '#/components/schemas/UpdateCampaignRequestAttributes'
type:
- $ref: "#/components/schemas/CampaignType"
+ $ref: '#/components/schemas/CampaignType'
required:
- type
- attributes
@@ -122390,19 +122451,19 @@ components:
type: connection_id
properties:
data:
- $ref: "#/components/schemas/UpdateConnectionRequestData"
+ $ref: '#/components/schemas/UpdateConnectionRequestData'
type: object
UpdateConnectionRequestData:
description: The data object containing the resource identifier and attributes for updating an existing connection.
properties:
attributes:
- $ref: "#/components/schemas/UpdateConnectionRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateConnectionRequestDataAttributes'
id:
description: The unique identifier of the connection to update.
example: ""
type: string
type:
- $ref: "#/components/schemas/UpdateConnectionRequestDataType"
+ $ref: '#/components/schemas/UpdateConnectionRequestDataType'
required:
- type
- id
@@ -122413,7 +122474,7 @@ components:
fields_to_add:
description: New fields to add to the connection from the data source.
items:
- $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems"
+ $ref: '#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems'
type: array
fields_to_delete:
description: Identifiers of existing fields to remove from the connection.
@@ -122424,7 +122485,7 @@ components:
fields_to_update:
description: Existing fields with updated metadata to apply to the connection.
items:
- $ref: "#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems"
+ $ref: '#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems'
type: array
type: object
UpdateConnectionRequestDataAttributesFieldsToUpdateItems:
@@ -122465,7 +122526,7 @@ components:
description: Request object to update a custom framework.
properties:
data:
- $ref: "#/components/schemas/CustomFrameworkData"
+ $ref: '#/components/schemas/CustomFrameworkData'
required:
- data
type: object
@@ -122473,7 +122534,7 @@ components:
description: Response object to update a custom framework.
properties:
data:
- $ref: "#/components/schemas/FrameworkHandleAndVersionResponseData"
+ $ref: '#/components/schemas/FrameworkHandleAndVersionResponseData'
required:
- data
type: object
@@ -122481,7 +122542,7 @@ components:
description: Parameters for updating a deployment gate.
properties:
data:
- $ref: "#/components/schemas/UpdateDeploymentGateParamsData"
+ $ref: '#/components/schemas/UpdateDeploymentGateParamsData'
required:
- data
type: object
@@ -122489,13 +122550,13 @@ components:
description: Parameters for updating a deployment gate.
properties:
attributes:
- $ref: "#/components/schemas/UpdateDeploymentGateParamsDataAttributes"
+ $ref: '#/components/schemas/UpdateDeploymentGateParamsDataAttributes'
id:
description: Unique identifier of the deployment gate.
example: "12345678-1234-1234-1234-123456789012"
type: string
type:
- $ref: "#/components/schemas/DeploymentGateDataType"
+ $ref: '#/components/schemas/DeploymentGateDataType'
required:
- type
- id
@@ -122515,7 +122576,7 @@ components:
description: Parameters for updating a deployment rule.
properties:
data:
- $ref: "#/components/schemas/UpdateDeploymentRuleParamsData"
+ $ref: '#/components/schemas/UpdateDeploymentRuleParamsData'
required:
- data
type: object
@@ -122523,9 +122584,9 @@ components:
description: Parameters for updating a deployment rule.
properties:
attributes:
- $ref: "#/components/schemas/UpdateDeploymentRuleParamsDataAttributes"
+ $ref: '#/components/schemas/UpdateDeploymentRuleParamsDataAttributes'
type:
- $ref: "#/components/schemas/DeploymentRuleDataType"
+ $ref: '#/components/schemas/DeploymentRuleDataType'
required:
- type
- attributes
@@ -122542,7 +122603,7 @@ components:
example: "Updated deployment rule"
type: string
options:
- $ref: "#/components/schemas/DeploymentRulesOptions"
+ $ref: '#/components/schemas/DeploymentRulesOptions'
required:
- dry_run
- name
@@ -122576,9 +122637,9 @@ components:
description: Data for updating an environment.
properties:
attributes:
- $ref: "#/components/schemas/UpdateEnvironmentAttributes"
+ $ref: '#/components/schemas/UpdateEnvironmentAttributes'
type:
- $ref: "#/components/schemas/UpdateEnvironmentDataType"
+ $ref: '#/components/schemas/UpdateEnvironmentDataType'
required:
- type
- attributes
@@ -122595,7 +122656,7 @@ components:
description: Request to update an environment.
properties:
data:
- $ref: "#/components/schemas/UpdateEnvironmentData"
+ $ref: '#/components/schemas/UpdateEnvironmentData'
required:
- data
type: object
@@ -122620,9 +122681,9 @@ components:
description: Data for updating a feature flag.
properties:
attributes:
- $ref: "#/components/schemas/UpdateFeatureFlagAttributes"
+ $ref: '#/components/schemas/UpdateFeatureFlagAttributes'
type:
- $ref: "#/components/schemas/UpdateFeatureFlagDataType"
+ $ref: '#/components/schemas/UpdateFeatureFlagDataType'
required:
- type
- attributes
@@ -122639,7 +122700,7 @@ components:
description: Request to update a feature flag.
properties:
data:
- $ref: "#/components/schemas/UpdateFeatureFlagData"
+ $ref: '#/components/schemas/UpdateFeatureFlagData'
required:
- data
type: object
@@ -122647,7 +122708,7 @@ components:
description: Request to update the state of multiple flaky tests.
properties:
data:
- $ref: "#/components/schemas/UpdateFlakyTestsRequestData"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequestData'
required:
- data
type: object
@@ -122657,7 +122718,7 @@ components:
tests:
description: List of flaky tests to update.
items:
- $ref: "#/components/schemas/UpdateFlakyTestsRequestTest"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequestTest'
type: array
required:
- tests
@@ -122666,9 +122727,9 @@ components:
description: The JSON:API data for updating flaky test states.
properties:
attributes:
- $ref: "#/components/schemas/UpdateFlakyTestsRequestAttributes"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequestAttributes'
type:
- $ref: "#/components/schemas/UpdateFlakyTestsRequestDataType"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequestDataType'
required:
- type
- attributes
@@ -122693,7 +122754,7 @@ components:
example: 4eb1887a8adb1847
type: string
new_state:
- $ref: "#/components/schemas/UpdateFlakyTestsRequestTestNewState"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequestTestNewState'
required:
- id
- new_state
@@ -122716,7 +122777,7 @@ components:
description: Response object for updating flaky test states.
properties:
data:
- $ref: "#/components/schemas/UpdateFlakyTestsResponseData"
+ $ref: '#/components/schemas/UpdateFlakyTestsResponseData'
type: object
UpdateFlakyTestsResponseAttributes:
description: Attributes for the update flaky test state response.
@@ -122728,7 +122789,7 @@ components:
results:
description: Results of the update operation for each test.
items:
- $ref: "#/components/schemas/UpdateFlakyTestsResponseResult"
+ $ref: '#/components/schemas/UpdateFlakyTestsResponseResult'
type: array
required:
- has_errors
@@ -122738,12 +122799,12 @@ components:
description: Summary of the update operations. Tells whether a test succeeded or failed to be updated.
properties:
attributes:
- $ref: "#/components/schemas/UpdateFlakyTestsResponseAttributes"
+ $ref: '#/components/schemas/UpdateFlakyTestsResponseAttributes'
id:
description: The ID of the response.
type: string
type:
- $ref: "#/components/schemas/UpdateFlakyTestsResponseDataType"
+ $ref: '#/components/schemas/UpdateFlakyTestsResponseDataType'
type: object
UpdateFlakyTestsResponseDataType:
description: The definition of `UpdateFlakyTestsResponseDataType` object.
@@ -122777,14 +122838,14 @@ components:
description: The data for updating a form.
properties:
attributes:
- $ref: "#/components/schemas/UpdateFormDataAttributes"
+ $ref: '#/components/schemas/UpdateFormDataAttributes'
id:
description: The ID of the form.
example: 22f6006a-2302-4926-9396-d2dfcf7b0b34
format: uuid
type: string
type:
- $ref: "#/components/schemas/FormType"
+ $ref: '#/components/schemas/FormType'
required:
- type
- attributes
@@ -122793,7 +122854,7 @@ components:
description: The attributes for updating a form.
properties:
form_update:
- $ref: "#/components/schemas/FormUpdateAttributes"
+ $ref: '#/components/schemas/FormUpdateAttributes'
required:
- form_update
type: object
@@ -122801,7 +122862,7 @@ components:
description: A request to update a form.
properties:
data:
- $ref: "#/components/schemas/UpdateFormData"
+ $ref: '#/components/schemas/UpdateFormData'
required:
- data
type: object
@@ -122824,7 +122885,7 @@ components:
type: notification_rules
properties:
data:
- $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequestData"
+ $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestData'
required:
- data
type: object
@@ -122832,7 +122893,7 @@ components:
description: Attributes for creating or modifying an on-call notification rule.
properties:
category:
- $ref: "#/components/schemas/OnCallNotificationRuleCategory"
+ $ref: '#/components/schemas/OnCallNotificationRuleCategory'
channel_settings:
$ref: "#/components/schemas/OnCallNotificationRuleChannelSettings"
description: Configuration for the associated channel, if necessary
@@ -122846,14 +122907,14 @@ components:
description: Data for updating an on-call notification rule
properties:
attributes:
- $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes"
+ $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequestAttributes'
id:
description: Unique identifier for the rule
type: string
relationships:
- $ref: "#/components/schemas/OnCallNotificationRuleRelationships"
+ $ref: '#/components/schemas/OnCallNotificationRuleRelationships'
type:
- $ref: "#/components/schemas/OnCallNotificationRuleType"
+ $ref: '#/components/schemas/OnCallNotificationRuleType'
required:
- type
type: object
@@ -122861,7 +122922,7 @@ components:
description: Response for `UpdateOpenAPI`.
properties:
data:
- $ref: "#/components/schemas/UpdateOpenAPIResponseData"
+ $ref: '#/components/schemas/UpdateOpenAPIResponseData'
type: object
UpdateOpenAPIResponseAttributes:
description: Attributes for `UpdateOpenAPI`.
@@ -122869,16 +122930,16 @@ components:
failed_endpoints:
description: List of endpoints which couldn't be parsed.
items:
- $ref: "#/components/schemas/OpenAPIEndpoint"
+ $ref: '#/components/schemas/OpenAPIEndpoint'
type: array
type: object
UpdateOpenAPIResponseData:
description: Data envelope for `UpdateOpenAPIResponse`.
properties:
attributes:
- $ref: "#/components/schemas/UpdateOpenAPIResponseAttributes"
+ $ref: '#/components/schemas/UpdateOpenAPIResponseAttributes'
id:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
type: object
UpdateOutcomesAsyncAttributes:
description: The JSON:API attributes for a batched set of scorecard outcomes.
@@ -122886,37 +122947,37 @@ components:
results:
description: Set of scorecard outcomes to update asynchronously.
items:
- $ref: "#/components/schemas/UpdateOutcomesAsyncRequestItem"
+ $ref: '#/components/schemas/UpdateOutcomesAsyncRequestItem'
type: array
type: object
UpdateOutcomesAsyncRequest:
description: Scorecard outcomes batch request.
properties:
data:
- $ref: "#/components/schemas/UpdateOutcomesAsyncRequestData"
+ $ref: '#/components/schemas/UpdateOutcomesAsyncRequestData'
type: object
UpdateOutcomesAsyncRequestData:
description: Scorecard outcomes batch request data.
properties:
attributes:
- $ref: "#/components/schemas/UpdateOutcomesAsyncAttributes"
+ $ref: '#/components/schemas/UpdateOutcomesAsyncAttributes'
type:
- $ref: "#/components/schemas/UpdateOutcomesAsyncType"
+ $ref: '#/components/schemas/UpdateOutcomesAsyncType'
type: object
UpdateOutcomesAsyncRequestItem:
description: Scorecard outcome for a single entity and rule.
properties:
entity_reference:
- $ref: "#/components/schemas/EntityReference"
+ $ref: '#/components/schemas/EntityReference'
remarks:
description: >-
Any remarks regarding the scorecard rule's evaluation. Supports HTML hyperlinks.
example: 'See: Services'
type: string
rule_id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
state:
- $ref: "#/components/schemas/State"
+ $ref: '#/components/schemas/State'
required:
- rule_id
- entity_reference
@@ -122933,7 +122994,7 @@ components:
description: Request object to update a resource filter.
properties:
data:
- $ref: "#/components/schemas/UpdateResourceEvaluationFiltersRequestData"
+ $ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequestData'
required:
- data
type: object
@@ -122941,13 +123002,13 @@ components:
description: The definition of `UpdateResourceFilterRequestData` object.
properties:
attributes:
- $ref: "#/components/schemas/ResourceFilterAttributes"
+ $ref: '#/components/schemas/ResourceFilterAttributes'
id:
description: The `UpdateResourceEvaluationFiltersRequestData` `id`.
example: csm_resource_filter
type: string
type:
- $ref: "#/components/schemas/ResourceFilterRequestType"
+ $ref: '#/components/schemas/ResourceFilterRequestType'
required:
- attributes
- type
@@ -122956,7 +123017,7 @@ components:
description: The definition of `UpdateResourceEvaluationFiltersResponse` object.
properties:
data:
- $ref: "#/components/schemas/UpdateResourceEvaluationFiltersResponseData"
+ $ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponseData'
required:
- data
type: object
@@ -122964,13 +123025,13 @@ components:
description: The definition of `UpdateResourceFilterResponseData` object.
properties:
attributes:
- $ref: "#/components/schemas/ResourceFilterAttributes"
+ $ref: '#/components/schemas/ResourceFilterAttributes'
id:
description: The `data` `id`.
example: csm_resource_filter
type: string
type:
- $ref: "#/components/schemas/ResourceFilterRequestType"
+ $ref: '#/components/schemas/ResourceFilterRequestType'
required:
- attributes
- type
@@ -122979,33 +123040,33 @@ components:
description: Request to update a scorecard rule.
properties:
data:
- $ref: "#/components/schemas/UpdateRuleRequestData"
+ $ref: '#/components/schemas/UpdateRuleRequestData'
type: object
UpdateRuleRequestData:
description: Data for the request to update a scorecard rule.
properties:
attributes:
- $ref: "#/components/schemas/RuleAttributesRequest"
+ $ref: '#/components/schemas/RuleAttributesRequest'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
UpdateRuleResponse:
description: The response from a rule update request.
properties:
data:
- $ref: "#/components/schemas/UpdateRuleResponseData"
+ $ref: '#/components/schemas/UpdateRuleResponseData'
type: object
UpdateRuleResponseData:
description: The data for a rule update response.
properties:
attributes:
- $ref: "#/components/schemas/RuleAttributes"
+ $ref: '#/components/schemas/RuleAttributes'
id:
- $ref: "#/components/schemas/RuleId"
+ $ref: '#/components/schemas/RuleId'
relationships:
- $ref: "#/components/schemas/RelationshipToRule"
+ $ref: '#/components/schemas/RelationshipToRule'
type:
- $ref: "#/components/schemas/RuleType"
+ $ref: '#/components/schemas/RuleType'
type: object
UpdateRulesetRequest:
description: The definition of `UpdateRulesetRequest` object.
@@ -123059,18 +123120,18 @@ components:
type: update_ruleset
properties:
data:
- $ref: "#/components/schemas/UpdateRulesetRequestData"
+ $ref: '#/components/schemas/UpdateRulesetRequestData'
type: object
UpdateRulesetRequestData:
description: The definition of `UpdateRulesetRequestData` object.
properties:
attributes:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributes"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributes'
id:
description: The `UpdateRulesetRequestData` `id`.
type: string
type:
- $ref: "#/components/schemas/UpdateRulesetRequestDataType"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataType'
required:
- type
type: object
@@ -123088,7 +123149,7 @@ components:
rules:
description: The `attributes` `rules`.
items:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItems"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItems'
type: array
required:
- enabled
@@ -123102,17 +123163,17 @@ components:
example: false
type: boolean
mapping:
- $ref: "#/components/schemas/DataAttributesRulesItemsMapping"
+ $ref: '#/components/schemas/DataAttributesRulesItemsMapping'
metadata:
- $ref: "#/components/schemas/RulesetItemMetadata"
+ $ref: '#/components/schemas/RulesetItemMetadata'
name:
description: The `items` `name`.
example: ""
type: string
query:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQuery"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQuery'
reference_table:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTable"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTable'
required:
- enabled
- name
@@ -123122,7 +123183,7 @@ components:
nullable: true
properties:
addition:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQueryAddition"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsQueryAddition'
case_insensitivity:
description: The `query` `case_insensitivity`.
type: boolean
@@ -123131,7 +123192,7 @@ components:
description: Deprecated. Use `if_tag_exists` instead. The `query` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
query:
description: The `query` `query`.
example: ""
@@ -123166,14 +123227,14 @@ components:
field_pairs:
description: The `reference_table` `field_pairs`.
items:
- $ref: "#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems"
+ $ref: '#/components/schemas/UpdateRulesetRequestDataAttributesRulesItemsReferenceTableFieldPairsItems'
type: array
if_not_exists:
deprecated: true
description: Deprecated. Use `if_tag_exists` instead. The `reference_table` `if_not_exists`.
type: boolean
if_tag_exists:
- $ref: "#/components/schemas/DataAttributesRulesItemsIfTagExists"
+ $ref: '#/components/schemas/DataAttributesRulesItemsIfTagExists'
source_keys:
description: The `reference_table` `source_keys`.
example:
@@ -123219,13 +123280,13 @@ components:
description: The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes.
properties:
attributes:
- $ref: "#/components/schemas/UpdateTenancyConfigDataAttributes"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataAttributes'
id:
description: The OCID of the OCI tenancy to update.
example: ""
type: string
type:
- $ref: "#/components/schemas/UpdateTenancyConfigDataType"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataType'
required:
- type
- id
@@ -123234,7 +123295,7 @@ components:
description: Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options.
properties:
auth_credentials:
- $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesAuthCredentials"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesAuthCredentials'
cost_collection_enabled:
description: Whether cost data collection from OCI is enabled for the tenancy.
type: boolean
@@ -123242,11 +123303,11 @@ components:
description: The home region of the OCI tenancy (for example, us-ashburn-1).
type: string
logs_config:
- $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig'
metrics_config:
- $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesMetricsConfig"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesMetricsConfig'
regions_config:
- $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig"
+ $ref: '#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig'
resource_collection_enabled:
description: Whether resource collection from OCI is enabled for the tenancy.
type: boolean
@@ -123395,7 +123456,7 @@ components:
type: oci_tenancy
properties:
data:
- $ref: "#/components/schemas/UpdateTenancyConfigData"
+ $ref: '#/components/schemas/UpdateTenancyConfigData'
required:
- data
type: object
@@ -123403,7 +123464,7 @@ components:
description: Request body for setting identity provider overrides for a user.
properties:
data:
- $ref: "#/components/schemas/UserRelationshipIdentityProviderDataList"
+ $ref: '#/components/schemas/UserRelationshipIdentityProviderDataList'
required:
- data
type: object
@@ -123484,7 +123545,7 @@ components:
type: "workflows"
properties:
data:
- $ref: "#/components/schemas/WorkflowDataUpdate"
+ $ref: '#/components/schemas/WorkflowDataUpdate'
required:
- data
type: object
@@ -123492,7 +123553,7 @@ components:
description: The response object after updating a workflow.
properties:
data:
- $ref: "#/components/schemas/WorkflowDataUpdate"
+ $ref: '#/components/schemas/WorkflowDataUpdate'
type: object
UpsertAllocationRequest:
description: Request to create or update a targeting rule (allocation) for a feature flag environment.
@@ -123503,11 +123564,11 @@ components:
nullable: true
type: string
exposure_schedule:
- $ref: "#/components/schemas/ExposureScheduleRequest"
+ $ref: '#/components/schemas/ExposureScheduleRequest'
guardrail_metrics:
description: Guardrail metrics used to monitor and auto-pause or abort.
items:
- $ref: "#/components/schemas/GuardrailMetricRequest"
+ $ref: '#/components/schemas/GuardrailMetricRequest'
type: array
id:
description: The unique identifier of the targeting rule allocation.
@@ -123525,14 +123586,14 @@ components:
targeting_rules:
description: Targeting rules that determine audience eligibility.
items:
- $ref: "#/components/schemas/TargetingRuleRequest"
+ $ref: '#/components/schemas/TargetingRuleRequest'
type: array
type:
- $ref: "#/components/schemas/AllocationType"
+ $ref: '#/components/schemas/AllocationType'
variant_weights:
description: Variant distribution weights.
items:
- $ref: "#/components/schemas/VariantWeightRequest"
+ $ref: '#/components/schemas/VariantWeightRequest'
type: array
required:
- name
@@ -123543,9 +123604,9 @@ components:
description: The data for upserting and publishing a form version.
properties:
attributes:
- $ref: "#/components/schemas/UpsertAndPublishFormVersionDataAttributes"
+ $ref: '#/components/schemas/UpsertAndPublishFormVersionDataAttributes'
type:
- $ref: "#/components/schemas/FormVersionType"
+ $ref: '#/components/schemas/FormVersionType'
required:
- type
- attributes
@@ -123554,11 +123615,11 @@ components:
description: The attributes for upserting and publishing a form version.
properties:
data_definition:
- $ref: "#/components/schemas/FormDataDefinition"
+ $ref: '#/components/schemas/FormDataDefinition'
ui_definition:
- $ref: "#/components/schemas/FormUiDefinition"
+ $ref: '#/components/schemas/FormUiDefinition'
upsert_params:
- $ref: "#/components/schemas/UpsertAndPublishFormVersionUpsertParams"
+ $ref: '#/components/schemas/UpsertAndPublishFormVersionUpsertParams'
required:
- data_definition
- ui_definition
@@ -123568,7 +123629,7 @@ components:
description: A request to upsert and publish a form version in a single transaction.
properties:
data:
- $ref: "#/components/schemas/UpsertAndPublishFormVersionData"
+ $ref: '#/components/schemas/UpsertAndPublishFormVersionData'
required:
- data
type: object
@@ -123585,45 +123646,45 @@ components:
UpsertCatalogEntityRequest:
description: Create or update entity request.
oneOf:
- - $ref: "#/components/schemas/EntityV3"
- - $ref: "#/components/schemas/EntityRaw"
+ - $ref: '#/components/schemas/EntityV3'
+ - $ref: '#/components/schemas/EntityRaw'
UpsertCatalogEntityResponse:
description: Upsert entity response.
properties:
data:
- $ref: "#/components/schemas/EntityResponseData"
+ $ref: '#/components/schemas/EntityResponseData'
included:
- $ref: "#/components/schemas/UpsertCatalogEntityResponseIncluded"
+ $ref: '#/components/schemas/UpsertCatalogEntityResponseIncluded'
meta:
- $ref: "#/components/schemas/EntityResponseMeta"
+ $ref: '#/components/schemas/EntityResponseMeta'
type: object
UpsertCatalogEntityResponseIncluded:
description: Upsert entity response included.
items:
- $ref: "#/components/schemas/UpsertCatalogEntityResponseIncludedItem"
+ $ref: '#/components/schemas/UpsertCatalogEntityResponseIncludedItem'
type: array
UpsertCatalogEntityResponseIncludedItem:
description: Upsert entity response included item.
oneOf:
- - $ref: "#/components/schemas/EntityResponseIncludedSchema"
+ - $ref: '#/components/schemas/EntityResponseIncludedSchema'
UpsertCatalogKindRequest:
description: Create or update kind request.
oneOf:
- - $ref: "#/components/schemas/KindObj"
- - $ref: "#/components/schemas/KindRaw"
+ - $ref: '#/components/schemas/KindObj'
+ - $ref: '#/components/schemas/KindRaw'
UpsertCatalogKindResponse:
description: Upsert kind response.
properties:
data:
- $ref: "#/components/schemas/KindResponseData"
+ $ref: '#/components/schemas/KindResponseData'
meta:
- $ref: "#/components/schemas/KindResponseMeta"
+ $ref: '#/components/schemas/KindResponseMeta'
type: object
UpsertCloudInventorySyncConfigRequest:
description: Request body for creating or updating a cloud inventory sync configuration.
properties:
data:
- $ref: "#/components/schemas/UpsertCloudInventorySyncConfigRequestData"
+ $ref: '#/components/schemas/UpsertCloudInventorySyncConfigRequestData'
required:
- data
type: object
@@ -123632,21 +123693,21 @@ components:
Settings for the cloud provider specified in `data.id`. Include only the matching provider object (`aws`, `gcp`, or `azure`).
properties:
aws:
- $ref: "#/components/schemas/CloudInventorySyncConfigAWSRequestAttributes"
+ $ref: '#/components/schemas/CloudInventorySyncConfigAWSRequestAttributes'
azure:
- $ref: "#/components/schemas/CloudInventorySyncConfigAzureRequestAttributes"
+ $ref: '#/components/schemas/CloudInventorySyncConfigAzureRequestAttributes'
gcp:
- $ref: "#/components/schemas/CloudInventorySyncConfigGCPRequestAttributes"
+ $ref: '#/components/schemas/CloudInventorySyncConfigGCPRequestAttributes'
type: object
UpsertCloudInventorySyncConfigRequestData:
description: Storage Management configuration data for the create or update request.
properties:
attributes:
- $ref: "#/components/schemas/UpsertCloudInventorySyncConfigRequestAttributes"
+ $ref: '#/components/schemas/UpsertCloudInventorySyncConfigRequestAttributes'
id:
- $ref: "#/components/schemas/CloudInventoryCloudProviderId"
+ $ref: '#/components/schemas/CloudInventoryCloudProviderId'
type:
- $ref: "#/components/schemas/CloudInventoryCloudProviderRequestType"
+ $ref: '#/components/schemas/CloudInventoryCloudProviderRequestType'
required:
- type
- id
@@ -123656,9 +123717,9 @@ components:
description: The data for creating or updating a form version.
properties:
attributes:
- $ref: "#/components/schemas/UpsertFormVersionDataAttributes"
+ $ref: '#/components/schemas/UpsertFormVersionDataAttributes'
type:
- $ref: "#/components/schemas/FormVersionType"
+ $ref: '#/components/schemas/FormVersionType'
required:
- type
- attributes
@@ -123667,13 +123728,13 @@ components:
description: The attributes for creating or updating a form version.
properties:
data_definition:
- $ref: "#/components/schemas/FormDataDefinition"
+ $ref: '#/components/schemas/FormDataDefinition'
state:
- $ref: "#/components/schemas/FormVersionState"
+ $ref: '#/components/schemas/FormVersionState'
ui_definition:
- $ref: "#/components/schemas/FormUiDefinition"
+ $ref: '#/components/schemas/FormUiDefinition'
upsert_params:
- $ref: "#/components/schemas/UpsertFormVersionUpsertParams"
+ $ref: '#/components/schemas/UpsertFormVersionUpsertParams'
required:
- state
- data_definition
@@ -123684,7 +123745,7 @@ components:
description: A request to create or update a form version.
properties:
data:
- $ref: "#/components/schemas/UpsertFormVersionData"
+ $ref: '#/components/schemas/UpsertFormVersionData'
required:
- data
type: object
@@ -123701,7 +123762,7 @@ components:
example: false
type: boolean
match_policy:
- $ref: "#/components/schemas/LatestVersionMatchPolicy"
+ $ref: '#/components/schemas/LatestVersionMatchPolicy'
required:
- match_policy
type: object
@@ -123709,9 +123770,9 @@ components:
description: Data object of an upsert OAuth2 scopes restriction request.
properties:
attributes:
- $ref: "#/components/schemas/UpsertOAuthScopesRestrictionDataAttributes"
+ $ref: '#/components/schemas/UpsertOAuthScopesRestrictionDataAttributes'
type:
- $ref: "#/components/schemas/UpsertOAuthScopesRestrictionType"
+ $ref: '#/components/schemas/UpsertOAuthScopesRestrictionType'
required:
- type
type: object
@@ -123724,7 +123785,7 @@ components:
- openid
- email
items:
- $ref: "#/components/schemas/OAuthOidcScope"
+ $ref: '#/components/schemas/OAuthOidcScope'
type: array
permission_scopes:
description: |-
@@ -123743,7 +123804,7 @@ components:
description: Request payload for creating or updating the scopes restriction of an OAuth2 client.
properties:
data:
- $ref: "#/components/schemas/UpsertOAuthScopesRestrictionData"
+ $ref: '#/components/schemas/UpsertOAuthScopesRestrictionData'
required:
- data
type: object
@@ -123804,7 +123865,7 @@ components:
data:
description: Response containing Application Security Monitoring usage.
items:
- $ref: "#/components/schemas/UsageDataObject"
+ $ref: '#/components/schemas/UsageDataObject'
type: array
type: object
UsageAttributesObject:
@@ -123825,10 +123886,10 @@ components:
timeseries:
description: List of usage data reported for each requested hour.
items:
- $ref: "#/components/schemas/UsageTimeSeriesObject"
+ $ref: '#/components/schemas/UsageTimeSeriesObject'
type: array
usage_type:
- $ref: "#/components/schemas/HourlyUsageType"
+ $ref: '#/components/schemas/HourlyUsageType'
type: object
UsageAttributionTypesAttributes:
description: List of usage attribution types.
@@ -123845,18 +123906,18 @@ components:
description: Usage attribution types data.
properties:
attributes:
- $ref: "#/components/schemas/UsageAttributionTypesAttributes"
+ $ref: '#/components/schemas/UsageAttributionTypesAttributes'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/UsageAttributionTypesType"
+ $ref: '#/components/schemas/UsageAttributionTypesType'
type: object
UsageAttributionTypesResponse:
description: Usage attribution types response.
properties:
data:
- $ref: "#/components/schemas/UsageAttributionTypesBody"
+ $ref: '#/components/schemas/UsageAttributionTypesBody'
type: object
UsageAttributionTypesType:
default: usage_attribution_types
@@ -123870,12 +123931,12 @@ components:
description: Usage data.
properties:
attributes:
- $ref: "#/components/schemas/UsageAttributesObject"
+ $ref: '#/components/schemas/UsageAttributesObject'
id:
description: Unique ID of the response.
type: string
type:
- $ref: "#/components/schemas/UsageTimeSeriesType"
+ $ref: '#/components/schemas/UsageTimeSeriesType'
type: object
UsageLambdaTracedInvocationsResponse:
description: Lambda Traced Invocations usage response.
@@ -123883,7 +123944,7 @@ components:
data:
description: Response containing Lambda Traced Invocations usage.
items:
- $ref: "#/components/schemas/UsageDataObject"
+ $ref: '#/components/schemas/UsageDataObject'
type: array
type: object
UsageObservabilityPipelinesResponse:
@@ -123892,7 +123953,7 @@ components:
data:
description: Response containing Observability Pipelines usage.
items:
- $ref: "#/components/schemas/UsageDataObject"
+ $ref: '#/components/schemas/UsageDataObject'
type: array
type: object
UsageQuotaBulkResultAttributes:
@@ -123911,7 +123972,7 @@ components:
example: abcdef12345
type: string
scope:
- $ref: "#/components/schemas/UsageQuotaResponseScope"
+ $ref: '#/components/schemas/UsageQuotaResponseScope'
usage_limit:
description: The quota limit in the usage units defined by the quota namespace. May be fractional for quotas configured before public writes required whole units. Omitted if this item failed to write.
example: 100000
@@ -123922,13 +123983,13 @@ components:
description: The result of writing one usage quota in a bulk create-or-update request.
properties:
attributes:
- $ref: "#/components/schemas/UsageQuotaBulkResultAttributes"
+ $ref: '#/components/schemas/UsageQuotaBulkResultAttributes'
id:
description: An opaque usage quota identifier. Clients must pass this value back verbatim in update and delete requests and must not infer any structure from it.
example: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f"
type: string
type:
- $ref: "#/components/schemas/UsageQuotaType"
+ $ref: '#/components/schemas/UsageQuotaType'
required:
- id
- type
@@ -123937,7 +123998,7 @@ components:
UsageQuotaBulkResultDataList:
description: The results of writing each usage quota in a bulk create-or-update request, in the same order as the request.
items:
- $ref: "#/components/schemas/UsageQuotaBulkResultData"
+ $ref: '#/components/schemas/UsageQuotaBulkResultData'
type: array
UsageQuotaCreateAttributes:
description: Attributes for creating or updating a usage quota by scope.
@@ -123947,7 +124008,7 @@ components:
example: true
type: boolean
scope:
- $ref: "#/components/schemas/UsageQuotaRequestScope"
+ $ref: '#/components/schemas/UsageQuotaRequestScope'
usage_limit:
description: The quota limit to set in the usage units defined by the quota namespace. For an organization-wide quota (scope omitted), the limit must be greater than the usage already recorded in the current period.
example: 100000
@@ -123962,9 +124023,9 @@ components:
description: A usage quota resource to create or update by scope.
properties:
attributes:
- $ref: "#/components/schemas/UsageQuotaCreateAttributes"
+ $ref: '#/components/schemas/UsageQuotaCreateAttributes'
type:
- $ref: "#/components/schemas/UsageQuotaType"
+ $ref: '#/components/schemas/UsageQuotaType'
required:
- type
- attributes
@@ -123972,7 +124033,7 @@ components:
UsageQuotaCreateDataList:
description: A bulk list of usage quota resources to create or update by scope.
items:
- $ref: "#/components/schemas/UsageQuotaCreateData"
+ $ref: '#/components/schemas/UsageQuotaCreateData'
minItems: 1
type: array
UsageQuotaRequestScope:
@@ -123989,7 +124050,7 @@ components:
description: Response containing a usage quota.
properties:
data:
- $ref: "#/components/schemas/UsageQuotaResponseData"
+ $ref: '#/components/schemas/UsageQuotaResponseData'
required:
- data
type: object
@@ -124005,7 +124066,7 @@ components:
example: abcdef12345
type: string
scope:
- $ref: "#/components/schemas/UsageQuotaResponseScope"
+ $ref: '#/components/schemas/UsageQuotaResponseScope'
usage_limit:
description: The quota limit in the usage units defined by the quota namespace. May be fractional for quotas configured before public writes required whole units.
example: 100000
@@ -124020,13 +124081,13 @@ components:
description: A usage quota resource.
properties:
attributes:
- $ref: "#/components/schemas/UsageQuotaResponseAttributes"
+ $ref: '#/components/schemas/UsageQuotaResponseAttributes'
id:
description: An opaque usage quota identifier. Clients must pass this value back verbatim in update and delete requests and must not infer any structure from it.
example: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f"
type: string
type:
- $ref: "#/components/schemas/UsageQuotaType"
+ $ref: '#/components/schemas/UsageQuotaType'
required:
- id
- type
@@ -124035,7 +124096,7 @@ components:
UsageQuotaResponseDataList:
description: A list of usage quota resources.
items:
- $ref: "#/components/schemas/UsageQuotaResponseData"
+ $ref: '#/components/schemas/UsageQuotaResponseData'
type: array
UsageQuotaResponseScope:
additionalProperties:
@@ -124075,13 +124136,13 @@ components:
description: A usage quota resource to update.
properties:
attributes:
- $ref: "#/components/schemas/UsageQuotaUpdateAttributes"
+ $ref: '#/components/schemas/UsageQuotaUpdateAttributes'
id:
description: The opaque usage quota identifier, which must match the identifier in the request path.
example: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f"
type: string
type:
- $ref: "#/components/schemas/UsageQuotaType"
+ $ref: '#/components/schemas/UsageQuotaType'
required:
- id
- type
@@ -124091,7 +124152,7 @@ components:
description: Request containing the usage quota resource to update.
properties:
data:
- $ref: "#/components/schemas/UsageQuotaUpdateData"
+ $ref: '#/components/schemas/UsageQuotaUpdateData'
required:
- data
type: object
@@ -124099,7 +124160,7 @@ components:
description: Response containing the result of a bulk usage quota create-or-update request. Returned with a `200` status regardless of whether individual items succeeded or failed; check each item's `error` attribute to determine its outcome.
properties:
data:
- $ref: "#/components/schemas/UsageQuotaBulkResultDataList"
+ $ref: '#/components/schemas/UsageQuotaBulkResultDataList'
required:
- data
type: object
@@ -124107,7 +124168,7 @@ components:
description: A JSON:API bulk request containing an array of usage quota resources rather than a single resource.
properties:
data:
- $ref: "#/components/schemas/UsageQuotaCreateDataList"
+ $ref: '#/components/schemas/UsageQuotaCreateDataList'
required:
- data
type: object
@@ -124115,9 +124176,9 @@ components:
description: Response containing a paginated list of usage quotas.
properties:
data:
- $ref: "#/components/schemas/UsageQuotaResponseDataList"
+ $ref: '#/components/schemas/UsageQuotaResponseDataList'
meta:
- $ref: "#/components/schemas/UsageQuotasResponseMeta"
+ $ref: '#/components/schemas/UsageQuotasResponseMeta'
required:
- data
- meta
@@ -124126,7 +124187,7 @@ components:
description: Pagination metadata for a usage quota list response.
properties:
page:
- $ref: "#/components/schemas/UsageQuotasResponseMetaPage"
+ $ref: '#/components/schemas/UsageQuotasResponseMetaPage'
required:
- page
type: object
@@ -124174,13 +124235,13 @@ components:
description: Available-fields data.
properties:
attributes:
- $ref: "#/components/schemas/UsageSummaryAvailableFieldsAttributes"
+ $ref: '#/components/schemas/UsageSummaryAvailableFieldsAttributes'
id:
description: The identifier for the discovery scope. Always `"all"`.
example: all
type: string
type:
- $ref: "#/components/schemas/UsageSummaryAvailableFieldsType"
+ $ref: '#/components/schemas/UsageSummaryAvailableFieldsType'
type: object
UsageSummaryAvailableFieldsResponse:
description: |-
@@ -124189,7 +124250,7 @@ components:
`additionalProperties` keys.
properties:
data:
- $ref: "#/components/schemas/UsageSummaryAvailableFieldsBody"
+ $ref: '#/components/schemas/UsageSummaryAvailableFieldsBody'
type: object
UsageSummaryAvailableFieldsType:
default: usage_summary_available_fields
@@ -124225,14 +124286,14 @@ components:
description: User object returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/UserAttributes"
+ $ref: '#/components/schemas/UserAttributes'
id:
description: ID of the user.
type: string
relationships:
- $ref: "#/components/schemas/UserResponseRelationships"
+ $ref: '#/components/schemas/UserResponseRelationships'
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
type: object
UserAttributes:
description: Attributes of user object returned by the API.
@@ -124340,15 +124401,15 @@ components:
description: Data object representing a user authorized client.
properties:
attributes:
- $ref: "#/components/schemas/UserAuthorizedClientAttributes"
+ $ref: '#/components/schemas/UserAuthorizedClientAttributes'
id:
description: The unique identifier of the user authorized client.
example: "00000000-0000-0000-0000-000000000001"
type: string
relationships:
- $ref: "#/components/schemas/UserAuthorizedClientRelationships"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationships'
type:
- $ref: "#/components/schemas/UserAuthorizedClientType"
+ $ref: '#/components/schemas/UserAuthorizedClientType'
required:
- id
- type
@@ -124358,13 +124419,13 @@ components:
UserAuthorizedClientDataList:
description: List of user authorized client data objects.
items:
- $ref: "#/components/schemas/UserAuthorizedClientData"
+ $ref: '#/components/schemas/UserAuthorizedClientData'
type: array
UserAuthorizedClientRelationshipOAuth2Client:
description: Relationship to the OAuth2 client that was authorized.
properties:
data:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientData"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientData'
required:
- data
type: object
@@ -124376,7 +124437,7 @@ components:
example: "00000000-0000-0000-0000-000000000010"
type: string
type:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientDataType"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipOAuth2ClientDataType'
required:
- type
- id
@@ -124397,7 +124458,7 @@ components:
example: "example_scope"
type: string
type:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeDataType"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipScopeDataType'
required:
- type
- id
@@ -124405,7 +124466,7 @@ components:
UserAuthorizedClientRelationshipScopeDataList:
description: List of scope relationship data objects.
items:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeData"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipScopeData'
type: array
UserAuthorizedClientRelationshipScopeDataType:
description: Scope resource type.
@@ -124419,7 +124480,7 @@ components:
description: Relationship to the scopes granted to the OAuth2 client.
properties:
data:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopeDataList"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipScopeDataList'
required:
- data
type: object
@@ -124427,7 +124488,7 @@ components:
description: Relationship to the user who granted this authorization.
properties:
data:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipUserData"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipUserData'
required:
- data
type: object
@@ -124439,7 +124500,7 @@ components:
example: "00000000-0000-9999-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipUserDataType"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipUserDataType'
required:
- type
- id
@@ -124456,11 +124517,11 @@ components:
description: Relationships for a user authorized client.
properties:
oauth2_client:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipOAuth2Client"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipOAuth2Client'
scopes:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipScopes"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipScopes'
user:
- $ref: "#/components/schemas/UserAuthorizedClientRelationshipUser"
+ $ref: '#/components/schemas/UserAuthorizedClientRelationshipUser'
required:
- user
- oauth2_client
@@ -124470,7 +124531,7 @@ components:
description: Response containing a single user authorized client.
properties:
data:
- $ref: "#/components/schemas/UserAuthorizedClientData"
+ $ref: '#/components/schemas/UserAuthorizedClientData'
required:
- data
type: object
@@ -124486,9 +124547,9 @@ components:
description: Response containing a list of user authorized clients.
properties:
data:
- $ref: "#/components/schemas/UserAuthorizedClientDataList"
+ $ref: '#/components/schemas/UserAuthorizedClientDataList'
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
required:
- data
- meta
@@ -124513,11 +124574,11 @@ components:
description: Object to create a user.
properties:
attributes:
- $ref: "#/components/schemas/UserCreateAttributes"
+ $ref: '#/components/schemas/UserCreateAttributes'
relationships:
- $ref: "#/components/schemas/UserRelationships"
+ $ref: '#/components/schemas/UserRelationships'
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
required:
- attributes
- type
@@ -124526,7 +124587,7 @@ components:
description: Create a user.
properties:
data:
- $ref: "#/components/schemas/UserCreateData"
+ $ref: '#/components/schemas/UserCreateData'
required:
- data
type: object
@@ -124534,9 +124595,9 @@ components:
description: Object to create a user invitation.
properties:
relationships:
- $ref: "#/components/schemas/UserInvitationRelationships"
+ $ref: '#/components/schemas/UserInvitationRelationships'
type:
- $ref: "#/components/schemas/UserInvitationsType"
+ $ref: '#/components/schemas/UserInvitationsType'
required:
- type
- relationships
@@ -124563,7 +124624,7 @@ components:
description: Relationships data for user invitation.
properties:
user:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
required:
- user
type: object
@@ -124571,20 +124632,20 @@ components:
description: User invitation as returned by the API.
properties:
data:
- $ref: "#/components/schemas/UserInvitationResponseData"
+ $ref: '#/components/schemas/UserInvitationResponseData'
type: object
UserInvitationResponseData:
description: Object of a user invitation returned by the API.
properties:
attributes:
- $ref: "#/components/schemas/UserInvitationDataAttributes"
+ $ref: '#/components/schemas/UserInvitationDataAttributes'
id:
description: ID of the user invitation.
type: string
relationships:
- $ref: "#/components/schemas/UserInvitationRelationships"
+ $ref: '#/components/schemas/UserInvitationRelationships'
type:
- $ref: "#/components/schemas/UserInvitationsType"
+ $ref: '#/components/schemas/UserInvitationsType'
type: object
UserInvitationsRequest:
description: Object to invite users to join the organization.
@@ -124593,7 +124654,7 @@ components:
description: "List of user invitations."
example: []
items:
- $ref: "#/components/schemas/UserInvitationData"
+ $ref: '#/components/schemas/UserInvitationData'
type: array
required:
- data
@@ -124604,7 +124665,7 @@ components:
data:
description: Array of user invitations.
items:
- $ref: "#/components/schemas/UserInvitationResponseData"
+ $ref: '#/components/schemas/UserInvitationResponseData'
type: array
type: object
UserInvitationsType:
@@ -124630,13 +124691,13 @@ components:
description: Data object representing a user identity provider override.
properties:
attributes:
- $ref: "#/components/schemas/UserOverrideIdentityProviderAttributes"
+ $ref: '#/components/schemas/UserOverrideIdentityProviderAttributes'
id:
description: The unique identifier of the identity provider.
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/UserOverrideIdentityProviderDataType"
+ $ref: '#/components/schemas/UserOverrideIdentityProviderDataType'
required:
- id
- type
@@ -124645,7 +124706,7 @@ components:
UserOverrideIdentityProviderDataList:
description: List of user identity provider override data objects.
items:
- $ref: "#/components/schemas/UserOverrideIdentityProviderData"
+ $ref: '#/components/schemas/UserOverrideIdentityProviderData'
type: array
UserOverrideIdentityProviderDataType:
description: The resource type for identity providers.
@@ -124659,7 +124720,7 @@ components:
description: Response containing a user's identity provider overrides.
properties:
data:
- $ref: "#/components/schemas/UserOverrideIdentityProviderDataList"
+ $ref: '#/components/schemas/UserOverrideIdentityProviderDataList'
required:
- data
type: object
@@ -124671,7 +124732,7 @@ components:
example: "00000000-0000-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UserResourceType"
+ $ref: '#/components/schemas/UserResourceType'
required:
- id
- type
@@ -124684,7 +124745,7 @@ components:
example: "00000000-0000-0000-0000-000000000001"
type: string
type:
- $ref: "#/components/schemas/UserRelationshipIdentityProviderDataType"
+ $ref: '#/components/schemas/UserRelationshipIdentityProviderDataType'
required:
- id
- type
@@ -124692,7 +124753,7 @@ components:
UserRelationshipIdentityProviderDataList:
description: List of identity provider resource identifiers for a relationship update.
items:
- $ref: "#/components/schemas/UserRelationshipIdentityProviderData"
+ $ref: '#/components/schemas/UserRelationshipIdentityProviderData'
type: array
UserRelationshipIdentityProviderDataType:
description: The resource type for identity providers.
@@ -124706,7 +124767,7 @@ components:
description: Relationships of the user object.
properties:
roles:
- $ref: "#/components/schemas/RelationshipToRoles"
+ $ref: '#/components/schemas/RelationshipToRoles'
type: object
UserResourceType:
default: user
@@ -124721,30 +124782,30 @@ components:
description: Response containing information about a single user.
properties:
data:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
included:
description: Array of objects related to the user.
items:
- $ref: "#/components/schemas/UserResponseIncludedItem"
+ $ref: '#/components/schemas/UserResponseIncludedItem'
type: array
type: object
UserResponseIncludedItem:
description: An object related to a user.
oneOf:
- - $ref: "#/components/schemas/Organization"
- - $ref: "#/components/schemas/Permission"
- - $ref: "#/components/schemas/Role"
+ - $ref: '#/components/schemas/Organization'
+ - $ref: '#/components/schemas/Permission'
+ - $ref: '#/components/schemas/Role'
UserResponseRelationships:
description: Relationships of the user object returned by the API.
properties:
org:
- $ref: "#/components/schemas/RelationshipToOrganization"
+ $ref: '#/components/schemas/RelationshipToOrganization'
other_orgs:
- $ref: "#/components/schemas/RelationshipToOrganizations"
+ $ref: '#/components/schemas/RelationshipToOrganizations'
other_users:
- $ref: "#/components/schemas/RelationshipToUsers"
+ $ref: '#/components/schemas/RelationshipToUsers'
roles:
- $ref: "#/components/schemas/RelationshipToRoles"
+ $ref: '#/components/schemas/RelationshipToRoles'
type: object
UserTarget:
description: "Represents a user target for an escalation policy step, including the user's ID and resource type."
@@ -124754,7 +124815,7 @@ components:
example: "00000000-aba1-0000-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UserTargetType"
+ $ref: '#/components/schemas/UserTargetType'
required:
- type
- id
@@ -124772,15 +124833,15 @@ components:
description: A user's relationship with a team
properties:
attributes:
- $ref: "#/components/schemas/UserTeamAttributes"
+ $ref: '#/components/schemas/UserTeamAttributes'
id:
description: The ID of a user's relationship with a team
example: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835
type: string
relationships:
- $ref: "#/components/schemas/UserTeamRelationships"
+ $ref: '#/components/schemas/UserTeamRelationships'
type:
- $ref: "#/components/schemas/UserTeamType"
+ $ref: '#/components/schemas/UserTeamType'
required:
- id
- type
@@ -124801,36 +124862,36 @@ components:
readOnly: true
type: string
role:
- $ref: "#/components/schemas/UserTeamRole"
+ $ref: '#/components/schemas/UserTeamRole'
type: object
UserTeamCreate:
description: A user's relationship with a team
properties:
attributes:
- $ref: "#/components/schemas/UserTeamAttributes"
+ $ref: '#/components/schemas/UserTeamAttributes'
relationships:
- $ref: "#/components/schemas/UserTeamRelationships"
+ $ref: '#/components/schemas/UserTeamRelationships'
type:
- $ref: "#/components/schemas/UserTeamType"
+ $ref: '#/components/schemas/UserTeamType'
required:
- type
type: object
UserTeamIncluded:
description: Included resources related to the team membership
oneOf:
- - $ref: "#/components/schemas/User"
- - $ref: "#/components/schemas/Team"
+ - $ref: '#/components/schemas/User'
+ - $ref: '#/components/schemas/Team'
UserTeamPermission:
description: A user's permissions for a given team
properties:
attributes:
- $ref: "#/components/schemas/UserTeamPermissionAttributes"
+ $ref: '#/components/schemas/UserTeamPermissionAttributes'
id:
description: The user team permission's identifier
example: UserTeamPermissions-aeadc05e-98a8-11ec-ac2c-da7ad0900001-416595
type: string
type:
- $ref: "#/components/schemas/UserTeamPermissionType"
+ $ref: '#/components/schemas/UserTeamPermissionType'
required:
- id
- type
@@ -124856,15 +124917,15 @@ components:
description: Relationship between membership and a user
properties:
team:
- $ref: "#/components/schemas/RelationshipToUserTeamTeam"
+ $ref: '#/components/schemas/RelationshipToUserTeamTeam'
user:
- $ref: "#/components/schemas/RelationshipToUserTeamUser"
+ $ref: '#/components/schemas/RelationshipToUserTeamUser'
type: object
UserTeamRequest:
description: Team membership request
properties:
data:
- $ref: "#/components/schemas/UserTeamCreate"
+ $ref: '#/components/schemas/UserTeamCreate'
required:
- data
type: object
@@ -124872,11 +124933,11 @@ components:
description: Team membership response
properties:
data:
- $ref: "#/components/schemas/UserTeam"
+ $ref: '#/components/schemas/UserTeam'
included:
description: Resources related to the team memberships
items:
- $ref: "#/components/schemas/UserTeamIncluded"
+ $ref: '#/components/schemas/UserTeamIncluded'
type: array
type: object
UserTeamRole:
@@ -124909,9 +124970,9 @@ components:
description: A user's relationship with a team
properties:
attributes:
- $ref: "#/components/schemas/UserTeamAttributes"
+ $ref: '#/components/schemas/UserTeamAttributes'
type:
- $ref: "#/components/schemas/UserTeamType"
+ $ref: '#/components/schemas/UserTeamType'
required:
- type
type: object
@@ -124919,7 +124980,7 @@ components:
description: Team membership request
properties:
data:
- $ref: "#/components/schemas/UserTeamUpdate"
+ $ref: '#/components/schemas/UserTeamUpdate'
required:
- data
type: object
@@ -124938,17 +124999,17 @@ components:
data:
description: Team memberships response data
items:
- $ref: "#/components/schemas/UserTeam"
+ $ref: '#/components/schemas/UserTeam'
type: array
included:
description: Resources related to the team memberships
items:
- $ref: "#/components/schemas/UserTeamIncluded"
+ $ref: '#/components/schemas/UserTeamIncluded'
type: array
links:
- $ref: "#/components/schemas/TeamsResponseLinks"
+ $ref: '#/components/schemas/TeamsResponseLinks'
meta:
- $ref: "#/components/schemas/TeamsResponseMeta"
+ $ref: '#/components/schemas/TeamsResponseMeta'
type: object
UserUpdateAttributes:
description: Attributes of the edited user.
@@ -124977,13 +125038,13 @@ components:
description: Object to update a user.
properties:
attributes:
- $ref: "#/components/schemas/UserUpdateAttributes"
+ $ref: '#/components/schemas/UserUpdateAttributes'
id:
description: ID of the user.
example: "00000000-0000-feed-0000-000000000000"
type: string
type:
- $ref: "#/components/schemas/UsersType"
+ $ref: '#/components/schemas/UsersType'
required:
- attributes
- type
@@ -124993,7 +125054,7 @@ components:
description: Update a user.
properties:
data:
- $ref: "#/components/schemas/UserUpdateData"
+ $ref: '#/components/schemas/UserUpdateData'
required:
- data
type: object
@@ -125004,7 +125065,7 @@ components:
description: Relationships to user objects.
example: []
items:
- $ref: "#/components/schemas/UserRelationshipData"
+ $ref: '#/components/schemas/UserRelationshipData'
type: array
required:
- data
@@ -125015,15 +125076,15 @@ components:
data:
description: Array of returned users.
items:
- $ref: "#/components/schemas/User"
+ $ref: '#/components/schemas/User'
type: array
included:
description: Array of objects related to the users.
items:
- $ref: "#/components/schemas/UserResponseIncludedItem"
+ $ref: '#/components/schemas/UserResponseIncludedItem'
type: array
meta:
- $ref: "#/components/schemas/ResponseMetaAttributes"
+ $ref: '#/components/schemas/ResponseMetaAttributes'
readOnly: true
type: object
UsersType:
@@ -125039,7 +125100,7 @@ components:
description: An event object.
properties:
attributes:
- $ref: "#/components/schemas/V2EventAttributes"
+ $ref: '#/components/schemas/V2EventAttributes'
id:
description: The event's ID.
example: ""
@@ -125057,7 +125118,7 @@ components:
description: Event attributes.
properties:
attributes:
- $ref: "#/components/schemas/V2EventAttributesAttributes"
+ $ref: '#/components/schemas/V2EventAttributesAttributes'
message:
description: Free-form text associated with the event.
example: "The event message"
@@ -125077,13 +125138,13 @@ components:
V2EventAttributesAttributes:
description: JSON object for category-specific attributes.
oneOf:
- - $ref: "#/components/schemas/ChangeEventAttributes"
- - $ref: "#/components/schemas/AlertEventAttributes"
+ - $ref: '#/components/schemas/ChangeEventAttributes'
+ - $ref: '#/components/schemas/AlertEventAttributes'
V2EventResponse:
description: Get an event response.
properties:
data:
- $ref: "#/components/schemas/V2Event"
+ $ref: '#/components/schemas/V2Event'
type: object
V2EventService:
description: Service that triggered the event.
@@ -125102,7 +125163,7 @@ components:
description: Response object for the API and application key validation status check.
properties:
status:
- $ref: "#/components/schemas/ValidateAPIKeyStatus"
+ $ref: '#/components/schemas/ValidateAPIKeyStatus'
required:
- status
type: object
@@ -125141,13 +125202,13 @@ components:
description: Data object containing the API key validation result.
properties:
attributes:
- $ref: "#/components/schemas/ValidateV2Attributes"
+ $ref: '#/components/schemas/ValidateV2Attributes'
id:
description: The UUID of the organization associated with the API key.
example: "550e8400-e29b-41d4-a716-446655440000"
type: string
type:
- $ref: "#/components/schemas/ValidateV2Type"
+ $ref: '#/components/schemas/ValidateV2Type'
required:
- id
- type
@@ -125157,7 +125218,7 @@ components:
description: Response for the API key validation endpoint.
properties:
data:
- $ref: "#/components/schemas/ValidateV2Data"
+ $ref: '#/components/schemas/ValidateV2Data'
required:
- data
type: object
@@ -125173,7 +125234,7 @@ components:
description: Represents a single validation error, including a human-readable title and metadata.
properties:
meta:
- $ref: "#/components/schemas/ValidationErrorMeta"
+ $ref: '#/components/schemas/ValidationErrorMeta'
title:
description: A short, human-readable summary of the error.
example: Field 'region' is required
@@ -125213,7 +125274,7 @@ components:
errors:
description: The `ValidationResponse` `errors`.
items:
- $ref: "#/components/schemas/ValidationError"
+ $ref: '#/components/schemas/ValidationError'
type: array
type: object
ValueType:
@@ -125292,7 +125353,7 @@ components:
format: double
type: number
variant:
- $ref: "#/components/schemas/Variant"
+ $ref: '#/components/schemas/Variant'
variant_id:
description: The variant ID.
example: "550e8400-e29b-41d4-a716-446655440001"
@@ -125339,7 +125400,7 @@ components:
example: Tags
type: string
type:
- $ref: "#/components/schemas/VersionHistoryUpdateType"
+ $ref: '#/components/schemas/VersionHistoryUpdateType'
type: object
VersionHistoryUpdateType:
description: The type of change.
@@ -125358,7 +125419,7 @@ components:
data:
description: Array of viewership history session data objects.
items:
- $ref: "#/components/schemas/ViewershipHistorySessionData"
+ $ref: '#/components/schemas/ViewershipHistorySessionData'
type: array
required:
- data
@@ -125367,12 +125428,12 @@ components:
description: Data object representing a session in the viewership history, including its identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/ViewershipHistorySessionDataAttributes"
+ $ref: '#/components/schemas/ViewershipHistorySessionDataAttributes'
id:
description: Unique identifier of the RUM replay session.
type: string
type:
- $ref: "#/components/schemas/ViewershipHistorySessionDataType"
+ $ref: '#/components/schemas/ViewershipHistorySessionDataType'
required:
- type
type: object
@@ -125414,7 +125475,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/VirusTotalAPIKeyType"
+ $ref: '#/components/schemas/VirusTotalAPIKeyType'
required:
- type
- api_key
@@ -125434,25 +125495,25 @@ components:
description: The `VirusTotalAPIKeyUpdate` `api_key`.
type: string
type:
- $ref: "#/components/schemas/VirusTotalAPIKeyType"
+ $ref: '#/components/schemas/VirusTotalAPIKeyType'
required:
- type
type: object
VirusTotalCredentials:
description: The definition of the `VirusTotalCredentials` object.
oneOf:
- - $ref: "#/components/schemas/VirusTotalAPIKey"
+ - $ref: '#/components/schemas/VirusTotalAPIKey'
VirusTotalCredentialsUpdate:
description: The definition of the `VirusTotalCredentialsUpdate` object.
oneOf:
- - $ref: "#/components/schemas/VirusTotalAPIKeyUpdate"
+ - $ref: '#/components/schemas/VirusTotalAPIKeyUpdate'
VirusTotalIntegration:
description: The definition of the `VirusTotalIntegration` object.
properties:
credentials:
- $ref: "#/components/schemas/VirusTotalCredentials"
+ $ref: '#/components/schemas/VirusTotalCredentials'
type:
- $ref: "#/components/schemas/VirusTotalIntegrationType"
+ $ref: '#/components/schemas/VirusTotalIntegrationType'
required:
- type
- credentials
@@ -125469,9 +125530,9 @@ components:
description: The definition of the `VirusTotalIntegrationUpdate` object.
properties:
credentials:
- $ref: "#/components/schemas/VirusTotalCredentialsUpdate"
+ $ref: '#/components/schemas/VirusTotalCredentialsUpdate'
type:
- $ref: "#/components/schemas/VirusTotalIntegrationType"
+ $ref: '#/components/schemas/VirusTotalIntegrationType'
required:
- type
type: object
@@ -125487,15 +125548,15 @@ components:
description: A single vulnerability
properties:
attributes:
- $ref: "#/components/schemas/VulnerabilityAttributes"
+ $ref: '#/components/schemas/VulnerabilityAttributes'
id:
description: The unique ID for this vulnerability.
example: 3ecdfea798f2ce8f6e964805a344945f
type: string
relationships:
- $ref: "#/components/schemas/VulnerabilityRelationships"
+ $ref: '#/components/schemas/VulnerabilityRelationships'
type:
- $ref: "#/components/schemas/VulnerabilitiesType"
+ $ref: '#/components/schemas/VulnerabilitiesType'
required:
- id
- type
@@ -125524,13 +125585,13 @@ components:
description: The JSON:API attributes of the vulnerability.
properties:
advisory:
- $ref: "#/components/schemas/VulnerabilityAdvisory"
+ $ref: '#/components/schemas/VulnerabilityAdvisory'
advisory_id:
description: Vulnerability advisory ID.
example: TRIVY-CVE-2023-0615
type: string
code_location:
- $ref: "#/components/schemas/CodeLocation"
+ $ref: '#/components/schemas/CodeLocation'
cve_list:
description: Vulnerability CVE list.
example:
@@ -125541,15 +125602,15 @@ components:
type: string
type: array
cvss:
- $ref: "#/components/schemas/VulnerabilityCvss"
+ $ref: '#/components/schemas/VulnerabilityCvss'
dependency_locations:
- $ref: "#/components/schemas/VulnerabilityDependencyLocations"
+ $ref: '#/components/schemas/VulnerabilityDependencyLocations'
description:
description: Vulnerability description.
example: "LDAP Injection is a security vulnerability that occurs when untrusted user input is improperly handled and directly incorporated into LDAP queries without appropriate sanitization or validation. This vulnerability enables attackers to manipulate LDAP queries and potentially gain unauthorized access, modify data, or extract sensitive information from the directory server. By exploiting the LDAP injection vulnerability, attackers can execute malicious commands, bypass authentication mechanisms, and perform unauthorized actions within the directory service."
type: string
ecosystem:
- $ref: "#/components/schemas/VulnerabilityEcosystem"
+ $ref: '#/components/schemas/VulnerabilityEcosystem'
exposure_time:
description: Vulnerability exposure time in seconds.
example: 5618604
@@ -125572,7 +125633,7 @@ components:
example: 2024-09-01 21:23:08+00:00
type: string
library:
- $ref: "#/components/schemas/Library"
+ $ref: '#/components/schemas/Library'
origin:
description: Vulnerability origin.
example:
@@ -125585,7 +125646,7 @@ components:
remediations:
description: List of remediations.
items:
- $ref: "#/components/schemas/Remediation"
+ $ref: '#/components/schemas/Remediation'
type: array
repo_digests:
description: Vulnerability `repo_digest` list (when the vulnerability is related to `Image` asset).
@@ -125595,21 +125656,21 @@ components:
type: string
type: array
risks:
- $ref: "#/components/schemas/VulnerabilityRisks"
+ $ref: '#/components/schemas/VulnerabilityRisks'
running_kernel:
description: True if the vulnerability affects a package in the host’s running kernel, false if it affects a non-running kernel, and omit if it is not kernel-related.
example: true
type: boolean
status:
- $ref: "#/components/schemas/VulnerabilityStatus"
+ $ref: '#/components/schemas/VulnerabilityStatus'
title:
description: Vulnerability title.
example: "LDAP Injection"
type: string
tool:
- $ref: "#/components/schemas/VulnerabilityTool"
+ $ref: '#/components/schemas/VulnerabilityTool'
type:
- $ref: "#/components/schemas/VulnerabilityType"
+ $ref: '#/components/schemas/VulnerabilityType'
required:
- type
- cvss
@@ -125631,9 +125692,9 @@ components:
description: Vulnerability severities.
properties:
base:
- $ref: "#/components/schemas/CVSS"
+ $ref: '#/components/schemas/CVSS'
datadog:
- $ref: "#/components/schemas/CVSS"
+ $ref: '#/components/schemas/CVSS'
required:
- base
- datadog
@@ -125642,11 +125703,11 @@ components:
description: Static library vulnerability location.
properties:
block:
- $ref: "#/components/schemas/DependencyLocation"
+ $ref: '#/components/schemas/DependencyLocation'
name:
- $ref: "#/components/schemas/DependencyLocation"
+ $ref: '#/components/schemas/DependencyLocation'
version:
- $ref: "#/components/schemas/DependencyLocation"
+ $ref: '#/components/schemas/DependencyLocation'
required:
- block
type: object
@@ -125691,7 +125752,7 @@ components:
description: Related entities object.
properties:
affects:
- $ref: "#/components/schemas/VulnerabilityRelationshipsAffects"
+ $ref: '#/components/schemas/VulnerabilityRelationshipsAffects'
required:
- affects
type: object
@@ -125699,7 +125760,7 @@ components:
description: Relationship type.
properties:
data:
- $ref: "#/components/schemas/VulnerabilityRelationshipsAffectsData"
+ $ref: '#/components/schemas/VulnerabilityRelationshipsAffectsData'
required:
- data
type: object
@@ -125711,7 +125772,7 @@ components:
example: Repository|github.com/DataDog/datadog-agent.git
type: string
type:
- $ref: "#/components/schemas/AssetEntityType"
+ $ref: '#/components/schemas/AssetEntityType'
required:
- id
- type
@@ -125720,7 +125781,7 @@ components:
description: Vulnerability risks.
properties:
epss:
- $ref: "#/components/schemas/EPSS"
+ $ref: '#/components/schemas/EPSS'
exploit_available:
description: Vulnerability public exploit availability.
example: false
@@ -125894,7 +125955,7 @@ components:
description: A single RUM replay session watch resource returned by create operations.
properties:
data:
- $ref: "#/components/schemas/WatchData"
+ $ref: '#/components/schemas/WatchData'
required:
- data
type: object
@@ -125902,12 +125963,12 @@ components:
description: Data object representing a session watch record, including its identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/WatchDataAttributes"
+ $ref: '#/components/schemas/WatchDataAttributes'
id:
description: Unique identifier of the watch record.
type: string
type:
- $ref: "#/components/schemas/WatchDataType"
+ $ref: '#/components/schemas/WatchDataType'
required:
- type
type: object
@@ -125950,7 +126011,7 @@ components:
data:
description: Array of watcher data objects.
items:
- $ref: "#/components/schemas/WatcherData"
+ $ref: '#/components/schemas/WatcherData'
type: array
required:
- data
@@ -125959,12 +126020,12 @@ components:
description: Data object representing a session watcher, including their identifier, type, and attributes.
properties:
attributes:
- $ref: "#/components/schemas/WatcherDataAttributes"
+ $ref: '#/components/schemas/WatcherDataAttributes'
id:
description: Unique identifier of the watcher user.
type: string
type:
- $ref: "#/components/schemas/WatcherDataType"
+ $ref: '#/components/schemas/WatcherDataType'
required:
- type
type: object
@@ -126010,7 +126071,7 @@ components:
description: Attributes of a webhooks auth method.
properties:
protocol:
- $ref: "#/components/schemas/WebhooksAuthMethodProtocol"
+ $ref: '#/components/schemas/WebhooksAuthMethodProtocol'
type: object
WebhooksAuthMethodProtocol:
description: Authentication protocol used by the auth method.
@@ -126024,21 +126085,21 @@ components:
description: Relationships of a webhooks auth method to its protocol-specific resource.
properties:
oauth2-client-credentials:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsRelationship"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsRelationship'
type: object
WebhooksAuthMethodResponseData:
description: Webhooks auth method data from a response.
properties:
attributes:
- $ref: "#/components/schemas/WebhooksAuthMethodAttributes"
+ $ref: '#/components/schemas/WebhooksAuthMethodAttributes'
id:
description: The ID of the auth method.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
type: string
relationships:
- $ref: "#/components/schemas/WebhooksAuthMethodRelationships"
+ $ref: '#/components/schemas/WebhooksAuthMethodRelationships'
type:
- $ref: "#/components/schemas/WebhooksAuthMethodType"
+ $ref: '#/components/schemas/WebhooksAuthMethodType'
required:
- id
- type
@@ -126059,12 +126120,12 @@ components:
data:
description: An array of webhooks auth methods.
items:
- $ref: "#/components/schemas/WebhooksAuthMethodResponseData"
+ $ref: '#/components/schemas/WebhooksAuthMethodResponseData'
type: array
included:
description: Resources related to the auth methods, included when requested via the `include` query parameter.
items:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponseData"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponseData'
type: array
required:
- data
@@ -126122,9 +126183,9 @@ components:
description: OAuth2 client credentials data for a create request.
properties:
attributes:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsCreateAttributes"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsCreateAttributes'
type:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsType"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsType'
required:
- type
- attributes
@@ -126133,7 +126194,7 @@ components:
description: Create request for an OAuth2 client credentials auth method.
properties:
data:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsCreateData"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsCreateData'
required:
- data
type: object
@@ -126141,7 +126202,7 @@ components:
description: Relationship pointing to the OAuth2 client credentials resource for this auth method.
properties:
data:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsRelationshipData"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsRelationshipData'
type: object
WebhooksOAuth2ClientCredentialsRelationshipData:
description: Relationship data referencing an OAuth2 client credentials resource.
@@ -126151,13 +126212,13 @@ components:
example: "596da4af-0563-4097-90ff-07230c3f9db3"
type: string
type:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsType"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsType'
type: object
WebhooksOAuth2ClientCredentialsResponse:
description: Response containing an OAuth2 client credentials auth method.
properties:
data:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponseData"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponseData'
required:
- data
type: object
@@ -126182,7 +126243,7 @@ components:
example: "my-oauth2-auth"
type: string
protocol:
- $ref: "#/components/schemas/WebhooksAuthMethodProtocol"
+ $ref: '#/components/schemas/WebhooksAuthMethodProtocol'
scope:
description: Space-separated list of OAuth2 scopes to request.
example: "read:webhooks write:webhooks"
@@ -126193,13 +126254,13 @@ components:
description: OAuth2 client credentials data from a response.
properties:
attributes:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponseAttributes"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponseAttributes'
id:
description: The ID of the OAuth2 client credentials auth method.
example: "596da4af-0563-4097-90ff-07230c3f9db3"
type: string
type:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsType"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsType'
required:
- id
- type
@@ -126262,9 +126323,9 @@ components:
description: OAuth2 client credentials data for an update request.
properties:
attributes:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateAttributes"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateAttributes'
type:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsType"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsType'
required:
- type
- attributes
@@ -126273,7 +126334,7 @@ components:
description: Update request for an OAuth2 client credentials auth method.
properties:
data:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateData"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateData'
required:
- data
type: object
@@ -126307,7 +126368,7 @@ components:
type: array
WidgetAnnotationsMap:
additionalProperties:
- $ref: "#/components/schemas/WidgetAnnotationIds"
+ $ref: '#/components/schemas/WidgetAnnotationIds'
description: Map from widget ID to the list of annotation IDs displayed on that widget.
example:
"1234567890":
@@ -126321,7 +126382,7 @@ components:
example: "2024-01-15T00:00:00.000Z"
type: string
definition:
- $ref: "#/components/schemas/WidgetDefinition"
+ $ref: '#/components/schemas/WidgetDefinition'
is_favorited:
description: |-
Whether the current user has favorited this widget. Populated on get,
@@ -126355,13 +126416,13 @@ components:
description: A widget resource object.
properties:
attributes:
- $ref: "#/components/schemas/WidgetAttributes"
+ $ref: '#/components/schemas/WidgetAttributes'
id:
description: The unique identifier of the widget.
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
type: string
relationships:
- $ref: "#/components/schemas/WidgetRelationships"
+ $ref: '#/components/schemas/WidgetRelationships'
type:
description: Widgets resource type.
example: widgets
@@ -126382,7 +126443,7 @@ components:
minLength: 1
type: string
type:
- $ref: "#/components/schemas/WidgetType"
+ $ref: '#/components/schemas/WidgetType'
required:
- type
- title
@@ -126405,7 +126466,7 @@ components:
description: A user resource included in the response.
properties:
attributes:
- $ref: "#/components/schemas/WidgetIncludedUserAttributes"
+ $ref: '#/components/schemas/WidgetIncludedUserAttributes'
id:
description: The unique identifier of the user.
example: "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
@@ -126437,15 +126498,15 @@ components:
data:
description: List of widget resources.
items:
- $ref: "#/components/schemas/WidgetData"
+ $ref: '#/components/schemas/WidgetData'
type: array
included:
description: Array of user resources related to the widgets.
items:
- $ref: "#/components/schemas/WidgetIncludedUser"
+ $ref: '#/components/schemas/WidgetIncludedUser'
type: array
meta:
- $ref: "#/components/schemas/WidgetSearchMeta"
+ $ref: '#/components/schemas/WidgetSearchMeta'
required:
- data
type: object
@@ -126504,7 +126565,7 @@ components:
description: A JSON:API relationship to a user.
properties:
data:
- $ref: "#/components/schemas/WidgetRelationshipData"
+ $ref: '#/components/schemas/WidgetRelationshipData'
type: object
WidgetRelationships:
description: Relationships of the widget resource.
@@ -126520,11 +126581,11 @@ components:
description: Response containing a single widget.
properties:
data:
- $ref: "#/components/schemas/WidgetData"
+ $ref: '#/components/schemas/WidgetData'
included:
description: Array of user resources related to the widget.
items:
- $ref: "#/components/schemas/WidgetIncludedUser"
+ $ref: '#/components/schemas/WidgetIncludedUser'
type: array
required:
- data
@@ -126591,15 +126652,15 @@ components:
description: Data related to the workflow.
properties:
attributes:
- $ref: "#/components/schemas/WorkflowDataAttributes"
+ $ref: '#/components/schemas/WorkflowDataAttributes'
id:
description: The workflow identifier
readOnly: true
type: string
relationships:
- $ref: "#/components/schemas/WorkflowDataRelationships"
+ $ref: '#/components/schemas/WorkflowDataRelationships'
type:
- $ref: "#/components/schemas/WorkflowDataType"
+ $ref: '#/components/schemas/WorkflowDataType'
required:
- type
- attributes
@@ -126629,7 +126690,7 @@ components:
$ref: "#/components/schemas/WorkflowRunAsUserMode"
readOnly: true
spec:
- $ref: "#/components/schemas/Spec"
+ $ref: '#/components/schemas/Spec'
tags:
description: Tags of the workflow.
items:
@@ -126653,9 +126714,9 @@ components:
description: The definition of `WorkflowDataRelationships` object.
properties:
creator:
- $ref: "#/components/schemas/WorkflowUserRelationship"
+ $ref: '#/components/schemas/WorkflowUserRelationship'
owner:
- $ref: "#/components/schemas/WorkflowUserRelationship"
+ $ref: '#/components/schemas/WorkflowUserRelationship'
runAs:
$ref: "#/components/schemas/WorkflowUserRelationship"
description: The service account used to run the workflow. Present when `runAsUserMode` is `service_account`.
@@ -126673,14 +126734,14 @@ components:
description: Data related to the workflow being updated.
properties:
attributes:
- $ref: "#/components/schemas/WorkflowDataUpdateAttributes"
+ $ref: '#/components/schemas/WorkflowDataUpdateAttributes'
id:
description: The workflow identifier
type: string
relationships:
- $ref: "#/components/schemas/WorkflowDataRelationships"
+ $ref: '#/components/schemas/WorkflowDataRelationships'
type:
- $ref: "#/components/schemas/WorkflowDataType"
+ $ref: '#/components/schemas/WorkflowDataType'
required:
- type
- attributes
@@ -126709,7 +126770,7 @@ components:
$ref: "#/components/schemas/WorkflowRunAsUserMode"
readOnly: true
spec:
- $ref: "#/components/schemas/Spec"
+ $ref: '#/components/schemas/Spec'
tags:
description: Tags of the workflow.
items:
@@ -126738,14 +126799,14 @@ components:
description: Request used to create a workflow instance.
properties:
meta:
- $ref: "#/components/schemas/WorkflowInstanceCreateMeta"
+ $ref: '#/components/schemas/WorkflowInstanceCreateMeta'
type: object
WorkflowInstanceCreateResponse:
additionalProperties: {}
description: Response returned upon successful workflow instance creation.
properties:
data:
- $ref: "#/components/schemas/WorkflowInstanceCreateResponseData"
+ $ref: '#/components/schemas/WorkflowInstanceCreateResponseData'
type: object
WorkflowInstanceCreateResponseData:
additionalProperties: {}
@@ -126770,17 +126831,17 @@ components:
data:
description: A list of workflow instances.
items:
- $ref: "#/components/schemas/WorkflowInstanceListItem"
+ $ref: '#/components/schemas/WorkflowInstanceListItem'
type: array
meta:
- $ref: "#/components/schemas/WorkflowListInstancesResponseMeta"
+ $ref: '#/components/schemas/WorkflowListInstancesResponseMeta'
type: object
WorkflowListInstancesResponseMeta:
additionalProperties: {}
description: Metadata about the instances list
properties:
page:
- $ref: "#/components/schemas/WorkflowListInstancesResponseMetaPage"
+ $ref: '#/components/schemas/WorkflowListInstancesResponseMetaPage'
type: object
WorkflowListInstancesResponseMetaPage:
additionalProperties: {}
@@ -126795,15 +126856,15 @@ components:
description: A workflow returned by the list workflows endpoint.
properties:
attributes:
- $ref: "#/components/schemas/WorkflowListItemAttributes"
+ $ref: '#/components/schemas/WorkflowListItemAttributes'
id:
description: The workflow identifier.
readOnly: true
type: string
relationships:
- $ref: "#/components/schemas/WorkflowDataRelationships"
+ $ref: '#/components/schemas/WorkflowDataRelationships'
type:
- $ref: "#/components/schemas/WorkflowDataType"
+ $ref: '#/components/schemas/WorkflowDataType'
required:
- type
- attributes
@@ -126851,15 +126912,15 @@ components:
example:
type: owner
oneOf:
- - $ref: "#/components/schemas/WorkflowRunAsOwner"
- - $ref: "#/components/schemas/WorkflowRunAsServiceAccount"
- - $ref: "#/components/schemas/WorkflowRunAsInitiator"
+ - $ref: '#/components/schemas/WorkflowRunAsOwner'
+ - $ref: '#/components/schemas/WorkflowRunAsServiceAccount'
+ - $ref: '#/components/schemas/WorkflowRunAsInitiator'
WorkflowRunAsInitiator:
additionalProperties: false
description: Run the workflow as the user who initiates the execution.
properties:
type:
- $ref: "#/components/schemas/WorkflowRunAsInitiatorType"
+ $ref: '#/components/schemas/WorkflowRunAsInitiatorType'
required:
- type
type: object
@@ -126876,7 +126937,7 @@ components:
description: Run the workflow as its owner.
properties:
type:
- $ref: "#/components/schemas/WorkflowRunAsOwnerType"
+ $ref: '#/components/schemas/WorkflowRunAsOwnerType'
required:
- type
type: object
@@ -126897,7 +126958,7 @@ components:
example: 00000000-0000-0000-0000-000000000007
type: string
type:
- $ref: "#/components/schemas/WorkflowRunAsServiceAccountType"
+ $ref: '#/components/schemas/WorkflowRunAsServiceAccountType'
required:
- type
- id
@@ -126926,7 +126987,7 @@ components:
description: "Schema for a Workflow-based trigger."
properties:
startStepNames:
- $ref: "#/components/schemas/StartStepNames"
+ $ref: '#/components/schemas/StartStepNames'
workflowTrigger:
description: "Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger."
type: object
@@ -126937,7 +126998,7 @@ components:
description: The definition of `WorkflowUserRelationship` object.
properties:
data:
- $ref: "#/components/schemas/WorkflowUserRelationshipData"
+ $ref: '#/components/schemas/WorkflowUserRelationshipData'
type: object
WorkflowUserRelationshipData:
description: The definition of `WorkflowUserRelationshipData` object.
@@ -126947,7 +127008,7 @@ components:
example: ""
type: string
type:
- $ref: "#/components/schemas/WorkflowUserRelationshipType"
+ $ref: '#/components/schemas/WorkflowUserRelationshipType'
required:
- type
- id
@@ -126964,7 +127025,7 @@ components:
description: Information about the canceled instance.
properties:
data:
- $ref: "#/components/schemas/WorklflowCancelInstanceResponseData"
+ $ref: '#/components/schemas/WorklflowCancelInstanceResponseData'
type: object
WorklflowCancelInstanceResponseData:
description: Data about the canceled instance.
@@ -126978,14 +127039,14 @@ components:
description: The state of the given workflow instance.
properties:
data:
- $ref: "#/components/schemas/WorklflowGetInstanceResponseData"
+ $ref: '#/components/schemas/WorklflowGetInstanceResponseData'
type: object
WorklflowGetInstanceResponseData:
additionalProperties: {}
description: The data of the instance response.
properties:
attributes:
- $ref: "#/components/schemas/WorklflowGetInstanceResponseDataAttributes"
+ $ref: '#/components/schemas/WorklflowGetInstanceResponseDataAttributes'
type: object
WorklflowGetInstanceResponseDataAttributes:
additionalProperties: {}
@@ -127024,14 +127085,14 @@ components:
XRayServicesList:
description: AWS X-Ray services to collect traces from. Defaults to `include_only`.
oneOf:
- - $ref: "#/components/schemas/XRayServicesIncludeAll"
- - $ref: "#/components/schemas/XRayServicesIncludeOnly"
+ - $ref: '#/components/schemas/XRayServicesIncludeAll'
+ - $ref: '#/components/schemas/XRayServicesIncludeOnly'
ZoomConfigurationReference:
description: A reference to a Zoom configuration resource.
nullable: true
properties:
data:
- $ref: "#/components/schemas/ZoomConfigurationReferenceData"
+ $ref: '#/components/schemas/ZoomConfigurationReferenceData'
required:
- data
type: object
@@ -127261,7 +127322,7 @@ paths:
meta:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/FleetTracersResponse"
+ $ref: '#/components/schemas/FleetTracersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -127352,7 +127413,7 @@ paths:
version_to_latest: 0
type: schedule
schema:
- $ref: "#/components/schemas/FleetScheduleCreateRequest"
+ $ref: '#/components/schemas/FleetScheduleCreateRequest'
description: Request payload containing the schedule details.
required: true
responses:
@@ -127378,7 +127439,7 @@ paths:
id: abc-123
type: schedule
schema:
- $ref: "#/components/schemas/FleetScheduleResponse"
+ $ref: '#/components/schemas/FleetScheduleResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -127508,7 +127569,7 @@ paths:
query: "env:prod AND service:api"
type: schedule
schema:
- $ref: "#/components/schemas/FleetSchedulePatchRequest"
+ $ref: '#/components/schemas/FleetSchedulePatchRequest'
description: Request payload containing the fields to update.
required: true
responses:
@@ -127538,7 +127599,7 @@ paths:
id: abc-def-ghi-123
type: schedule
schema:
- $ref: "#/components/schemas/FleetScheduleResponse"
+ $ref: '#/components/schemas/FleetScheduleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -127610,7 +127671,7 @@ paths:
id: abc-123
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentResponse"
+ $ref: '#/components/schemas/FleetDeploymentResponse'
description: CREATED - Deployment successfully created and started.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -127706,7 +127767,7 @@ paths:
meta:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/FleetTracersResponse"
+ $ref: '#/components/schemas/FleetTracersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -127768,19 +127829,19 @@ paths:
id: "my-custom-evaluator"
type: "evaluator_config"
schema:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigListResponse"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigListResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -127807,25 +127868,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -127876,31 +127937,31 @@ paths:
id: "my-custom-evaluator"
type: "evaluator_config"
schema:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigResponse"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -127980,7 +128041,7 @@ paths:
id: "my-custom-evaluator"
type: "evaluator_config"
schema:
- $ref: "#/components/schemas/LLMObsCustomEvalConfigUpdateRequest"
+ $ref: '#/components/schemas/LLMObsCustomEvalConfigUpdateRequest'
description: Custom evaluator configuration payload.
required: true
responses:
@@ -127990,31 +128051,31 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128051,7 +128112,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: datastores
schema:
- $ref: "#/components/schemas/DatastoreArray"
+ $ref: '#/components/schemas/DatastoreArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128080,7 +128141,7 @@ paths:
primary_key_generation_strategy: none
type: datastores
schema:
- $ref: "#/components/schemas/CreateAppsDatastoreRequest"
+ $ref: '#/components/schemas/CreateAppsDatastoreRequest'
required: true
responses:
"200":
@@ -128093,13 +128154,13 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: datastores
schema:
- $ref: "#/components/schemas/CreateAppsDatastoreResponse"
+ $ref: '#/components/schemas/CreateAppsDatastoreResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128129,7 +128190,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128170,19 +128231,19 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: datastores
schema:
- $ref: "#/components/schemas/Datastore"
+ $ref: '#/components/schemas/Datastore'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128213,7 +128274,7 @@ paths:
data:
type: datastores
schema:
- $ref: "#/components/schemas/UpdateAppsDatastoreRequest"
+ $ref: '#/components/schemas/UpdateAppsDatastoreRequest'
required: true
responses:
"200":
@@ -128234,19 +128295,19 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: datastores
schema:
- $ref: "#/components/schemas/Datastore"
+ $ref: '#/components/schemas/Datastore'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128281,7 +128342,7 @@ paths:
item_key: primaryKey
type: items
schema:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemRequest"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemRequest'
required: true
responses:
"200":
@@ -128294,19 +128355,19 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: items
schema:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemResponse"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128378,19 +128439,19 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: items
schema:
- $ref: "#/components/schemas/ItemApiPayloadArray"
+ $ref: '#/components/schemas/ItemApiPayloadArray'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128427,7 +128488,7 @@ paths:
item_key: my-item-key
type: items
schema:
- $ref: "#/components/schemas/UpdateAppsDatastoreItemRequest"
+ $ref: '#/components/schemas/UpdateAppsDatastoreItemRequest'
required: true
responses:
"200":
@@ -128449,19 +128510,19 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: items
schema:
- $ref: "#/components/schemas/ItemApiPayload"
+ $ref: '#/components/schemas/ItemApiPayload'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128494,7 +128555,7 @@ paths:
data:
type: items
schema:
- $ref: "#/components/schemas/BulkDeleteAppsDatastoreItemsRequest"
+ $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequest'
required: true
responses:
"200":
@@ -128507,19 +128568,19 @@ paths:
- id: 00000000-0000-0000-0000-000000000010
type: items
schema:
- $ref: "#/components/schemas/DeleteAppsDatastoreItemResponseArray"
+ $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseArray'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128527,7 +128588,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Bulk delete datastore items
tags:
@@ -128564,7 +128625,7 @@ paths:
key: value2
type: items
schema:
- $ref: "#/components/schemas/BulkPutAppsDatastoreItemsRequest"
+ $ref: '#/components/schemas/BulkPutAppsDatastoreItemsRequest'
required: true
responses:
"200":
@@ -128577,19 +128638,19 @@ paths:
- id: 00000000-0000-0000-0000-000000000011
type: items
schema:
- $ref: "#/components/schemas/PutAppsDatastoreItemResponseArray"
+ $ref: '#/components/schemas/PutAppsDatastoreItemResponseArray'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -128634,25 +128695,25 @@ paths:
total: 1
total_filtered: 1
schema:
- $ref: "#/components/schemas/ListAppKeyRegistrationsResponse"
+ $ref: '#/components/schemas/ListAppKeyRegistrationsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: List App Key Registrations
tags:
@@ -128675,25 +128736,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Unregister an App Key
tags:
@@ -128721,31 +128782,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: app_key_registration
schema:
- $ref: "#/components/schemas/GetAppKeyRegistrationResponse"
+ $ref: '#/components/schemas/GetAppKeyRegistrationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Get an existing App Key Registration
tags:
@@ -128771,25 +128832,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: app_key_registration
schema:
- $ref: "#/components/schemas/RegisterAppKeyResponse"
+ $ref: '#/components/schemas/RegisterAppKeyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Register a new App Key
tags:
@@ -128825,7 +128886,7 @@ paths:
- team:action-platform
type: action_connection
schema:
- $ref: "#/components/schemas/CreateActionConnectionRequest"
+ $ref: '#/components/schemas/CreateActionConnectionRequest'
required: true
responses:
"201":
@@ -128845,25 +128906,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: action_connection
schema:
- $ref: "#/components/schemas/CreateActionConnectionResponse"
+ $ref: '#/components/schemas/CreateActionConnectionResponse'
description: Successfully created Action Connection
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Request
summary: Create a new Action Connection
tags:
@@ -128882,19 +128943,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Request
summary: Delete an existing Action Connection
tags:
@@ -128927,31 +128988,31 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: action_connection
schema:
- $ref: "#/components/schemas/GetActionConnectionResponse"
+ $ref: '#/components/schemas/GetActionConnectionResponse'
description: Successfully get Action Connection
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Request
summary: Get an existing Action Connection
tags:
@@ -128978,7 +129039,7 @@ paths:
- team:action-platform
type: action_connection
schema:
- $ref: "#/components/schemas/UpdateActionConnectionRequest"
+ $ref: '#/components/schemas/UpdateActionConnectionRequest'
description: Update an existing Action Connection request body
required: true
responses:
@@ -128999,31 +129060,31 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: action_connection
schema:
- $ref: "#/components/schemas/UpdateActionConnectionResponse"
+ $ref: '#/components/schemas/UpdateActionConnectionResponse'
description: Successfully updated Action Connection
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Request
summary: Update an existing Action Connection
tags:
@@ -129083,7 +129144,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/ExecutionPolicyIntegration"
+ $ref: '#/components/schemas/ExecutionPolicyIntegration'
type: array
style: form
- description: Filter execution policies by a list of effects.
@@ -129095,7 +129156,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/ExecutionPolicyEffect"
+ $ref: '#/components/schemas/ExecutionPolicyEffect'
type: array
style: form
- description: Filter execution policies by a list of creator IDs.
@@ -129152,19 +129213,19 @@ paths:
page:
total: 1
schema:
- $ref: "#/components/schemas/ExecutionPolicyListResponse"
+ $ref: '#/components/schemas/ExecutionPolicyListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129198,7 +129259,7 @@ paths:
name: "Block prod restarts"
type: execution_policy
schema:
- $ref: "#/components/schemas/ExecutionPolicyCreateRequest"
+ $ref: '#/components/schemas/ExecutionPolicyCreateRequest'
description: The execution policy to create.
required: true
responses:
@@ -129225,19 +129286,19 @@ paths:
id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: execution_policy
schema:
- $ref: "#/components/schemas/ExecutionPolicyResponse"
+ $ref: '#/components/schemas/ExecutionPolicyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129266,13 +129327,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129316,19 +129377,19 @@ paths:
id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: execution_policy
schema:
- $ref: "#/components/schemas/ExecutionPolicyResponse"
+ $ref: '#/components/schemas/ExecutionPolicyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129367,7 +129428,7 @@ paths:
id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: execution_policy
schema:
- $ref: "#/components/schemas/ExecutionPolicyUpdateRequest"
+ $ref: '#/components/schemas/ExecutionPolicyUpdateRequest'
description: The new execution policy.
required: true
responses:
@@ -129394,25 +129455,25 @@ paths:
id: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
type: execution_policy
schema:
- $ref: "#/components/schemas/ExecutionPolicyResponse"
+ $ref: '#/components/schemas/ExecutionPolicyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129448,7 +129509,7 @@ paths:
id: "123456789012"
type: aws_scan_options
schema:
- $ref: "#/components/schemas/AwsScanOptionsListResponse"
+ $ref: '#/components/schemas/AwsScanOptionsListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -129481,7 +129542,7 @@ paths:
id: "123456789012"
type: aws_scan_options
schema:
- $ref: "#/components/schemas/AwsScanOptionsCreateRequest"
+ $ref: '#/components/schemas/AwsScanOptionsCreateRequest'
description: The definition of the new scan options.
required: true
responses:
@@ -129500,7 +129561,7 @@ paths:
id: "123456789012"
type: aws_scan_options
schema:
- $ref: "#/components/schemas/AwsScanOptionsResponse"
+ $ref: '#/components/schemas/AwsScanOptionsResponse'
description: Agentless scan options enabled successfully.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -129565,7 +129626,7 @@ paths:
id: "123456789012"
type: aws_scan_options
schema:
- $ref: "#/components/schemas/AwsScanOptionsResponse"
+ $ref: '#/components/schemas/AwsScanOptionsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -129604,7 +129665,7 @@ paths:
id: "123456789012"
type: aws_scan_options
schema:
- $ref: "#/components/schemas/AwsScanOptionsUpdateRequest"
+ $ref: '#/components/schemas/AwsScanOptionsUpdateRequest'
description: New definition of the scan options.
required: true
responses:
@@ -129645,7 +129706,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptionsArray"
+ $ref: '#/components/schemas/AzureScanOptionsArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129675,7 +129736,7 @@ paths:
id: 12345678-90ab-cdef-1234-567890abcdef
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptions"
+ $ref: '#/components/schemas/AzureScanOptions'
required: true
responses:
"201":
@@ -129691,7 +129752,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptions"
+ $ref: '#/components/schemas/AzureScanOptions'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129755,7 +129816,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptions"
+ $ref: '#/components/schemas/AzureScanOptions'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -129796,7 +129857,7 @@ paths:
id: 12345678-90ab-cdef-1234-567890abcdef
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptionsInputUpdate"
+ $ref: '#/components/schemas/AzureScanOptionsInputUpdate'
required: true
responses:
"200":
@@ -129812,7 +129873,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: azure_scan_options
schema:
- $ref: "#/components/schemas/AzureScanOptions"
+ $ref: '#/components/schemas/AzureScanOptions'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -129843,7 +129904,7 @@ paths:
id: abc-123
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptionsArray"
+ $ref: '#/components/schemas/GcpScanOptionsArray'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -129875,7 +129936,7 @@ paths:
id: company-project-id
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptions"
+ $ref: '#/components/schemas/GcpScanOptions'
description: The definition of the new scan options.
required: true
responses:
@@ -129892,7 +129953,7 @@ paths:
id: abc-123
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptions"
+ $ref: '#/components/schemas/GcpScanOptions'
description: Agentless scan options enabled successfully.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -129969,7 +130030,7 @@ paths:
id: abc-123
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptions"
+ $ref: '#/components/schemas/GcpScanOptions'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -130011,7 +130072,7 @@ paths:
id: company-project-id
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptionsInputUpdate"
+ $ref: '#/components/schemas/GcpScanOptionsInputUpdate'
description: New definition of the scan options.
required: true
responses:
@@ -130028,7 +130089,7 @@ paths:
id: abc-123
type: gcp_scan_options
schema:
- $ref: "#/components/schemas/GcpScanOptions"
+ $ref: '#/components/schemas/GcpScanOptions'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -130068,7 +130129,7 @@ paths:
id: abc-123
type: aws_resource
schema:
- $ref: "#/components/schemas/AwsOnDemandListResponse"
+ $ref: '#/components/schemas/AwsOnDemandListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -130100,7 +130161,7 @@ paths:
arn: arn:aws:ec2:us-east-1:727000456123:instance/i-0eabb50529b67a1ba
type: aws_resource
schema:
- $ref: "#/components/schemas/AwsOnDemandCreateRequest"
+ $ref: '#/components/schemas/AwsOnDemandCreateRequest'
description: The definition of the on demand task.
required: true
responses:
@@ -130118,7 +130179,7 @@ paths:
id: abc-123
type: aws_resource
schema:
- $ref: "#/components/schemas/AwsOnDemandResponse"
+ $ref: '#/components/schemas/AwsOnDemandResponse'
description: AWS on demand task created successfully.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -130161,7 +130222,7 @@ paths:
id: abc-123
type: aws_resource
schema:
- $ref: "#/components/schemas/AwsOnDemandResponse"
+ $ref: '#/components/schemas/AwsOnDemandResponse'
description: OK.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -130228,19 +130289,19 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: annotation
schema:
- $ref: "#/components/schemas/AnnotationsResponse"
+ $ref: '#/components/schemas/AnnotationsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130248,7 +130309,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -130283,7 +130344,7 @@ paths:
- "1234567890"
type: annotation
schema:
- $ref: "#/components/schemas/AnnotationCreateRequest"
+ $ref: '#/components/schemas/AnnotationCreateRequest'
description: Annotation to create.
required: true
responses:
@@ -130309,19 +130370,19 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: annotation
schema:
- $ref: "#/components/schemas/AnnotationResponse"
+ $ref: '#/components/schemas/AnnotationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130329,7 +130390,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -130383,19 +130444,19 @@ paths:
id: "dashboard:abc-def-xyz"
type: page_annotations
schema:
- $ref: "#/components/schemas/PageAnnotationsResponse"
+ $ref: '#/components/schemas/PageAnnotationsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130403,7 +130464,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -130430,13 +130491,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130444,7 +130505,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -130481,7 +130542,7 @@ paths:
- "1234567890"
type: annotation
schema:
- $ref: "#/components/schemas/AnnotationUpdateRequest"
+ $ref: '#/components/schemas/AnnotationUpdateRequest'
description: Updated annotation payload.
required: true
responses:
@@ -130507,25 +130568,25 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: annotation
schema:
- $ref: "#/components/schemas/AnnotationResponse"
+ $ref: '#/components/schemas/AnnotationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130533,7 +130594,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -130563,7 +130624,7 @@ paths:
- "00000000-0000-0000-0000-000000000000"
type: anonymize_users_request
schema:
- $ref: "#/components/schemas/AnonymizeUsersRequest"
+ $ref: '#/components/schemas/AnonymizeUsersRequest'
required: true
responses:
"200":
@@ -130576,19 +130637,19 @@ paths:
id: abc-123
type: anonymize_users_response
schema:
- $ref: "#/components/schemas/AnonymizeUsersResponse"
+ $ref: '#/components/schemas/AnonymizeUsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130639,19 +130700,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeysResponse"
+ $ref: '#/components/schemas/APIKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130677,7 +130738,7 @@ paths:
name: API Key for submitting metrics
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeyCreateRequest"
+ $ref: '#/components/schemas/APIKeyCreateRequest'
required: true
responses:
"201":
@@ -130695,19 +130756,19 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeyResponse"
+ $ref: '#/components/schemas/APIKeyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130733,13 +130794,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130773,19 +130834,19 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeyResponse"
+ $ref: '#/components/schemas/APIKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130814,7 +130875,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeyUpdateRequest"
+ $ref: '#/components/schemas/APIKeyUpdateRequest'
required: true
responses:
"200":
@@ -130832,25 +130893,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: api_keys
schema:
- $ref: "#/components/schemas/APIKeyResponse"
+ $ref: '#/components/schemas/APIKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130911,19 +130972,19 @@ paths:
offset: 0
total_count: 1
schema:
- $ref: "#/components/schemas/ListAPIsResponse"
+ $ref: '#/components/schemas/ListAPIsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -130952,7 +131013,7 @@ paths:
name: id
required: true
schema:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
responses:
"204":
description: API deleted successfully
@@ -130960,19 +131021,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: API not found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131001,7 +131062,7 @@ paths:
name: id
required: true
schema:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
responses:
"200":
content:
@@ -131017,19 +131078,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: API not found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131059,7 +131120,7 @@ paths:
name: id
required: true
schema:
- $ref: "#/components/schemas/ApiID"
+ $ref: '#/components/schemas/ApiID'
requestBody:
content:
multipart/form-data:
@@ -131068,7 +131129,7 @@ paths:
value:
openapi_spec_file: openapi-spec.yaml
schema:
- $ref: "#/components/schemas/OpenAPIFile"
+ $ref: '#/components/schemas/OpenAPIFile'
required: true
responses:
"200":
@@ -131082,25 +131143,25 @@ paths:
failed_endpoints: []
id: abc-123
schema:
- $ref: "#/components/schemas/UpdateOpenAPIResponse"
+ $ref: '#/components/schemas/UpdateOpenAPIResponse'
description: API updated successfully
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: API not found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131135,7 +131196,7 @@ paths:
value:
openapi_spec_file: openapi-spec.yaml
schema:
- $ref: "#/components/schemas/OpenAPIFile"
+ $ref: '#/components/schemas/OpenAPIFile'
required: true
responses:
"201":
@@ -131149,19 +131210,19 @@ paths:
failed_endpoints: []
id: abc-123
schema:
- $ref: "#/components/schemas/CreateOpenAPIResponse"
+ $ref: '#/components/schemas/CreateOpenAPIResponse'
description: API created successfully
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131204,7 +131265,7 @@ paths:
id: my.metric
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricsResponse"
+ $ref: '#/components/schemas/SpansMetricsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -131243,7 +131304,7 @@ paths:
id: my.metric
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricCreateRequest"
+ $ref: '#/components/schemas/SpansMetricCreateRequest'
description: The definition of the new span-based metric.
required: true
responses:
@@ -131267,7 +131328,7 @@ paths:
id: my.metric
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricResponse"
+ $ref: '#/components/schemas/SpansMetricResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -131335,7 +131396,7 @@ paths:
id: my.metric
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricResponse"
+ $ref: '#/components/schemas/SpansMetricResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -131375,7 +131436,7 @@ paths:
tag_name: resource_name
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricUpdateRequest"
+ $ref: '#/components/schemas/SpansMetricUpdateRequest'
description: New definition of the span-based metric.
required: true
responses:
@@ -131399,7 +131460,7 @@ paths:
id: my.metric
type: spans_metrics
schema:
- $ref: "#/components/schemas/SpansMetricResponse"
+ $ref: '#/components/schemas/SpansMetricResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -131440,7 +131501,7 @@ paths:
id: abc-123
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFiltersResponse"
+ $ref: '#/components/schemas/RetentionFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -131478,7 +131539,7 @@ paths:
trace_rate: 1.0
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFilterCreateRequest"
+ $ref: '#/components/schemas/RetentionFilterCreateRequest'
description: The definition of the new retention filter.
required: true
responses:
@@ -131499,7 +131560,7 @@ paths:
id: abc-123
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFilterCreateResponse"
+ $ref: '#/components/schemas/RetentionFilterCreateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -131532,7 +131593,7 @@ paths:
- id: 7RBOb7dLSYWI01yc3pIH8w
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/ReorderRetentionFiltersRequest"
+ $ref: '#/components/schemas/ReorderRetentionFiltersRequest'
description: The list of retention filters in the new order.
required: true
responses:
@@ -131602,7 +131663,7 @@ paths:
id: abc-123
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFilterResponse"
+ $ref: '#/components/schemas/RetentionFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -131644,7 +131705,7 @@ paths:
id: retention-filter-id
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFilterUpdateRequest"
+ $ref: '#/components/schemas/RetentionFilterUpdateRequest'
description: The updated definition of the retention filter.
required: true
responses:
@@ -131665,7 +131726,7 @@ paths:
id: abc-123
type: apm_retention_filter
schema:
- $ref: "#/components/schemas/RetentionFilterResponse"
+ $ref: '#/components/schemas/RetentionFilterResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -131711,7 +131772,7 @@ paths:
id: abc-123
type: services_list
schema:
- $ref: "#/components/schemas/ServiceList"
+ $ref: '#/components/schemas/ServiceList'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131742,7 +131803,7 @@ paths:
- id: ab1ed73e-13ad-4426-b0df-a0ff8876a088
type: appDefinitions
schema:
- $ref: "#/components/schemas/DeleteAppsRequest"
+ $ref: '#/components/schemas/DeleteAppsRequest'
required: true
responses:
"200":
@@ -131755,25 +131816,25 @@ paths:
- id: 00000000-0000-0000-0000-000000000001
type: appDefinitions
schema:
- $ref: "#/components/schemas/DeleteAppsResponse"
+ $ref: '#/components/schemas/DeleteAppsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131860,7 +131921,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/AppsSortField"
+ $ref: '#/components/schemas/AppsSortField'
type: array
style: form
responses:
@@ -131885,19 +131946,19 @@ paths:
totalCount: 1
totalFilteredCount: 1
schema:
- $ref: "#/components/schemas/ListAppsResponse"
+ $ref: '#/components/schemas/ListAppsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131927,7 +131988,7 @@ paths:
rootInstanceName: grid0
type: appDefinitions
schema:
- $ref: "#/components/schemas/CreateAppRequest"
+ $ref: '#/components/schemas/CreateAppRequest'
required: true
responses:
"201":
@@ -131940,19 +132001,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: appDefinitions
schema:
- $ref: "#/components/schemas/CreateAppResponse"
+ $ref: '#/components/schemas/CreateAppResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -131990,31 +132051,31 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: appDefinitions
schema:
- $ref: "#/components/schemas/DeleteAppResponse"
+ $ref: '#/components/schemas/DeleteAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"410":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Gone
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132061,31 +132122,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: appDefinitions
schema:
- $ref: "#/components/schemas/GetAppResponse"
+ $ref: '#/components/schemas/GetAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"410":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Gone
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132126,7 +132187,7 @@ paths:
id: 9e20cbaf-68da-45a6-9ccf-54193ac29fa5
type: appDefinitions
schema:
- $ref: "#/components/schemas/UpdateAppRequest"
+ $ref: '#/components/schemas/UpdateAppRequest'
required: true
responses:
"200":
@@ -132145,19 +132206,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: appDefinitions
schema:
- $ref: "#/components/schemas/UpdateAppResponse"
+ $ref: '#/components/schemas/UpdateAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132197,25 +132258,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: deployment
schema:
- $ref: "#/components/schemas/UnpublishAppResponse"
+ $ref: '#/components/schemas/UnpublishAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132252,25 +132313,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: deployment
schema:
- $ref: "#/components/schemas/PublishAppResponse"
+ $ref: '#/components/schemas/PublishAppResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132306,7 +132367,7 @@ paths:
favorite: true
type: favorites
schema:
- $ref: "#/components/schemas/UpdateAppFavoriteRequest"
+ $ref: '#/components/schemas/UpdateAppFavoriteRequest'
required: true
responses:
"204":
@@ -132315,19 +132376,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132363,7 +132424,7 @@ paths:
protectionLevel: approval_required
type: protectionLevel
schema:
- $ref: "#/components/schemas/UpdateAppProtectionLevelRequest"
+ $ref: '#/components/schemas/UpdateAppProtectionLevelRequest'
required: true
responses:
"200":
@@ -132384,25 +132445,25 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: appDefinitions
schema:
- $ref: "#/components/schemas/UpdateAppResponse"
+ $ref: '#/components/schemas/UpdateAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132439,7 +132500,7 @@ paths:
title: Release v1.2 to production
type: publishRequest
schema:
- $ref: "#/components/schemas/CreatePublishRequestRequest"
+ $ref: '#/components/schemas/CreatePublishRequestRequest'
required: true
responses:
"201":
@@ -132458,25 +132519,25 @@ paths:
user_uuid: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: deployment
schema:
- $ref: "#/components/schemas/PublishAppResponse"
+ $ref: '#/components/schemas/PublishAppResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132527,25 +132588,25 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: appDefinitions
schema:
- $ref: "#/components/schemas/UpdateAppResponse"
+ $ref: '#/components/schemas/UpdateAppResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132581,7 +132642,7 @@ paths:
selfService: true
type: selfService
schema:
- $ref: "#/components/schemas/UpdateAppSelfServiceRequest"
+ $ref: '#/components/schemas/UpdateAppSelfServiceRequest'
required: true
responses:
"204":
@@ -132590,19 +132651,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132640,7 +132701,7 @@ paths:
- service:ops
type: tags
schema:
- $ref: "#/components/schemas/UpdateAppTagsRequest"
+ $ref: '#/components/schemas/UpdateAppTagsRequest'
required: true
responses:
"204":
@@ -132649,19 +132710,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132704,7 +132765,7 @@ paths:
name: v1.2.0 - bug fix release
type: versionNames
schema:
- $ref: "#/components/schemas/UpdateAppVersionNameRequest"
+ $ref: '#/components/schemas/UpdateAppVersionNameRequest'
required: true
responses:
"204":
@@ -132713,19 +132774,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132787,25 +132848,25 @@ paths:
page:
totalCount: 1
schema:
- $ref: "#/components/schemas/ListAppVersionsResponse"
+ $ref: '#/components/schemas/ListAppVersionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132849,19 +132910,19 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: blueprint
schema:
- $ref: "#/components/schemas/GetBlueprintResponse"
+ $ref: '#/components/schemas/GetBlueprintResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132912,13 +132973,13 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: blueprint
schema:
- $ref: "#/components/schemas/ListBlueprintsResponse"
+ $ref: '#/components/schemas/ListBlueprintsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -132964,13 +133025,13 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: blueprint
schema:
- $ref: "#/components/schemas/GetBlueprintsResponse"
+ $ref: '#/components/schemas/GetBlueprintsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133015,13 +133076,13 @@ paths:
id: 65bb1f25-52e1-4510-9f8d-22d1516ed693
type: blueprint
schema:
- $ref: "#/components/schemas/GetBlueprintsResponse"
+ $ref: '#/components/schemas/GetBlueprintsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133051,13 +133112,13 @@ paths:
- id: production
type: tag
schema:
- $ref: "#/components/schemas/AppBuilderListTagsResponse"
+ $ref: '#/components/schemas/AppBuilderListTagsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133097,25 +133158,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: application_keys
schema:
- $ref: "#/components/schemas/ListApplicationKeysResponse"
+ $ref: '#/components/schemas/ListApplicationKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133140,13 +133201,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133180,25 +133241,25 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133231,7 +133292,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyUpdateRequest"
+ $ref: '#/components/schemas/ApplicationKeyUpdateRequest'
required: true
responses:
"200":
@@ -133248,25 +133309,25 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133318,7 +133379,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/AuditLogsSort"
+ $ref: '#/components/schemas/AuditLogsSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -133358,7 +133419,7 @@ paths:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
status: done
schema:
- $ref: "#/components/schemas/AuditLogsEventsResponse"
+ $ref: '#/components/schemas/AuditLogsEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -133405,7 +133466,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/AuditLogsSearchEventsRequest"
+ $ref: '#/components/schemas/AuditLogsSearchEventsRequest'
required: false
responses:
"200":
@@ -133430,7 +133491,7 @@ paths:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
status: done
schema:
- $ref: "#/components/schemas/AuditLogsEventsResponse"
+ $ref: '#/components/schemas/AuditLogsEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -133463,7 +133524,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/AuthNMappingsSort"
+ $ref: '#/components/schemas/AuthNMappingsSort'
- description: Filter all mappings by the given string.
in: query
name: filter
@@ -133474,7 +133535,7 @@ paths:
in: query
name: resource_type
schema:
- $ref: "#/components/schemas/AuthNMappingResourceType"
+ $ref: '#/components/schemas/AuthNMappingResourceType'
responses:
"200":
content:
@@ -133489,13 +133550,13 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingsResponse"
+ $ref: '#/components/schemas/AuthNMappingsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133522,7 +133583,7 @@ paths:
attribute_value: Development
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingCreateRequest"
+ $ref: '#/components/schemas/AuthNMappingCreateRequest'
required: true
responses:
"200":
@@ -133538,25 +133599,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingResponse"
+ $ref: '#/components/schemas/AuthNMappingResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133582,13 +133643,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133619,19 +133680,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingResponse"
+ $ref: '#/components/schemas/AuthNMappingResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133661,7 +133722,7 @@ paths:
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingUpdateRequest"
+ $ref: '#/components/schemas/AuthNMappingUpdateRequest'
required: true
responses:
"200":
@@ -133677,37 +133738,37 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: authn_mappings
schema:
- $ref: "#/components/schemas/AuthNMappingResponse"
+ $ref: '#/components/schemas/AuthNMappingResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133774,13 +133835,13 @@ paths:
offset: 0
total: 50
schema:
- $ref: "#/components/schemas/ListInvestigationsResponse"
+ $ref: '#/components/schemas/ListInvestigationsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133823,7 +133884,7 @@ paths:
type: monitor_alert_trigger
type: trigger_investigation_request
schema:
- $ref: "#/components/schemas/TriggerInvestigationRequest"
+ $ref: '#/components/schemas/TriggerInvestigationRequest'
description: Trigger investigation request body.
required: true
responses:
@@ -133839,13 +133900,13 @@ paths:
id: "f5e6a7b8-c9d0-1e2f-3a4b-5c6d7e8f9a0b"
type: trigger_investigation_response
schema:
- $ref: "#/components/schemas/TriggerInvestigationResponse"
+ $ref: '#/components/schemas/TriggerInvestigationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133898,19 +133959,19 @@ paths:
links:
self: "https://app.datadoghq.com/bits-ai/investigations/a1b2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
schema:
- $ref: "#/components/schemas/GetInvestigationResponse"
+ $ref: '#/components/schemas/GetInvestigationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -133981,7 +134042,7 @@ paths:
size: 10
total: 1
schema:
- $ref: "#/components/schemas/CasesResponse"
+ $ref: '#/components/schemas/CasesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134033,7 +134094,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseCreateRequest"
+ $ref: '#/components/schemas/CaseCreateRequest'
description: Case payload
required: true
responses:
@@ -134059,7 +134120,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134099,7 +134160,7 @@ paths:
query_filter: "service:case-api"
type: aggregate
schema:
- $ref: "#/components/schemas/CaseAggregateRequest"
+ $ref: '#/components/schemas/CaseAggregateRequest'
description: Case aggregate request payload.
required: true
responses:
@@ -134119,7 +134180,7 @@ paths:
id: agg-result-001
type: aggregate
schema:
- $ref: "#/components/schemas/CaseAggregateResponse"
+ $ref: '#/components/schemas/CaseAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134160,7 +134221,7 @@ paths:
type: priority
type: bulk
schema:
- $ref: "#/components/schemas/CaseBulkUpdateRequest"
+ $ref: '#/components/schemas/CaseBulkUpdateRequest'
description: Case bulk update request payload.
required: true
responses:
@@ -134227,7 +134288,7 @@ paths:
id: count-result-001
type: count
schema:
- $ref: "#/components/schemas/CaseCountResponse"
+ $ref: '#/components/schemas/CaseCountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134291,7 +134352,7 @@ paths:
id: 804cd682-55f6-4541-ab00-b608b282ea7d
type: link
schema:
- $ref: "#/components/schemas/CaseLinksResponse"
+ $ref: '#/components/schemas/CaseLinksResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134330,7 +134391,7 @@ paths:
relationship: BLOCKS
type: link
schema:
- $ref: "#/components/schemas/CaseLinkCreateRequest"
+ $ref: '#/components/schemas/CaseLinkCreateRequest'
description: "Case link create request."
required: true
responses:
@@ -134350,7 +134411,7 @@ paths:
id: 804cd682-55f6-4541-ab00-b608b282ea7d
type: link
schema:
- $ref: "#/components/schemas/CaseLinkResponse"
+ $ref: '#/components/schemas/CaseLinkResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134418,7 +134479,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: project
schema:
- $ref: "#/components/schemas/ProjectsResponse"
+ $ref: '#/components/schemas/ProjectsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134454,7 +134515,7 @@ paths:
name: Security Investigation
type: project
schema:
- $ref: "#/components/schemas/ProjectCreateRequest"
+ $ref: '#/components/schemas/ProjectCreateRequest'
description: Project payload.
required: true
responses:
@@ -134471,7 +134532,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: project
schema:
- $ref: "#/components/schemas/ProjectResponse"
+ $ref: '#/components/schemas/ProjectResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134507,7 +134568,7 @@ paths:
- id: e555e290-ed65-49bd-ae18-8acbfcf18db7
type: project_favorite
schema:
- $ref: "#/components/schemas/ProjectFavoritesResponse"
+ $ref: '#/components/schemas/ProjectFavoritesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134543,7 +134604,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -134576,7 +134637,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: project
schema:
- $ref: "#/components/schemas/ProjectResponse"
+ $ref: '#/components/schemas/ProjectResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134612,7 +134673,7 @@ paths:
data:
type: project
schema:
- $ref: "#/components/schemas/ProjectUpdateRequest"
+ $ref: '#/components/schemas/ProjectUpdateRequest'
description: Project payload.
required: true
responses:
@@ -134629,7 +134690,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: project
schema:
- $ref: "#/components/schemas/ProjectResponse"
+ $ref: '#/components/schemas/ProjectResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134739,7 +134800,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_rule
schema:
- $ref: "#/components/schemas/CaseNotificationRulesResponse"
+ $ref: '#/components/schemas/CaseNotificationRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134785,7 +134846,7 @@ paths:
- type: CASE_CREATED
type: notification_rule
schema:
- $ref: "#/components/schemas/CaseNotificationRuleCreateRequest"
+ $ref: '#/components/schemas/CaseNotificationRuleCreateRequest'
description: Notification rule payload
required: true
responses:
@@ -134809,7 +134870,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: notification_rule
schema:
- $ref: "#/components/schemas/CaseNotificationRuleResponse"
+ $ref: '#/components/schemas/CaseNotificationRuleResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -134852,7 +134913,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -134892,7 +134953,7 @@ paths:
- type: CASE_CREATED
type: notification_rule
schema:
- $ref: "#/components/schemas/CaseNotificationRuleUpdateRequest"
+ $ref: '#/components/schemas/CaseNotificationRuleUpdateRequest'
description: Notification rule payload
required: true
responses:
@@ -134950,7 +135011,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRulesResponse"
+ $ref: '#/components/schemas/AutomationRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135000,7 +135061,7 @@ paths:
type: CASE_CREATED
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleCreateRequest"
+ $ref: '#/components/schemas/AutomationRuleCreateRequest'
description: Automation rule payload.
required: true
responses:
@@ -135024,7 +135085,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleResponse"
+ $ref: '#/components/schemas/AutomationRuleResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135109,7 +135170,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleResponse"
+ $ref: '#/components/schemas/AutomationRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135160,7 +135221,7 @@ paths:
type: CASE_CREATED
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleUpdateRequest"
+ $ref: '#/components/schemas/AutomationRuleUpdateRequest'
description: Automation rule payload.
required: true
responses:
@@ -135184,7 +135245,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleResponse"
+ $ref: '#/components/schemas/AutomationRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135239,7 +135300,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleResponse"
+ $ref: '#/components/schemas/AutomationRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135294,7 +135355,7 @@ paths:
id: e6773723-fe58-49ff-9975-dff00f14e28d
type: rule
schema:
- $ref: "#/components/schemas/AutomationRuleResponse"
+ $ref: '#/components/schemas/AutomationRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135334,7 +135395,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: case_type
schema:
- $ref: "#/components/schemas/CaseTypesResponse"
+ $ref: '#/components/schemas/CaseTypesResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -135362,7 +135423,7 @@ paths:
name: Investigation
type: case_type
schema:
- $ref: "#/components/schemas/CaseTypeCreateRequest"
+ $ref: '#/components/schemas/CaseTypeCreateRequest'
description: Case type payload
required: true
responses:
@@ -135380,7 +135441,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: case_type
schema:
- $ref: "#/components/schemas/CaseTypeResponse"
+ $ref: '#/components/schemas/CaseTypeResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135416,7 +135477,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigsResponse"
+ $ref: '#/components/schemas/CustomAttributeConfigsResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -135465,7 +135526,7 @@ paths:
name: Investigation
type: case_type
schema:
- $ref: "#/components/schemas/CaseTypeUpdateRequest"
+ $ref: '#/components/schemas/CaseTypeUpdateRequest'
description: Case type payload.
required: true
responses:
@@ -135483,7 +135544,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: case_type
schema:
- $ref: "#/components/schemas/CaseTypeResponse"
+ $ref: '#/components/schemas/CaseTypeResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135528,7 +135589,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigsResponse"
+ $ref: '#/components/schemas/CustomAttributeConfigsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135562,7 +135623,7 @@ paths:
type: NUMBER
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigCreateRequest"
+ $ref: '#/components/schemas/CustomAttributeConfigCreateRequest'
description: Custom attribute config payload
required: true
responses:
@@ -135583,7 +135644,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigResponse"
+ $ref: '#/components/schemas/CustomAttributeConfigResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135639,7 +135700,7 @@ paths:
display_name: AWS Region
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigUpdateRequest"
+ $ref: '#/components/schemas/CustomAttributeConfigUpdateRequest'
description: Custom attribute config payload.
required: true
responses:
@@ -135660,7 +135721,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: custom_attribute
schema:
- $ref: "#/components/schemas/CustomAttributeConfigResponse"
+ $ref: '#/components/schemas/CustomAttributeConfigResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135708,7 +135769,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: view
schema:
- $ref: "#/components/schemas/CaseViewsResponse"
+ $ref: '#/components/schemas/CaseViewsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135745,7 +135806,7 @@ paths:
query: "status:open type:bug"
type: view
schema:
- $ref: "#/components/schemas/CaseViewCreateRequest"
+ $ref: '#/components/schemas/CaseViewCreateRequest'
description: Case view payload.
required: true
responses:
@@ -135763,7 +135824,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: view
schema:
- $ref: "#/components/schemas/CaseViewResponse"
+ $ref: '#/components/schemas/CaseViewResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135832,7 +135893,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: view
schema:
- $ref: "#/components/schemas/CaseViewResponse"
+ $ref: '#/components/schemas/CaseViewResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135869,7 +135930,7 @@ paths:
name: Updated view name
type: view
schema:
- $ref: "#/components/schemas/CaseViewUpdateRequest"
+ $ref: '#/components/schemas/CaseViewUpdateRequest'
description: Case view payload.
required: true
responses:
@@ -135887,7 +135948,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: view
schema:
- $ref: "#/components/schemas/CaseViewResponse"
+ $ref: '#/components/schemas/CaseViewResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135938,7 +135999,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -135974,7 +136035,7 @@ paths:
data:
type: case
schema:
- $ref: "#/components/schemas/CaseEmptyRequest"
+ $ref: '#/components/schemas/CaseEmptyRequest'
description: Archive case payload
required: true
responses:
@@ -136000,7 +136061,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136038,7 +136099,7 @@ paths:
assignee_id: f98a5a5b-e0ff-45d4-b2f5-afe6e74de504
type: case
schema:
- $ref: "#/components/schemas/CaseAssignRequest"
+ $ref: '#/components/schemas/CaseAssignRequest'
description: Assign case payload
required: true
responses:
@@ -136064,7 +136125,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136109,7 +136170,7 @@ paths:
- engineering
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateAttributesRequest"
+ $ref: '#/components/schemas/CaseUpdateAttributesRequest'
description: Case attributes update payload
required: true
responses:
@@ -136135,7 +136196,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136173,7 +136234,7 @@ paths:
comment: This is my comment !
type: case
schema:
- $ref: "#/components/schemas/CaseCommentRequest"
+ $ref: '#/components/schemas/CaseCommentRequest'
description: Case comment payload
required: true
responses:
@@ -136192,7 +136253,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: timeline_cell
schema:
- $ref: "#/components/schemas/TimelineResponse"
+ $ref: '#/components/schemas/TimelineResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136249,7 +136310,7 @@ paths:
comment: Updated comment text
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateCommentRequest"
+ $ref: '#/components/schemas/CaseUpdateCommentRequest'
description: Case update comment payload.
required: true
responses:
@@ -136304,7 +136365,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -136342,7 +136403,7 @@ paths:
value: 42
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateCustomAttributeRequest"
+ $ref: '#/components/schemas/CaseUpdateCustomAttributeRequest'
description: Update case custom attribute payload
required: true
responses:
@@ -136368,7 +136429,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136406,7 +136467,7 @@ paths:
description: Seeing some weird memory increase... We shouldn't ignore this
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateDescriptionRequest"
+ $ref: '#/components/schemas/CaseUpdateDescriptionRequest'
description: Case description update payload
required: true
responses:
@@ -136432,7 +136493,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136470,7 +136531,7 @@ paths:
due_date: "2026-12-31"
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateDueDateRequest"
+ $ref: '#/components/schemas/CaseUpdateDueDateRequest'
description: Case due date update payload.
required: true
responses:
@@ -136496,7 +136557,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136537,7 +136598,7 @@ paths:
type: SECURITY_SIGNAL
type: case
schema:
- $ref: "#/components/schemas/CaseInsightsRequest"
+ $ref: '#/components/schemas/CaseInsightsRequest'
description: Case insights request.
required: true
responses:
@@ -136563,31 +136624,31 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -136620,7 +136681,7 @@ paths:
type: SECURITY_SIGNAL
type: case
schema:
- $ref: "#/components/schemas/CaseInsightsRequest"
+ $ref: '#/components/schemas/CaseInsightsRequest'
description: Case insights request.
required: true
responses:
@@ -136646,31 +136707,31 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -136700,7 +136761,7 @@ paths:
priority: NOT_DEFINED
type: case
schema:
- $ref: "#/components/schemas/CaseUpdatePriorityRequest"
+ $ref: '#/components/schemas/CaseUpdatePriorityRequest'
description: Case priority update payload
required: true
responses:
@@ -136726,7 +136787,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -136763,7 +136824,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: incidents
schema:
- $ref: "#/components/schemas/RelationshipToIncidentRequest"
+ $ref: '#/components/schemas/RelationshipToIncidentRequest'
description: Incident link request
required: true
responses:
@@ -136782,31 +136843,31 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -136832,25 +136893,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -136879,7 +136940,7 @@ paths:
jira_issue_url: https://jira.example.com/browse/PROJ-123
type: issues
schema:
- $ref: "#/components/schemas/JiraIssueLinkRequest"
+ $ref: '#/components/schemas/JiraIssueLinkRequest'
description: Jira issue link request
required: true
responses:
@@ -136889,31 +136950,31 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -136945,7 +137006,7 @@ paths:
project_id: "5678"
type: issues
schema:
- $ref: "#/components/schemas/JiraIssueCreateRequest"
+ $ref: '#/components/schemas/JiraIssueCreateRequest'
description: Jira issue creation request
required: true
responses:
@@ -136955,25 +137016,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -137001,7 +137062,7 @@ paths:
data:
type: notebook
schema:
- $ref: "#/components/schemas/NotebookCreateRequest"
+ $ref: '#/components/schemas/NotebookCreateRequest'
description: Notebook creation request
required: true
responses:
@@ -137011,25 +137072,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -137058,7 +137119,7 @@ paths:
id: e555e290-ed65-49bd-ae18-8acbfcf18db7
type: project
schema:
- $ref: "#/components/schemas/ProjectRelationship"
+ $ref: '#/components/schemas/ProjectRelationship'
description: Project update request
required: true
responses:
@@ -137077,31 +137138,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -137132,7 +137193,7 @@ paths:
instance_name: my-instance
type: tickets
schema:
- $ref: "#/components/schemas/ServiceNowTicketCreateRequest"
+ $ref: '#/components/schemas/ServiceNowTicketCreateRequest'
description: ServiceNow ticket creation request
required: true
responses:
@@ -137142,25 +137203,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -137190,7 +137251,7 @@ paths:
security_resolved_reason: "FALSE_POSITIVE"
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateResolvedReasonRequest"
+ $ref: '#/components/schemas/CaseUpdateResolvedReasonRequest'
description: Case resolved reason update payload.
required: true
responses:
@@ -137216,7 +137277,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137255,7 +137316,7 @@ paths:
status_name: Open
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateStatusRequest"
+ $ref: '#/components/schemas/CaseUpdateStatusRequest'
description: Case status update payload
required: true
responses:
@@ -137281,7 +137342,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137347,7 +137408,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: timeline_cell
schema:
- $ref: "#/components/schemas/TimelineResponse"
+ $ref: '#/components/schemas/TimelineResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137385,7 +137446,7 @@ paths:
title: Memory leak investigation on API
type: case
schema:
- $ref: "#/components/schemas/CaseUpdateTitleRequest"
+ $ref: '#/components/schemas/CaseUpdateTitleRequest'
description: Case title update payload
required: true
responses:
@@ -137411,7 +137472,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137447,7 +137508,7 @@ paths:
data:
type: case
schema:
- $ref: "#/components/schemas/CaseEmptyRequest"
+ $ref: '#/components/schemas/CaseEmptyRequest'
description: Unarchive case payload
required: true
responses:
@@ -137473,7 +137534,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137509,7 +137570,7 @@ paths:
data:
type: case
schema:
- $ref: "#/components/schemas/CaseEmptyRequest"
+ $ref: '#/components/schemas/CaseEmptyRequest'
description: Unassign case payload
required: true
responses:
@@ -137535,7 +137596,7 @@ paths:
type: project
type: case
schema:
- $ref: "#/components/schemas/CaseResponse"
+ $ref: '#/components/schemas/CaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137578,7 +137639,7 @@ paths:
type: user
type: watcher
schema:
- $ref: "#/components/schemas/CaseWatchersResponse"
+ $ref: '#/components/schemas/CaseWatchersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137705,7 +137766,7 @@ paths:
count: 1
includeCount: 0
schema:
- $ref: "#/components/schemas/ListEntityCatalogResponse"
+ $ref: '#/components/schemas/ListEntityCatalogResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -137758,7 +137819,7 @@ paths:
- this:tag
- that:tag
schema:
- $ref: "#/components/schemas/UpsertCatalogEntityRequest"
+ $ref: '#/components/schemas/UpsertCatalogEntityRequest'
description: Entity YAML or JSON.
required: true
responses:
@@ -137780,7 +137841,7 @@ paths:
count: 1
includeCount: 0
schema:
- $ref: "#/components/schemas/UpsertCatalogEntityResponse"
+ $ref: '#/components/schemas/UpsertCatalogEntityResponse'
description: ACCEPTED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137812,7 +137873,7 @@ paths:
- id: 4b163705-23c0-4573-b2fb-f6cea2163fcb
type: entity
schema:
- $ref: "#/components/schemas/EntityResponseArray"
+ $ref: '#/components/schemas/EntityResponseArray'
description: Accepted
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -137885,7 +137946,7 @@ paths:
meta:
count: 1
schema:
- $ref: "#/components/schemas/ListKindCatalogResponse"
+ $ref: '#/components/schemas/ListKindCatalogResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -137917,7 +137978,7 @@ paths:
value:
kind: my-job
schema:
- $ref: "#/components/schemas/UpsertCatalogKindRequest"
+ $ref: '#/components/schemas/UpsertCatalogKindRequest'
description: Kind YAML or JSON.
required: true
responses:
@@ -137937,7 +137998,7 @@ paths:
meta:
count: 1
schema:
- $ref: "#/components/schemas/UpsertCatalogKindResponse"
+ $ref: '#/components/schemas/UpsertCatalogKindResponse'
description: ACCEPTED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -138028,7 +138089,7 @@ paths:
meta:
count: 1
schema:
- $ref: "#/components/schemas/ListRelationCatalogResponse"
+ $ref: '#/components/schemas/ListRelationCatalogResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -138073,7 +138134,7 @@ paths:
title: Deploy new payment service
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestCreateRequest"
+ $ref: '#/components/schemas/ChangeRequestCreateRequest'
description: Change request payload.
required: true
responses:
@@ -138118,19 +138179,19 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138194,19 +138255,19 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138253,7 +138314,7 @@ paths:
id: decision-id-0
type: change_request_decision
schema:
- $ref: "#/components/schemas/ChangeRequestUpdateRequest"
+ $ref: '#/components/schemas/ChangeRequestUpdateRequest'
description: Change request update payload.
required: true
responses:
@@ -138298,25 +138359,25 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138350,7 +138411,7 @@ paths:
repo_id: DataDog/test-repo
type: change_request_branch
schema:
- $ref: "#/components/schemas/ChangeRequestBranchCreateRequest"
+ $ref: '#/components/schemas/ChangeRequestBranchCreateRequest'
description: Branch creation payload.
required: true
responses:
@@ -138395,19 +138456,19 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138472,19 +138533,19 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138527,7 +138588,7 @@ paths:
id: decision-id-0
type: change_request_decision
schema:
- $ref: "#/components/schemas/ChangeRequestDecisionUpdateRequest"
+ $ref: '#/components/schemas/ChangeRequestDecisionUpdateRequest'
description: Decision update payload.
required: true
responses:
@@ -138572,19 +138633,19 @@ paths:
type: user
type: change_request
schema:
- $ref: "#/components/schemas/ChangeRequestResponse"
+ $ref: '#/components/schemas/ChangeRequestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -138627,7 +138688,7 @@ paths:
id: github.com/datadog
type: ci_github_account
schema:
- $ref: "#/components/schemas/CIAppGitHubAccountsResponse"
+ $ref: '#/components/schemas/CIAppGitHubAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -138675,7 +138736,7 @@ paths:
name: shopist
type: ci_github_account
schema:
- $ref: "#/components/schemas/CIAppGitHubAccountUpdateRequest"
+ $ref: '#/components/schemas/CIAppGitHubAccountUpdateRequest'
required: true
responses:
"200":
@@ -138698,7 +138759,7 @@ paths:
id: github.com/datadog
type: ci_github_account
schema:
- $ref: "#/components/schemas/CIAppGitHubAccountResponse"
+ $ref: '#/components/schemas/CIAppGitHubAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -138756,7 +138817,7 @@ paths:
url: https://my-ci-provider.example/pipelines/my-pipeline/run/1
type: cipipeline_resource_request
schema:
- $ref: "#/components/schemas/CIAppCreatePipelineEventRequest"
+ $ref: '#/components/schemas/CIAppCreatePipelineEventRequest'
required: true
responses:
"202":
@@ -138772,49 +138833,49 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Forbidden
"408":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Request Timeout
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Payload Too Large
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Too Many Requests
"500":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
"503":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Service Unavailable
security:
- apiKeyAuth: []
@@ -138854,7 +138915,7 @@ paths:
options:
timezone: GMT
schema:
- $ref: "#/components/schemas/CIAppPipelinesAggregateRequest"
+ $ref: '#/components/schemas/CIAppPipelinesAggregateRequest'
required: true
responses:
"200":
@@ -138872,7 +138933,7 @@ paths:
- time: "2020-06-08T11:55:00.123Z"
value: 2345
schema:
- $ref: "#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse"
+ $ref: '#/components/schemas/CIAppPipelinesAnalyticsAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -138930,7 +138991,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/CIAppSort"
+ $ref: '#/components/schemas/CIAppSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -138960,7 +139021,7 @@ paths:
meta:
page: {}
schema:
- $ref: "#/components/schemas/CIAppPipelineEventsResponse"
+ $ref: '#/components/schemas/CIAppPipelineEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139010,7 +139071,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/CIAppPipelineEventsRequest"
+ $ref: '#/components/schemas/CIAppPipelineEventsRequest'
required: false
responses:
"200":
@@ -139033,7 +139094,7 @@ paths:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
status: done
schema:
- $ref: "#/components/schemas/CIAppPipelineEventsResponse"
+ $ref: '#/components/schemas/CIAppPipelineEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139097,7 +139158,7 @@ paths:
repository_id: "github.com/example-org/example-repo"
type: test_optimization_update_flaky_tests_management_policies_request
schema:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequest"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesUpdateRequest'
required: true
responses:
"200":
@@ -139112,7 +139173,7 @@ paths:
id: github.com/datadog/test-service
type: test_optimization_flaky_tests_management_policies
schema:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139150,7 +139211,7 @@ paths:
repository_id: "github.com/example-org/example-repo"
type: test_optimization_get_flaky_tests_management_policies_request
schema:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequest"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesGetRequest'
required: true
responses:
"200":
@@ -139165,7 +139226,7 @@ paths:
id: github.com/datadog/test-service
type: test_optimization_flaky_tests_management_policies
schema:
- $ref: "#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse"
+ $ref: '#/components/schemas/TestOptimizationFlakyTestsManagementPoliciesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139206,7 +139267,7 @@ paths:
service_name: test-service
type: test_optimization_delete_service_settings_request
schema:
- $ref: "#/components/schemas/TestOptimizationDeleteServiceSettingsRequest"
+ $ref: '#/components/schemas/TestOptimizationDeleteServiceSettingsRequest'
required: true
responses:
"204":
@@ -139253,7 +139314,7 @@ paths:
test_impact_analysis_enabled_inherit: true
type: test_optimization_update_service_settings_request
schema:
- $ref: "#/components/schemas/TestOptimizationUpdateServiceSettingsRequest"
+ $ref: '#/components/schemas/TestOptimizationUpdateServiceSettingsRequest'
required: true
responses:
"200":
@@ -139281,7 +139342,7 @@ paths:
id: 9b8a7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
type: test_optimization_service_settings
schema:
- $ref: "#/components/schemas/TestOptimizationServiceSettingsResponse"
+ $ref: '#/components/schemas/TestOptimizationServiceSettingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139321,7 +139382,7 @@ paths:
service_name: test-service
type: test_optimization_get_service_settings_request
schema:
- $ref: "#/components/schemas/TestOptimizationGetServiceSettingsRequest"
+ $ref: '#/components/schemas/TestOptimizationGetServiceSettingsRequest'
required: true
responses:
"200":
@@ -139349,7 +139410,7 @@ paths:
id: 9b8a7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d
type: test_optimization_service_settings
schema:
- $ref: "#/components/schemas/TestOptimizationServiceSettingsResponse"
+ $ref: '#/components/schemas/TestOptimizationServiceSettingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139404,7 +139465,7 @@ paths:
options:
timezone: GMT
schema:
- $ref: "#/components/schemas/CIAppTestsAggregateRequest"
+ $ref: '#/components/schemas/CIAppTestsAggregateRequest'
required: true
responses:
"200":
@@ -139422,7 +139483,7 @@ paths:
- time: "2020-06-08T11:55:00.123Z"
value: 2345
schema:
- $ref: "#/components/schemas/CIAppTestsAnalyticsAggregateResponse"
+ $ref: '#/components/schemas/CIAppTestsAnalyticsAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139483,7 +139544,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/CIAppSort"
+ $ref: '#/components/schemas/CIAppSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -139513,7 +139574,7 @@ paths:
meta:
page: {}
schema:
- $ref: "#/components/schemas/CIAppTestEventsResponse"
+ $ref: '#/components/schemas/CIAppTestEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139566,7 +139627,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/CIAppTestEventsRequest"
+ $ref: '#/components/schemas/CIAppTestEventsRequest'
required: false
responses:
"200":
@@ -139591,7 +139652,7 @@ paths:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
status: done
schema:
- $ref: "#/components/schemas/CIAppTestEventsResponse"
+ $ref: '#/components/schemas/CIAppTestEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139639,19 +139700,19 @@ paths:
id: abc-123
type: aws_cloud_auth_config
schema:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingsResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -139677,7 +139738,7 @@ paths:
arn_pattern: arn:aws:iam::123456789012:user/testuser
type: aws_cloud_auth_config
schema:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingCreateRequest"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingCreateRequest'
required: true
responses:
"201":
@@ -139694,25 +139755,25 @@ paths:
id: abc-123
type: aws_cloud_auth_config
schema:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -139737,13 +139798,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -139774,19 +139835,19 @@ paths:
id: abc-123
type: aws_cloud_auth_config
schema:
- $ref: "#/components/schemas/AWSCloudAuthPersonaMappingResponse"
+ $ref: '#/components/schemas/AWSCloudAuthPersonaMappingResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -139820,7 +139881,7 @@ paths:
version: "2"
type: custom_framework
schema:
- $ref: "#/components/schemas/CreateCustomFrameworkRequest"
+ $ref: '#/components/schemas/CreateCustomFrameworkRequest'
required: true
responses:
"200":
@@ -139836,7 +139897,7 @@ paths:
id: sec2-2
type: custom_framework
schema:
- $ref: "#/components/schemas/CreateCustomFrameworkResponse"
+ $ref: '#/components/schemas/CreateCustomFrameworkResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139883,7 +139944,7 @@ paths:
id: sec2-2
type: custom_framework
schema:
- $ref: "#/components/schemas/DeleteCustomFrameworkResponse"
+ $ref: '#/components/schemas/DeleteCustomFrameworkResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139933,7 +139994,7 @@ paths:
id: sec2-2
type: custom_framework
schema:
- $ref: "#/components/schemas/GetCustomFrameworkResponse"
+ $ref: '#/components/schemas/GetCustomFrameworkResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -139979,7 +140040,7 @@ paths:
version: "2"
type: custom_framework
schema:
- $ref: "#/components/schemas/UpdateCustomFrameworkRequest"
+ $ref: '#/components/schemas/UpdateCustomFrameworkRequest'
required: true
responses:
"200":
@@ -139995,7 +140056,7 @@ paths:
id: sec2-2
type: custom_framework
schema:
- $ref: "#/components/schemas/UpdateCustomFrameworkResponse"
+ $ref: '#/components/schemas/UpdateCustomFrameworkResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140042,7 +140103,7 @@ paths:
id: csm_resource_filter
type: csm_resource_filter
schema:
- $ref: "#/components/schemas/GetResourceEvaluationFiltersResponse"
+ $ref: '#/components/schemas/GetResourceEvaluationFiltersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140086,7 +140147,7 @@ paths:
id: csm_resource_filter
type: csm_resource_filter
schema:
- $ref: "#/components/schemas/UpdateResourceEvaluationFiltersRequest"
+ $ref: '#/components/schemas/UpdateResourceEvaluationFiltersRequest'
required: true
responses:
"201":
@@ -140104,7 +140165,7 @@ paths:
id: csm_resource_filter
type: csm_resource_filter
schema:
- $ref: "#/components/schemas/UpdateResourceEvaluationFiltersResponse"
+ $ref: '#/components/schemas/UpdateResourceEvaluationFiltersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140147,7 +140208,7 @@ paths:
id: aws
type: cloud_provider
schema:
- $ref: "#/components/schemas/UpsertCloudInventorySyncConfigRequest"
+ $ref: '#/components/schemas/UpsertCloudInventorySyncConfigRequest'
required: true
responses:
"200":
@@ -140164,13 +140225,13 @@ paths:
id: aws
type: sync_configs
schema:
- $ref: "#/components/schemas/CloudInventorySyncConfigResponse"
+ $ref: '#/components/schemas/CloudInventorySyncConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -140201,7 +140262,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140232,7 +140293,7 @@ paths:
repository_url: https://github.com/datadog/test-service
type: ci_app_coverage_branch_summary_request
schema:
- $ref: "#/components/schemas/BranchCoverageSummaryRequest"
+ $ref: '#/components/schemas/BranchCoverageSummaryRequest'
required: true
responses:
"200":
@@ -140250,7 +140311,7 @@ paths:
id: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA=
type: ci_app_coverage_summary
schema:
- $ref: "#/components/schemas/CoverageSummaryResponse"
+ $ref: '#/components/schemas/CoverageSummaryResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140264,7 +140325,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal server error
security:
- apiKeyAuth: []
@@ -140303,7 +140364,7 @@ paths:
repository_url: https://github.com/datadog/test-service
type: ci_app_coverage_commit_summary_request
schema:
- $ref: "#/components/schemas/CommitCoverageSummaryRequest"
+ $ref: '#/components/schemas/CommitCoverageSummaryRequest'
required: true
responses:
"200":
@@ -140321,7 +140382,7 @@ paths:
id: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA=
type: ci_app_coverage_summary
schema:
- $ref: "#/components/schemas/CoverageSummaryResponse"
+ $ref: '#/components/schemas/CoverageSummaryResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140335,7 +140396,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal server error
security:
- apiKeyAuth: []
@@ -140407,13 +140468,13 @@ paths:
id: JSONAPI_USELESS_ID
type: rule_based_view
schema:
- $ref: "#/components/schemas/RuleBasedViewResponse"
+ $ref: '#/components/schemas/RuleBasedViewResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -140423,7 +140484,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Service Unavailable
security:
- apiKeyAuth: []
@@ -140511,19 +140572,19 @@ paths:
total: 1
type: cursor_limit
schema:
- $ref: "#/components/schemas/ContainerImagesResponse"
+ $ref: '#/components/schemas/ContainerImagesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140609,19 +140670,19 @@ paths:
total: 1
type: cursor_limit
schema:
- $ref: "#/components/schemas/ContainersResponse"
+ $ref: '#/components/schemas/ContainersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140681,25 +140742,25 @@ paths:
id: "123"
type: account_filters
schema:
- $ref: "#/components/schemas/AccountFiltersResponse"
+ $ref: '#/components/schemas/AccountFiltersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140748,7 +140809,7 @@ paths:
include_new_accounts: true
type: account_filters_patch_request
schema:
- $ref: "#/components/schemas/AccountFiltersPatchRequest"
+ $ref: '#/components/schemas/AccountFiltersPatchRequest'
required: true
responses:
"200":
@@ -140784,25 +140845,25 @@ paths:
id: "123"
type: account_filters
schema:
- $ref: "#/components/schemas/AccountFiltersResponse"
+ $ref: '#/components/schemas/AccountFiltersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140939,7 +141000,7 @@ paths:
id: anomalies
type: anomalies
schema:
- $ref: "#/components/schemas/CostAnomaliesResponse"
+ $ref: '#/components/schemas/CostAnomaliesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -140947,7 +141008,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -140995,7 +141056,7 @@ paths:
id: b0a6aaa9-3c4c-48cb-9447-a0d1338b3e09
type: anomalies
schema:
- $ref: "#/components/schemas/CostAnomalyResponse"
+ $ref: '#/components/schemas/CostAnomalyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -141003,7 +141064,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -141058,7 +141119,7 @@ paths:
id: "123"
type: arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryRuleResponseArray"
+ $ref: '#/components/schemas/ArbitraryRuleResponseArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141130,7 +141191,7 @@ paths:
type: shared
type: upsert_arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequest"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequest'
required: true
responses:
"200":
@@ -141162,7 +141223,7 @@ paths:
id: "123"
type: arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryRuleResponse"
+ $ref: '#/components/schemas/ArbitraryRuleResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141200,7 +141261,7 @@ paths:
- id: "789"
type: arbitrary_rule
schema:
- $ref: "#/components/schemas/ReorderRuleResourceArray"
+ $ref: '#/components/schemas/ReorderRuleResourceArray'
required: true
responses:
"204":
@@ -141237,7 +141298,7 @@ paths:
id: "456"
type: arbitrary_rule_status
schema:
- $ref: "#/components/schemas/ArbitraryRuleStatusResponseArray"
+ $ref: '#/components/schemas/ArbitraryRuleStatusResponseArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141319,7 +141380,7 @@ paths:
id: "123"
type: arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryRuleResponse"
+ $ref: '#/components/schemas/ArbitraryRuleResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141400,7 +141461,7 @@ paths:
type: shared
type: upsert_arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryCostUpsertRequest"
+ $ref: '#/components/schemas/ArbitraryCostUpsertRequest'
required: true
responses:
"200":
@@ -141432,7 +141493,7 @@ paths:
id: "123"
type: arbitrary_rule
schema:
- $ref: "#/components/schemas/ArbitraryRuleResponse"
+ $ref: '#/components/schemas/ArbitraryRuleResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141472,13 +141533,13 @@ paths:
id: "123"
type: aws_cur_config
schema:
- $ref: "#/components/schemas/AwsCURConfigsResponse"
+ $ref: '#/components/schemas/AwsCURConfigsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141521,7 +141582,7 @@ paths:
report_prefix: dd-report-prefix
type: aws_cur_config_post_request
schema:
- $ref: "#/components/schemas/AwsCURConfigPostRequest"
+ $ref: '#/components/schemas/AwsCURConfigPostRequest'
required: true
responses:
"200":
@@ -141551,19 +141612,19 @@ paths:
id: "123456789123"
type: aws_cur_config
schema:
- $ref: "#/components/schemas/AwsCurConfigResponse"
+ $ref: '#/components/schemas/AwsCurConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141593,13 +141654,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141655,7 +141716,7 @@ paths:
id: "123456789123"
type: aws_cur_config
schema:
- $ref: "#/components/schemas/AwsCurConfigResponse"
+ $ref: '#/components/schemas/AwsCurConfigResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141692,7 +141753,7 @@ paths:
is_enabled: true
type: aws_cur_config_patch_request
schema:
- $ref: "#/components/schemas/AwsCURConfigPatchRequest"
+ $ref: '#/components/schemas/AwsCURConfigPatchRequest'
required: true
responses:
"200":
@@ -141717,19 +141778,19 @@ paths:
id: "123"
type: aws_cur_config
schema:
- $ref: "#/components/schemas/AwsCURConfigsResponse"
+ $ref: '#/components/schemas/AwsCURConfigsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141778,13 +141839,13 @@ paths:
id: "123456789123"
type: azure_uc_configs
schema:
- $ref: "#/components/schemas/AzureUCConfigsResponse"
+ $ref: '#/components/schemas/AzureUCConfigsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141827,7 +141888,7 @@ paths:
scope: /subscriptions/1234abcd-1234-abcd-1234-1234abcd1234
type: azure_uc_config_post_request
schema:
- $ref: "#/components/schemas/AzureUCConfigPostRequest"
+ $ref: '#/components/schemas/AzureUCConfigPostRequest'
required: true
responses:
"200":
@@ -141857,19 +141918,19 @@ paths:
id: "123456789123"
type: azure_uc_configs
schema:
- $ref: "#/components/schemas/AzureUCConfigPairsResponse"
+ $ref: '#/components/schemas/AzureUCConfigPairsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141899,13 +141960,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141961,7 +142022,7 @@ paths:
id: "123456789123"
type: azure_uc_configs
schema:
- $ref: "#/components/schemas/UCConfigPair"
+ $ref: '#/components/schemas/UCConfigPair'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -141990,7 +142051,7 @@ paths:
is_enabled: true
type: azure_uc_config_patch_request
schema:
- $ref: "#/components/schemas/AzureUCConfigPatchRequest"
+ $ref: '#/components/schemas/AzureUCConfigPatchRequest'
required: true
responses:
"200":
@@ -142020,25 +142081,25 @@ paths:
id: "123456789123"
type: azure_uc_configs
schema:
- $ref: "#/components/schemas/AzureUCConfigPairsResponse"
+ $ref: '#/components/schemas/AzureUCConfigPairsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142080,7 +142141,7 @@ paths:
id: 00000000-0a0a-0a0a-aaa0-00000000000a
type: ""
schema:
- $ref: "#/components/schemas/BudgetWithEntries"
+ $ref: '#/components/schemas/BudgetWithEntries'
required: true
responses:
"200":
@@ -142110,7 +142171,7 @@ paths:
id: 00000000-0a0a-0a0a-aaa0-00000000000a
type: budget
schema:
- $ref: "#/components/schemas/BudgetWithEntries"
+ $ref: '#/components/schemas/BudgetWithEntries'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -142137,7 +142198,7 @@ paths:
value:
errors: []
schema:
- $ref: "#/components/schemas/ValidationResponse"
+ $ref: '#/components/schemas/ValidationResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142175,7 +142236,7 @@ paths:
id: ""
type: custom_forecast
schema:
- $ref: "#/components/schemas/CustomForecastUpsertRequest"
+ $ref: '#/components/schemas/CustomForecastUpsertRequest'
required: true
responses:
"200":
@@ -142205,7 +142266,7 @@ paths:
id: 11111111-1111-1111-1111-111111111111
type: custom_forecast
schema:
- $ref: "#/components/schemas/CustomForecastResponse"
+ $ref: '#/components/schemas/CustomForecastResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -142256,7 +142317,7 @@ paths:
id: "1"
type: budget
schema:
- $ref: "#/components/schemas/BudgetValidationRequest"
+ $ref: '#/components/schemas/BudgetValidationRequest'
required: true
responses:
"200":
@@ -142272,7 +142333,7 @@ paths:
id: budget_validation
type: budget_validation
schema:
- $ref: "#/components/schemas/BudgetValidationResponse"
+ $ref: '#/components/schemas/BudgetValidationResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142380,7 +142441,7 @@ paths:
id: 00000000-0a0a-0a0a-aaa0-00000000000a
type: budget
schema:
- $ref: "#/components/schemas/BudgetWithEntries"
+ $ref: '#/components/schemas/BudgetWithEntries'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -142450,7 +142511,7 @@ paths:
id: 11111111-1111-1111-1111-111111111111
type: custom_forecast
schema:
- $ref: "#/components/schemas/CustomForecastResponse"
+ $ref: '#/components/schemas/CustomForecastResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -142491,7 +142552,7 @@ paths:
id: 00000000-0a0a-0a0a-aaa0-00000000000a
type: budget
schema:
- $ref: "#/components/schemas/BudgetArray"
+ $ref: '#/components/schemas/BudgetArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142532,13 +142593,13 @@ paths:
term_length: 1
utilization: 0.85
schema:
- $ref: "#/components/schemas/CommitmentsListResponse"
+ $ref: '#/components/schemas/CommitmentsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142593,13 +142654,13 @@ paths:
values:
- 0.78
schema:
- $ref: "#/components/schemas/CommitmentsCoverageScalarResponse"
+ $ref: '#/components/schemas/CommitmentsCoverageScalarResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142671,13 +142732,13 @@ paths:
- 1693526400
- 1693612800
schema:
- $ref: "#/components/schemas/CommitmentsCoverageTimeseriesResponse"
+ $ref: '#/components/schemas/CommitmentsCoverageTimeseriesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142745,13 +142806,13 @@ paths:
values:
- 1500.0
schema:
- $ref: "#/components/schemas/CommitmentsOnDemandHotspotsScalarResponse"
+ $ref: '#/components/schemas/CommitmentsOnDemandHotspotsScalarResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142814,13 +142875,13 @@ paths:
values:
- 0.33
schema:
- $ref: "#/components/schemas/CommitmentsSavingsScalarResponse"
+ $ref: '#/components/schemas/CommitmentsSavingsScalarResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142897,13 +142958,13 @@ paths:
- 1693526400
- 1693612800
schema:
- $ref: "#/components/schemas/CommitmentsSavingsTimeseriesResponse"
+ $ref: '#/components/schemas/CommitmentsSavingsTimeseriesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -142961,13 +143022,13 @@ paths:
- 0.85
- 0.72
schema:
- $ref: "#/components/schemas/CommitmentsUtilizationScalarResponse"
+ $ref: '#/components/schemas/CommitmentsUtilizationScalarResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143023,13 +143084,13 @@ paths:
scale_factor: 1
short_name: "$"
schema:
- $ref: "#/components/schemas/CommitmentsUtilizationTimeseriesResponse"
+ $ref: '#/components/schemas/CommitmentsUtilizationTimeseriesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143115,19 +143176,19 @@ paths:
total_filtered_count: 1
version: "1"
schema:
- $ref: "#/components/schemas/CustomCostsFileListResponse"
+ $ref: '#/components/schemas/CustomCostsFileListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143159,7 +143220,7 @@ paths:
ChargePeriodEnd: "2023-02-28"
ChargePeriodStart: "2023-02-01"
schema:
- $ref: "#/components/schemas/CustomCostsFileUploadRequest"
+ $ref: '#/components/schemas/CustomCostsFileUploadRequest'
required: true
responses:
"202":
@@ -143185,19 +143246,19 @@ paths:
meta:
version: "1"
schema:
- $ref: "#/components/schemas/CustomCostsFileUploadResponse"
+ $ref: '#/components/schemas/CustomCostsFileUploadResponse'
description: Accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143227,13 +143288,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143281,19 +143342,19 @@ paths:
meta:
version: "1"
schema:
- $ref: "#/components/schemas/CustomCostsFileGetResponse"
+ $ref: '#/components/schemas/CustomCostsFileGetResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143335,13 +143396,13 @@ paths:
id: "123456789123"
type: gcp_uc_config
schema:
- $ref: "#/components/schemas/GCPUsageCostConfigsResponse"
+ $ref: '#/components/schemas/GCPUsageCostConfigsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143377,7 +143438,7 @@ paths:
service_account: dd-ccm-gcp-integration@my-environment.iam.gserviceaccount.com
type: gcp_uc_config_post_request
schema:
- $ref: "#/components/schemas/GCPUsageCostConfigPostRequest"
+ $ref: '#/components/schemas/GCPUsageCostConfigPostRequest'
required: true
responses:
"200":
@@ -143404,19 +143465,19 @@ paths:
id: "123456789123"
type: gcp_uc_config
schema:
- $ref: "#/components/schemas/GCPUsageCostConfigResponse"
+ $ref: '#/components/schemas/GCPUsageCostConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143446,13 +143507,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143505,7 +143566,7 @@ paths:
id: "123456789123"
type: gcp_uc_config
schema:
- $ref: "#/components/schemas/GcpUcConfigResponse"
+ $ref: '#/components/schemas/GcpUcConfigResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143534,7 +143595,7 @@ paths:
is_enabled: true
type: gcp_uc_config_patch_request
schema:
- $ref: "#/components/schemas/GCPUsageCostConfigPatchRequest"
+ $ref: '#/components/schemas/GCPUsageCostConfigPatchRequest'
required: true
responses:
"200":
@@ -143561,25 +143622,25 @@ paths:
id: "123456789123"
type: gcp_uc_config
schema:
- $ref: "#/components/schemas/GCPUsageCostConfigResponse"
+ $ref: '#/components/schemas/GCPUsageCostConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143617,13 +143678,13 @@ paths:
id: "1"
type: oci_config
schema:
- $ref: "#/components/schemas/OCIConfigsResponse"
+ $ref: '#/components/schemas/OCIConfigsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143666,7 +143727,7 @@ paths:
- expression: potential_daily_savings.amount
order: DESC
schema:
- $ref: "#/components/schemas/RecommendationsFilterRequest"
+ $ref: '#/components/schemas/RecommendationsFilterRequest'
required: true
responses:
"200":
@@ -143695,7 +143756,7 @@ paths:
next_page_token: ""
page_size: 100
schema:
- $ref: "#/components/schemas/CostRecommendationArray"
+ $ref: '#/components/schemas/CostRecommendationArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143740,13 +143801,13 @@ paths:
id: account_id
type: cost_tag_description
schema:
- $ref: "#/components/schemas/CostTagDescriptionsResponse"
+ $ref: '#/components/schemas/CostTagDescriptionsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143787,13 +143848,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143844,25 +143905,25 @@ paths:
id: account_id
type: cost_tag_description
schema:
- $ref: "#/components/schemas/CostTagDescriptionResponse"
+ $ref: '#/components/schemas/CostTagDescriptionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143902,7 +143963,7 @@ paths:
id: account_id
type: cost_tag_description
schema:
- $ref: "#/components/schemas/CostTagDescriptionUpsertRequest"
+ $ref: '#/components/schemas/CostTagDescriptionUpsertRequest'
required: true
responses:
"204":
@@ -143911,13 +143972,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -143958,19 +144019,19 @@ paths:
id: account_id
type: cost_generated_tag_description
schema:
- $ref: "#/components/schemas/GenerateCostTagDescriptionResponse"
+ $ref: '#/components/schemas/GenerateCostTagDescriptionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144025,19 +144086,19 @@ paths:
id: service
type: cost_tag_key
schema:
- $ref: "#/components/schemas/CostTagKeysResponse"
+ $ref: '#/components/schemas/CostTagKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144095,25 +144156,25 @@ paths:
id: providername
type: cost_tag_key
schema:
- $ref: "#/components/schemas/CostTagKeyResponse"
+ $ref: '#/components/schemas/CostTagKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144161,7 +144222,7 @@ paths:
in: query
name: filter[daily]
schema:
- $ref: "#/components/schemas/CostTagMetadataDailyFilter"
+ $ref: '#/components/schemas/CostTagMetadataDailyFilter'
responses:
"200":
content:
@@ -144185,19 +144246,19 @@ paths:
id: env:aws.cost.net.amortized
type: cost_tag_key_metadata
schema:
- $ref: "#/components/schemas/CostTagKeyMetadataResponse"
+ $ref: '#/components/schemas/CostTagKeyMetadataResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144245,19 +144306,19 @@ paths:
- id: USD
type: cost_currency
schema:
- $ref: "#/components/schemas/CostCurrencyResponse"
+ $ref: '#/components/schemas/CostCurrencyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144307,19 +144368,19 @@ paths:
- id: gcp.cost.amortized
type: cost_metric
schema:
- $ref: "#/components/schemas/CostMetricsResponse"
+ $ref: '#/components/schemas/CostMetricsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144370,19 +144431,19 @@ paths:
- id: "2026-03"
type: cost_tag_metadata_month
schema:
- $ref: "#/components/schemas/CostTagMetadataMonthsResponse"
+ $ref: '#/components/schemas/CostTagMetadataMonthsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144432,19 +144493,19 @@ paths:
- id: kubernetes
type: cost_orchestrator
schema:
- $ref: "#/components/schemas/CostOrchestratorsResponse"
+ $ref: '#/components/schemas/CostOrchestratorsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144508,19 +144569,19 @@ paths:
id: service
type: cost_tag_key_source
schema:
- $ref: "#/components/schemas/CostTagKeySourcesResponse"
+ $ref: '#/components/schemas/CostTagKeySourcesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144600,19 +144661,19 @@ paths:
id: providername:gcp
type: cost_tag
schema:
- $ref: "#/components/schemas/CostTagsResponse"
+ $ref: '#/components/schemas/CostTagsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -144645,25 +144706,25 @@ paths:
id: abc-123
type: billing_dimensions
schema:
- $ref: "#/components/schemas/ActiveBillingDimensionsResponse"
+ $ref: '#/components/schemas/ActiveBillingDimensionsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -144730,7 +144791,7 @@ paths:
name: sort_direction
required: false
schema:
- $ref: "#/components/schemas/SortDirection"
+ $ref: '#/components/schemas/SortDirection'
- description: "The billing dimension to sort by. Always sorted by total cost. Example: `infra_host`."
in: query
name: sort_name
@@ -144769,25 +144830,25 @@ paths:
- id: abc-123
type: cost_by_tag
schema:
- $ref: "#/components/schemas/MonthlyCostAttributionResponse"
+ $ref: '#/components/schemas/MonthlyCostAttributionResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -144841,7 +144902,7 @@ paths:
name: order_direction
required: false
schema:
- $ref: "#/components/schemas/OrderDirection"
+ $ref: '#/components/schemas/OrderDirection'
responses:
"200":
content:
@@ -144861,7 +144922,7 @@ paths:
page_size: 10
total_filtered: 1
schema:
- $ref: "#/components/schemas/CsmAgentsResponse"
+ $ref: '#/components/schemas/CsmAgentsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -144895,7 +144956,7 @@ paths:
id: abc-123
type: get_cloud_accounts_coverage_analysis_response_public_v0
schema:
- $ref: "#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse"
+ $ref: '#/components/schemas/CsmCloudAccountsCoverageAnalysisResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -144929,7 +144990,7 @@ paths:
id: abc-123
type: get_hosts_and_containers_coverage_analysis_response_public_v0
schema:
- $ref: "#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse"
+ $ref: '#/components/schemas/CsmHostsAndContainersCoverageAnalysisResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -144963,7 +145024,7 @@ paths:
id: abc-123
type: get_serverless_coverage_analysis_response_public_v0
schema:
- $ref: "#/components/schemas/CsmServerlessCoverageAnalysisResponse"
+ $ref: '#/components/schemas/CsmServerlessCoverageAnalysisResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145009,7 +145070,7 @@ paths:
name: order_direction
required: false
schema:
- $ref: "#/components/schemas/OrderDirection"
+ $ref: '#/components/schemas/OrderDirection'
responses:
"200":
content:
@@ -145029,7 +145090,7 @@ paths:
page_size: 10
total_filtered: 1
schema:
- $ref: "#/components/schemas/CsmAgentsResponse"
+ $ref: '#/components/schemas/CsmAgentsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145057,13 +145118,13 @@ paths:
id: settings
type: ownership_settings
schema:
- $ref: "#/components/schemas/OwnershipSettingsResponse"
+ $ref: '#/components/schemas/OwnershipSettingsResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145088,7 +145149,7 @@ paths:
confidence_level: high
type: ownership_settings
schema:
- $ref: "#/components/schemas/OwnershipSettingsRequest"
+ $ref: '#/components/schemas/OwnershipSettingsRequest'
required: true
responses:
"200":
@@ -145105,19 +145166,19 @@ paths:
id: settings
type: ownership_settings
schema:
- $ref: "#/components/schemas/OwnershipSettingsResponse"
+ $ref: '#/components/schemas/OwnershipSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145147,13 +145208,13 @@ paths:
id: untagged
type: ownership_untagged_findings
schema:
- $ref: "#/components/schemas/OwnershipUntaggedFindingsResponse"
+ $ref: '#/components/schemas/OwnershipUntaggedFindingsResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145200,25 +145261,25 @@ paths:
id: test-resource
type: ownership_inferences
schema:
- $ref: "#/components/schemas/OwnershipInferenceListResponse"
+ $ref: '#/components/schemas/OwnershipInferenceListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145288,19 +145349,19 @@ paths:
id: res-1
type: ownership_history
schema:
- $ref: "#/components/schemas/OwnershipHistoryResponse"
+ $ref: '#/components/schemas/OwnershipHistoryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145330,7 +145391,7 @@ paths:
name: owner_type
required: true
schema:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
- description: A previously returned `ETag` value. When supplied and the resource has not changed, the endpoint returns `304 Not Modified`.
in: header
name: If-None-Match
@@ -145361,7 +145422,7 @@ paths:
id: test-resource:team
type: ownership_inference
schema:
- $ref: "#/components/schemas/OwnershipInferenceResponse"
+ $ref: '#/components/schemas/OwnershipInferenceResponse'
description: OK
headers:
Cache-Control:
@@ -145378,19 +145439,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145420,7 +145481,7 @@ paths:
name: owner_type
required: true
schema:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
- description: A previously returned weak `ETag` value. When supplied and the evidence has not changed, the endpoint returns `304 Not Modified`.
in: header
name: If-None-Match
@@ -145443,7 +145504,7 @@ paths:
id: test-resource
type: ownership_evidence
schema:
- $ref: "#/components/schemas/OwnershipEvidenceResponse"
+ $ref: '#/components/schemas/OwnershipEvidenceResponse'
description: OK
headers:
ETag:
@@ -145455,19 +145516,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145499,7 +145560,7 @@ paths:
name: owner_type
required: true
schema:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
requestBody:
content:
application/json:
@@ -145512,7 +145573,7 @@ paths:
inference_checksum: abc123
type: ownership_feedback
schema:
- $ref: "#/components/schemas/OwnershipFeedbackRequest"
+ $ref: '#/components/schemas/OwnershipFeedbackRequest'
required: true
responses:
"201":
@@ -145533,31 +145594,31 @@ paths:
id: res-1
type: ownership_feedback_result
schema:
- $ref: "#/components/schemas/OwnershipFeedbackResponse"
+ $ref: '#/components/schemas/OwnershipFeedbackResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/OwnershipInferenceResponse"
+ $ref: '#/components/schemas/OwnershipInferenceResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145584,7 +145645,7 @@ paths:
name: owner_type
required: true
schema:
- $ref: "#/components/schemas/OwnershipOwnerType"
+ $ref: '#/components/schemas/OwnershipOwnerType'
- description: An opaque, base64-encoded cursor token returned by a previous call in `pagination.next_cursor`. Omit to fetch the first page.
in: query
name: cursor
@@ -145633,19 +145694,19 @@ paths:
id: res-1
type: ownership_history
schema:
- $ref: "#/components/schemas/OwnershipHistoryResponse"
+ $ref: '#/components/schemas/OwnershipHistoryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -145710,13 +145771,13 @@ paths:
page_size: 10
total_filtered: 1
schema:
- $ref: "#/components/schemas/CsmAgentlessHostsResponse"
+ $ref: '#/components/schemas/CsmAgentlessHostsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145773,13 +145834,13 @@ paths:
total_count: 2
type: facet_info
schema:
- $ref: "#/components/schemas/CsmHostFacetInfoResponse"
+ $ref: '#/components/schemas/CsmHostFacetInfoResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145825,7 +145886,7 @@ paths:
id: cloud_provider
type: agentless_host_facet
schema:
- $ref: "#/components/schemas/CsmAgentlessHostFacetsResponse"
+ $ref: '#/components/schemas/CsmAgentlessHostFacetsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145903,13 +145964,13 @@ paths:
total_filtered: 2
total_pages: 1
schema:
- $ref: "#/components/schemas/CsmUnifiedHostsResponse"
+ $ref: '#/components/schemas/CsmUnifiedHostsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -145966,13 +146027,13 @@ paths:
total_count: 2
type: facet_info
schema:
- $ref: "#/components/schemas/CsmHostFacetInfoResponse"
+ $ref: '#/components/schemas/CsmHostFacetInfoResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -146018,7 +146079,7 @@ paths:
id: cloud_provider
type: unified_host_facet
schema:
- $ref: "#/components/schemas/CsmUnifiedHostFacetsResponse"
+ $ref: '#/components/schemas/CsmUnifiedHostFacetsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -146064,13 +146125,13 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146103,7 +146164,7 @@ paths:
id: 00000000-0000-9999-0000-000000000000
type: users
schema:
- $ref: "#/components/schemas/UserUpdateRequest"
+ $ref: '#/components/schemas/UserUpdateRequest'
required: true
responses:
"200":
@@ -146130,31 +146191,31 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146197,25 +146258,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: application_keys
schema:
- $ref: "#/components/schemas/ListApplicationKeysResponse"
+ $ref: '#/components/schemas/ListApplicationKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146245,7 +146306,7 @@ paths:
- dashboards_public_share
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyCreateRequest"
+ $ref: '#/components/schemas/ApplicationKeyCreateRequest'
required: true
responses:
"201":
@@ -146262,19 +146323,19 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146300,13 +146361,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146340,19 +146401,19 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146387,7 +146448,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyUpdateRequest"
+ $ref: '#/components/schemas/ApplicationKeyUpdateRequest'
required: true
responses:
"200":
@@ -146404,25 +146465,25 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146457,7 +146518,7 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListDeleteItemsRequest"
+ $ref: '#/components/schemas/DashboardListDeleteItemsRequest'
description: Dashboards to delete from the dashboard list.
required: true
responses:
@@ -146471,25 +146532,25 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListDeleteItemsResponse"
+ $ref: '#/components/schemas/DashboardListDeleteItemsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146521,19 +146582,19 @@ paths:
type: host_timeboard
total: 1
schema:
- $ref: "#/components/schemas/DashboardListItems"
+ $ref: '#/components/schemas/DashboardListItems'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146571,7 +146632,7 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListAddItemsRequest"
+ $ref: '#/components/schemas/DashboardListAddItemsRequest'
description: Dashboards to add to the dashboard list.
required: true
responses:
@@ -146585,25 +146646,25 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListAddItemsResponse"
+ $ref: '#/components/schemas/DashboardListAddItemsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146633,7 +146694,7 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListUpdateItemsRequest"
+ $ref: '#/components/schemas/DashboardListUpdateItemsRequest'
description: New dashboards of the dashboard list.
required: true
responses:
@@ -146647,25 +146708,25 @@ paths:
- id: q5j-nti-fv6
type: host_timeboard
schema:
- $ref: "#/components/schemas/DashboardListUpdateItemsResponse"
+ $ref: '#/components/schemas/DashboardListUpdateItemsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146732,19 +146793,19 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: user
schema:
- $ref: "#/components/schemas/ListSharedDashboardsResponse"
+ $ref: '#/components/schemas/ListSharedDashboardsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Dashboard Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146794,7 +146855,7 @@ paths:
theme: "system"
type: secure_embed_request
schema:
- $ref: "#/components/schemas/SecureEmbedCreateRequest"
+ $ref: '#/components/schemas/SecureEmbedCreateRequest'
description: Secure embed creation request body.
required: true
responses:
@@ -146819,25 +146880,25 @@ paths:
id: "12345"
type: secure_embed_create_response
schema:
- $ref: "#/components/schemas/SecureEmbedCreateResponse"
+ $ref: '#/components/schemas/SecureEmbedCreateResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Dashboard Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict — max 1000 share URLs per dashboard exceeded
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146873,13 +146934,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146928,13 +146989,13 @@ paths:
id: "12345"
type: secure_embed_get_response
schema:
- $ref: "#/components/schemas/SecureEmbedGetResponse"
+ $ref: '#/components/schemas/SecureEmbedGetResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -146973,7 +147034,7 @@ paths:
title: "Q1 Metrics Dashboard (Updated)"
type: secure_embed_update_request
schema:
- $ref: "#/components/schemas/SecureEmbedUpdateRequest"
+ $ref: '#/components/schemas/SecureEmbedUpdateRequest'
description: Secure embed update request body.
required: true
responses:
@@ -146998,19 +147059,19 @@ paths:
id: "12345"
type: secure_embed_update_response
schema:
- $ref: "#/components/schemas/SecureEmbedUpdateResponse"
+ $ref: '#/components/schemas/SecureEmbedUpdateResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147119,7 +147180,7 @@ paths:
total: 1234
type: offset_limit
schema:
- $ref: "#/components/schemas/ListDashboardsUsageResponse"
+ $ref: '#/components/schemas/ListDashboardsUsageResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147196,7 +147257,7 @@ paths:
id: "q5j-nti-fv6"
type: "dashboards-usages"
schema:
- $ref: "#/components/schemas/DashboardUsageResponse"
+ $ref: '#/components/schemas/DashboardUsageResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147247,13 +147308,13 @@ paths:
id: "abc123def456"
type: monitor_run
schema:
- $ref: "#/components/schemas/GetDataObservabilityMonitorRunStatusResponse"
+ $ref: '#/components/schemas/GetDataObservabilityMonitorRunStatusResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147294,19 +147355,19 @@ paths:
id: "abc123def456"
type: monitor_run
schema:
- $ref: "#/components/schemas/RunDataObservabilityMonitorResponse"
+ $ref: '#/components/schemas/RunDataObservabilityMonitorResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147346,7 +147407,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: dataset
schema:
- $ref: "#/components/schemas/DatasetResponseMulti"
+ $ref: '#/components/schemas/DatasetResponseMulti'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -147390,7 +147451,7 @@ paths:
restriction_query_id: 00000000-0000-0000-0000-000000000001
type: dataset
schema:
- $ref: "#/components/schemas/DatasetCreateRequest"
+ $ref: '#/components/schemas/DatasetCreateRequest'
description: Dataset payload
required: true
responses:
@@ -147412,7 +147473,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: dataset
schema:
- $ref: "#/components/schemas/DatasetResponseSingle"
+ $ref: '#/components/schemas/DatasetResponseSingle'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147496,7 +147557,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: dataset
schema:
- $ref: "#/components/schemas/DatasetResponseSingle"
+ $ref: '#/components/schemas/DatasetResponseSingle'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147544,7 +147605,7 @@ paths:
product: logs
type: dataset
schema:
- $ref: "#/components/schemas/DatasetUpdateRequest"
+ $ref: '#/components/schemas/DatasetUpdateRequest'
description: Dataset payload
required: true
responses:
@@ -147566,7 +147627,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: dataset
schema:
- $ref: "#/components/schemas/DatasetResponseSingle"
+ $ref: '#/components/schemas/DatasetResponseSingle'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147615,7 +147676,7 @@ paths:
to_timestamp: 1736946000000
type: ddsql_query_request
schema:
- $ref: "#/components/schemas/DdsqlTabularQueryRequest"
+ $ref: '#/components/schemas/DdsqlTabularQueryRequest'
required: true
responses:
"200":
@@ -147679,19 +147740,19 @@ paths:
elapsed: 42
request_id: "req-7f3e7d2c-1a0b-4d3e-9b2a-3c4d5e6f7081"
schema:
- $ref: "#/components/schemas/DdsqlTabularQueryResponse"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147699,7 +147760,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Execute a tabular DDSQL query
tags:
@@ -147724,7 +147785,7 @@ paths:
query_id: "eyJxdWVyeSI6ICJTRUxFQ1QgKiBGUk9NIGxvZ3MifQ=="
type: ddsql_query_fetch_request
schema:
- $ref: "#/components/schemas/DdsqlTabularQueryFetchRequest"
+ $ref: '#/components/schemas/DdsqlTabularQueryFetchRequest'
required: true
responses:
"200":
@@ -147788,19 +147849,19 @@ paths:
elapsed: 12
request_id: "req-7f3e7d2c-1a0b-4d3e-9b2a-3c4d5e6f7082"
schema:
- $ref: "#/components/schemas/DdsqlTabularQueryResponse"
+ $ref: '#/components/schemas/DdsqlTabularQueryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147808,7 +147869,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Fetch the result of a DDSQL query
tags:
@@ -147839,7 +147900,7 @@ paths:
to: 1704063600000
type: create_deletion_req
schema:
- $ref: "#/components/schemas/CreateDataDeletionRequestBody"
+ $ref: '#/components/schemas/CreateDataDeletionRequestBody'
required: true
responses:
"200":
@@ -147869,7 +147930,7 @@ paths:
product: logs
request_status: pending
schema:
- $ref: "#/components/schemas/CreateDataDeletionResponseBody"
+ $ref: '#/components/schemas/CreateDataDeletionResponseBody'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147879,7 +147940,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Precondition failed error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -147887,7 +147948,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal server error
security:
- apiKeyAuth: []
@@ -147973,7 +148034,7 @@ paths:
next_page: "cGFnZTI="
product: logs
schema:
- $ref: "#/components/schemas/GetDataDeletionsResponseBody"
+ $ref: '#/components/schemas/GetDataDeletionsResponseBody'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -147985,7 +148046,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal server error
security:
- apiKeyAuth: []
@@ -148032,7 +148093,7 @@ paths:
product: logs
request_status: canceled
schema:
- $ref: "#/components/schemas/CancelDataDeletionResponseBody"
+ $ref: '#/components/schemas/CancelDataDeletionResponseBody'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -148042,7 +148103,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Precondition failed error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -148050,7 +148111,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal server error
security:
- apiKeyAuth: []
@@ -148108,7 +148169,7 @@ paths:
page:
size: 50
schema:
- $ref: "#/components/schemas/DeploymentGatesListResponse"
+ $ref: '#/components/schemas/DeploymentGatesListResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148122,7 +148183,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148155,7 +148216,7 @@ paths:
service: my-service
type: deployment_gate
schema:
- $ref: "#/components/schemas/CreateDeploymentGateParams"
+ $ref: '#/components/schemas/CreateDeploymentGateParams'
required: true
responses:
"200":
@@ -148178,7 +148239,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: deployment_gate
schema:
- $ref: "#/components/schemas/DeploymentGateResponse"
+ $ref: '#/components/schemas/DeploymentGateResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148192,7 +148253,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148240,7 +148301,7 @@ paths:
id: 00000000-0000-0000-0000-000000000011
type: list_deployment_rules
schema:
- $ref: "#/components/schemas/DeploymentGateRulesResponse"
+ $ref: '#/components/schemas/DeploymentGateRulesResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148254,7 +148315,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148296,7 +148357,7 @@ paths:
type: faulty_deployment_detection
type: deployment_rule
schema:
- $ref: "#/components/schemas/CreateDeploymentRuleParams"
+ $ref: '#/components/schemas/CreateDeploymentRuleParams'
required: true
responses:
"200":
@@ -148320,7 +148381,7 @@ paths:
id: 00000000-0000-0000-0000-000000000009
type: deployment_rule
schema:
- $ref: "#/components/schemas/DeploymentRuleResponse"
+ $ref: '#/components/schemas/DeploymentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148334,7 +148395,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148384,7 +148445,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148436,7 +148497,7 @@ paths:
id: 00000000-0000-0000-0000-000000000013
type: deployment_rule
schema:
- $ref: "#/components/schemas/DeploymentRuleResponse"
+ $ref: '#/components/schemas/DeploymentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148452,7 +148513,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148499,7 +148560,7 @@ paths:
- resource2
type: deployment_rule
schema:
- $ref: "#/components/schemas/UpdateDeploymentRuleParams"
+ $ref: '#/components/schemas/UpdateDeploymentRuleParams'
required: true
responses:
"200":
@@ -148522,7 +148583,7 @@ paths:
id: 00000000-0000-0000-0000-000000000015
type: deployment_rule
schema:
- $ref: "#/components/schemas/DeploymentRuleResponse"
+ $ref: '#/components/schemas/DeploymentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148538,7 +148599,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148582,7 +148643,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148627,7 +148688,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: deployment_gate
schema:
- $ref: "#/components/schemas/DeploymentGateResponse"
+ $ref: '#/components/schemas/DeploymentGateResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148643,7 +148704,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148681,7 +148742,7 @@ paths:
id: 12345678-1234-1234-1234-123456789012
type: deployment_gate
schema:
- $ref: "#/components/schemas/UpdateDeploymentGateParams"
+ $ref: '#/components/schemas/UpdateDeploymentGateParams'
required: true
responses:
"200":
@@ -148702,7 +148763,7 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: deployment_gate
schema:
- $ref: "#/components/schemas/DeploymentGateResponse"
+ $ref: '#/components/schemas/DeploymentGateResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148718,7 +148779,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148785,7 +148846,7 @@ paths:
version: 1.2.3
type: deployment_gates_evaluation_request
schema:
- $ref: "#/components/schemas/DeploymentGatesEvaluationRequest"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationRequest'
required: true
responses:
"202":
@@ -148800,7 +148861,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: deployment_gates_evaluation_response
schema:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResponse"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResponse'
description: Accepted
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148816,7 +148877,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148866,7 +148927,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: deployment_gates_evaluation_result_response
schema:
- $ref: "#/components/schemas/DeploymentGatesEvaluationResultResponse"
+ $ref: '#/components/schemas/DeploymentGatesEvaluationResultResponse'
description: OK
"400":
$ref: "#/components/responses/HTTPCDGatesBadRequestResponse"
@@ -148882,7 +148943,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPCIAppErrors"
+ $ref: '#/components/schemas/HTTPCIAppErrors'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -148916,7 +148977,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: domain_allowlist
schema:
- $ref: "#/components/schemas/DomainAllowlistResponse"
+ $ref: '#/components/schemas/DomainAllowlistResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -148955,7 +149016,7 @@ paths:
enabled: false
type: domain_allowlist
schema:
- $ref: "#/components/schemas/DomainAllowlistRequest"
+ $ref: '#/components/schemas/DomainAllowlistRequest'
required: true
responses:
"200":
@@ -148972,7 +149033,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: domain_allowlist
schema:
- $ref: "#/components/schemas/DomainAllowlistResponse"
+ $ref: '#/components/schemas/DomainAllowlistResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -149027,7 +149088,7 @@ paths:
team: backend
version: v1.12.07
schema:
- $ref: "#/components/schemas/DORADeploymentRequest"
+ $ref: '#/components/schemas/DORADeploymentRequest'
required: true
responses:
"200":
@@ -149040,7 +149101,7 @@ paths:
id: 4242fcdd31586083
type: dora_deployment
schema:
- $ref: "#/components/schemas/DORADeploymentResponse"
+ $ref: '#/components/schemas/DORADeploymentResponse'
description: OK
"202":
content:
@@ -149052,13 +149113,13 @@ paths:
id: 4242fcdd31586083
type: dora_deployment
schema:
- $ref: "#/components/schemas/DORADeploymentResponse"
+ $ref: '#/components/schemas/DORADeploymentResponse'
description: OK - but delayed due to incident
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149089,7 +149150,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149124,7 +149185,7 @@ paths:
version: v1.2.3
type: dora_deployment_patch_request
schema:
- $ref: "#/components/schemas/DORADeploymentPatchByVersionRequest"
+ $ref: '#/components/schemas/DORADeploymentPatchByVersionRequest'
required: true
responses:
"202":
@@ -149133,7 +149194,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149172,7 +149233,7 @@ paths:
to: "2025-01-31T23:59:59Z"
type: dora_deployments_list_request
schema:
- $ref: "#/components/schemas/DORAListDeploymentsRequest"
+ $ref: '#/components/schemas/DORAListDeploymentsRequest'
required: true
responses:
"200":
@@ -149191,13 +149252,13 @@ paths:
id: abc-123
type: dora_deployment
schema:
- $ref: "#/components/schemas/DORADeploymentsListResponse"
+ $ref: '#/components/schemas/DORADeploymentsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149243,13 +149304,13 @@ paths:
id: abc-123
type: dora_deployment
schema:
- $ref: "#/components/schemas/DORADeploymentFetchResponse"
+ $ref: '#/components/schemas/DORADeploymentFetchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149292,7 +149353,7 @@ paths:
id: z_RwVLi7v4Y
type: dora_deployment_patch_request
schema:
- $ref: "#/components/schemas/DORADeploymentPatchRequest"
+ $ref: '#/components/schemas/DORADeploymentPatchRequest'
required: true
responses:
"202":
@@ -149301,7 +149362,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149349,7 +149410,7 @@ paths:
team: backend
version: v1.12.07
schema:
- $ref: "#/components/schemas/DORAFailureRequest"
+ $ref: '#/components/schemas/DORAFailureRequest'
required: true
responses:
"200":
@@ -149362,7 +149423,7 @@ paths:
id: 4242fcdd31586085
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailureResponse"
+ $ref: '#/components/schemas/DORAFailureResponse'
description: OK
"202":
content:
@@ -149374,13 +149435,13 @@ paths:
id: 4242fcdd31586085
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailureResponse"
+ $ref: '#/components/schemas/DORAFailureResponse'
description: OK - but delayed due to incident
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149411,7 +149472,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149447,7 +149508,7 @@ paths:
to: "2025-01-31T23:59:59Z"
type: dora_failures_list_request
schema:
- $ref: "#/components/schemas/DORAListFailuresRequest"
+ $ref: '#/components/schemas/DORAListFailuresRequest'
required: true
responses:
"200":
@@ -149468,13 +149529,13 @@ paths:
id: abc-123
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailuresListResponse"
+ $ref: '#/components/schemas/DORAFailuresListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149522,13 +149583,13 @@ paths:
id: abc-123
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailureFetchResponse"
+ $ref: '#/components/schemas/DORAFailureFetchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149578,7 +149639,7 @@ paths:
team: backend
version: v1.12.07
schema:
- $ref: "#/components/schemas/DORAFailureRequest"
+ $ref: '#/components/schemas/DORAFailureRequest'
required: true
responses:
"200":
@@ -149591,7 +149652,7 @@ paths:
id: 4242fcdd31586085
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailureResponse"
+ $ref: '#/components/schemas/DORAFailureResponse'
description: OK
"202":
content:
@@ -149603,13 +149664,13 @@ paths:
id: 4242fcdd31586085
type: dora_failure
schema:
- $ref: "#/components/schemas/DORAFailureResponse"
+ $ref: '#/components/schemas/DORAFailureResponse'
description: OK - but delayed due to incident
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -149682,13 +149743,13 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/ListDowntimesResponse"
+ $ref: '#/components/schemas/ListDowntimesResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -149736,7 +149797,7 @@ paths:
scope: env:(staging OR prod) AND datacenter:us-east-1
type: downtime
schema:
- $ref: "#/components/schemas/DowntimeCreateRequest"
+ $ref: '#/components/schemas/DowntimeCreateRequest'
description: Schedule a downtime request body.
required: true
responses:
@@ -149767,19 +149828,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: downtime
schema:
- $ref: "#/components/schemas/DowntimeResponse"
+ $ref: '#/components/schemas/DowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -149819,13 +149880,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtime not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -149890,25 +149951,25 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: downtime
schema:
- $ref: "#/components/schemas/DowntimeResponse"
+ $ref: '#/components/schemas/DowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -149961,7 +150022,7 @@ paths:
id: 00000000-0000-1234-0000-000000000000
type: downtime
schema:
- $ref: "#/components/schemas/DowntimeUpdateRequest"
+ $ref: '#/components/schemas/DowntimeUpdateRequest'
description: Update a downtime request body.
required: true
responses:
@@ -149992,25 +150053,25 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: downtime
schema:
- $ref: "#/components/schemas/DowntimeResponse"
+ $ref: '#/components/schemas/DowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Downtime not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150049,7 +150110,7 @@ paths:
to: 1671620004000
type: search_request
schema:
- $ref: "#/components/schemas/IssuesSearchRequest"
+ $ref: '#/components/schemas/IssuesSearchRequest'
description: Search issues request payload.
required: true
responses:
@@ -150067,7 +150128,7 @@ paths:
id: abc-123
type: error_tracking_search_result
schema:
- $ref: "#/components/schemas/IssuesSearchResponse"
+ $ref: '#/components/schemas/IssuesSearchResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150109,7 +150170,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: issue
schema:
- $ref: "#/components/schemas/IssueResponse"
+ $ref: '#/components/schemas/IssueResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150176,7 +150237,7 @@ paths:
id: 87cb11a0-278c-440a-99fe-701223c80296
type: assignee
schema:
- $ref: "#/components/schemas/IssueUpdateAssigneeRequest"
+ $ref: '#/components/schemas/IssueUpdateAssigneeRequest'
description: Update issue assignee request payload.
required: true
responses:
@@ -150195,7 +150256,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: issue
schema:
- $ref: "#/components/schemas/IssueResponse"
+ $ref: '#/components/schemas/IssueResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150237,7 +150298,7 @@ paths:
id: c1726a66-1f64-11ee-b338-da7ad0900002
type: error_tracking_issue
schema:
- $ref: "#/components/schemas/IssueUpdateStateRequest"
+ $ref: '#/components/schemas/IssueUpdateStateRequest'
description: Update issue state request payload.
required: true
responses:
@@ -150256,7 +150317,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: issue
schema:
- $ref: "#/components/schemas/IssueResponse"
+ $ref: '#/components/schemas/IssueResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150310,7 +150371,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/EventsSort"
+ $ref: '#/components/schemas/EventsSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -150347,7 +150408,7 @@ paths:
meta:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
schema:
- $ref: "#/components/schemas/EventsListResponse"
+ $ref: '#/components/schemas/EventsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150438,7 +150499,7 @@ paths:
title: payment_processed feature flag updated
type: event
schema:
- $ref: "#/components/schemas/EventCreateRequestPayload"
+ $ref: '#/components/schemas/EventCreateRequestPayload'
description: Event creation request payload.
required: true
responses:
@@ -150455,19 +150516,19 @@ paths:
uid: abc-123
type: event
schema:
- $ref: "#/components/schemas/EventCreateResponsePayload"
+ $ref: '#/components/schemas/EventCreateResponsePayload'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150548,7 +150609,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/EventsListRequest"
+ $ref: '#/components/schemas/EventsListRequest'
required: false
responses:
"200":
@@ -150568,7 +150629,7 @@ paths:
meta:
request_id: MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR
schema:
- $ref: "#/components/schemas/EventsListResponse"
+ $ref: '#/components/schemas/EventsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150622,7 +150683,7 @@ paths:
id: abc-123
type: event
schema:
- $ref: "#/components/schemas/V2EventResponse"
+ $ref: '#/components/schemas/V2EventResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -150693,13 +150754,13 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListFeatureFlagsResponse"
+ $ref: '#/components/schemas/ListFeatureFlagsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150746,7 +150807,7 @@ paths:
value: "false"
type: feature-flags
schema:
- $ref: "#/components/schemas/CreateFeatureFlagRequest"
+ $ref: '#/components/schemas/CreateFeatureFlagRequest'
required: true
responses:
"201":
@@ -150775,25 +150836,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: feature-flags
schema:
- $ref: "#/components/schemas/FeatureFlagResponse"
+ $ref: '#/components/schemas/FeatureFlagResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150862,13 +150923,13 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListEnvironmentsResponse"
+ $ref: '#/components/schemas/ListEnvironmentsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150901,7 +150962,7 @@ paths:
- canary
type: environments
schema:
- $ref: "#/components/schemas/CreateEnvironmentRequest"
+ $ref: '#/components/schemas/CreateEnvironmentRequest'
required: true
responses:
"201":
@@ -150923,25 +150984,25 @@ paths:
id: 00000000-0000-0000-0000-000000000017
type: environments
schema:
- $ref: "#/components/schemas/EnvironmentResponse"
+ $ref: '#/components/schemas/EnvironmentResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -150970,13 +151031,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151017,19 +151078,19 @@ paths:
id: 00000000-0000-0000-0000-000000000018
type: environments
schema:
- $ref: "#/components/schemas/EnvironmentResponse"
+ $ref: '#/components/schemas/EnvironmentResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151065,7 +151126,7 @@ paths:
- prod-us
type: environments
schema:
- $ref: "#/components/schemas/UpdateEnvironmentRequest"
+ $ref: '#/components/schemas/UpdateEnvironmentRequest'
required: true
responses:
"200":
@@ -151087,25 +151148,25 @@ paths:
id: 00000000-0000-0000-0000-000000000019
type: environments
schema:
- $ref: "#/components/schemas/EnvironmentResponse"
+ $ref: '#/components/schemas/EnvironmentResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151148,31 +151209,31 @@ paths:
rollout_steps: []
updated_at: "2024-01-01T12:00:00Z"
schema:
- $ref: "#/components/schemas/AllocationExposureScheduleResponse"
+ $ref: '#/components/schemas/AllocationExposureScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151215,31 +151276,31 @@ paths:
rollout_steps: []
updated_at: "2024-01-01T12:00:00Z"
schema:
- $ref: "#/components/schemas/AllocationExposureScheduleResponse"
+ $ref: '#/components/schemas/AllocationExposureScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151282,31 +151343,31 @@ paths:
rollout_steps: []
updated_at: "2024-01-01T12:00:00Z"
schema:
- $ref: "#/components/schemas/AllocationExposureScheduleResponse"
+ $ref: '#/components/schemas/AllocationExposureScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151349,31 +151410,31 @@ paths:
rollout_steps: []
updated_at: "2024-01-01T12:00:00Z"
schema:
- $ref: "#/components/schemas/AllocationExposureScheduleResponse"
+ $ref: '#/components/schemas/AllocationExposureScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151423,19 +151484,19 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: feature-flags
schema:
- $ref: "#/components/schemas/FeatureFlagResponse"
+ $ref: '#/components/schemas/FeatureFlagResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151471,7 +151532,7 @@ paths:
name: Updated Feature Flag XYZ789
type: feature-flags
schema:
- $ref: "#/components/schemas/UpdateFeatureFlagRequest"
+ $ref: '#/components/schemas/UpdateFeatureFlagRequest'
required: true
responses:
"200":
@@ -151500,25 +151561,25 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: feature-flags
schema:
- $ref: "#/components/schemas/FeatureFlagResponse"
+ $ref: '#/components/schemas/FeatureFlagResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151569,25 +151630,25 @@ paths:
id: 00000000-0000-0000-0000-000000000010
type: feature-flags
schema:
- $ref: "#/components/schemas/FeatureFlagResponse"
+ $ref: '#/components/schemas/FeatureFlagResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151629,7 +151690,7 @@ paths:
variant_id: "550e8400-e29b-41d4-a716-446655440002"
type: "allocations"
schema:
- $ref: "#/components/schemas/CreateAllocationsRequest"
+ $ref: '#/components/schemas/CreateAllocationsRequest'
required: true
responses:
"201":
@@ -151657,7 +151718,7 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440020"
type: "allocations"
schema:
- $ref: "#/components/schemas/AllocationResponse"
+ $ref: '#/components/schemas/AllocationResponse'
description: Created
"202":
content:
@@ -151684,31 +151745,31 @@ paths:
id: 00000000-0000-0000-0000-000000000015
type: allocations
schema:
- $ref: "#/components/schemas/AllocationResponse"
+ $ref: '#/components/schemas/AllocationResponse'
description: Accepted - Approval required for this change
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151749,7 +151810,7 @@ paths:
variant_id: "550e8400-e29b-41d4-a716-446655440002"
type: "allocations"
schema:
- $ref: "#/components/schemas/OverwriteAllocationsRequest"
+ $ref: '#/components/schemas/OverwriteAllocationsRequest'
required: true
responses:
"200":
@@ -151777,7 +151838,7 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440020"
type: "allocations"
schema:
- $ref: "#/components/schemas/ListAllocationsResponse"
+ $ref: '#/components/schemas/ListAllocationsResponse'
description: OK
"202":
content:
@@ -151787,31 +151848,31 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListAllocationsResponse"
+ $ref: '#/components/schemas/ListAllocationsResponse'
description: Accepted - Approval required for this change
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151843,13 +151904,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151882,13 +151943,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151938,25 +151999,25 @@ paths:
id: 00000000-0000-0000-0000-000000000013
type: feature-flags
schema:
- $ref: "#/components/schemas/FeatureFlagResponse"
+ $ref: '#/components/schemas/FeatureFlagResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -151998,7 +152059,7 @@ paths:
value: dark
type: variants
schema:
- $ref: "#/components/schemas/CreateVariant"
+ $ref: '#/components/schemas/CreateVariant'
required: true
responses:
"201":
@@ -152017,31 +152078,31 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440002"
type: variants
schema:
- $ref: "#/components/schemas/Variant"
+ $ref: '#/components/schemas/Variant'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict - A variant with this key already exists on the flag.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -152073,25 +152134,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict - A pending suggestion already exists for this property.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -152128,7 +152189,7 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440002"
type: variants
schema:
- $ref: "#/components/schemas/UpdateVariantRequest"
+ $ref: '#/components/schemas/UpdateVariantRequest'
required: true
responses:
"200":
@@ -152147,31 +152208,31 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440002"
type: variants
schema:
- $ref: "#/components/schemas/Variant"
+ $ref: '#/components/schemas/Variant'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict - A pending suggestion already exists for this property.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -152215,7 +152276,7 @@ paths:
page:
total_count: 2
schema:
- $ref: "#/components/schemas/FleetAgentVersionsV2Response"
+ $ref: '#/components/schemas/FleetAgentVersionsV2Response'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -152336,7 +152397,7 @@ paths:
total_count: 500
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/FleetAgentsV2Response"
+ $ref: '#/components/schemas/FleetAgentsV2Response'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152400,7 +152461,7 @@ paths:
id: a1b2c3d4e5f67890a1b2c3d4e5f67890
type: agent
schema:
- $ref: "#/components/schemas/FleetAgentDetailV2Response"
+ $ref: '#/components/schemas/FleetAgentDetailV2Response'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152508,7 +152569,7 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/FleetDeploymentsV2Response"
+ $ref: '#/components/schemas/FleetDeploymentsV2Response'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152582,7 +152643,7 @@ paths:
filter_query: env:prod AND datacenter:us-east-1
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2CreateRequest"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2CreateRequest'
description: Request payload containing the deployment details.
required: true
responses:
@@ -152602,7 +152663,7 @@ paths:
id: dry-run
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentConfigureV2DryRunResponse"
+ $ref: '#/components/schemas/FleetDeploymentConfigureV2DryRunResponse'
description: OK
"201":
content:
@@ -152626,7 +152687,7 @@ paths:
id: k7Q-3mX-p9Z
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentV2CreateResponse"
+ $ref: '#/components/schemas/FleetDeploymentV2CreateResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152678,7 +152739,7 @@ paths:
version: 7.52.0
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentPackageUpgradeV2CreateRequest"
+ $ref: '#/components/schemas/FleetDeploymentPackageUpgradeV2CreateRequest'
description: Request payload containing the package upgrade details.
required: true
responses:
@@ -152704,7 +152765,7 @@ paths:
id: k7Q-3mX-p9Z
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentV2CreateResponse"
+ $ref: '#/components/schemas/FleetDeploymentV2CreateResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152792,7 +152853,7 @@ paths:
id: k7Q-3mX-p9Z
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentV2DetailResponse"
+ $ref: '#/components/schemas/FleetDeploymentV2DetailResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152851,7 +152912,7 @@ paths:
id: k7Q-3mX-p9Z
type: deployment
schema:
- $ref: "#/components/schemas/FleetDeploymentV2CancelResponse"
+ $ref: '#/components/schemas/FleetDeploymentV2CancelResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152916,7 +152977,7 @@ paths:
page:
total_count: 1
schema:
- $ref: "#/components/schemas/FleetSchedulesV2Response"
+ $ref: '#/components/schemas/FleetSchedulesV2Response'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -152980,7 +153041,7 @@ paths:
id: abc-def-ghi-123
type: schedule
schema:
- $ref: "#/components/schemas/FleetScheduleV2Response"
+ $ref: '#/components/schemas/FleetScheduleV2Response'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -153036,19 +153097,19 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormsResponse"
+ $ref: '#/components/schemas/FormsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153079,7 +153140,7 @@ paths:
ui_definition: {}
type: forms
schema:
- $ref: "#/components/schemas/CreateFormRequest"
+ $ref: '#/components/schemas/CreateFormRequest'
required: true
responses:
"200":
@@ -153110,19 +153171,19 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153154,7 +153215,7 @@ paths:
ui_definition: {}
type: forms
schema:
- $ref: "#/components/schemas/CreateFormRequest"
+ $ref: '#/components/schemas/CreateFormRequest'
required: true
responses:
"200":
@@ -153185,19 +153246,19 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153232,19 +153293,19 @@ paths:
id: 844dfd88-aa84-4db4-8979-e7bdbb9c1dc3
type: forms
schema:
- $ref: "#/components/schemas/DeleteFormResponse"
+ $ref: '#/components/schemas/DeleteFormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153303,25 +153364,25 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153357,7 +153418,7 @@ paths:
name: Updated Form Name
type: forms
schema:
- $ref: "#/components/schemas/UpdateFormRequest"
+ $ref: '#/components/schemas/UpdateFormRequest'
required: true
responses:
"200":
@@ -153388,25 +153449,25 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153441,7 +153502,7 @@ paths:
name: Copy of My Form
type: forms
schema:
- $ref: "#/components/schemas/CloneFormRequest"
+ $ref: '#/components/schemas/CloneFormRequest'
required: true
responses:
"200":
@@ -153472,25 +153533,25 @@ paths:
id: 7a1e9054-5f6a-4b08-9e3d-c2f189a3bce0
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153525,7 +153586,7 @@ paths:
version: 1
type: form_publications
schema:
- $ref: "#/components/schemas/PublishFormRequest"
+ $ref: '#/components/schemas/PublishFormRequest'
required: true
responses:
"200":
@@ -153548,25 +153609,25 @@ paths:
id: "42"
type: form_publications
schema:
- $ref: "#/components/schemas/FormPublicationResponse"
+ $ref: '#/components/schemas/FormPublicationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153607,7 +153668,7 @@ paths:
match_policy: none
type: form_versions
schema:
- $ref: "#/components/schemas/UpsertFormVersionRequest"
+ $ref: '#/components/schemas/UpsertFormVersionRequest'
required: true
responses:
"200":
@@ -153632,25 +153693,25 @@ paths:
id: "126"
type: form_versions
schema:
- $ref: "#/components/schemas/FormVersionResponse"
+ $ref: '#/components/schemas/FormVersionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153688,7 +153749,7 @@ paths:
etag: b51f08b698d88d8027a935d9db649774949f5fb41a0c559bfee6a9a13225c72d
type: form_versions
schema:
- $ref: "#/components/schemas/UpsertAndPublishFormVersionRequest"
+ $ref: '#/components/schemas/UpsertAndPublishFormVersionRequest'
required: true
responses:
"200":
@@ -153719,25 +153780,25 @@ paths:
id: 22f6006a-2302-4926-9396-d2dfcf7b0b34
type: forms
schema:
- $ref: "#/components/schemas/FormResponse"
+ $ref: '#/components/schemas/FormResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153809,7 +153870,7 @@ paths:
next_cursor: next-page
type: cursor
schema:
- $ref: "#/components/schemas/GlobalOrgsResponse"
+ $ref: '#/components/schemas/GlobalOrgsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -153860,25 +153921,25 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: "governance_console_config"
schema:
- $ref: "#/components/schemas/GovernanceConfigResponse"
+ $ref: '#/components/schemas/GovernanceConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -153949,25 +154010,25 @@ paths:
id: "unused_api_keys"
type: "governance_control"
schema:
- $ref: "#/components/schemas/GovernanceControlsResponse"
+ $ref: '#/components/schemas/GovernanceControlsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154039,31 +154100,31 @@ paths:
id: "unused_api_keys"
type: "governance_control"
schema:
- $ref: "#/components/schemas/GovernanceControlResponse"
+ $ref: '#/components/schemas/GovernanceControlResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154109,7 +154170,7 @@ paths:
mitigation_type: "revoke_api_key"
type: "governance_control"
schema:
- $ref: "#/components/schemas/GovernanceControlUpdateRequest"
+ $ref: '#/components/schemas/GovernanceControlUpdateRequest'
required: true
responses:
"200":
@@ -154143,31 +154204,31 @@ paths:
id: "unused_api_keys"
type: "governance_control"
schema:
- $ref: "#/components/schemas/GovernanceControlResponse"
+ $ref: '#/components/schemas/GovernanceControlResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154270,25 +154331,25 @@ paths:
id: "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
type: "governance_control_detection"
schema:
- $ref: "#/components/schemas/GovernanceControlDetectionsResponse"
+ $ref: '#/components/schemas/GovernanceControlDetectionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154340,25 +154401,25 @@ paths:
id: "unused_api_keys"
type: "control_notification_settings"
schema:
- $ref: "#/components/schemas/ControlNotificationSettingsResponse"
+ $ref: '#/components/schemas/ControlNotificationSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154407,7 +154468,7 @@ paths:
type: "slack"
type: "control_notification_settings"
schema:
- $ref: "#/components/schemas/ControlNotificationSettingsUpdateRequest"
+ $ref: '#/components/schemas/ControlNotificationSettingsUpdateRequest'
required: true
responses:
"200":
@@ -154427,25 +154488,25 @@ paths:
id: "unused_api_keys"
type: "control_notification_settings"
schema:
- $ref: "#/components/schemas/ControlNotificationSettingsResponse"
+ $ref: '#/components/schemas/ControlNotificationSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154487,7 +154548,7 @@ paths:
mitigation_type: "revoke_api_key"
type: "governance_control_detection"
schema:
- $ref: "#/components/schemas/GovernanceMitigationRequest"
+ $ref: '#/components/schemas/GovernanceMitigationRequest'
required: true
responses:
"202":
@@ -154496,19 +154557,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154564,31 +154625,31 @@ paths:
id: "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
type: "governance_control_detection"
schema:
- $ref: "#/components/schemas/GovernanceControlDetectionResponse"
+ $ref: '#/components/schemas/GovernanceControlDetectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154633,7 +154694,7 @@ paths:
state: "exception"
type: "governance_control_detection"
schema:
- $ref: "#/components/schemas/GovernanceControlDetectionUpdateRequest"
+ $ref: '#/components/schemas/GovernanceControlDetectionUpdateRequest'
required: true
responses:
"200":
@@ -154660,31 +154721,31 @@ paths:
id: "3f9b2c1a-8d4e-4a6b-9c2f-1e7d5a0b3c4d"
type: "governance_control_detection"
schema:
- $ref: "#/components/schemas/GovernanceControlDetectionResponse"
+ $ref: '#/components/schemas/GovernanceControlDetectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154782,25 +154843,25 @@ paths:
id: "a3248d1b-5578-4345-a34e-fe9657300f22"
type: "insight"
schema:
- $ref: "#/components/schemas/GovernanceInsightsResponse"
+ $ref: '#/components/schemas/GovernanceInsightsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154843,25 +154904,25 @@ paths:
id: "11111111-2222-3333-4444-555555555555"
type: "governance_notification_settings"
schema:
- $ref: "#/components/schemas/GovernanceNotificationSettingsResponse"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154896,7 +154957,7 @@ paths:
assignment_notifications_enabled: true
type: "governance_notification_settings"
schema:
- $ref: "#/components/schemas/GovernanceNotificationSettingsUpdateRequest"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsUpdateRequest'
required: true
responses:
"200":
@@ -154911,25 +154972,25 @@ paths:
id: "11111111-2222-3333-4444-555555555555"
type: "governance_notification_settings"
schema:
- $ref: "#/components/schemas/GovernanceNotificationSettingsResponse"
+ $ref: '#/components/schemas/GovernanceNotificationSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -154977,13 +155038,13 @@ paths:
name: include
required: false
schema:
- $ref: "#/components/schemas/TagRuleInclude"
+ $ref: '#/components/schemas/TagRuleInclude'
- description: Restrict the result set to rules whose source matches the given value.
in: query
name: filter[source]
required: false
schema:
- $ref: "#/components/schemas/TagRuleSource"
+ $ref: '#/components/schemas/TagRuleSource'
- description: Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds. Defaults to a recent window appropriate for the source.
example: 1779315066097
in: query
@@ -155041,25 +155102,25 @@ paths:
id: "123-v1-1779315066097-1779401466097"
type: "tag_rule_score"
schema:
- $ref: "#/components/schemas/TagRulesListResponse"
+ $ref: '#/components/schemas/TagRulesListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155105,7 +155166,7 @@ paths:
- "web"
type: "tag_rule"
schema:
- $ref: "#/components/schemas/TagRuleCreateRequest"
+ $ref: '#/components/schemas/TagRuleCreateRequest'
required: true
responses:
"201":
@@ -155135,31 +155196,31 @@ paths:
id: "123"
type: "tag_rule"
schema:
- $ref: "#/components/schemas/TagRuleResponse"
+ $ref: '#/components/schemas/TagRuleResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155206,25 +155267,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155262,7 +155323,7 @@ paths:
name: include
required: false
schema:
- $ref: "#/components/schemas/TagRuleInclude"
+ $ref: '#/components/schemas/TagRuleInclude'
- description: Start of the time window used for compliance score computation, as a Unix timestamp in milliseconds.
example: 1779315066097
in: query
@@ -155320,31 +155381,31 @@ paths:
id: "123-v1-1779315066097-1779401466097"
type: "tag_rule_score"
schema:
- $ref: "#/components/schemas/TagRuleResponse"
+ $ref: '#/components/schemas/TagRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155390,7 +155451,7 @@ paths:
id: "123"
type: "tag_rule"
schema:
- $ref: "#/components/schemas/TagRuleUpdateRequest"
+ $ref: '#/components/schemas/TagRuleUpdateRequest'
required: true
responses:
"200":
@@ -155420,31 +155481,31 @@ paths:
id: "123"
type: "tag_rule"
schema:
- $ref: "#/components/schemas/TagRuleResponse"
+ $ref: '#/components/schemas/TagRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155510,31 +155571,31 @@ paths:
id: "123-v1-1779315066097-1779401466097"
type: "tag_rule_score"
schema:
- $ref: "#/components/schemas/TagRuleScoreResponse"
+ $ref: '#/components/schemas/TagRuleScoreResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155579,25 +155640,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: hamr_org_connections
schema:
- $ref: "#/components/schemas/HamrOrgConnectionResponse"
+ $ref: '#/components/schemas/HamrOrgConnectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155634,7 +155695,7 @@ paths:
id: 550e8400-e29b-41d4-a716-446655440000
type: hamr_org_connections
schema:
- $ref: "#/components/schemas/HamrOrgConnectionRequest"
+ $ref: '#/components/schemas/HamrOrgConnectionRequest'
required: true
responses:
"200":
@@ -155655,19 +155716,19 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: hamr_org_connections
schema:
- $ref: "#/components/schemas/HamrOrgConnectionResponse"
+ $ref: '#/components/schemas/HamrOrgConnectionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155675,7 +155736,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -155715,13 +155776,13 @@ paths:
id: "00000000-0000-0000-0000-000000000003"
type: identity_providers
schema:
- $ref: "#/components/schemas/IdentityProvidersResponse"
+ $ref: '#/components/schemas/IdentityProvidersResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155757,7 +155818,7 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: identity_providers
schema:
- $ref: "#/components/schemas/IdentityProviderUpdateRequest"
+ $ref: '#/components/schemas/IdentityProviderUpdateRequest'
required: true
responses:
"200":
@@ -155773,25 +155834,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: identity_providers
schema:
- $ref: "#/components/schemas/IdentityProviderResponse"
+ $ref: '#/components/schemas/IdentityProviderResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155832,7 +155893,7 @@ paths:
name: sort_dir
required: false
schema:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
- description: Filter users by the given string. Defaults to no filtering.
in: query
name: filter
@@ -155869,25 +155930,25 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/UsersResponse"
+ $ref: '#/components/schemas/UsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155921,7 +155982,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -155929,7 +155990,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -155966,13 +156027,13 @@ paths:
id: 01HJABCD12345678ABCDEFGHIJ
type: entity_integration_configs
schema:
- $ref: "#/components/schemas/EntityIntegrationConfigResponse"
+ $ref: '#/components/schemas/EntityIntegrationConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -155980,7 +156041,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156042,7 +156103,7 @@ paths:
subdomain: mycompany
type: entity_integration_config_requests
schema:
- $ref: "#/components/schemas/EntityIntegrationConfigRequest"
+ $ref: '#/components/schemas/EntityIntegrationConfigRequest'
required: true
responses:
"200":
@@ -156061,13 +156122,13 @@ paths:
id: 01HJABCD12345678ABCDEFGHIJ
type: entity_integration_configs
schema:
- $ref: "#/components/schemas/EntityIntegrationConfigResponse"
+ $ref: '#/components/schemas/EntityIntegrationConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -156110,7 +156171,7 @@ paths:
id: "00000000-0000-0000-1234-000000000000"
type: incidents
schema:
- $ref: "#/components/schemas/IncidentsResponse"
+ $ref: '#/components/schemas/IncidentsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156181,7 +156242,7 @@ paths:
type: users
type: incidents
schema:
- $ref: "#/components/schemas/IncidentCreateRequest"
+ $ref: '#/components/schemas/IncidentCreateRequest'
description: Incident payload.
required: true
responses:
@@ -156204,7 +156265,7 @@ paths:
id: "00000000-0000-0000-1234-000000000000"
type: incidents
schema:
- $ref: "#/components/schemas/IncidentResponse"
+ $ref: '#/components/schemas/IncidentResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156244,7 +156305,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156284,13 +156345,13 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: incidents_handles
schema:
- $ref: "#/components/schemas/IncidentHandlesResponse"
+ $ref: '#/components/schemas/IncidentHandlesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156336,7 +156397,7 @@ paths:
type: incident_types
type: incidents_handles
schema:
- $ref: "#/components/schemas/IncidentHandleRequest"
+ $ref: '#/components/schemas/IncidentHandleRequest'
required: true
responses:
"201":
@@ -156356,13 +156417,13 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: incidents_handles
schema:
- $ref: "#/components/schemas/IncidentHandleResponse"
+ $ref: '#/components/schemas/IncidentHandleResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156408,7 +156469,7 @@ paths:
type: incident_types
type: incidents_handles
schema:
- $ref: "#/components/schemas/IncidentHandleRequest"
+ $ref: '#/components/schemas/IncidentHandleRequest'
required: true
responses:
"200":
@@ -156428,13 +156489,13 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: incidents_handles
schema:
- $ref: "#/components/schemas/IncidentHandleResponse"
+ $ref: '#/components/schemas/IncidentHandleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156464,13 +156525,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_global_settings
schema:
- $ref: "#/components/schemas/GlobalIncidentSettingsResponse"
+ $ref: '#/components/schemas/GlobalIncidentSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156495,7 +156556,7 @@ paths:
analytics_dashboard_id: 00000000-0000-0000-0000-000000000003-def
type: incidents_global_settings
schema:
- $ref: "#/components/schemas/GlobalIncidentSettingsRequest"
+ $ref: '#/components/schemas/GlobalIncidentSettingsRequest'
required: true
responses:
"200":
@@ -156512,13 +156573,13 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: incidents_global_settings
schema:
- $ref: "#/components/schemas/GlobalIncidentSettingsResponse"
+ $ref: '#/components/schemas/GlobalIncidentSettingsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -156552,7 +156613,7 @@ paths:
type: incident_types
type: google_chat_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationRequest'
description: Google Chat configuration payload.
required: true
responses:
@@ -156573,7 +156634,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_chat_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationResponse"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156618,7 +156679,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_chat_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationPatchRequest"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationPatchRequest'
description: Google Chat configuration patch payload.
required: true
responses:
@@ -156639,7 +156700,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_chat_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleChatConfigurationResponse"
+ $ref: '#/components/schemas/IncidentGoogleChatConfigurationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156689,7 +156750,7 @@ paths:
type: incident_types
type: google_meet_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationRequest'
description: Google Meet configuration payload.
required: true
responses:
@@ -156708,7 +156769,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_meet_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationResponse"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156753,7 +156814,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_meet_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationPatchRequest"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationPatchRequest'
description: Google Meet configuration patch payload.
required: true
responses:
@@ -156772,7 +156833,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google_meet_configurations
schema:
- $ref: "#/components/schemas/IncidentGoogleMeetConfigurationResponse"
+ $ref: '#/components/schemas/IncidentGoogleMeetConfigurationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156814,7 +156875,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/IncidentImpactFieldsResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156868,7 +156929,7 @@ paths:
type: incident_types
type: impact_fields
schema:
- $ref: "#/components/schemas/IncidentImpactFieldRequest"
+ $ref: '#/components/schemas/IncidentImpactFieldRequest'
description: Impact field payload.
required: true
responses:
@@ -156890,7 +156951,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: impact_fields
schema:
- $ref: "#/components/schemas/IncidentImpactFieldResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -156975,7 +157036,7 @@ paths:
type: incident_types
type: impact_fields
schema:
- $ref: "#/components/schemas/IncidentImpactFieldRequest"
+ $ref: '#/components/schemas/IncidentImpactFieldRequest'
description: Impact field update payload.
required: true
responses:
@@ -156993,7 +157054,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: impact_fields
schema:
- $ref: "#/components/schemas/IncidentImpactFieldResponse"
+ $ref: '#/components/schemas/IncidentImpactFieldResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157052,7 +157113,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/IncidentNotificationRuleArray"
+ $ref: '#/components/schemas/IncidentNotificationRuleArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157115,7 +157176,7 @@ paths:
type: notification_templates
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/CreateIncidentNotificationRuleRequest"
+ $ref: '#/components/schemas/CreateIncidentNotificationRuleRequest'
required: true
responses:
"201":
@@ -157141,7 +157202,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/IncidentNotificationRule"
+ $ref: '#/components/schemas/IncidentNotificationRule'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157236,7 +157297,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/IncidentNotificationRule"
+ $ref: '#/components/schemas/IncidentNotificationRule'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157304,7 +157365,7 @@ paths:
type: notification_templates
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/PutIncidentNotificationRuleRequest"
+ $ref: '#/components/schemas/PutIncidentNotificationRuleRequest'
required: true
responses:
"200":
@@ -157330,7 +157391,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_notification_rules
schema:
- $ref: "#/components/schemas/IncidentNotificationRule"
+ $ref: '#/components/schemas/IncidentNotificationRule'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157384,7 +157445,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_templates
schema:
- $ref: "#/components/schemas/IncidentNotificationTemplateArray"
+ $ref: '#/components/schemas/IncidentNotificationTemplateArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157433,7 +157494,7 @@ paths:
type: incident_types
type: notification_templates
schema:
- $ref: "#/components/schemas/CreateIncidentNotificationTemplateRequest"
+ $ref: '#/components/schemas/CreateIncidentNotificationTemplateRequest'
required: true
responses:
"201":
@@ -157453,7 +157514,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_templates
schema:
- $ref: "#/components/schemas/IncidentNotificationTemplate"
+ $ref: '#/components/schemas/IncidentNotificationTemplate'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157542,7 +157603,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_templates
schema:
- $ref: "#/components/schemas/IncidentNotificationTemplate"
+ $ref: '#/components/schemas/IncidentNotificationTemplate'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157594,7 +157655,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_templates
schema:
- $ref: "#/components/schemas/PatchIncidentNotificationTemplateRequest"
+ $ref: '#/components/schemas/PatchIncidentNotificationTemplateRequest'
required: true
responses:
"200":
@@ -157614,7 +157675,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: notification_templates
schema:
- $ref: "#/components/schemas/IncidentNotificationTemplate"
+ $ref: '#/components/schemas/IncidentNotificationTemplate'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157673,13 +157734,13 @@ paths:
type: incident_types
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplatesResponse"
+ $ref: '#/components/schemas/PostmortemTemplatesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -157710,7 +157771,7 @@ paths:
type: incident_types
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplateRequest"
+ $ref: '#/components/schemas/PostmortemTemplateRequest'
required: true
responses:
"201":
@@ -157735,19 +157796,19 @@ paths:
type: incident_types
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplateResponse"
+ $ref: '#/components/schemas/PostmortemTemplateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -157771,13 +157832,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -157816,19 +157877,19 @@ paths:
type: incident_types
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplateResponse"
+ $ref: '#/components/schemas/PostmortemTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -157856,7 +157917,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplateRequest"
+ $ref: '#/components/schemas/PostmortemTemplateRequest'
required: true
responses:
"200":
@@ -157881,19 +157942,19 @@ paths:
type: incident_types
type: postmortem_templates
schema:
- $ref: "#/components/schemas/PostmortemTemplateResponse"
+ $ref: '#/components/schemas/PostmortemTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -157940,7 +158001,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/IncidentRulesResponse"
+ $ref: '#/components/schemas/IncidentRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -157988,7 +158049,7 @@ paths:
trigger: incident_created_trigger
type: incident_rules
schema:
- $ref: "#/components/schemas/IncidentRuleRequest"
+ $ref: '#/components/schemas/IncidentRuleRequest'
description: Incident rule payload.
required: true
responses:
@@ -158013,7 +158074,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_rules
schema:
- $ref: "#/components/schemas/IncidentRuleResponse"
+ $ref: '#/components/schemas/IncidentRuleResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158104,7 +158165,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_rules
schema:
- $ref: "#/components/schemas/IncidentRuleResponse"
+ $ref: '#/components/schemas/IncidentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158150,7 +158211,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_rules
schema:
- $ref: "#/components/schemas/IncidentRulePatchRequest"
+ $ref: '#/components/schemas/IncidentRulePatchRequest'
description: Incident rule patch payload.
required: true
responses:
@@ -158175,7 +158236,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_rules
schema:
- $ref: "#/components/schemas/IncidentRuleResponse"
+ $ref: '#/components/schemas/IncidentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158226,7 +158287,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypeListResponse"
+ $ref: '#/components/schemas/IncidentTypeListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158272,7 +158333,7 @@ paths:
prefix: IR
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypeCreateRequest"
+ $ref: '#/components/schemas/IncidentTypeCreateRequest'
description: Incident type payload.
required: true
responses:
@@ -158290,7 +158351,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypeResponse"
+ $ref: '#/components/schemas/IncidentTypeResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158363,7 +158424,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/IncidentOrgSettingsListResponse"
+ $ref: '#/components/schemas/IncidentOrgSettingsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158446,7 +158507,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypeResponse"
+ $ref: '#/components/schemas/IncidentTypeResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158496,7 +158557,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypePatchRequest"
+ $ref: '#/components/schemas/IncidentTypePatchRequest'
description: Incident type payload.
required: true
responses:
@@ -158514,7 +158575,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: incident_types
schema:
- $ref: "#/components/schemas/IncidentTypeResponse"
+ $ref: '#/components/schemas/IncidentTypeResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158575,7 +158636,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_org_settings
schema:
- $ref: "#/components/schemas/IncidentOrgSettingsResponse"
+ $ref: '#/components/schemas/IncidentOrgSettingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -158688,13 +158749,13 @@ paths:
offset: 0
size: 1
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldListResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -158756,7 +158817,7 @@ paths:
type: incident_types
type: user_defined_field
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldCreateRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldCreateRequest'
description: Incident user-defined field payload.
required: true
responses:
@@ -158799,13 +158860,13 @@ paths:
type: "users"
type: "user_defined_field"
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldResponse'
description: CREATED
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -158815,7 +158876,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -158849,7 +158910,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -158859,7 +158920,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -158932,7 +158993,7 @@ paths:
type: "users"
type: "user_defined_field"
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -158942,7 +159003,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -158994,7 +159055,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: user_defined_field
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldUpdateRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldUpdateRequest'
description: Incident user-defined field update payload.
required: true
responses:
@@ -159037,13 +159098,13 @@ paths:
type: "users"
type: "user_defined_field"
schema:
- $ref: "#/components/schemas/IncidentUserDefinedFieldResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedFieldResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -159053,7 +159114,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159112,13 +159173,13 @@ paths:
id: "00000000-0000-0000-0000-000000000002"
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRolesResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRolesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159164,7 +159225,7 @@ paths:
type: incident_types
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRoleRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleRequest'
required: true
responses:
"201":
@@ -159184,19 +159245,19 @@ paths:
id: "00000000-0000-0000-0000-000000000002"
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRoleResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159225,13 +159286,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159277,19 +159338,19 @@ paths:
id: "00000000-0000-0000-0000-000000000002"
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRoleResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159329,7 +159390,7 @@ paths:
id: "00000000-0000-0000-0000-000000000002"
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRolePatchRequest"
+ $ref: '#/components/schemas/IncidentUserDefinedRolePatchRequest'
required: true
responses:
"200":
@@ -159348,19 +159409,19 @@ paths:
id: "00000000-0000-0000-0000-000000000002"
type: incident_user_defined_roles
schema:
- $ref: "#/components/schemas/IncidentUserDefinedRoleResponse"
+ $ref: '#/components/schemas/IncidentUserDefinedRoleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -159415,7 +159476,7 @@ paths:
type: users
type: incidents
schema:
- $ref: "#/components/schemas/IncidentImportRequest"
+ $ref: '#/components/schemas/IncidentImportRequest'
description: Incident import payload.
required: true
responses:
@@ -159438,7 +159499,7 @@ paths:
id: "00000000-0000-0000-1234-000000000000"
type: incidents
schema:
- $ref: "#/components/schemas/IncidentImportResponse"
+ $ref: '#/components/schemas/IncidentImportResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159494,7 +159555,7 @@ paths:
total: 0
type: incidents_search_results
schema:
- $ref: "#/components/schemas/IncidentSearchResponse"
+ $ref: '#/components/schemas/IncidentSearchResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159588,7 +159649,7 @@ paths:
id: "00000000-0000-0000-1234-000000000000"
type: incidents
schema:
- $ref: "#/components/schemas/IncidentResponse"
+ $ref: '#/components/schemas/IncidentResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159663,7 +159724,7 @@ paths:
type: incident_postmortems
type: incidents
schema:
- $ref: "#/components/schemas/IncidentUpdateRequest"
+ $ref: '#/components/schemas/IncidentUpdateRequest'
description: Incident Payload.
required: true
responses:
@@ -159686,7 +159747,7 @@ paths:
id: "00000000-0000-0000-1234-000000000000"
type: incidents
schema:
- $ref: "#/components/schemas/IncidentResponse"
+ $ref: '#/components/schemas/IncidentResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159739,7 +159800,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: get_incident_ai_postmortem_response
schema:
- $ref: "#/components/schemas/IncidentAIPostmortemResponse"
+ $ref: '#/components/schemas/IncidentAIPostmortemResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159802,7 +159863,7 @@ paths:
type: incidents
type: incident_attachments
schema:
- $ref: "#/components/schemas/AttachmentArray"
+ $ref: '#/components/schemas/AttachmentArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159842,7 +159903,7 @@ paths:
attachment_type: postmortem
type: incident_attachments
schema:
- $ref: "#/components/schemas/CreateAttachmentRequest"
+ $ref: '#/components/schemas/CreateAttachmentRequest'
required: true
responses:
"201":
@@ -159866,7 +159927,7 @@ paths:
type: incidents
type: incident_attachments
schema:
- $ref: "#/components/schemas/Attachment"
+ $ref: '#/components/schemas/Attachment'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -159923,7 +159984,7 @@ paths:
title: Postmortem-IR-123
type: incident_attachments
schema:
- $ref: "#/components/schemas/PostmortemAttachmentRequest"
+ $ref: '#/components/schemas/PostmortemAttachmentRequest'
required: true
responses:
"201":
@@ -159947,13 +160008,13 @@ paths:
type: incidents
type: incident_attachments
schema:
- $ref: "#/components/schemas/Attachment"
+ $ref: '#/components/schemas/Attachment'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -160017,7 +160078,7 @@ paths:
id: 00000000-abcd-0002-0000-000000000000
type: incident_attachments
schema:
- $ref: "#/components/schemas/PatchAttachmentRequest"
+ $ref: '#/components/schemas/PatchAttachmentRequest'
required: true
responses:
"200":
@@ -160041,7 +160102,7 @@ paths:
type: incidents
type: incident_attachments
schema:
- $ref: "#/components/schemas/Attachment"
+ $ref: '#/components/schemas/Attachment'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160092,7 +160153,7 @@ paths:
title: Production outage - SEV-1
type: page
schema:
- $ref: "#/components/schemas/IncidentCreatePageFromIncidentRequest"
+ $ref: '#/components/schemas/IncidentCreatePageFromIncidentRequest'
description: Page creation payload.
required: true
responses:
@@ -160106,7 +160167,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: page_uuid
schema:
- $ref: "#/components/schemas/IncidentPageUUIDResponse"
+ $ref: '#/components/schemas/IncidentPageUUIDResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160154,7 +160215,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_configurations
schema:
- $ref: "#/components/schemas/IncidentConfigurationPatchRequest"
+ $ref: '#/components/schemas/IncidentConfigurationPatchRequest'
description: Incident configuration patch payload.
required: true
responses:
@@ -160176,7 +160237,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_configurations
schema:
- $ref: "#/components/schemas/IncidentConfigurationResponse"
+ $ref: '#/components/schemas/IncidentConfigurationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160224,7 +160285,7 @@ paths:
include_in_search: true
type: incidents_configurations
schema:
- $ref: "#/components/schemas/IncidentConfigurationRequest"
+ $ref: '#/components/schemas/IncidentConfigurationRequest'
description: Incident configuration payload.
required: true
responses:
@@ -160246,7 +160307,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_configurations
schema:
- $ref: "#/components/schemas/IncidentConfigurationResponse"
+ $ref: '#/components/schemas/IncidentConfigurationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160297,7 +160358,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_impacts
schema:
- $ref: "#/components/schemas/IncidentImpactsResponse"
+ $ref: '#/components/schemas/IncidentImpactsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160346,7 +160407,7 @@ paths:
start_at: "2025-08-28T13:17:00Z"
type: incident_impacts
schema:
- $ref: "#/components/schemas/IncidentImpactCreateRequest"
+ $ref: '#/components/schemas/IncidentImpactCreateRequest'
description: Incident impact payload.
required: true
responses:
@@ -160364,7 +160425,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_impacts
schema:
- $ref: "#/components/schemas/IncidentImpactResponse"
+ $ref: '#/components/schemas/IncidentImpactResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160439,7 +160500,7 @@ paths:
description: Patched service impact description
type: incident_impacts
schema:
- $ref: "#/components/schemas/IncidentImpactPatchRequest"
+ $ref: '#/components/schemas/IncidentImpactPatchRequest'
description: Incident impact patch payload.
required: true
responses:
@@ -160456,7 +160517,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_impacts
schema:
- $ref: "#/components/schemas/IncidentImpactResponse"
+ $ref: '#/components/schemas/IncidentImpactResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160508,7 +160569,7 @@ paths:
title: Production outage - SEV-1
type: page
schema:
- $ref: "#/components/schemas/IncidentCreateOnCallPageRequest"
+ $ref: '#/components/schemas/IncidentCreateOnCallPageRequest'
description: On-call page creation payload.
required: true
responses:
@@ -160522,7 +160583,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: page_uuid
schema:
- $ref: "#/components/schemas/IncidentPageUUIDResponse"
+ $ref: '#/components/schemas/IncidentPageUUIDResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160573,7 +160634,7 @@ paths:
id: PAGE-12345
type: page
schema:
- $ref: "#/components/schemas/IncidentOnCallPageLinkRequest"
+ $ref: '#/components/schemas/IncidentOnCallPageLinkRequest'
description: On-call page link payload.
required: true
responses:
@@ -160590,7 +160651,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160604,7 +160665,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict - page already linked to incident.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -160649,7 +160710,7 @@ paths:
id: 00000000-0000-0000-1234-000000000000
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataListResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160700,7 +160761,7 @@ paths:
team_id: T01234567
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataCreateRequest"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataCreateRequest'
description: Incident integration metadata payload.
required: true
responses:
@@ -160721,7 +160782,7 @@ paths:
id: 00000000-0000-0000-1234-000000000000
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160807,7 +160868,7 @@ paths:
id: 00000000-0000-0000-1234-000000000000
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160855,7 +160916,7 @@ paths:
team_id: T01234567
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataPatchRequest"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataPatchRequest'
description: Incident integration metadata payload.
required: true
responses:
@@ -160877,7 +160938,7 @@ paths:
id: 00000000-0000-0000-1234-000000000000
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160923,7 +160984,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoListResponse"
+ $ref: '#/components/schemas/IncidentTodoListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -160972,7 +161033,7 @@ paths:
incident_id: 00000000-aaaa-0000-0000-000000000000
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoCreateRequest"
+ $ref: '#/components/schemas/IncidentTodoCreateRequest'
description: Incident todo payload.
required: true
responses:
@@ -160990,7 +161051,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoResponse"
+ $ref: '#/components/schemas/IncidentTodoResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161076,7 +161137,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoResponse"
+ $ref: '#/components/schemas/IncidentTodoResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161126,7 +161187,7 @@ paths:
incident_id: 00000000-aaaa-0000-0000-000000000000
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoPatchRequest"
+ $ref: '#/components/schemas/IncidentTodoPatchRequest'
description: Incident todo payload.
required: true
responses:
@@ -161144,7 +161205,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: incident_todos
schema:
- $ref: "#/components/schemas/IncidentTodoResponse"
+ $ref: '#/components/schemas/IncidentTodoResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161188,7 +161249,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/IncidentRespondersResponse"
+ $ref: '#/components/schemas/IncidentRespondersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161235,7 +161296,7 @@ paths:
type: users
type: incident_responders
schema:
- $ref: "#/components/schemas/IncidentResponderRequest"
+ $ref: '#/components/schemas/IncidentResponderRequest'
description: Incident responder payload.
required: true
responses:
@@ -161253,7 +161314,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_responders
schema:
- $ref: "#/components/schemas/IncidentResponderResponse"
+ $ref: '#/components/schemas/IncidentResponderResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161339,7 +161400,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: incident_responders
schema:
- $ref: "#/components/schemas/IncidentResponderResponse"
+ $ref: '#/components/schemas/IncidentResponderResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161386,7 +161447,7 @@ paths:
instance_name: my-instance
type: incident_servicenow_record_prompt
schema:
- $ref: "#/components/schemas/IncidentServiceNowRecordRequest"
+ $ref: '#/components/schemas/IncidentServiceNowRecordRequest'
description: ServiceNow record payload.
required: true
responses:
@@ -161409,7 +161470,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incident_integrations
schema:
- $ref: "#/components/schemas/IncidentIntegrationMetadataResponse"
+ $ref: '#/components/schemas/IncidentIntegrationMetadataResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161453,7 +161514,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/IncidentTimestampOverridesResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverridesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161498,7 +161559,7 @@ paths:
timestamp_value: "2024-01-01T10:00:00.000Z"
type: incidents_timestamp_overrides
schema:
- $ref: "#/components/schemas/IncidentTimestampOverrideRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverrideRequest'
description: Timestamp override payload.
required: true
responses:
@@ -161518,7 +161579,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_timestamp_overrides
schema:
- $ref: "#/components/schemas/IncidentTimestampOverrideResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverrideResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161601,7 +161662,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_timestamp_overrides
schema:
- $ref: "#/components/schemas/IncidentTimestampOverridePatchRequest"
+ $ref: '#/components/schemas/IncidentTimestampOverridePatchRequest'
description: Timestamp override patch payload.
required: true
responses:
@@ -161621,7 +161682,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: incidents_timestamp_overrides
schema:
- $ref: "#/components/schemas/IncidentTimestampOverrideResponse"
+ $ref: '#/components/schemas/IncidentTimestampOverrideResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161681,7 +161742,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountsResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161709,7 +161770,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountCreateRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountCreateRequest'
required: true
responses:
"201":
@@ -161738,7 +161799,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161822,7 +161883,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161852,7 +161913,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountUpdateRequest"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountUpdateRequest'
required: true
responses:
"200":
@@ -161881,7 +161942,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/ElasticCloudIntegrationAccountResponse"
+ $ref: '#/components/schemas/ElasticCloudIntegrationAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161934,7 +161995,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountsResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -161962,7 +162023,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountCreateRequest"
+ $ref: '#/components/schemas/TwilioIntegrationAccountCreateRequest'
required: true
responses:
"201":
@@ -161989,7 +162050,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162071,7 +162132,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162101,7 +162162,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountUpdateRequest"
+ $ref: '#/components/schemas/TwilioIntegrationAccountUpdateRequest'
required: true
responses:
"200":
@@ -162128,7 +162189,7 @@ paths:
id: 953a0060-81ec-4221-aed4-d4733b59cd96
type: integration-account
schema:
- $ref: "#/components/schemas/TwilioIntegrationAccountResponse"
+ $ref: '#/components/schemas/TwilioIntegrationAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162175,7 +162236,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/AWSAccountsResponse"
+ $ref: '#/components/schemas/AWSAccountsResponse'
description: AWS Accounts List object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162231,7 +162292,7 @@ paths:
extended_collection: true
type: account
schema:
- $ref: "#/components/schemas/AWSAccountCreateRequest"
+ $ref: '#/components/schemas/AWSAccountCreateRequest'
required: true
responses:
"200":
@@ -162249,7 +162310,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: account
schema:
- $ref: "#/components/schemas/AWSAccountResponse"
+ $ref: '#/components/schemas/AWSAccountResponse'
description: AWS Account object
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162314,7 +162375,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: account
schema:
- $ref: "#/components/schemas/AWSAccountResponse"
+ $ref: '#/components/schemas/AWSAccountResponse'
description: AWS Account object
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162377,7 +162438,7 @@ paths:
id: 00000000-abcd-0001-0000-000000000000
type: account
schema:
- $ref: "#/components/schemas/AWSAccountUpdateRequest"
+ $ref: '#/components/schemas/AWSAccountUpdateRequest'
required: true
responses:
"200":
@@ -162395,7 +162456,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: account
schema:
- $ref: "#/components/schemas/AWSAccountResponse"
+ $ref: '#/components/schemas/AWSAccountResponse'
description: AWS Account object
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162467,7 +162528,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: ccm_config
schema:
- $ref: "#/components/schemas/AWSCcmConfigResponse"
+ $ref: '#/components/schemas/AWSCcmConfigResponse'
description: AWS CCM Config object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162510,7 +162571,7 @@ paths:
report_type: CUR2.0
type: ccm_config
schema:
- $ref: "#/components/schemas/AWSCcmConfigRequest"
+ $ref: '#/components/schemas/AWSCcmConfigRequest'
description: Update a Cloud Cost Management config for an AWS Account Integration Config.
required: true
responses:
@@ -162531,7 +162592,7 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: ccm_config
schema:
- $ref: "#/components/schemas/AWSCcmConfigResponse"
+ $ref: '#/components/schemas/AWSCcmConfigResponse'
description: AWS CCM Config object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162575,7 +162636,7 @@ paths:
report_type: CUR2.0
type: ccm_config
schema:
- $ref: "#/components/schemas/AWSCcmConfigRequest"
+ $ref: '#/components/schemas/AWSCcmConfigRequest'
description: Create a Cloud Cost Management config for an AWS Account Integration Config.
required: true
responses:
@@ -162596,7 +162657,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: ccm_config
schema:
- $ref: "#/components/schemas/AWSCcmConfigResponse"
+ $ref: '#/components/schemas/AWSCcmConfigResponse'
description: AWS CCM Config object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162647,7 +162708,7 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: metric_name_filter_preview
schema:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewResponse"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewResponse'
description: AWS metric name filter preview result
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162687,7 +162748,7 @@ paths:
namespace: "AWS/EC2"
type: metric_name_filter_preview
schema:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewRequest"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewRequest'
description: The metric name filters to preview.
required: true
responses:
@@ -162712,13 +162773,13 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: metric_name_filter_preview
schema:
- $ref: "#/components/schemas/AWSMetricNameFilterPreviewResponse"
+ $ref: '#/components/schemas/AWSMetricNameFilterPreviewResponse'
description: AWS metric name filter preview result
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162756,7 +162817,7 @@ paths:
id: namespaces
type: namespaces
schema:
- $ref: "#/components/schemas/AWSNamespacesResponse"
+ $ref: '#/components/schemas/AWSNamespacesResponse'
description: AWS Namespaces List object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162787,7 +162848,7 @@ paths:
region: us-east-1
type: event_bridge
schema:
- $ref: "#/components/schemas/AWSEventBridgeDeleteRequest"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteRequest'
description: Delete the Amazon EventBridge source with the given name, region, and associated AWS account.
required: true
responses:
@@ -162803,7 +162864,7 @@ paths:
id: delete_event_bridge
type: event_bridge
schema:
- $ref: "#/components/schemas/AWSEventBridgeDeleteResponse"
+ $ref: '#/components/schemas/AWSEventBridgeDeleteResponse'
description: Amazon EventBridge source deleted.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162837,7 +162898,7 @@ paths:
id: get_event_bridge
type: event_bridge
schema:
- $ref: "#/components/schemas/AWSEventBridgeListResponse"
+ $ref: '#/components/schemas/AWSEventBridgeListResponse'
description: Amazon EventBridge sources list.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162870,7 +162931,7 @@ paths:
region: us-east-1
type: event_bridge
schema:
- $ref: "#/components/schemas/AWSEventBridgeCreateRequest"
+ $ref: '#/components/schemas/AWSEventBridgeCreateRequest'
description: Create an Amazon EventBridge source for an AWS account with a given name and region.
required: true
responses:
@@ -162889,7 +162950,7 @@ paths:
id: create_event_bridge
type: event_bridge
schema:
- $ref: "#/components/schemas/AWSEventBridgeCreateResponse"
+ $ref: '#/components/schemas/AWSEventBridgeCreateResponse'
description: Amazon EventBridge source created.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -162925,7 +162986,7 @@ paths:
id: external_id
type: external_id
schema:
- $ref: "#/components/schemas/AWSNewExternalIDResponse"
+ $ref: '#/components/schemas/AWSNewExternalIDResponse'
description: AWS External ID object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -162957,7 +163018,7 @@ paths:
id: permissions
type: permissions
schema:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse'
description: AWS IAM Permissions object
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -162983,7 +163044,7 @@ paths:
id: permissions
type: permissions
schema:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse'
description: AWS integration resource collection IAM permissions.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -163009,7 +163070,7 @@ paths:
id: permissions
type: permissions
schema:
- $ref: "#/components/schemas/AWSIntegrationIamPermissionsResponse"
+ $ref: '#/components/schemas/AWSIntegrationIamPermissionsResponse'
description: AWS integration standard IAM permissions.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -163035,7 +163096,7 @@ paths:
id: logs_services
type: logs_services
schema:
- $ref: "#/components/schemas/AWSLogsServicesResponse"
+ $ref: '#/components/schemas/AWSLogsServicesResponse'
description: AWS Logs Services List object
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163070,7 +163131,7 @@ paths:
report_prefix: reports
type: ccm_config_validation
schema:
- $ref: "#/components/schemas/AWSCcmConfigValidationRequest"
+ $ref: '#/components/schemas/AWSCcmConfigValidationRequest'
description: Validate a Cloud Cost Management config for an AWS account integration config.
required: true
responses:
@@ -163089,13 +163150,13 @@ paths:
id: ccm_config_validation
type: ccm_config_validation
schema:
- $ref: "#/components/schemas/AWSCcmConfigValidationResponse"
+ $ref: '#/components/schemas/AWSCcmConfigValidationResponse'
description: AWS CCM Config validation result
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163105,7 +163166,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Service Unavailable
summary: Validate AWS CCM config
tags:
@@ -163140,7 +163201,7 @@ paths:
id: abc-123
type: gcp_service_account
schema:
- $ref: "#/components/schemas/GCPSTSServiceAccountsResponse"
+ $ref: '#/components/schemas/GCPSTSServiceAccountsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -163193,7 +163254,7 @@ paths:
- europe-north1
type: gcp_service_account
schema:
- $ref: "#/components/schemas/GCPSTSServiceAccountCreateRequest"
+ $ref: '#/components/schemas/GCPSTSServiceAccountCreateRequest'
required: true
responses:
"201":
@@ -163211,7 +163272,7 @@ paths:
id: abc-123
type: gcp_service_account
schema:
- $ref: "#/components/schemas/GCPSTSServiceAccountResponse"
+ $ref: '#/components/schemas/GCPSTSServiceAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163294,7 +163355,7 @@ paths:
id: d291291f-12c2-22g4-j290-123456678897
type: gcp_service_account
schema:
- $ref: "#/components/schemas/GCPSTSServiceAccountUpdateRequest"
+ $ref: '#/components/schemas/GCPSTSServiceAccountUpdateRequest'
required: true
responses:
"201":
@@ -163312,7 +163373,7 @@ paths:
id: abc-123
type: gcp_service_account
schema:
- $ref: "#/components/schemas/GCPSTSServiceAccountResponse"
+ $ref: '#/components/schemas/GCPSTSServiceAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163348,7 +163409,7 @@ paths:
id: abc-123
type: gcp_sts_delegate
schema:
- $ref: "#/components/schemas/GCPSTSDelegateAccountResponse"
+ $ref: '#/components/schemas/GCPSTSDelegateAccountResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -163390,7 +163451,7 @@ paths:
id: abc-123
type: gcp_sts_delegate
schema:
- $ref: "#/components/schemas/GCPSTSDelegateAccountResponse"
+ $ref: '#/components/schemas/GCPSTSDelegateAccountResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -163435,7 +163496,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: google-chat-organization
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationsResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163468,7 +163529,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: google-chat-app-named-space
schema:
- $ref: "#/components/schemas/GoogleChatAppNamedSpaceResponse"
+ $ref: '#/components/schemas/GoogleChatAppNamedSpaceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163525,7 +163586,7 @@ paths:
type: google-chat-delegated-user
type: google-chat-organization
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163578,7 +163639,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: google-chat-delegated-user
schema:
- $ref: "#/components/schemas/GoogleChatDelegatedUserResponse"
+ $ref: '#/components/schemas/GoogleChatDelegatedUserResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163611,7 +163672,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationHandlesResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandlesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163642,7 +163703,7 @@ paths:
space_resource_name: spaces/AAAAAAAAA
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatCreateOrganizationHandleRequest"
+ $ref: '#/components/schemas/GoogleChatCreateOrganizationHandleRequest'
description: Organization handle payload.
required: true
responses:
@@ -163660,7 +163721,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163728,7 +163789,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163760,7 +163821,7 @@ paths:
space_resource_name: spaces/AAAAAAAAA
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatUpdateOrganizationHandleRequest"
+ $ref: '#/components/schemas/GoogleChatUpdateOrganizationHandleRequest'
description: Organization handle payload.
required: true
responses:
@@ -163778,7 +163839,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: google-chat-organization-handle
schema:
- $ref: "#/components/schemas/GoogleChatOrganizationHandleResponse"
+ $ref: '#/components/schemas/GoogleChatOrganizationHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163820,7 +163881,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudiencesResponse"
+ $ref: '#/components/schemas/GoogleChatTargetAudiencesResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163849,7 +163910,7 @@ paths:
audience_name: fake audience name 1
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudienceCreateRequest"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceCreateRequest'
description: Target audience payload.
required: true
responses:
@@ -163866,7 +163927,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudienceResponse"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -163923,7 +163984,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudienceResponse"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -163953,7 +164014,7 @@ paths:
audience_name: updated-audience-name
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudienceUpdateRequest"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceUpdateRequest'
description: Target audience payload.
required: true
responses:
@@ -163970,7 +164031,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: google-chat-target-audience
schema:
- $ref: "#/components/schemas/GoogleChatTargetAudienceResponse"
+ $ref: '#/components/schemas/GoogleChatTargetAudienceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164006,13 +164067,13 @@ paths:
meta:
public_key: "c29tZSBkYXRhIHdpdGggACBhbmQg77u/"
schema:
- $ref: "#/components/schemas/JiraAccountsResponse"
+ $ref: '#/components/schemas/JiraAccountsResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164044,7 +164105,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164079,7 +164140,7 @@ paths:
id: "abc-123"
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplatesResponse"
+ $ref: '#/components/schemas/JiraIssueTemplatesResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164113,7 +164174,7 @@ paths:
project_id: "10772"
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplateCreateRequest"
+ $ref: '#/components/schemas/JiraIssueTemplateCreateRequest'
required: true
responses:
"201":
@@ -164134,13 +164195,13 @@ paths:
id: "abc-123"
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplateResponse"
+ $ref: '#/components/schemas/JiraIssueTemplateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164209,13 +164270,13 @@ paths:
id: "abc-123"
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplateResponse"
+ $ref: '#/components/schemas/JiraIssueTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164254,7 +164315,7 @@ paths:
name: test_template_updated
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplateUpdateRequest"
+ $ref: '#/components/schemas/JiraIssueTemplateUpdateRequest'
required: true
responses:
"200":
@@ -164275,13 +164336,13 @@ paths:
id: "abc-123"
type: jira-issue-template
schema:
- $ref: "#/components/schemas/JiraIssueTemplateResponse"
+ $ref: '#/components/schemas/JiraIssueTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164315,7 +164376,7 @@ paths:
id: "19:b41k24b14bn1nwffkernfkwrnfneubgkr@thread.tacv2"
type: ms-teams-channel-info
schema:
- $ref: "#/components/schemas/MicrosoftTeamsGetChannelByNameResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsGetChannelByNameResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164352,7 +164413,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: ms-teams-tenant-based-handle-info
schema:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandlesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164385,7 +164446,7 @@ paths:
tenant_id: 00000000-0000-0000-0000-000000000001
type: tenant-based-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest"
+ $ref: '#/components/schemas/MicrosoftTeamsCreateTenantBasedHandleRequest'
description: Tenant-based handle payload.
required: true
responses:
@@ -164404,7 +164465,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: tenant-based-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164465,7 +164526,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: tenant-based-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164500,7 +164561,7 @@ paths:
tenant_id: 00000000-0000-0000-0000-000000000001
type: tenant-based-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest"
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateTenantBasedHandleRequest'
description: Tenant-based handle payload.
required: true
responses:
@@ -164519,7 +164580,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: tenant-based-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsTenantBasedHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164578,7 +164639,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandlesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164609,7 +164670,7 @@ paths:
url: https://fake.url.com
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest"
+ $ref: '#/components/schemas/MicrosoftTeamsCreateWorkflowsWebhookHandleRequest'
description: Workflows Webhook handle payload.
required: true
responses:
@@ -164625,7 +164686,7 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164683,7 +164744,7 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164716,7 +164777,7 @@ paths:
url: https://fake.url.com
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest"
+ $ref: '#/components/schemas/MicrosoftTeamsUpdateWorkflowsWebhookHandleRequest'
description: Workflows Webhook handle payload.
required: true
responses:
@@ -164732,7 +164793,7 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: workflows-webhook-handle
schema:
- $ref: "#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse"
+ $ref: '#/components/schemas/MicrosoftTeamsWorkflowsWebhookHandleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -164778,7 +164839,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy_product
schema:
- $ref: "#/components/schemas/TenancyProductsList"
+ $ref: '#/components/schemas/TenancyProductsList'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164810,7 +164871,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/TenancyConfigList"
+ $ref: '#/components/schemas/TenancyConfigList'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164870,7 +164931,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/CreateTenancyConfigRequest"
+ $ref: '#/components/schemas/CreateTenancyConfigRequest'
required: true
responses:
"201":
@@ -164888,7 +164949,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/TenancyConfig"
+ $ref: '#/components/schemas/TenancyConfig'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -164951,7 +165012,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/TenancyConfig"
+ $ref: '#/components/schemas/TenancyConfig'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165015,7 +165076,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/UpdateTenancyConfigRequest"
+ $ref: '#/components/schemas/UpdateTenancyConfigRequest'
required: true
responses:
"200":
@@ -165033,7 +165094,7 @@ paths:
id: ocid.tenancy.test
type: oci_tenancy
schema:
- $ref: "#/components/schemas/TenancyConfig"
+ $ref: '#/components/schemas/TenancyConfig'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165061,7 +165122,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: opsgenie-account
schema:
- $ref: "#/components/schemas/OpsgenieAccountsResponse"
+ $ref: '#/components/schemas/OpsgenieAccountsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -165090,7 +165151,7 @@ paths:
region: us
type: opsgenie-account
schema:
- $ref: "#/components/schemas/OpsgenieAccountCreateRequest"
+ $ref: '#/components/schemas/OpsgenieAccountCreateRequest'
description: Opsgenie account payload.
required: true
responses:
@@ -165106,7 +165167,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: opsgenie-account
schema:
- $ref: "#/components/schemas/OpsgenieAccountResponse"
+ $ref: '#/components/schemas/OpsgenieAccountResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165166,7 +165227,7 @@ paths:
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: opsgenie-account
schema:
- $ref: "#/components/schemas/OpsgenieAccountUpdateRequest"
+ $ref: '#/components/schemas/OpsgenieAccountUpdateRequest'
description: Opsgenie account payload.
required: true
responses:
@@ -165182,7 +165243,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: opsgenie-account
schema:
- $ref: "#/components/schemas/OpsgenieAccountResponse"
+ $ref: '#/components/schemas/OpsgenieAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165222,7 +165283,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServicesResponse"
+ $ref: '#/components/schemas/OpsgenieServicesResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -165253,7 +165314,7 @@ paths:
region: us
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServiceCreateRequest"
+ $ref: '#/components/schemas/OpsgenieServiceCreateRequest'
description: Opsgenie service payload
required: true
responses:
@@ -165271,7 +165332,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServiceResponse"
+ $ref: '#/components/schemas/OpsgenieServiceResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165335,7 +165396,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServiceResponse"
+ $ref: '#/components/schemas/OpsgenieServiceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165375,7 +165436,7 @@ paths:
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServiceUpdateRequest"
+ $ref: '#/components/schemas/OpsgenieServiceUpdateRequest'
description: Opsgenie service payload.
required: true
responses:
@@ -165393,7 +165454,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: opsgenie-service
schema:
- $ref: "#/components/schemas/OpsgenieServiceResponse"
+ $ref: '#/components/schemas/OpsgenieServiceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165436,7 +165497,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: salesforce-incidents-incident-template
schema:
- $ref: "#/components/schemas/SalesforceIncidentsTemplatesResponse"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplatesResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -165471,7 +165532,7 @@ paths:
subject: "Datadog Incident: Production Outage"
type: salesforce-incidents-incident-template
schema:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateCreateRequest"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateCreateRequest'
description: Salesforce incident template payload.
required: true
responses:
@@ -165492,7 +165553,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: salesforce-incidents-incident-template
schema:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateResponse"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165553,7 +165614,7 @@ paths:
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: salesforce-incidents-incident-template
schema:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateUpdateRequest"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateUpdateRequest'
description: Salesforce incident template payload.
required: true
responses:
@@ -165574,7 +165635,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: salesforce-incidents-incident-template
schema:
- $ref: "#/components/schemas/SalesforceIncidentsTemplateResponse"
+ $ref: '#/components/schemas/SalesforceIncidentsTemplateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165618,7 +165679,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: salesforce-incidents-org
schema:
- $ref: "#/components/schemas/SalesforceIncidentsOrganizationsResponse"
+ $ref: '#/components/schemas/SalesforceIncidentsOrganizationsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -165692,19 +165753,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: assignment_groups
schema:
- $ref: "#/components/schemas/ServiceNowAssignmentGroupsResponse"
+ $ref: '#/components/schemas/ServiceNowAssignmentGroupsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165741,19 +165802,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: business_services
schema:
- $ref: "#/components/schemas/ServiceNowBusinessServicesResponse"
+ $ref: '#/components/schemas/ServiceNowBusinessServicesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165781,7 +165842,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplatesResponse"
+ $ref: '#/components/schemas/ServiceNowTemplatesResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165812,7 +165873,7 @@ paths:
user_id: 65b3341b-0680-47f9-a6d4-134db45c603e
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplateCreateRequest"
+ $ref: '#/components/schemas/ServiceNowTemplateCreateRequest'
required: true
responses:
"201":
@@ -165829,13 +165890,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplateResponse"
+ $ref: '#/components/schemas/ServiceNowTemplateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165864,13 +165925,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165906,19 +165967,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplateResponse"
+ $ref: '#/components/schemas/ServiceNowTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -165958,7 +166019,7 @@ paths:
user_id: 65b3341b-0680-47f9-a6d4-134db45c603e
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplateUpdateRequest"
+ $ref: '#/components/schemas/ServiceNowTemplateUpdateRequest'
required: true
responses:
"200":
@@ -165975,19 +166036,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: servicenow_templates
schema:
- $ref: "#/components/schemas/ServiceNowTemplateResponse"
+ $ref: '#/components/schemas/ServiceNowTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -166013,13 +166074,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: instance
schema:
- $ref: "#/components/schemas/ServiceNowInstancesResponse"
+ $ref: '#/components/schemas/ServiceNowInstancesResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -166058,19 +166119,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: users
schema:
- $ref: "#/components/schemas/ServiceNowUsersResponse"
+ $ref: '#/components/schemas/ServiceNowUsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -166097,7 +166158,7 @@ paths:
- id: T09876543
type: team_id
schema:
- $ref: "#/components/schemas/SlackUserBindingsResponse"
+ $ref: '#/components/schemas/SlackUserBindingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166147,7 +166208,7 @@ paths:
api_key: "*****"
type: statuspage-account
schema:
- $ref: "#/components/schemas/StatuspageAccountResponse"
+ $ref: '#/components/schemas/StatuspageAccountResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -166177,7 +166238,7 @@ paths:
api_key: 00000000-0000-0000-0000-000000000000
type: statuspage-account
schema:
- $ref: "#/components/schemas/StatuspageAccountUpdateRequest"
+ $ref: '#/components/schemas/StatuspageAccountUpdateRequest'
description: Statuspage account payload.
required: true
responses:
@@ -166192,7 +166253,7 @@ paths:
api_key: "*****"
type: statuspage-account
schema:
- $ref: "#/components/schemas/StatuspageAccountResponse"
+ $ref: '#/components/schemas/StatuspageAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166227,7 +166288,7 @@ paths:
api_key: 00000000-0000-0000-0000-000000000000
type: statuspage-account
schema:
- $ref: "#/components/schemas/StatuspageAccountCreateRequest"
+ $ref: '#/components/schemas/StatuspageAccountCreateRequest'
description: Statuspage account payload.
required: true
responses:
@@ -166242,7 +166303,7 @@ paths:
api_key: "*****"
type: statuspage-account
schema:
- $ref: "#/components/schemas/StatuspageAccountResponse"
+ $ref: '#/components/schemas/StatuspageAccountResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166279,7 +166340,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: statuspage-url-setting
schema:
- $ref: "#/components/schemas/StatuspageUrlSettingsResponse"
+ $ref: '#/components/schemas/StatuspageUrlSettingsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -166310,7 +166371,7 @@ paths:
url: "https://example.statuspage.io"
type: statuspage-url-setting
schema:
- $ref: "#/components/schemas/StatuspageUrlSettingCreateRequest"
+ $ref: '#/components/schemas/StatuspageUrlSettingCreateRequest'
description: Statuspage URL setting payload.
required: true
responses:
@@ -166327,7 +166388,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: statuspage-url-setting
schema:
- $ref: "#/components/schemas/StatuspageUrlSettingResponse"
+ $ref: '#/components/schemas/StatuspageUrlSettingResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166389,7 +166450,7 @@ paths:
id: 596da4af-0563-4097-90ff-07230c3f9db3
type: statuspage-url-setting
schema:
- $ref: "#/components/schemas/StatuspageUrlSettingUpdateRequest"
+ $ref: '#/components/schemas/StatuspageUrlSettingUpdateRequest'
description: Statuspage URL setting payload.
required: true
responses:
@@ -166406,7 +166467,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: statuspage-url-setting
schema:
- $ref: "#/components/schemas/StatuspageUrlSettingResponse"
+ $ref: '#/components/schemas/StatuspageUrlSettingResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166453,7 +166514,7 @@ paths:
type: webhooks-auth-method-oauth2-client-credentials
type: webhooks-auth-method
schema:
- $ref: "#/components/schemas/WebhooksAuthMethodsResponse"
+ $ref: '#/components/schemas/WebhooksAuthMethodsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -166489,7 +166550,7 @@ paths:
scope: read:webhooks write:webhooks
type: webhooks-auth-method-oauth2-client-credentials
schema:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsCreateRequest"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsCreateRequest'
description: OAuth2 client credentials payload.
required: true
responses:
@@ -166510,7 +166571,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: webhooks-auth-method-oauth2-client-credentials
schema:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponse"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166575,7 +166636,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: webhooks-auth-method-oauth2-client-credentials
schema:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponse"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -166607,7 +166668,7 @@ paths:
name: my-oauth2-auth-renamed
type: webhooks-auth-method-oauth2-client-credentials
schema:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateRequest"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsUpdateRequest'
description: OAuth2 client credentials payload.
required: true
responses:
@@ -166628,7 +166689,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: webhooks-auth-method-oauth2-client-credentials
schema:
- $ref: "#/components/schemas/WebhooksOAuth2ClientCredentialsResponse"
+ $ref: '#/components/schemas/WebhooksOAuth2ClientCredentialsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166669,7 +166730,7 @@ paths:
id: calico
type: integration
schema:
- $ref: "#/components/schemas/ListIntegrationsResponse"
+ $ref: '#/components/schemas/ListIntegrationsResponse'
description: Successful Response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -166706,7 +166767,7 @@ paths:
id: abc-123
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountsResponse"
+ $ref: '#/components/schemas/CloudflareAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166748,7 +166809,7 @@ paths:
- zone_id_2
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountCreateRequest"
+ $ref: '#/components/schemas/CloudflareAccountCreateRequest'
required: true
responses:
"201":
@@ -166764,7 +166825,7 @@ paths:
id: abc-123
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountResponse"
+ $ref: '#/components/schemas/CloudflareAccountResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166845,7 +166906,7 @@ paths:
id: abc-123
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountResponse"
+ $ref: '#/components/schemas/CloudflareAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166893,7 +166954,7 @@ paths:
- zone_id_2
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountUpdateRequest"
+ $ref: '#/components/schemas/CloudflareAccountUpdateRequest'
required: true
responses:
"200":
@@ -166917,7 +166978,7 @@ paths:
id: abc-123
type: cloudflare-accounts
schema:
- $ref: "#/components/schemas/CloudflareAccountResponse"
+ $ref: '#/components/schemas/CloudflareAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166955,7 +167016,7 @@ paths:
id: abc-123
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountsResponse"
+ $ref: '#/components/schemas/ConfluentAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -166998,7 +167059,7 @@ paths:
- myTag2:myValue
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountCreateRequest"
+ $ref: '#/components/schemas/ConfluentAccountCreateRequest'
description: Confluent payload
required: true
responses:
@@ -167016,7 +167077,7 @@ paths:
id: abc-123
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountResponse"
+ $ref: '#/components/schemas/ConfluentAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167080,7 +167141,7 @@ paths:
id: abc-123
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountResponse"
+ $ref: '#/components/schemas/ConfluentAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167118,7 +167179,7 @@ paths:
- myTag2:myValue
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountUpdateRequest"
+ $ref: '#/components/schemas/ConfluentAccountUpdateRequest'
description: Confluent payload
required: true
responses:
@@ -167136,7 +167197,7 @@ paths:
id: abc-123
type: confluent-cloud-accounts
schema:
- $ref: "#/components/schemas/ConfluentAccountResponse"
+ $ref: '#/components/schemas/ConfluentAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167177,7 +167238,7 @@ paths:
id: abc-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourcesResponse"
+ $ref: '#/components/schemas/ConfluentResourcesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167216,7 +167277,7 @@ paths:
id: resource-id-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourceRequest"
+ $ref: '#/components/schemas/ConfluentResourceRequest'
description: Confluent payload
required: true
responses:
@@ -167235,7 +167296,7 @@ paths:
id: abc-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourceResponse"
+ $ref: '#/components/schemas/ConfluentResourceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167302,7 +167363,7 @@ paths:
id: abc-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourceResponse"
+ $ref: '#/components/schemas/ConfluentResourceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167342,7 +167403,7 @@ paths:
id: resource-id-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourceRequest"
+ $ref: '#/components/schemas/ConfluentResourceRequest'
description: Confluent payload
required: true
responses:
@@ -167361,7 +167422,7 @@ paths:
id: abc-123
type: confluent-cloud-resources
schema:
- $ref: "#/components/schemas/ConfluentResourceResponse"
+ $ref: '#/components/schemas/ConfluentResourceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167398,7 +167459,7 @@ paths:
id: abc-123
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountsResponse"
+ $ref: '#/components/schemas/FastlyAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167436,7 +167497,7 @@ paths:
- myTag2:myValue
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountCreateRequest"
+ $ref: '#/components/schemas/FastlyAccountCreateRequest'
required: true
responses:
"201":
@@ -167452,7 +167513,7 @@ paths:
id: abc-123
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountResponse"
+ $ref: '#/components/schemas/FastlyAccountResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167515,7 +167576,7 @@ paths:
id: abc-123
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountResponse"
+ $ref: '#/components/schemas/FastlyAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167549,7 +167610,7 @@ paths:
api_key: ABCDEFG123
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountUpdateRequest"
+ $ref: '#/components/schemas/FastlyAccountUpdateRequest'
required: true
responses:
"200":
@@ -167565,7 +167626,7 @@ paths:
id: abc-123
type: fastly-accounts
schema:
- $ref: "#/components/schemas/FastlyAccountResponse"
+ $ref: '#/components/schemas/FastlyAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167604,7 +167665,7 @@ paths:
id: abc-123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServicesResponse"
+ $ref: '#/components/schemas/FastlyServicesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167641,7 +167702,7 @@ paths:
id: abc123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServiceRequest"
+ $ref: '#/components/schemas/FastlyServiceRequest'
required: true
responses:
"201":
@@ -167657,7 +167718,7 @@ paths:
id: abc-123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServiceResponse"
+ $ref: '#/components/schemas/FastlyServiceResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167722,7 +167783,7 @@ paths:
id: abc-123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServiceResponse"
+ $ref: '#/components/schemas/FastlyServiceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167760,7 +167821,7 @@ paths:
id: abc123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServiceRequest"
+ $ref: '#/components/schemas/FastlyServiceRequest'
required: true
responses:
"200":
@@ -167776,7 +167837,7 @@ paths:
id: abc-123
type: fastly-services
schema:
- $ref: "#/components/schemas/FastlyServiceResponse"
+ $ref: '#/components/schemas/FastlyServiceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167814,7 +167875,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountsResponse"
+ $ref: '#/components/schemas/OktaAccountsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167851,7 +167912,7 @@ paths:
id: f749daaf-682e-4208-a38d-c9b43162c609
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountRequest"
+ $ref: '#/components/schemas/OktaAccountRequest'
required: true
responses:
"201":
@@ -167868,7 +167929,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountResponse"
+ $ref: '#/components/schemas/OktaAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167942,7 +168003,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountResponse"
+ $ref: '#/components/schemas/OktaAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -167982,7 +168043,7 @@ paths:
domain: https://example.okta.com/
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountUpdateRequest"
+ $ref: '#/components/schemas/OktaAccountUpdateRequest'
required: true
responses:
"200":
@@ -167999,7 +168060,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: okta-accounts
schema:
- $ref: "#/components/schemas/OktaAccountResponse"
+ $ref: '#/components/schemas/OktaAccountResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -168042,7 +168103,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: ip_allowlist
schema:
- $ref: "#/components/schemas/IPAllowlistResponse"
+ $ref: '#/components/schemas/IPAllowlistResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -168082,7 +168143,7 @@ paths:
type: ip_allowlist_entry
type: ip_allowlist
schema:
- $ref: "#/components/schemas/IPAllowlistUpdateRequest"
+ $ref: '#/components/schemas/IPAllowlistUpdateRequest'
required: true
responses:
"200":
@@ -168104,7 +168165,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: ip_allowlist
schema:
- $ref: "#/components/schemas/IPAllowlistResponse"
+ $ref: '#/components/schemas/IPAllowlistResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -168193,25 +168254,25 @@ paths:
id: trace-query
type: annotated_interactions_by_trace
schema:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsByTraceResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsByTraceResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168219,7 +168280,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -168276,25 +168337,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueuesResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueuesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168364,7 +168425,7 @@ paths:
project_id: 00000000-0000-0000-0000-000000000002
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueRequest'
description: Create annotation queue payload.
required: true
responses:
@@ -168392,25 +168453,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168437,19 +168498,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168487,7 +168548,7 @@ paths:
- reviewer@example.com
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueUpdateRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueUpdateRequest'
description: Update annotation queue payload.
required: true
responses:
@@ -168515,31 +168576,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168577,31 +168638,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: annotated_interactions
schema:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionsResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168670,31 +168731,31 @@ paths:
id: interaction-456
type: annotated_interactions
schema:
- $ref: "#/components/schemas/LLMObsAnnotatedInteractionResponse"
+ $ref: '#/components/schemas/LLMObsAnnotatedInteractionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168741,7 +168802,7 @@ paths:
value: positive
type: annotations
schema:
- $ref: "#/components/schemas/LLMObsAnnotationsRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationsRequest'
description: Payload for creating or updating annotations.
required: true
responses:
@@ -168787,32 +168848,32 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: annotations
schema:
- $ref: "#/components/schemas/LLMObsAnnotationsResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationsResponse'
description: >-
OK — annotations created or updated. For mixed batches, denied items and other per-item errors are listed in `errors`.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden — all request items were denied by queue access rules
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found — the queue does not exist.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168844,7 +168905,7 @@ paths:
- 00000000-0000-0000-0000-000000000000
type: annotations
schema:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsRequest'
description: Delete annotations payload.
required: true
responses:
@@ -168874,32 +168935,32 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: annotations
schema:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationsResponse"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationsResponse'
description: >-
OK — annotations deleted. Errors for annotations that could not be deleted are listed in `errors`.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found — the queue does not exist.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -168960,7 +169021,7 @@ paths:
type: display_block
type: interactions
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsRequest'
description: Add interactions payload.
required: true
responses:
@@ -168995,31 +169056,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: interactions
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueInteractionsResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169052,7 +169113,7 @@ paths:
- 00000000-0000-0000-0000-000000000001
type: interactions
schema:
- $ref: "#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsRequest'
description: Delete interactions payload.
required: true
responses:
@@ -169062,25 +169123,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169127,25 +169188,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169153,7 +169214,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -169244,7 +169305,7 @@ paths:
type: text
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateRequest"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaUpdateRequest'
description: Update label schema payload.
required: true
responses:
@@ -169267,31 +169328,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: queues
schema:
- $ref: "#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse"
+ $ref: '#/components/schemas/LLMObsAnnotationQueueLabelSchemaResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169299,7 +169360,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -169339,7 +169400,7 @@ paths:
query: "@experiment_id:3fd6b5e0-8910-4b1c-a7d0-5b84de329012 @label:faithfulness"
type: experimentation
schema:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsRequest'
description: Analytics payload.
required: true
responses:
@@ -169361,25 +169422,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: experimentation
schema:
- $ref: "#/components/schemas/LLMObsExperimentationAnalyticsResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationAnalyticsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169387,7 +169448,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -169424,7 +169485,7 @@ paths:
limit: 50
type: experimentation
schema:
- $ref: "#/components/schemas/LLMObsExperimentationSearchRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchRequest'
description: Experimentation search payload.
required: true
responses:
@@ -169449,7 +169510,7 @@ paths:
meta:
after:
schema:
- $ref: "#/components/schemas/LLMObsExperimentationSearchResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchResponse'
description: OK — all results returned in a single page.
"206":
content:
@@ -169472,25 +169533,25 @@ paths:
meta:
after: eyJpZCI6ImFiYzEyMyJ9
schema:
- $ref: "#/components/schemas/LLMObsExperimentationSearchResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationSearchResponse'
description: Partial Content — more results are available. Use `meta.after` as the next `page.cursor`.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169498,7 +169559,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -169538,7 +169599,7 @@ paths:
field: created_at
type: experimentation
schema:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchRequest"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchRequest'
description: Simple search payload.
required: true
responses:
@@ -169566,25 +169627,25 @@ paths:
total_count: 63
total_pages: 2
schema:
- $ref: "#/components/schemas/LLMObsExperimentationSimpleSearchResponse"
+ $ref: '#/components/schemas/LLMObsExperimentationSimpleSearchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169592,7 +169653,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -169698,25 +169759,25 @@ paths:
id: 00000000-0000-0000-0000-000000000009
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentsResponse"
+ $ref: '#/components/schemas/LLMObsExperimentsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169746,7 +169807,7 @@ paths:
project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentRequest"
+ $ref: '#/components/schemas/LLMObsExperimentRequest'
description: Create experiment payload.
required: true
responses:
@@ -169769,7 +169830,7 @@ paths:
id: 00000000-0000-0000-0000-000000000012
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentResponse"
+ $ref: '#/components/schemas/LLMObsExperimentResponse'
description: OK
"201":
content:
@@ -169790,25 +169851,25 @@ paths:
id: 00000000-0000-0000-0000-000000000015
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentResponse"
+ $ref: '#/components/schemas/LLMObsExperimentResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169838,7 +169899,7 @@ paths:
- 3fd6b5e0-8910-4b1c-a7d0-5b84de329012
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsDeleteExperimentsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteExperimentsRequest'
description: Delete experiments payload.
required: true
responses:
@@ -169848,19 +169909,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169889,7 +169950,7 @@ paths:
data:
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentUpdateRequest"
+ $ref: '#/components/schemas/LLMObsExperimentUpdateRequest'
description: Update experiment payload.
required: true
responses:
@@ -169912,31 +169973,31 @@ paths:
id: 00000000-0000-0000-0000-000000000018
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentResponse"
+ $ref: '#/components/schemas/LLMObsExperimentResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -169978,31 +170039,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: experiments
schema:
- $ref: "#/components/schemas/LLMObsExperimentSpansResponse"
+ $ref: '#/components/schemas/LLMObsExperimentSpansResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170010,7 +170071,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -170052,7 +170113,7 @@ paths:
trace_id: abc123def456
type: events
schema:
- $ref: "#/components/schemas/LLMObsExperimentEventsRequest"
+ $ref: '#/components/schemas/LLMObsExperimentEventsRequest'
description: Experiment events payload.
required: true
responses:
@@ -170062,25 +170123,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170114,26 +170175,26 @@ paths:
integration: "openai"
schema:
items:
- $ref: "#/components/schemas/LLMObsIntegrationAccount"
+ $ref: '#/components/schemas/LLMObsIntegrationAccount'
type: array
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170167,7 +170228,7 @@ paths:
model_id: "gpt-4o"
temperature: 0.7
schema:
- $ref: "#/components/schemas/LLMObsIntegrationInferenceRequest"
+ $ref: '#/components/schemas/LLMObsIntegrationInferenceRequest'
description: Inference request parameters.
required: true
responses:
@@ -170194,25 +170255,25 @@ paths:
total_tokens: 24
temperature: 0.7
schema:
- $ref: "#/components/schemas/LLMObsIntegrationInferenceResponse"
+ $ref: '#/components/schemas/LLMObsIntegrationInferenceResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170220,7 +170281,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -170257,26 +170318,26 @@ paths:
provider_display_name: "OpenAI"
schema:
items:
- $ref: "#/components/schemas/LLMObsIntegrationModel"
+ $ref: '#/components/schemas/LLMObsIntegrationModel'
type: array
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170332,25 +170393,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectsResponse"
+ $ref: '#/components/schemas/LLMObsProjectsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170378,7 +170439,7 @@ paths:
name: My LLM Project
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectRequest"
+ $ref: '#/components/schemas/LLMObsProjectRequest'
description: Create project payload.
required: true
responses:
@@ -170397,7 +170458,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectResponse"
+ $ref: '#/components/schemas/LLMObsProjectResponse'
description: OK
"201":
content:
@@ -170414,25 +170475,25 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectResponse"
+ $ref: '#/components/schemas/LLMObsProjectResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170462,7 +170523,7 @@ paths:
- a33671aa-24fd-4dcd-9b33-a8ec7dde7751
type: projects
schema:
- $ref: "#/components/schemas/LLMObsDeleteProjectsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteProjectsRequest'
description: Delete projects payload.
required: true
responses:
@@ -170472,19 +170533,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170513,7 +170574,7 @@ paths:
data:
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectUpdateRequest"
+ $ref: '#/components/schemas/LLMObsProjectUpdateRequest'
description: Update project payload.
required: true
responses:
@@ -170532,31 +170593,31 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: projects
schema:
- $ref: "#/components/schemas/LLMObsProjectResponse"
+ $ref: '#/components/schemas/LLMObsProjectResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170603,19 +170664,19 @@ paths:
id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsPromptsResponse"
+ $ref: '#/components/schemas/LLMObsPromptsResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170654,7 +170715,7 @@ paths:
title: "Customer Support Assistant"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsCreatePromptRequest"
+ $ref: '#/components/schemas/LLMObsCreatePromptRequest'
description: Create prompt payload.
required: true
responses:
@@ -170679,31 +170740,31 @@ paths:
id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsPromptResponse"
+ $ref: '#/components/schemas/LLMObsPromptResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170746,25 +170807,25 @@ paths:
id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsDeletedPromptResponse"
+ $ref: '#/components/schemas/LLMObsDeletedPromptResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170812,25 +170873,25 @@ paths:
id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsPromptSDKResponse"
+ $ref: '#/components/schemas/LLMObsPromptSDKResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170865,7 +170926,7 @@ paths:
title: "Customer Support Assistant"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsUpdatePromptRequest"
+ $ref: '#/components/schemas/LLMObsUpdatePromptRequest'
description: Update prompt payload.
required: true
responses:
@@ -170890,31 +170951,31 @@ paths:
id: "4a1a28ff-8a25-5f0f-946f-f48264d772eb"
type: prompt-templates
schema:
- $ref: "#/components/schemas/LLMObsPromptResponse"
+ $ref: '#/components/schemas/LLMObsPromptResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -170972,19 +171033,19 @@ paths:
id: "20e5280b-c75d-5699-8a70-a2773a751428"
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsPromptVersionsResponse"
+ $ref: '#/components/schemas/LLMObsPromptVersionsResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171023,7 +171084,7 @@ paths:
role: "user"
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsCreatePromptVersionRequest"
+ $ref: '#/components/schemas/LLMObsCreatePromptVersionRequest'
description: Create prompt version payload.
required: true
responses:
@@ -171050,31 +171111,31 @@ paths:
id: "d83ab666-61cc-5545-a83b-2424bb85467b"
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsPromptVersionResponse"
+ $ref: '#/components/schemas/LLMObsPromptVersionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171127,31 +171188,31 @@ paths:
id: "d83ab666-61cc-5545-a83b-2424bb85467b"
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsPromptVersionResponse"
+ $ref: '#/components/schemas/LLMObsPromptVersionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171187,7 +171248,7 @@ paths:
description: "Give concise answers and cite relevant help-center articles."
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsUpdatePromptVersionRequest"
+ $ref: '#/components/schemas/LLMObsUpdatePromptVersionRequest'
description: Update prompt version payload.
required: true
responses:
@@ -171214,31 +171275,31 @@ paths:
id: "d83ab666-61cc-5545-a83b-2424bb85467b"
type: prompt-template-versions
schema:
- $ref: "#/components/schemas/LLMObsPromptVersionResponse"
+ $ref: '#/components/schemas/LLMObsPromptVersionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171380,25 +171441,25 @@ paths:
request_id: req-def456
status: done
schema:
- $ref: "#/components/schemas/LLMObsSpansResponse"
+ $ref: '#/components/schemas/LLMObsSpansResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171450,7 +171511,7 @@ paths:
limit: 50
type: spans
schema:
- $ref: "#/components/schemas/LLMObsSearchSpansRequest"
+ $ref: '#/components/schemas/LLMObsSearchSpansRequest'
description: Search spans payload.
required: true
responses:
@@ -171480,25 +171541,25 @@ paths:
request_id: req-abc123
status: done
schema:
- $ref: "#/components/schemas/LLMObsSpansResponse"
+ $ref: '#/components/schemas/LLMObsSpansResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171545,31 +171606,31 @@ paths:
id: 5c1fae90-2b6d-4e3a-9f12-7a0c4d8e6b21
type: clustered_points_response
schema:
- $ref: "#/components/schemas/LLMObsPatternsClusteredPointsResponse"
+ $ref: '#/components/schemas/LLMObsPatternsClusteredPointsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171577,7 +171638,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171615,25 +171676,25 @@ paths:
id: "1000000001"
type: list_topic_discovery_configs_response
schema:
- $ref: "#/components/schemas/LLMObsPatternsConfigsResponse"
+ $ref: '#/components/schemas/LLMObsPatternsConfigsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171641,7 +171702,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171671,7 +171732,7 @@ paths:
sampling_ratio: 0.1
type: topic_discovery_configs
schema:
- $ref: "#/components/schemas/LLMObsPatternsConfigUpsertRequest"
+ $ref: '#/components/schemas/LLMObsPatternsConfigUpsertRequest'
description: Patterns configuration payload.
required: true
responses:
@@ -171694,31 +171755,31 @@ paths:
id: a7c8d9e0-1234-5678-9abc-def012345678
type: topic_discovery_configs
schema:
- $ref: "#/components/schemas/LLMObsPatternsConfigResponse"
+ $ref: '#/components/schemas/LLMObsPatternsConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171726,7 +171787,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171762,31 +171823,31 @@ paths:
id: a7c8d9e0-1234-5678-9abc-def012345678
type: topic_discovery_configs
schema:
- $ref: "#/components/schemas/LLMObsPatternsConfigResponse"
+ $ref: '#/components/schemas/LLMObsPatternsConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171794,7 +171855,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171819,25 +171880,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171845,7 +171906,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171880,31 +171941,31 @@ paths:
id: a7c8d9e0-1234-5678-9abc-def012345678
type: list_topic_discovery_runs_response
schema:
- $ref: "#/components/schemas/LLMObsPatternsRunsResponse"
+ $ref: '#/components/schemas/LLMObsPatternsRunsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171912,7 +171973,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -171938,7 +171999,7 @@ paths:
config_id: a7c8d9e0-1234-5678-9abc-def012345678
type: topic_discovery
schema:
- $ref: "#/components/schemas/LLMObsPatternsTriggerRequest"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerRequest'
description: Trigger patterns payload.
required: true
responses:
@@ -171956,31 +172017,31 @@ paths:
id: a7c8d9e0-1234-5678-9abc-def012345678
type: topic_discovery_run
schema:
- $ref: "#/components/schemas/LLMObsPatternsTriggerResponse"
+ $ref: '#/components/schemas/LLMObsPatternsTriggerResponse'
description: Accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -171988,7 +172049,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172030,31 +172091,31 @@ paths:
id: 3fd6b5e0-8910-4b1c-a7d0-5b84de329012
type: topic_discovery_run_status
schema:
- $ref: "#/components/schemas/LLMObsPatternsRunStatusResponse"
+ $ref: '#/components/schemas/LLMObsPatternsRunStatusResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172062,7 +172123,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172111,31 +172172,31 @@ paths:
id: 3fd6b5e0-8910-4b1c-a7d0-5b84de329012
type: get_topics_response
schema:
- $ref: "#/components/schemas/LLMObsPatternsTopicsResponse"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172143,7 +172204,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172204,31 +172265,31 @@ paths:
id: 3fd6b5e0-8910-4b1c-a7d0-5b84de329012
type: get_topics_with_cluster_points_response
schema:
- $ref: "#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponse"
+ $ref: '#/components/schemas/LLMObsPatternsTopicsWithClusteredPointsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172236,7 +172297,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172293,31 +172354,31 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetsResponse"
+ $ref: '#/components/schemas/LLMObsDatasetsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172347,7 +172408,7 @@ paths:
name: My LLM Dataset
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRequest'
description: Create dataset payload.
required: true
responses:
@@ -172368,7 +172429,7 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetResponse"
+ $ref: '#/components/schemas/LLMObsDatasetResponse'
description: OK
"201":
content:
@@ -172387,31 +172448,31 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetResponse"
+ $ref: '#/components/schemas/LLMObsDatasetResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172443,7 +172504,7 @@ paths:
- 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDeleteDatasetsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetsRequest'
description: Delete datasets payload.
required: true
responses:
@@ -172453,25 +172514,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172501,7 +172562,7 @@ paths:
data:
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetUpdateRequest"
+ $ref: '#/components/schemas/LLMObsDatasetUpdateRequest'
description: Update dataset payload.
required: true
responses:
@@ -172522,31 +172583,31 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetResponse"
+ $ref: '#/components/schemas/LLMObsDatasetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172604,7 +172665,7 @@ paths:
id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetBatchUpdateRequest"
+ $ref: '#/components/schemas/LLMObsDatasetBatchUpdateRequest'
description: Batch update payload.
required: true
responses:
@@ -172626,37 +172687,37 @@ paths:
metadata:
updated_at: "2024-01-15T10:30:00Z"
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Payload Too Large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172664,7 +172725,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172708,7 +172769,7 @@ paths:
id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetCloneRequest"
+ $ref: '#/components/schemas/LLMObsDatasetCloneRequest'
description: Clone dataset payload.
required: true
responses:
@@ -172729,31 +172790,31 @@ paths:
id: 7c8d4e9a-1234-5678-9abc-def012345678
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetResponse"
+ $ref: '#/components/schemas/LLMObsDatasetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172761,7 +172822,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172810,31 +172871,31 @@ paths:
id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: draft_state_data
schema:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172842,7 +172903,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172891,31 +172952,31 @@ paths:
id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: draft_state_data
schema:
- $ref: "#/components/schemas/LLMObsDatasetDraftStateResponse"
+ $ref: '#/components/schemas/LLMObsDatasetDraftStateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172923,7 +172984,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -172961,25 +173022,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -172987,7 +173048,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173022,7 +173083,7 @@ paths:
in: query
name: format
schema:
- $ref: "#/components/schemas/LLMObsDatasetExportFormat"
+ $ref: '#/components/schemas/LLMObsDatasetExportFormat'
- description: Version of the dataset to export. If omitted, the current version is used. Must be between 0 and the current version of the dataset, inclusive.
in: query
name: version
@@ -173044,25 +173105,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173070,7 +173131,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173124,31 +173185,31 @@ paths:
metadata:
updated_at: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsListResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173180,7 +173241,7 @@ paths:
- id: rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c
type: records
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsUpdateRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsUpdateRequest'
description: Update records payload.
required: true
responses:
@@ -173202,31 +173263,31 @@ paths:
metadata:
updated_at: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173255,7 +173316,7 @@ paths:
data:
type: records
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsRequest'
description: Append records payload.
required: true
responses:
@@ -173277,7 +173338,7 @@ paths:
metadata:
updated_at: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse'
description: OK
"201":
content:
@@ -173297,31 +173358,31 @@ paths:
metadata:
updated_at: "2024-01-01T00:00:00+00:00"
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsMutationResponse"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsMutationResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173354,7 +173415,7 @@ paths:
- rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c
type: records
schema:
- $ref: "#/components/schemas/LLMObsDeleteDatasetRecordsRequest"
+ $ref: '#/components/schemas/LLMObsDeleteDatasetRecordsRequest'
description: Delete records payload.
required: true
responses:
@@ -173364,25 +173425,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173427,7 +173488,7 @@ paths:
id: 9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d
type: datasets
schema:
- $ref: "#/components/schemas/LLMObsDatasetRestoreVersionRequest"
+ $ref: '#/components/schemas/LLMObsDatasetRestoreVersionRequest'
description: Restore dataset version payload.
required: true
responses:
@@ -173437,25 +173498,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173463,7 +173524,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173515,31 +173576,31 @@ paths:
id: 4ee7c6f1-9a01-5c2d-b8e1-6c95ef43a123
type: dataset_version
schema:
- $ref: "#/components/schemas/LLMObsDatasetVersionsResponse"
+ $ref: '#/components/schemas/LLMObsDatasetVersionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173547,7 +173608,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173590,31 +173651,31 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: experiment_events
schema:
- $ref: "#/components/schemas/LLMObsExperimentEventsV2Response"
+ $ref: '#/components/schemas/LLMObsExperimentEventsV2Response'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173622,7 +173683,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173692,7 +173753,7 @@ paths:
value:
file: records.csv
schema:
- $ref: "#/components/schemas/LLMObsDatasetRecordsUploadFile"
+ $ref: '#/components/schemas/LLMObsDatasetRecordsUploadFile'
description: Multipart upload payload containing the records file.
required: true
responses:
@@ -173702,25 +173763,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173728,7 +173789,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173783,31 +173844,31 @@ paths:
meta:
after:
schema:
- $ref: "#/components/schemas/LLMObsExperimentEventsV2Response"
+ $ref: '#/components/schemas/LLMObsExperimentEventsV2Response'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -173815,7 +173876,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -173844,7 +173905,7 @@ paths:
max_session_duration: 604800
type: max_session_duration
schema:
- $ref: "#/components/schemas/MaxSessionDurationUpdateRequest"
+ $ref: '#/components/schemas/MaxSessionDurationUpdateRequest'
required: true
responses:
"204":
@@ -173903,7 +173964,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/ContentEncoding"
+ $ref: '#/components/schemas/ContentEncoding'
- description: Log tags can be passed as query parameters with `text/plain` content type.
example: "env:prod,user:my-user"
in: query
@@ -173946,7 +174007,7 @@ paths:
message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World
service: "payment"
schema:
- $ref: "#/components/schemas/HTTPLog"
+ $ref: '#/components/schemas/HTTPLog'
application/logplex-1:
examples:
default:
@@ -174004,49 +174065,49 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Forbidden
"408":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Request Timeout
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Payload Too Large
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Too Many Requests
"500":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Internal Server Error
"503":
content:
application/json:
schema:
- $ref: "#/components/schemas/HTTPLogErrors"
+ $ref: '#/components/schemas/HTTPLogErrors'
description: Service Unavailable
security:
- apiKeyAuth: []
@@ -174138,7 +174199,7 @@ paths:
page:
cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
schema:
- $ref: "#/components/schemas/LogsAggregateRequest"
+ $ref: '#/components/schemas/LogsAggregateRequest'
required: true
responses:
"200":
@@ -174157,7 +174218,7 @@ paths:
elapsed: 132
status: done
schema:
- $ref: "#/components/schemas/LogsAggregateResponse"
+ $ref: '#/components/schemas/LogsAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -174199,13 +174260,13 @@ paths:
- a2zcMylnM4OCHpYusxIi3g
type: archive_order
schema:
- $ref: "#/components/schemas/LogsArchiveOrder"
+ $ref: '#/components/schemas/LogsArchiveOrder'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174239,7 +174300,7 @@ paths:
- a2zcMylnM4OCHpYusxIi3g
type: archive_order
schema:
- $ref: "#/components/schemas/LogsArchiveOrder"
+ $ref: '#/components/schemas/LogsArchiveOrder'
description: An object containing the new ordered list of archive IDs.
required: true
responses:
@@ -174257,25 +174318,25 @@ paths:
- a2zcMylnM4OCHpYusxIi3g
type: archive_order
schema:
- $ref: "#/components/schemas/LogsArchiveOrder"
+ $ref: '#/components/schemas/LogsArchiveOrder'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174315,13 +174376,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: archives
schema:
- $ref: "#/components/schemas/LogsArchives"
+ $ref: '#/components/schemas/LogsArchives'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174370,7 +174431,7 @@ paths:
query: source:nginx
type: archives
schema:
- $ref: "#/components/schemas/LogsArchiveCreateRequest"
+ $ref: '#/components/schemas/LogsArchiveCreateRequest'
description: The definition of the new archive.
required: true
responses:
@@ -174410,19 +174471,19 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: archives
schema:
- $ref: "#/components/schemas/LogsArchive"
+ $ref: '#/components/schemas/LogsArchive'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174449,19 +174510,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174501,25 +174562,25 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: archives
schema:
- $ref: "#/components/schemas/LogsArchive"
+ $ref: '#/components/schemas/LogsArchive'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174574,7 +174635,7 @@ paths:
query: source:nginx
type: archives
schema:
- $ref: "#/components/schemas/LogsArchiveCreateRequest"
+ $ref: '#/components/schemas/LogsArchiveCreateRequest'
description: New definition of the archive.
required: true
responses:
@@ -174614,25 +174675,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: archives
schema:
- $ref: "#/components/schemas/LogsArchive"
+ $ref: '#/components/schemas/LogsArchive'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174661,7 +174722,7 @@ paths:
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
required: true
responses:
"204":
@@ -174670,19 +174731,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174713,25 +174774,25 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: roles
schema:
- $ref: "#/components/schemas/RolesResponse"
+ $ref: '#/components/schemas/RolesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174759,7 +174820,7 @@ paths:
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
required: true
responses:
"204":
@@ -174768,19 +174829,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174822,13 +174883,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationsResponse"
+ $ref: '#/components/schemas/CustomDestinationsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -174865,7 +174926,7 @@ paths:
query: source:nginx
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationCreateRequest"
+ $ref: '#/components/schemas/CustomDestinationCreateRequest'
description: The definition of the new custom destination.
required: true
responses:
@@ -174893,7 +174954,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationResponse"
+ $ref: '#/components/schemas/CustomDestinationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -174967,7 +175028,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationResponse"
+ $ref: '#/components/schemas/CustomDestinationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -175013,7 +175074,7 @@ paths:
id: be5d7a69-d0c8-4d4d-8ee8-bba292d98139
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationUpdateRequest"
+ $ref: '#/components/schemas/CustomDestinationUpdateRequest'
description: New definition of the custom destination's fields.
required: true
responses:
@@ -175041,7 +175102,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: custom_destination
schema:
- $ref: "#/components/schemas/CustomDestinationResponse"
+ $ref: '#/components/schemas/CustomDestinationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -175087,7 +175148,7 @@ paths:
id: logs.page.load.count
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricsResponse"
+ $ref: '#/components/schemas/LogsMetricsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -175126,7 +175187,7 @@ paths:
id: logs.page.load.count
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricCreateRequest"
+ $ref: '#/components/schemas/LogsMetricCreateRequest'
description: The definition of the new log-based metric.
required: true
responses:
@@ -175150,7 +175211,7 @@ paths:
id: logs.page.load.count
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricResponse"
+ $ref: '#/components/schemas/LogsMetricResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -175218,7 +175279,7 @@ paths:
id: logs.page.load.count
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricResponse"
+ $ref: '#/components/schemas/LogsMetricResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -175258,7 +175319,7 @@ paths:
tag_name: status_code
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricUpdateRequest"
+ $ref: '#/components/schemas/LogsMetricUpdateRequest'
description: New definition of the log-based metric.
required: true
responses:
@@ -175282,7 +175343,7 @@ paths:
id: logs.page.load.count
type: logs_metrics
schema:
- $ref: "#/components/schemas/LogsMetricResponse"
+ $ref: '#/components/schemas/LogsMetricResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -175323,13 +175384,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryListResponse"
+ $ref: '#/components/schemas/RestrictionQueryListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175358,7 +175419,7 @@ paths:
restriction_query: env:sandbox
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryCreatePayload"
+ $ref: '#/components/schemas/RestrictionQueryCreatePayload'
required: true
responses:
"200":
@@ -175373,19 +175434,19 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse"
+ $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175422,25 +175483,25 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryListResponse"
+ $ref: '#/components/schemas/RestrictionQueryListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175476,25 +175537,25 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryListResponse"
+ $ref: '#/components/schemas/RestrictionQueryListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175522,19 +175583,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175570,25 +175631,25 @@ paths:
type: logs_restriction_queries
included: []
schema:
- $ref: "#/components/schemas/RestrictionQueryWithRelationshipsResponse"
+ $ref: '#/components/schemas/RestrictionQueryWithRelationshipsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175621,7 +175682,7 @@ paths:
restriction_query: env:sandbox
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryUpdatePayload"
+ $ref: '#/components/schemas/RestrictionQueryUpdatePayload'
required: true
responses:
"200":
@@ -175636,25 +175697,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse"
+ $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175687,7 +175748,7 @@ paths:
restriction_query: env:sandbox
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryUpdatePayload"
+ $ref: '#/components/schemas/RestrictionQueryUpdatePayload'
required: true
responses:
"200":
@@ -175702,25 +175763,25 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: logs_restriction_queries
schema:
- $ref: "#/components/schemas/RestrictionQueryWithoutRelationshipsResponse"
+ $ref: '#/components/schemas/RestrictionQueryWithoutRelationshipsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175752,7 +175813,7 @@ paths:
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
required: true
responses:
"204":
@@ -175761,19 +175822,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175809,25 +175870,25 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: roles
schema:
- $ref: "#/components/schemas/RestrictionQueryRolesResponse"
+ $ref: '#/components/schemas/RestrictionQueryRolesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175861,7 +175922,7 @@ paths:
id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/RelationshipToRole"
+ $ref: '#/components/schemas/RelationshipToRole'
required: true
responses:
"204":
@@ -175870,19 +175931,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -175956,13 +176017,13 @@ paths:
name: filter[storage_tier]
required: false
schema:
- $ref: "#/components/schemas/LogsStorageTier"
+ $ref: '#/components/schemas/LogsStorageTier'
- description: Order of logs in results.
in: query
name: sort
required: false
schema:
- $ref: "#/components/schemas/LogsSort"
+ $ref: '#/components/schemas/LogsSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -176001,7 +176062,7 @@ paths:
elapsed: 132
status: done
schema:
- $ref: "#/components/schemas/LogsListResponse"
+ $ref: '#/components/schemas/LogsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -176057,7 +176118,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/LogsListRequest"
+ $ref: '#/components/schemas/LogsListRequest'
required: false
responses:
"200":
@@ -176077,7 +176138,7 @@ paths:
elapsed: 132
status: done
schema:
- $ref: "#/components/schemas/LogsListResponse"
+ $ref: '#/components/schemas/LogsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -176123,7 +176184,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: maintenance_window
schema:
- $ref: "#/components/schemas/MaintenanceWindowsResponse"
+ $ref: '#/components/schemas/MaintenanceWindowsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -176161,7 +176222,7 @@ paths:
start_at: "2026-06-01T00:00:00Z"
type: maintenance_window
schema:
- $ref: "#/components/schemas/MaintenanceWindowCreateRequest"
+ $ref: '#/components/schemas/MaintenanceWindowCreateRequest'
description: Maintenance window payload.
required: true
responses:
@@ -176180,7 +176241,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: maintenance_window
schema:
- $ref: "#/components/schemas/MaintenanceWindowResponse"
+ $ref: '#/components/schemas/MaintenanceWindowResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -176248,7 +176309,7 @@ paths:
start_at: "2026-06-01T00:00:00Z"
type: maintenance_window
schema:
- $ref: "#/components/schemas/MaintenanceWindowUpdateRequest"
+ $ref: '#/components/schemas/MaintenanceWindowUpdateRequest'
description: Maintenance window payload.
required: true
responses:
@@ -176267,7 +176328,7 @@ paths:
id: a1b2c3d4-e5f6-7890-abcd-ef1234567890
type: maintenance_window
schema:
- $ref: "#/components/schemas/MaintenanceWindowResponse"
+ $ref: '#/components/schemas/MaintenanceWindowResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -176323,7 +176384,7 @@ paths:
name: filter[metric_type]
required: false
schema:
- $ref: "#/components/schemas/MetricTagConfigurationMetricTypeCategory"
+ $ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory'
- description: Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
example: true
in: query
@@ -176462,25 +176523,25 @@ paths:
id: user.custom.mem.usage
type: metric_volumes
schema:
- $ref: "#/components/schemas/MetricsAndMetricTagConfigurationsResponse"
+ $ref: '#/components/schemas/MetricsAndMetricTagConfigurationsResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -176525,7 +176586,7 @@ paths:
id: kafka.lag
type: metric_bulk_configure_tags
schema:
- $ref: "#/components/schemas/MetricBulkTagConfigDeleteRequest"
+ $ref: '#/components/schemas/MetricBulkTagConfigDeleteRequest'
required: true
responses:
"202":
@@ -176542,31 +176603,31 @@ paths:
id: kafka.lag
type: metric_bulk_configure_tags
schema:
- $ref: "#/components/schemas/MetricBulkTagConfigResponse"
+ $ref: '#/components/schemas/MetricBulkTagConfigResponse'
description: Accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Delete tags for multiple metrics
tags:
@@ -176609,7 +176670,7 @@ paths:
id: kafka.lag
type: metric_bulk_configure_tags
schema:
- $ref: "#/components/schemas/MetricBulkTagConfigCreateRequest"
+ $ref: '#/components/schemas/MetricBulkTagConfigCreateRequest'
required: true
responses:
"202":
@@ -176627,31 +176688,31 @@ paths:
id: kafka.lag
type: metric_bulk_configure_tags
schema:
- $ref: "#/components/schemas/MetricBulkTagConfigResponse"
+ $ref: '#/components/schemas/MetricBulkTagConfigResponse'
description: Accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Configure tags for multiple metrics
tags:
@@ -176681,7 +176742,7 @@ paths:
id: dd.test.metric
type: historical_metrics_configurations
schema:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationCreateRequest"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationCreateRequest'
required: true
responses:
"200":
@@ -176696,7 +176757,7 @@ paths:
id: dd.test.metric
type: historical_metrics_configurations
schema:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationResponse"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationResponse'
description: OK
"201":
content:
@@ -176710,25 +176771,25 @@ paths:
id: dd.test.metric
type: historical_metrics_configurations
schema:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationResponse"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -176765,7 +176826,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -176806,19 +176867,19 @@ paths:
id: dd.test.metric
type: historical_metrics_configurations
schema:
- $ref: "#/components/schemas/HistoricalMetricsConfigurationResponse"
+ $ref: '#/components/schemas/HistoricalMetricsConfigurationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -176882,25 +176943,25 @@ paths:
meta:
total: 1
schema:
- $ref: "#/components/schemas/TagIndexingRulesResponse"
+ $ref: '#/components/schemas/TagIndexingRulesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -176940,7 +177001,7 @@ paths:
- service
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleCreateRequest"
+ $ref: '#/components/schemas/TagIndexingRuleCreateRequest'
required: true
responses:
"201":
@@ -176963,25 +177024,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleResponse"
+ $ref: '#/components/schemas/TagIndexingRuleResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177021,7 +177082,7 @@ paths:
- "00000000-0000-0000-0000-000000000002"
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleOrderRequest"
+ $ref: '#/components/schemas/TagIndexingRuleOrderRequest'
required: true
responses:
"204":
@@ -177030,25 +177091,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177083,19 +177144,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177139,31 +177200,31 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleResponse"
+ $ref: '#/components/schemas/TagIndexingRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177204,7 +177265,7 @@ paths:
- version
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleUpdateRequest"
+ $ref: '#/components/schemas/TagIndexingRuleUpdateRequest'
required: true
responses:
"200":
@@ -177227,37 +177288,37 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: tag_indexing_rules
schema:
- $ref: "#/components/schemas/TagIndexingRuleResponse"
+ $ref: '#/components/schemas/TagIndexingRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177310,31 +177371,31 @@ paths:
id: http.endpoint.request
type: actively_queried_configurations
schema:
- $ref: "#/components/schemas/MetricSuggestedTagsAndAggregationsResponse"
+ $ref: '#/components/schemas/MetricSuggestedTagsAndAggregationsResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: List active tags and aggregations
tags:
@@ -177424,31 +177485,31 @@ paths:
id: system.cpu.user
type: metrics
schema:
- $ref: "#/components/schemas/MetricAllTagsResponse"
+ $ref: '#/components/schemas/MetricAllTagsResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177505,31 +177566,31 @@ paths:
id: "1775073"
type: monitors
schema:
- $ref: "#/components/schemas/MetricAssetsResponse"
+ $ref: '#/components/schemas/MetricAssetsResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177611,31 +177672,31 @@ paths:
id: system.cpu.user
type: metric_cardinality_estimate
schema:
- $ref: "#/components/schemas/MetricEstimateResponse"
+ $ref: '#/components/schemas/MetricEstimateResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Tag Configuration Cardinality Estimator
tags:
@@ -177669,31 +177730,31 @@ paths:
meta:
metric_name: system.cpu.user
schema:
- $ref: "#/components/schemas/MetricTagCardinalitiesResponse"
+ $ref: '#/components/schemas/MetricTagCardinalitiesResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
summary: Get tag key cardinality details
tags:
@@ -177719,19 +177780,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177774,31 +177835,31 @@ paths:
id: dd.test.metric
type: tag_indexing_rule_exemptions
schema:
- $ref: "#/components/schemas/TagIndexingRuleExemptionResponse"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177834,7 +177895,7 @@ paths:
reason: This metric has a pre-existing tag configuration.
type: tag_indexing_rule_exemptions
schema:
- $ref: "#/components/schemas/TagIndexingRuleExemptionCreateRequest"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionCreateRequest'
required: true
responses:
"201":
@@ -177852,25 +177913,25 @@ paths:
id: dd.test.metric
type: tag_indexing_rule_exemptions
schema:
- $ref: "#/components/schemas/TagIndexingRuleExemptionResponse"
+ $ref: '#/components/schemas/TagIndexingRuleExemptionResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177908,25 +177969,25 @@ paths:
meta:
total: 0
schema:
- $ref: "#/components/schemas/TagIndexingRulesResponse"
+ $ref: '#/components/schemas/TagIndexingRulesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -177960,19 +178021,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Delete a tag configuration
tags:
@@ -178008,25 +178069,25 @@ paths:
id: http.endpoint.request
type: manage_tags
schema:
- $ref: "#/components/schemas/MetricTagConfigurationResponse"
+ $ref: '#/components/schemas/MetricTagConfigurationResponse'
description: Success
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: No tag configuration exists for the metric
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
@@ -178066,7 +178127,7 @@ paths:
id: http.endpoint.request
type: manage_tags
schema:
- $ref: "#/components/schemas/MetricTagConfigurationUpdateRequest"
+ $ref: '#/components/schemas/MetricTagConfigurationUpdateRequest'
required: true
responses:
"200":
@@ -178084,31 +178145,31 @@ paths:
id: http.endpoint.request
type: manage_tags
schema:
- $ref: "#/components/schemas/MetricTagConfigurationResponse"
+ $ref: '#/components/schemas/MetricTagConfigurationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Update a tag configuration
tags:
@@ -178145,7 +178206,7 @@ paths:
id: http.endpoint.request
type: manage_tags
schema:
- $ref: "#/components/schemas/MetricTagConfigurationCreateRequest"
+ $ref: '#/components/schemas/MetricTagConfigurationCreateRequest'
required: true
responses:
"201":
@@ -178163,31 +178224,31 @@ paths:
id: http.endpoint.request
type: manage_tags
schema:
- $ref: "#/components/schemas/MetricTagConfigurationResponse"
+ $ref: '#/components/schemas/MetricTagConfigurationResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: Create a tag configuration
tags:
@@ -178231,31 +178292,31 @@ paths:
id: http.endpoint.request
type: metric_volumes
schema:
- $ref: "#/components/schemas/MetricVolumesResponse"
+ $ref: '#/components/schemas/MetricVolumesResponse'
description: Success
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
summary: List distinct metric volumes by metric name
tags:
@@ -178298,7 +178359,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178306,7 +178367,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get Model Lab artifact content
tags:
@@ -178349,19 +178410,19 @@ paths:
id: "1"
type: facet_keys
schema:
- $ref: "#/components/schemas/ModelLabFacetKeysResponse"
+ $ref: '#/components/schemas/ModelLabFacetKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178369,7 +178430,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab run facet keys
tags:
@@ -178396,7 +178457,7 @@ paths:
name: facet_type
required: true
schema:
- $ref: "#/components/schemas/ModelLabFacetType"
+ $ref: '#/components/schemas/ModelLabFacetType'
- description: Facet name.
in: query
name: facet_name
@@ -178421,19 +178482,19 @@ paths:
id: "1"
type: facet_values
schema:
- $ref: "#/components/schemas/ModelLabFacetValuesResponse"
+ $ref: '#/components/schemas/ModelLabFacetValuesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178441,7 +178502,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab run facet values
tags:
@@ -178471,7 +178532,7 @@ paths:
id: "1"
type: facet_keys
schema:
- $ref: "#/components/schemas/ModelLabFacetKeysResponse"
+ $ref: '#/components/schemas/ModelLabFacetKeysResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178479,7 +178540,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab project facet keys
tags:
@@ -178498,7 +178559,7 @@ paths:
name: facet_type
required: true
schema:
- $ref: "#/components/schemas/ModelLabProjectFacetType"
+ $ref: '#/components/schemas/ModelLabProjectFacetType'
- description: Facet name.
in: query
name: facet_name
@@ -178523,13 +178584,13 @@ paths:
id: "1"
type: facet_values
schema:
- $ref: "#/components/schemas/ModelLabFacetValuesResponse"
+ $ref: '#/components/schemas/ModelLabFacetValuesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178537,7 +178598,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab project facet values
tags:
@@ -178620,13 +178681,13 @@ paths:
size: 25
total: 1
schema:
- $ref: "#/components/schemas/ModelLabProjectsResponse"
+ $ref: '#/components/schemas/ModelLabProjectsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178634,7 +178695,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab projects
tags:
@@ -178670,19 +178731,19 @@ paths:
id: "2"
type: projects
schema:
- $ref: "#/components/schemas/ModelLabProjectResponse"
+ $ref: '#/components/schemas/ModelLabProjectResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178690,7 +178751,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get a Model Lab project
tags:
@@ -178722,13 +178783,13 @@ paths:
id: "1"
type: project_files
schema:
- $ref: "#/components/schemas/ModelLabProjectArtifactsResponse"
+ $ref: '#/components/schemas/ModelLabProjectArtifactsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178736,7 +178797,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab project artifacts
tags:
@@ -178758,19 +178819,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178778,7 +178839,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Remove star from a Model Lab project
tags:
@@ -178799,19 +178860,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178819,7 +178880,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Star a Model Lab project
tags:
@@ -178856,7 +178917,7 @@ paths:
name: filter[status]
required: false
schema:
- $ref: "#/components/schemas/ModelLabRunStatus"
+ $ref: '#/components/schemas/ModelLabRunStatus'
- description: Filter by project ID.
in: query
name: filter[project_id]
@@ -178959,13 +179020,13 @@ paths:
size: 25
total: 1
schema:
- $ref: "#/components/schemas/ModelLabRunsResponse"
+ $ref: '#/components/schemas/ModelLabRunsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -178973,7 +179034,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab runs
tags:
@@ -178995,13 +179056,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179009,7 +179070,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Delete a Model Lab run
tags:
@@ -179053,19 +179114,19 @@ paths:
id: "2"
type: runs
schema:
- $ref: "#/components/schemas/ModelLabRunResponse"
+ $ref: '#/components/schemas/ModelLabRunResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179073,7 +179134,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get a Model Lab run
tags:
@@ -179113,19 +179174,19 @@ paths:
id: "42"
type: artifacts
schema:
- $ref: "#/components/schemas/ModelLabRunArtifactsResponse"
+ $ref: '#/components/schemas/ModelLabRunArtifactsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179133,7 +179194,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List Model Lab run artifacts
tags:
@@ -179155,19 +179216,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179175,7 +179236,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Unpin a Model Lab run
tags:
@@ -179196,19 +179257,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179216,7 +179277,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Pin a Model Lab run
tags:
@@ -179292,13 +179353,13 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleListResponse"
+ $ref: '#/components/schemas/MonitorNotificationRuleListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179336,7 +179397,7 @@ paths:
- jira-test
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleCreateRequest"
+ $ref: '#/components/schemas/MonitorNotificationRuleCreateRequest'
description: Request body to create a monitor notification rule.
required: true
responses:
@@ -179356,19 +179417,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleResponse"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179398,13 +179459,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179452,19 +179513,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleResponse"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179510,7 +179571,7 @@ paths:
id: 00000000-0000-1234-0000-000000000000
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleUpdateRequest"
+ $ref: '#/components/schemas/MonitorNotificationRuleUpdateRequest'
description: Request body to update the monitor notification rule.
required: true
responses:
@@ -179533,25 +179594,25 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-notification-rule
schema:
- $ref: "#/components/schemas/MonitorNotificationRuleResponse"
+ $ref: '#/components/schemas/MonitorNotificationRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179587,13 +179648,13 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyListResponse"
+ $ref: '#/components/schemas/MonitorConfigPolicyListResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179630,7 +179691,7 @@ paths:
policy_type: tag
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyCreateRequest"
+ $ref: '#/components/schemas/MonitorConfigPolicyCreateRequest'
description: Create a monitor configuration policy request body.
required: true
responses:
@@ -179652,19 +179713,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyResponse"
+ $ref: '#/components/schemas/MonitorConfigPolicyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179696,19 +179757,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179750,19 +179811,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyResponse"
+ $ref: '#/components/schemas/MonitorConfigPolicyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179808,7 +179869,7 @@ paths:
id: 00000000-0000-1234-0000-000000000000
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyEditRequest"
+ $ref: '#/components/schemas/MonitorConfigPolicyEditRequest'
description: Description of the update.
required: true
responses:
@@ -179830,25 +179891,25 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-config-policy
schema:
- $ref: "#/components/schemas/MonitorConfigPolicyResponse"
+ $ref: '#/components/schemas/MonitorConfigPolicyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179890,7 +179951,7 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateListResponse"
+ $ref: '#/components/schemas/MonitorUserTemplateListResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -179941,7 +180002,7 @@ paths:
title: Postgres CPU Monitor
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateCreateRequest"
+ $ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
required: true
responses:
"200":
@@ -179968,13 +180029,13 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateCreateResponse"
+ $ref: '#/components/schemas/MonitorUserTemplateCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180021,7 +180082,7 @@ paths:
title: Postgres CPU Monitor
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateCreateRequest"
+ $ref: '#/components/schemas/MonitorUserTemplateCreateRequest'
required: true
responses:
"204":
@@ -180030,7 +180091,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180063,7 +180124,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180121,13 +180182,13 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateResponse"
+ $ref: '#/components/schemas/MonitorUserTemplateResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180186,7 +180247,7 @@ paths:
id: 00000000-0000-1234-0000-000000000000
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest"
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
required: true
responses:
"200":
@@ -180213,19 +180274,19 @@ paths:
id: "00000000-0000-1234-0000-000000000000"
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateResponse"
+ $ref: '#/components/schemas/MonitorUserTemplateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180281,7 +180342,7 @@ paths:
id: 00000000-0000-1234-0000-000000000000
type: monitor-user-template
schema:
- $ref: "#/components/schemas/MonitorUserTemplateUpdateRequest"
+ $ref: '#/components/schemas/MonitorUserTemplateUpdateRequest'
required: true
responses:
"204":
@@ -180290,13 +180351,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180353,13 +180414,13 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/MonitorDowntimeMatchResponse"
+ $ref: '#/components/schemas/MonitorDowntimeMatchResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Monitor Not Found error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180423,7 +180484,7 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/ListDevicesResponse"
+ $ref: '#/components/schemas/ListDevicesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -180470,7 +180531,7 @@ paths:
id: foiwf7rgw38fh
type: device
schema:
- $ref: "#/components/schemas/GetDeviceResponse"
+ $ref: '#/components/schemas/GetDeviceResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180518,7 +180579,7 @@ paths:
id: foiwf7rgw38fh:99
type: interface
schema:
- $ref: "#/components/schemas/GetInterfacesResponse"
+ $ref: '#/components/schemas/GetInterfacesResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180555,7 +180616,7 @@ paths:
id: foiwf7rgw38fh
type: tags
schema:
- $ref: "#/components/schemas/ListTagsResponse"
+ $ref: '#/components/schemas/ListTagsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180592,7 +180653,7 @@ paths:
id: example:1.2.3.4
type: tags
schema:
- $ref: "#/components/schemas/ListTagsResponse"
+ $ref: '#/components/schemas/ListTagsResponse'
required: true
responses:
"200":
@@ -180609,7 +180670,7 @@ paths:
id: foiwf7rgw38fh
type: tags
schema:
- $ref: "#/components/schemas/ListTagsResponse"
+ $ref: '#/components/schemas/ListTagsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180648,7 +180709,7 @@ paths:
id: foiwf7rgw38fh:1
type: tags
schema:
- $ref: "#/components/schemas/ListInterfaceTagsResponse"
+ $ref: '#/components/schemas/ListInterfaceTagsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180685,7 +180746,7 @@ paths:
id: example:1.2.3.4:1
type: tags
schema:
- $ref: "#/components/schemas/ListInterfaceTagsResponse"
+ $ref: '#/components/schemas/ListInterfaceTagsResponse'
required: true
responses:
"200":
@@ -180702,7 +180763,7 @@ paths:
id: foiwf7rgw38fh:1
type: tags
schema:
- $ref: "#/components/schemas/ListInterfaceTagsResponse"
+ $ref: '#/components/schemas/ListInterfaceTagsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -180794,19 +180855,19 @@ paths:
id: "example-security-group-insight-id"
type: "network-health-insights"
schema:
- $ref: "#/components/schemas/NetworkHealthInsightsResponse"
+ $ref: '#/components/schemas/NetworkHealthInsightsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -180814,7 +180875,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List network health insights
tags:
@@ -180885,7 +180946,7 @@ paths:
id: abc-123
type: aggregated_connection
schema:
- $ref: "#/components/schemas/SingleAggregatedConnectionResponseArray"
+ $ref: '#/components/schemas/SingleAggregatedConnectionResponseArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -180968,7 +181029,7 @@ paths:
id: abc-123
type: aggregated_dns
schema:
- $ref: "#/components/schemas/SingleAggregatedDnsResponseArray"
+ $ref: '#/components/schemas/SingleAggregatedDnsResponseArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181012,7 +181073,7 @@ paths:
id: prod
type: env
schema:
- $ref: "#/components/schemas/OAuth2WellKnownSitesResponse"
+ $ref: '#/components/schemas/OAuth2WellKnownSitesResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181037,13 +181098,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181083,19 +181144,19 @@ paths:
id: fafa8e1c-36a5-11f0-a83d-da7ad0900001
type: scopes_restriction
schema:
- $ref: "#/components/schemas/OAuthScopesRestrictionResponse"
+ $ref: '#/components/schemas/OAuthScopesRestrictionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181131,7 +181192,7 @@ paths:
- metrics_read
type: upsert_scopes_restriction
schema:
- $ref: "#/components/schemas/UpsertOAuthScopesRestrictionRequest"
+ $ref: '#/components/schemas/UpsertOAuthScopesRestrictionRequest'
required: true
responses:
"200":
@@ -181153,19 +181214,19 @@ paths:
id: fafa8e1c-36a5-11f0-a83d-da7ad0900001
type: scopes_restriction
schema:
- $ref: "#/components/schemas/OAuthScopesRestrictionResponse"
+ $ref: '#/components/schemas/OAuthScopesRestrictionResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181201,7 +181262,7 @@ paths:
- code
token_endpoint_auth_method: none
schema:
- $ref: "#/components/schemas/OAuthClientRegistrationRequest"
+ $ref: '#/components/schemas/OAuthClientRegistrationRequest'
required: true
responses:
"201":
@@ -181221,7 +181282,7 @@ paths:
- code
token_endpoint_auth_method: none
schema:
- $ref: "#/components/schemas/OAuthClientRegistrationResponse"
+ $ref: '#/components/schemas/OAuthClientRegistrationResponse'
description: Created
"400":
content:
@@ -181232,7 +181293,7 @@ paths:
error: invalid_client_metadata
error_description: redirect URI is not well-formed
schema:
- $ref: "#/components/schemas/OAuthClientRegistrationError"
+ $ref: '#/components/schemas/OAuthClientRegistrationError'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181274,7 +181335,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: pipelines
schema:
- $ref: "#/components/schemas/ListPipelinesResponse"
+ $ref: '#/components/schemas/ListPipelinesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181331,7 +181392,7 @@ paths:
name: Main Observability Pipeline
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipelineSpec"
+ $ref: '#/components/schemas/ObservabilityPipelineSpec'
required: true
responses:
"201":
@@ -181355,7 +181416,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipeline"
+ $ref: '#/components/schemas/ObservabilityPipeline'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181417,7 +181478,7 @@ paths:
name: Main Observability Pipeline
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipelineSpec"
+ $ref: '#/components/schemas/ObservabilityPipelineSpec'
required: true
responses:
"200":
@@ -181428,7 +181489,7 @@ paths:
value:
errors: []
schema:
- $ref: "#/components/schemas/ValidationResponse"
+ $ref: '#/components/schemas/ValidationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181462,19 +181523,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181518,13 +181579,13 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipeline"
+ $ref: '#/components/schemas/ObservabilityPipeline'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -181585,7 +181646,7 @@ paths:
id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipeline"
+ $ref: '#/components/schemas/ObservabilityPipeline'
required: true
responses:
"200":
@@ -181609,7 +181670,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: pipelines
schema:
- $ref: "#/components/schemas/ObservabilityPipeline"
+ $ref: '#/components/schemas/ObservabilityPipeline'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181677,7 +181738,7 @@ paths:
type: teams
type: policies
schema:
- $ref: "#/components/schemas/EscalationPolicyCreateRequest"
+ $ref: '#/components/schemas/EscalationPolicyCreateRequest'
required: true
responses:
"201":
@@ -181703,7 +181764,7 @@ paths:
type: teams
type: policies
schema:
- $ref: "#/components/schemas/EscalationPolicy"
+ $ref: '#/components/schemas/EscalationPolicy'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181800,7 +181861,7 @@ paths:
type: teams
type: policies
schema:
- $ref: "#/components/schemas/EscalationPolicy"
+ $ref: '#/components/schemas/EscalationPolicy'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181868,7 +181929,7 @@ paths:
type: teams
type: policies
schema:
- $ref: "#/components/schemas/EscalationPolicyUpdateRequest"
+ $ref: '#/components/schemas/EscalationPolicyUpdateRequest'
required: true
responses:
"200":
@@ -181894,7 +181955,7 @@ paths:
type: teams
type: policies
schema:
- $ref: "#/components/schemas/EscalationPolicy"
+ $ref: '#/components/schemas/EscalationPolicy'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -181941,7 +182002,7 @@ paths:
urgency: low
type: pages
schema:
- $ref: "#/components/schemas/CreatePageRequest"
+ $ref: '#/components/schemas/CreatePageRequest'
required: true
responses:
"200":
@@ -181954,7 +182015,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: pages
schema:
- $ref: "#/components/schemas/CreatePageResponse"
+ $ref: '#/components/schemas/CreatePageResponse'
description: OK.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -182393,7 +182454,7 @@ paths:
type: teams
type: schedules
schema:
- $ref: "#/components/schemas/ScheduleCreateRequest"
+ $ref: '#/components/schemas/ScheduleCreateRequest'
required: true
responses:
"201":
@@ -182418,7 +182479,7 @@ paths:
type: teams
type: schedules
schema:
- $ref: "#/components/schemas/Schedule"
+ $ref: '#/components/schemas/Schedule'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -182514,7 +182575,7 @@ paths:
type: teams
type: schedules
schema:
- $ref: "#/components/schemas/Schedule"
+ $ref: '#/components/schemas/Schedule'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -182585,7 +182646,7 @@ paths:
type: teams
type: schedules
schema:
- $ref: "#/components/schemas/ScheduleUpdateRequest"
+ $ref: '#/components/schemas/ScheduleUpdateRequest'
required: true
responses:
"200":
@@ -182610,7 +182671,7 @@ paths:
type: teams
type: schedules
schema:
- $ref: "#/components/schemas/Schedule"
+ $ref: '#/components/schemas/Schedule'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -182677,7 +182738,7 @@ paths:
type: users
type: shifts
schema:
- $ref: "#/components/schemas/Shift"
+ $ref: '#/components/schemas/Shift'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -182773,7 +182834,7 @@ paths:
type: users
type: shifts
schema:
- $ref: "#/components/schemas/ScheduleOnCallResponders"
+ $ref: '#/components/schemas/ScheduleOnCallResponders'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -182834,7 +182895,7 @@ paths:
type: users
type: team_oncall_responders
schema:
- $ref: "#/components/schemas/TeamOnCallResponders"
+ $ref: '#/components/schemas/TeamOnCallResponders'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -182886,7 +182947,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: team_routing_rules
schema:
- $ref: "#/components/schemas/TeamRoutingRules"
+ $ref: '#/components/schemas/TeamRoutingRules'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -182953,7 +183014,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: team_routing_rules
schema:
- $ref: "#/components/schemas/TeamRoutingRulesRequest"
+ $ref: '#/components/schemas/TeamRoutingRulesRequest'
required: true
responses:
"200":
@@ -182966,7 +183027,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_routing_rules
schema:
- $ref: "#/components/schemas/TeamRoutingRules"
+ $ref: '#/components/schemas/TeamRoutingRules'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183011,7 +183072,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: notification_channels
schema:
- $ref: "#/components/schemas/ListNotificationChannelsResponse"
+ $ref: '#/components/schemas/ListNotificationChannelsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183061,7 +183122,7 @@ paths:
type: email
type: notification_channels
schema:
- $ref: "#/components/schemas/CreateUserNotificationChannelRequest"
+ $ref: '#/components/schemas/CreateUserNotificationChannelRequest'
required: true
responses:
"201":
@@ -183080,7 +183141,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: notification_channels
schema:
- $ref: "#/components/schemas/NotificationChannel"
+ $ref: '#/components/schemas/NotificationChannel'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183183,7 +183244,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: notification_channels
schema:
- $ref: "#/components/schemas/NotificationChannel"
+ $ref: '#/components/schemas/NotificationChannel'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183241,7 +183302,7 @@ paths:
id: 27590dae-47be-4a7d-9abf-8f4e45124020
type: notification_rules
schema:
- $ref: "#/components/schemas/ListOnCallNotificationRulesResponse"
+ $ref: '#/components/schemas/ListOnCallNotificationRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183296,7 +183357,7 @@ paths:
type: notification_channels
type: notification_rules
schema:
- $ref: "#/components/schemas/CreateOnCallNotificationRuleRequest"
+ $ref: '#/components/schemas/CreateOnCallNotificationRuleRequest'
required: true
responses:
"201":
@@ -183320,7 +183381,7 @@ paths:
type: notification_channels
type: notification_rules
schema:
- $ref: "#/components/schemas/OnCallNotificationRule"
+ $ref: '#/components/schemas/OnCallNotificationRule'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183433,7 +183494,7 @@ paths:
type: notification_channels
type: notification_rules
schema:
- $ref: "#/components/schemas/OnCallNotificationRule"
+ $ref: '#/components/schemas/OnCallNotificationRule'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183501,7 +183562,7 @@ paths:
type: notification_channels
type: notification_rules
schema:
- $ref: "#/components/schemas/UpdateOnCallNotificationRuleRequest"
+ $ref: '#/components/schemas/UpdateOnCallNotificationRuleRequest'
required: true
responses:
"200":
@@ -183525,7 +183586,7 @@ paths:
type: notification_channels
type: notification_rules
schema:
- $ref: "#/components/schemas/OnCallNotificationRule"
+ $ref: '#/components/schemas/OnCallNotificationRule'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -183604,7 +183665,7 @@ paths:
id: "a1b2c3d4-00cc-11ea-a77b-570c9d03c6c5"
type: "orgs"
schema:
- $ref: "#/components/schemas/ManagedOrgsResponse"
+ $ref: '#/components/schemas/ManagedOrgsResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -183648,7 +183709,7 @@ paths:
id: "1"
type: "customer_org_disable"
schema:
- $ref: "#/components/schemas/CustomerOrgDisableRequest"
+ $ref: '#/components/schemas/CustomerOrgDisableRequest'
required: true
responses:
"200":
@@ -183663,25 +183724,25 @@ paths:
id: "abcdef01-2345-6789-abcd-ef0123456789"
type: "org_disable"
schema:
- $ref: "#/components/schemas/CustomerOrgDisableResponse"
+ $ref: '#/components/schemas/CustomerOrgDisableResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183689,7 +183750,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -183725,7 +183786,7 @@ paths:
- example.com
type: saml_preferences
schema:
- $ref: "#/components/schemas/OrgSAMLPreferencesUpdateRequest"
+ $ref: '#/components/schemas/OrgSAMLPreferencesUpdateRequest'
required: true
responses:
"204":
@@ -183734,19 +183795,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183833,13 +183894,13 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/OrgAuthorizedClientsResponse"
+ $ref: '#/components/schemas/OrgAuthorizedClientsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183874,13 +183935,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183948,19 +184009,19 @@ paths:
related: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients"
type: org_authorized_clients
schema:
- $ref: "#/components/schemas/OrgAuthorizedClientResponse"
+ $ref: '#/components/schemas/OrgAuthorizedClientResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -183994,7 +184055,7 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: org_authorized_clients
schema:
- $ref: "#/components/schemas/OrgAuthorizedClientUpdateRequest"
+ $ref: '#/components/schemas/OrgAuthorizedClientUpdateRequest'
required: true
responses:
"200":
@@ -184020,31 +184081,31 @@ paths:
related: "/api/v2/org_authorized_clients/00000000-0000-0000-0000-000000000001/user_authorized_clients"
type: org_authorized_clients
schema:
- $ref: "#/components/schemas/OrgAuthorizedClientResponse"
+ $ref: '#/components/schemas/OrgAuthorizedClientResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184076,13 +184137,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184112,7 +184173,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/OrgAuthorizedClientUserAuthorizationsSort"
+ $ref: '#/components/schemas/OrgAuthorizedClientUserAuthorizationsSort'
- description: Filter results by the user authorization disabled status.
in: query
name: filter[disabled]
@@ -184171,19 +184232,19 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/UserAuthorizedClientsResponse"
+ $ref: '#/components/schemas/UserAuthorizedClientsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184218,13 +184279,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184261,7 +184322,7 @@ paths:
id: abcd1234
type: org_configs
schema:
- $ref: "#/components/schemas/OrgConfigListResponse"
+ $ref: '#/components/schemas/OrgConfigListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -184299,7 +184360,7 @@ paths:
id: abcd1234
type: org_configs
schema:
- $ref: "#/components/schemas/OrgConfigGetResponse"
+ $ref: '#/components/schemas/OrgConfigGetResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -184333,7 +184394,7 @@ paths:
value: UTC
type: org_configs
schema:
- $ref: "#/components/schemas/OrgConfigWriteRequest"
+ $ref: '#/components/schemas/OrgConfigWriteRequest'
required: true
responses:
"200":
@@ -184351,7 +184412,7 @@ paths:
id: abcd1234
type: org_configs
schema:
- $ref: "#/components/schemas/OrgConfigGetResponse"
+ $ref: '#/components/schemas/OrgConfigGetResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -184421,7 +184482,7 @@ paths:
relationships: {}
type: org_connection
schema:
- $ref: "#/components/schemas/OrgConnectionListResponse"
+ $ref: '#/components/schemas/OrgConnectionListResponse'
description: OK
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -184462,7 +184523,7 @@ paths:
type: orgs
type: org_connection
schema:
- $ref: "#/components/schemas/OrgConnectionCreateRequest"
+ $ref: '#/components/schemas/OrgConnectionCreateRequest'
required: true
responses:
"200":
@@ -184480,7 +184541,7 @@ paths:
relationships: {}
type: org_connection
schema:
- $ref: "#/components/schemas/OrgConnectionResponse"
+ $ref: '#/components/schemas/OrgConnectionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -184557,7 +184618,7 @@ paths:
id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
type: org_connection
schema:
- $ref: "#/components/schemas/OrgConnectionUpdateRequest"
+ $ref: '#/components/schemas/OrgConnectionUpdateRequest'
required: true
responses:
"200":
@@ -184575,7 +184636,7 @@ paths:
id: f9ec96b0-8c8a-4b0a-9b0a-1b2c3d4e5f6a
type: org_connection
schema:
- $ref: "#/components/schemas/OrgConnectionResponse"
+ $ref: '#/components/schemas/OrgConnectionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -184648,25 +184709,25 @@ paths:
total: 1
type: number_size
schema:
- $ref: "#/components/schemas/OrgGroupMembershipListResponse"
+ $ref: '#/components/schemas/OrgGroupMembershipListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184707,7 +184768,7 @@ paths:
type: org_groups
type: org_group_membership_bulk_updates
schema:
- $ref: "#/components/schemas/OrgGroupMembershipBulkUpdateRequest"
+ $ref: '#/components/schemas/OrgGroupMembershipBulkUpdateRequest'
required: true
responses:
"200":
@@ -184731,31 +184792,31 @@ paths:
type: org_groups
type: org_group_memberships
schema:
- $ref: "#/components/schemas/OrgGroupMembershipListResponse"
+ $ref: '#/components/schemas/OrgGroupMembershipListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184797,31 +184858,31 @@ paths:
type: org_groups
type: org_group_memberships
schema:
- $ref: "#/components/schemas/OrgGroupMembershipResponse"
+ $ref: '#/components/schemas/OrgGroupMembershipResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184855,7 +184916,7 @@ paths:
type: org_groups
type: org_group_memberships
schema:
- $ref: "#/components/schemas/OrgGroupMembershipUpdateRequest"
+ $ref: '#/components/schemas/OrgGroupMembershipUpdateRequest'
required: true
responses:
"200":
@@ -184879,31 +184940,31 @@ paths:
type: org_groups
type: org_group_memberships
schema:
- $ref: "#/components/schemas/OrgGroupMembershipResponse"
+ $ref: '#/components/schemas/OrgGroupMembershipResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -184967,25 +185028,25 @@ paths:
total: 1
type: number_size
schema:
- $ref: "#/components/schemas/OrgGroupPolicyListResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185038,7 +185099,7 @@ paths:
type: org_groups
type: org_group_policies
schema:
- $ref: "#/components/schemas/OrgGroupPolicyCreateRequest"
+ $ref: '#/components/schemas/OrgGroupPolicyCreateRequest'
required: true
responses:
"201":
@@ -185081,31 +185142,31 @@ paths:
type: org_groups
type: org_group_policies
schema:
- $ref: "#/components/schemas/OrgGroupPolicyResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185132,25 +185193,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185192,31 +185253,31 @@ paths:
type: org_groups
type: org_group_policies
schema:
- $ref: "#/components/schemas/OrgGroupPolicyResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185261,7 +185322,7 @@ paths:
id: "1a2b3c4d-5e6f-7890-abcd-ef0123456789"
type: org_group_policies
schema:
- $ref: "#/components/schemas/OrgGroupPolicyUpdateRequest"
+ $ref: '#/components/schemas/OrgGroupPolicyUpdateRequest'
required: true
responses:
"200":
@@ -185305,31 +185366,31 @@ paths:
type: org_groups
type: org_group_policies
schema:
- $ref: "#/components/schemas/OrgGroupPolicyResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185364,19 +185425,19 @@ paths:
id: "monitor_timezone"
type: org_group_policy_configs
schema:
- $ref: "#/components/schemas/OrgGroupPolicyConfigListResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyConfigListResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185442,25 +185503,25 @@ paths:
total: 1
type: number_size
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideListResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185498,7 +185559,7 @@ paths:
type: org_group_policies
type: org_group_policy_overrides
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideCreateRequest"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideCreateRequest'
required: true
responses:
"201":
@@ -185525,31 +185586,31 @@ paths:
type: org_group_policies
type: org_group_policy_overrides
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185576,25 +185637,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185638,31 +185699,31 @@ paths:
type: org_group_policies
type: org_group_policy_overrides
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185694,7 +185755,7 @@ paths:
id: "9f8e7d6c-5b4a-3210-fedc-ba0987654321"
type: org_group_policy_overrides
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideUpdateRequest"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideUpdateRequest'
required: true
responses:
"200":
@@ -185721,31 +185782,31 @@ paths:
type: org_group_policies
type: org_group_policy_overrides
schema:
- $ref: "#/components/schemas/OrgGroupPolicyOverrideResponse"
+ $ref: '#/components/schemas/OrgGroupPolicyOverrideResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185786,25 +185847,25 @@ paths:
type: org_groups
type: org_group_policy_suggestions
schema:
- $ref: "#/components/schemas/OrgGroupPolicySuggestionListResponse"
+ $ref: '#/components/schemas/OrgGroupPolicySuggestionListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185859,25 +185920,25 @@ paths:
total: 1
type: number_size
schema:
- $ref: "#/components/schemas/OrgGroupListResponse"
+ $ref: '#/components/schemas/OrgGroupListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185905,7 +185966,7 @@ paths:
name: "My Org Group"
type: org_groups
schema:
- $ref: "#/components/schemas/OrgGroupCreateRequest"
+ $ref: '#/components/schemas/OrgGroupCreateRequest'
required: true
responses:
"201":
@@ -185924,31 +185985,31 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
schema:
- $ref: "#/components/schemas/OrgGroupResponse"
+ $ref: '#/components/schemas/OrgGroupResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -185975,25 +186036,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186029,31 +186090,31 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
schema:
- $ref: "#/components/schemas/OrgGroupResponse"
+ $ref: '#/components/schemas/OrgGroupResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186084,7 +186145,7 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
schema:
- $ref: "#/components/schemas/OrgGroupUpdateRequest"
+ $ref: '#/components/schemas/OrgGroupUpdateRequest'
required: true
responses:
"200":
@@ -186103,31 +186164,31 @@ paths:
id: "a1b2c3d4-e5f6-7890-abcd-ef0123456789"
type: org_groups
schema:
- $ref: "#/components/schemas/OrgGroupResponse"
+ $ref: '#/components/schemas/OrgGroupResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186163,19 +186224,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: permissions
schema:
- $ref: "#/components/schemas/PermissionsResponse"
+ $ref: '#/components/schemas/PermissionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186223,19 +186284,19 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/ListPersonalAccessTokensResponse"
+ $ref: '#/components/schemas/ListPersonalAccessTokensResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186266,7 +186327,7 @@ paths:
- dashboards_write
type: personal_access_tokens
schema:
- $ref: "#/components/schemas/PersonalAccessTokenCreateRequest"
+ $ref: '#/components/schemas/PersonalAccessTokenCreateRequest'
required: true
responses:
"201":
@@ -186287,19 +186348,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: personal_access_tokens
schema:
- $ref: "#/components/schemas/PersonalAccessTokenCreateResponse"
+ $ref: '#/components/schemas/PersonalAccessTokenCreateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186325,13 +186386,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186367,19 +186428,19 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: personal_access_tokens
schema:
- $ref: "#/components/schemas/PersonalAccessTokenResponse"
+ $ref: '#/components/schemas/PersonalAccessTokenResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186412,7 +186473,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: personal_access_tokens
schema:
- $ref: "#/components/schemas/PersonalAccessTokenUpdateRequest"
+ $ref: '#/components/schemas/PersonalAccessTokenUpdateRequest'
required: true
responses:
"200":
@@ -186432,25 +186493,25 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: personal_access_tokens
schema:
- $ref: "#/components/schemas/PersonalAccessTokenResponse"
+ $ref: '#/components/schemas/PersonalAccessTokenResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186597,14 +186658,14 @@ paths:
name: filter[evaluation]
required: false
schema:
- $ref: "#/components/schemas/FindingEvaluation"
+ $ref: '#/components/schemas/FindingEvaluation'
- description: Return only findings with the specified status.
example: critical
in: query
name: filter[status]
required: false
schema:
- $ref: "#/components/schemas/FindingStatus"
+ $ref: '#/components/schemas/FindingStatus'
- description: Return findings that match the selected vulnerability types (repeatable).
example:
- misconfiguration
@@ -186614,7 +186675,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/FindingVulnerabilityType"
+ $ref: '#/components/schemas/FindingVulnerabilityType'
type: array
- description: Return additional fields for some findings.
example:
@@ -186645,7 +186706,7 @@ paths:
total_filtered_count: 1
snapshot_timestamp: 1678721573794
schema:
- $ref: "#/components/schemas/ListFindingsResponse"
+ $ref: '#/components/schemas/ListFindingsResponse'
description: OK
"400":
$ref: "#/components/responses/FindingsBadRequestResponse"
@@ -186711,7 +186772,7 @@ paths:
id: abc-123
type: detailed_finding
schema:
- $ref: "#/components/schemas/GetFindingResponse"
+ $ref: '#/components/schemas/GetFindingResponse'
description: OK
"400":
$ref: "#/components/responses/FindingsBadRequestResponse"
@@ -186780,7 +186841,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: powerpack
schema:
- $ref: "#/components/schemas/ListPowerpacksResponse"
+ $ref: '#/components/schemas/ListPowerpacksResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186848,7 +186909,7 @@ paths:
type: users
type: powerpack
schema:
- $ref: "#/components/schemas/Powerpack"
+ $ref: '#/components/schemas/Powerpack'
description: Create a powerpack request body.
required: true
responses:
@@ -186862,13 +186923,13 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: powerpack
schema:
- $ref: "#/components/schemas/PowerpackResponse"
+ $ref: '#/components/schemas/PowerpackResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186904,7 +186965,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Powerpack Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -186960,13 +187021,13 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: powerpack
schema:
- $ref: "#/components/schemas/PowerpackResponse"
+ $ref: '#/components/schemas/PowerpackResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Powerpack Not Found.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -187037,7 +187098,7 @@ paths:
type: users
type: powerpack
schema:
- $ref: "#/components/schemas/Powerpack"
+ $ref: '#/components/schemas/Powerpack'
description: Update a powerpack request body.
required: true
responses:
@@ -187069,19 +187130,19 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: powerpack
schema:
- $ref: "#/components/schemas/PowerpackResponse"
+ $ref: '#/components/schemas/PowerpackResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Powerpack Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -187170,19 +187231,19 @@ paths:
id: abc-123
type: process
schema:
- $ref: "#/components/schemas/ProcessSummariesResponse"
+ $ref: '#/components/schemas/ProcessSummariesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -187295,7 +187356,7 @@ paths:
usr:
id: "123"
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventItem"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventItem'
description: Server-side event to send (JSON format).
required: true
responses:
@@ -187312,49 +187373,49 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Forbidden
"408":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Request Timeout
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Payload Too Large
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Too Many Requests
"500":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Internal Server Error
"503":
content:
application/json:
schema:
- $ref: "#/components/schemas/ProductAnalyticsServerSideEventErrors"
+ $ref: '#/components/schemas/ProductAnalyticsServerSideEventErrors'
description: Service Unavailable
security:
- apiKeyAuth: []
@@ -187420,7 +187481,7 @@ paths:
id: facet_info_request
type: users_facet_info_request
schema:
- $ref: "#/components/schemas/FacetInfoRequest"
+ $ref: '#/components/schemas/FacetInfoRequest'
required: true
responses:
"200":
@@ -187438,7 +187499,7 @@ paths:
id: facet_info_response
type: users_facet_info
schema:
- $ref: "#/components/schemas/FacetInfoResponse"
+ $ref: '#/components/schemas/FacetInfoResponse'
description: Successful response with facet information
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -187481,7 +187542,7 @@ paths:
id: query_account_request
type: query_account_request
schema:
- $ref: "#/components/schemas/QueryAccountRequest"
+ $ref: '#/components/schemas/QueryAccountRequest'
required: true
responses:
"200":
@@ -187501,7 +187562,7 @@ paths:
id: query_response
type: query_response
schema:
- $ref: "#/components/schemas/QueryResponse"
+ $ref: '#/components/schemas/QueryResponse'
description: Successful response with account data
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -187541,7 +187602,7 @@ paths:
to: 1771836848262
type: formula_analytics_extended_list_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListRequest"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListRequest'
required: true
responses:
"200":
@@ -187557,7 +187618,7 @@ paths:
id: abc-123
type: list_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsListResponse"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187602,7 +187663,7 @@ paths:
to: 1771836848262
type: formula_analytics_extended_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequest'
required: true
responses:
"200":
@@ -187617,7 +187678,7 @@ paths:
id: abc-123
type: scalar_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponse"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187660,7 +187721,7 @@ paths:
to: 1771836848262
type: formula_analytics_extended_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsAnalyticsRequest"
+ $ref: '#/components/schemas/ProductAnalyticsAnalyticsRequest'
required: true
responses:
"200":
@@ -187676,7 +187737,7 @@ paths:
id: abc-123
type: timeseries_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponse"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187726,7 +187787,7 @@ paths:
to: 1756857600000
type: journey_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelRequest"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelRequest'
required: true
responses:
"200":
@@ -187755,7 +187816,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: funnel_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyFunnelResponse"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyFunnelResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187809,7 +187870,7 @@ paths:
to: 1756857600000
type: journey_list_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListRequest"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListRequest'
required: true
responses:
"200":
@@ -187829,7 +187890,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: journey_list_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyListResponse"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187882,7 +187943,7 @@ paths:
to: 1756857600000
type: formula_journey_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarRequest"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarRequest'
required: true
responses:
"200":
@@ -187897,7 +187958,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: journey_scalar_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyScalarResponse"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyScalarResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -187950,7 +188011,7 @@ paths:
to: 1756857600000
type: formula_journey_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsFormulaJourneyRequest"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaJourneyRequest'
required: true
responses:
"200":
@@ -187966,7 +188027,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: journey_timeseries_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsJourneyTimeseriesResponse"
+ $ref: '#/components/schemas/ProductAnalyticsJourneyTimeseriesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188028,7 +188089,7 @@ paths:
to: 1756857600000
type: retention_grid_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridRequest"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridRequest'
description: The retention grid query.
required: true
responses:
@@ -188046,7 +188107,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: retention_grid_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsRetentionGridResponse"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionGridResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188110,7 +188171,7 @@ paths:
to: 1756857600000
type: retention_list_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListRequest"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListRequest'
description: The retention list query.
required: true
responses:
@@ -188127,7 +188188,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: retention_list_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsRetentionListResponse"
+ $ref: '#/components/schemas/ProductAnalyticsRetentionListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188187,7 +188248,7 @@ paths:
to: 1756857600000
type: formula_retention_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionRequest"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionRequest'
description: The retention scalar query.
required: true
responses:
@@ -188202,7 +188263,7 @@ paths:
columns: []
type: scalar_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsScalarResponse"
+ $ref: '#/components/schemas/ProductAnalyticsScalarResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188264,7 +188325,7 @@ paths:
to: 1756857600000
type: formula_retention_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsFormulaRetentionRequest"
+ $ref: '#/components/schemas/ProductAnalyticsFormulaRetentionRequest'
description: The retention timeseries query.
required: true
responses:
@@ -188280,7 +188341,7 @@ paths:
times: []
type: timeseries_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponse"
+ $ref: '#/components/schemas/ProductAnalyticsTimeseriesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188326,7 +188387,7 @@ paths:
to: 1756857600000
type: sankey_request
schema:
- $ref: "#/components/schemas/ProductAnalyticsSankeyRequest"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyRequest'
description: The Sankey diagram query.
required: true
responses:
@@ -188343,7 +188404,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: sankey_response
schema:
- $ref: "#/components/schemas/ProductAnalyticsSankeyResponse"
+ $ref: '#/components/schemas/ProductAnalyticsSankeyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -188395,7 +188456,7 @@ paths:
id: query_event_filtered_users_request
type: query_event_filtered_users_request
schema:
- $ref: "#/components/schemas/QueryEventFilteredUsersRequest"
+ $ref: '#/components/schemas/QueryEventFilteredUsersRequest'
required: true
responses:
"200":
@@ -188415,7 +188476,7 @@ paths:
id: query_response
type: query_response
schema:
- $ref: "#/components/schemas/QueryResponse"
+ $ref: '#/components/schemas/QueryResponse'
description: Successful response with filtered user data
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -188449,7 +188510,7 @@ paths:
id: facet_info_request
type: users_facet_info_request
schema:
- $ref: "#/components/schemas/FacetInfoRequest"
+ $ref: '#/components/schemas/FacetInfoRequest'
required: true
responses:
"200":
@@ -188467,7 +188528,7 @@ paths:
id: facet_info_response
type: users_facet_info
schema:
- $ref: "#/components/schemas/FacetInfoResponse"
+ $ref: '#/components/schemas/FacetInfoResponse'
description: Successful response with facet information
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -188510,7 +188571,7 @@ paths:
id: query_users_request
type: query_users_request
schema:
- $ref: "#/components/schemas/QueryUsersRequest"
+ $ref: '#/components/schemas/QueryUsersRequest'
required: true
responses:
"200":
@@ -188528,7 +188589,7 @@ paths:
id: query_response
type: query_response
schema:
- $ref: "#/components/schemas/QueryResponse"
+ $ref: '#/components/schemas/QueryResponse'
description: Successful response with user data
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -188566,7 +188627,7 @@ paths:
id: get_mappings_response
type: get_mappings_response
schema:
- $ref: "#/components/schemas/GetMappingResponse"
+ $ref: '#/components/schemas/GetMappingResponse'
description: Successful response with entity mapping configuration
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -188616,7 +188677,7 @@ paths:
id: crm-integration
type: connection_id
schema:
- $ref: "#/components/schemas/CreateConnectionRequest"
+ $ref: '#/components/schemas/CreateConnectionRequest'
required: true
responses:
"201":
@@ -188671,7 +188732,7 @@ paths:
id: crm-integration
type: connection_id
schema:
- $ref: "#/components/schemas/UpdateConnectionRequest"
+ $ref: '#/components/schemas/UpdateConnectionRequest'
required: true
responses:
"200":
@@ -188745,7 +188806,7 @@ paths:
id: list_connections_response
type: list_connections_response
schema:
- $ref: "#/components/schemas/ListConnectionsResponse"
+ $ref: '#/components/schemas/ListConnectionsResponse'
description: Successful response with list of connections
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -188781,7 +188842,7 @@ paths:
name: version
required: true
schema:
- $ref: "#/components/schemas/ProductCatalogSKUsAPIVersion"
+ $ref: '#/components/schemas/ProductCatalogSKUsAPIVersion'
- description: |-
The date the returned prices, allotments, and pricing tiers are effective as of, in
`YYYY-MM-DD` format. Defaults to the date of the request, and must not be later
@@ -188874,25 +188935,25 @@ paths:
id: LLM-OBSERVABILITY-MIN-SPEND
type: Sku
schema:
- $ref: "#/components/schemas/ProductCatalogSKUsResponse"
+ $ref: '#/components/schemas/ProductCatalogSKUsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request - version is missing or invalid, or as_of_date is malformed or in the future
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden - the caller has neither the billing_read nor the usage_read permission
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found - the requested catalog version is not supported
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -189031,19 +189092,19 @@ paths:
id: "0000000000000000abc1230000000000"
type: pruned_trace
schema:
- $ref: "#/components/schemas/PrunedTraceResponse"
+ $ref: '#/components/schemas/PrunedTraceResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -189051,7 +189112,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Gateway Timeout
security:
- apiKeyAuth: []
@@ -189096,7 +189157,7 @@ paths:
to: 1568923200000
type: scalar_request
schema:
- $ref: "#/components/schemas/ScalarFormulaQueryRequest"
+ $ref: '#/components/schemas/ScalarFormulaQueryRequest'
required: true
responses:
"200":
@@ -189110,7 +189171,7 @@ paths:
columns: []
type: scalar_response
schema:
- $ref: "#/components/schemas/ScalarFormulaQueryResponse"
+ $ref: '#/components/schemas/ScalarFormulaQueryResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189162,7 +189223,7 @@ paths:
to: 1568923200000
type: timeseries_request
schema:
- $ref: "#/components/schemas/TimeseriesFormulaQueryRequest"
+ $ref: '#/components/schemas/TimeseriesFormulaQueryRequest'
required: true
responses:
"200":
@@ -189178,7 +189239,7 @@ paths:
values: []
type: timeseries_response
schema:
- $ref: "#/components/schemas/TimeseriesFormulaQueryResponse"
+ $ref: '#/components/schemas/TimeseriesFormulaQueryResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189230,7 +189291,7 @@ paths:
table_id: 00000000-0000-0000-0000-000000000000
type: reference-tables-batch-rows-query
schema:
- $ref: "#/components/schemas/BatchRowsQueryRequest"
+ $ref: '#/components/schemas/BatchRowsQueryRequest'
required: true
responses:
"200":
@@ -189250,7 +189311,7 @@ paths:
type: row
type: reference-tables-batch-rows-query
schema:
- $ref: "#/components/schemas/BatchRowsQueryResponse"
+ $ref: '#/components/schemas/BatchRowsQueryResponse'
description: Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189264,7 +189325,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -189306,7 +189367,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/ReferenceTableSortType"
+ $ref: '#/components/schemas/ReferenceTableSortType'
- description: Filter by table status.
example: DONE
in: query
@@ -189342,7 +189403,7 @@ paths:
id: abc-123
type: reference_table
schema:
- $ref: "#/components/schemas/TableResultV2Array"
+ $ref: '#/components/schemas/TableResultV2Array'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -189447,7 +189508,7 @@ paths:
- team:ecommerce
type: reference_table
schema:
- $ref: "#/components/schemas/CreateTableRequest"
+ $ref: '#/components/schemas/CreateTableRequest'
required: true
responses:
"201":
@@ -189463,7 +189524,7 @@ paths:
id: abc-123
type: reference_table
schema:
- $ref: "#/components/schemas/TableResultV2"
+ $ref: '#/components/schemas/TableResultV2'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189550,7 +189611,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: reference_table
schema:
- $ref: "#/components/schemas/TableResultV2"
+ $ref: '#/components/schemas/TableResultV2'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -189605,7 +189666,7 @@ paths:
- test_tag
type: reference_table
schema:
- $ref: "#/components/schemas/PatchTableRequest"
+ $ref: '#/components/schemas/PatchTableRequest'
required: true
responses:
"200":
@@ -189645,7 +189706,7 @@ paths:
- id: primary_key_value
type: row
schema:
- $ref: "#/components/schemas/BatchDeleteRowsRequestArray"
+ $ref: '#/components/schemas/BatchDeleteRowsRequestArray'
required: true
responses:
"200":
@@ -189662,7 +189723,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Precondition Failed
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -189670,7 +189731,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -189716,7 +189777,7 @@ paths:
id: row_id_1
type: row
schema:
- $ref: "#/components/schemas/TableRowResourceArray"
+ $ref: '#/components/schemas/TableRowResourceArray'
description: Some or all requested rows were found.
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -189769,7 +189830,7 @@ paths:
id: "primary_key_value"
type: row
schema:
- $ref: "#/components/schemas/BatchUpsertRowsRequestArray"
+ $ref: '#/components/schemas/BatchUpsertRowsRequestArray'
required: true
responses:
"200":
@@ -189786,7 +189847,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Precondition Failed
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -189794,7 +189855,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -189854,7 +189915,7 @@ paths:
next: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjY5NzA0ODkwNDE4ODA3MTAzOTgsInBrIjoiMTAyLjEzMC4xMjcuMTE3In0%3D&page%5Blimit%5D=100"
self: "/api/v2/reference-tables/tables/00000000-0000-0000-0000-000000000000/rows/list?page%5Bcontinuation_token%5D=eyJzaWQiOjEyMzQ1LCJwayI6ImV4YW1wbGVfcGsifQ%3D%3D&page%5Blimit%5D=100"
schema:
- $ref: "#/components/schemas/ListRowsResponse"
+ $ref: '#/components/schemas/ListRowsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189893,7 +189954,7 @@ paths:
table_name: my_products_table
type: upload
schema:
- $ref: "#/components/schemas/CreateUploadRequest"
+ $ref: '#/components/schemas/CreateUploadRequest'
required: true
responses:
"201":
@@ -189909,7 +189970,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: upload
schema:
- $ref: "#/components/schemas/CreateUploadResponse"
+ $ref: '#/components/schemas/CreateUploadResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -189955,7 +190016,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleListResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -189999,7 +190060,7 @@ paths:
type: users.login.success
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleCreateRequest'
description: The definition of the new WAF Custom Rule.
required: true
responses:
@@ -190028,7 +190089,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190096,7 +190157,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190149,7 +190210,7 @@ paths:
type: users.login.success
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleUpdateRequest'
description: New definition of the WAF Custom Rule.
required: true
responses:
@@ -190178,7 +190239,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: custom_rule
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafCustomRuleResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafCustomRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190219,7 +190280,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190267,7 +190328,7 @@ paths:
service: prod
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterCreateRequest'
description: The definition of the new WAF exclusion filter.
required: true
responses:
@@ -190289,7 +190350,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190359,7 +190420,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190409,7 +190470,7 @@ paths:
service: prod
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterUpdateRequest'
description: The exclusion filter to update.
required: true
responses:
@@ -190431,7 +190492,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: exclusion_filter
schema:
- $ref: "#/components/schemas/ApplicationSecurityWafExclusionFilterResponse"
+ $ref: '#/components/schemas/ApplicationSecurityWafExclusionFilterResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190490,7 +190551,7 @@ paths:
meta: {}
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyListResponse"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190527,7 +190588,7 @@ paths:
version: 0
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyCreateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyCreateRequest'
description: The new WAF policy.
required: true
responses:
@@ -190560,7 +190621,7 @@ paths:
added_by_name: CI Account
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyResponse"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190625,7 +190686,7 @@ paths:
added_by_name: CI Account
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyResponse"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190666,7 +190727,7 @@ paths:
version: 0
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyUpdateRequest"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyUpdateRequest'
description: New WAF policy.
required: true
responses:
@@ -190699,7 +190760,7 @@ paths:
added_by_name: CI Account
type: policy
schema:
- $ref: "#/components/schemas/ApplicationSecurityPolicyResponse"
+ $ref: '#/components/schemas/ApplicationSecurityPolicyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190742,7 +190803,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190773,7 +190834,7 @@ paths:
silent: false
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
description: "The definition of the new agent rule"
required: true
responses:
@@ -190792,7 +190853,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190853,7 +190914,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190890,7 +190951,7 @@ paths:
id: 3dd-0uc-h1s
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
description: "New definition of the agent rule"
required: true
responses:
@@ -190909,7 +190970,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -190947,7 +191008,7 @@ paths:
id: abc-123
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPoliciesListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -190977,7 +191038,7 @@ paths:
name: my_agent_policy
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyCreateRequest'
description: "The definition of the new Agent policy"
required: true
responses:
@@ -190995,7 +191056,7 @@ paths:
id: abc-123
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -191082,7 +191143,7 @@ paths:
id: abc-123
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -191116,7 +191177,7 @@ paths:
id: 6517fcc1-cec7-4394-a655-8d6e9d085255
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyUpdateRequest'
description: "New definition of the Agent policy"
required: true
responses:
@@ -191134,7 +191195,7 @@ paths:
id: abc-123
type: policy
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentPolicyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -191187,7 +191248,7 @@ paths:
updated_by: "user@datadoghq.com"
type: rum_sdk_config
schema:
- $ref: "#/components/schemas/RumSdkConfigResponse"
+ $ref: '#/components/schemas/RumSdkConfigResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -191195,7 +191256,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191235,7 +191296,7 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: rum_sdk_config
schema:
- $ref: "#/components/schemas/RumSdkConfigUpdateRequest"
+ $ref: '#/components/schemas/RumSdkConfigUpdateRequest'
description: The RUM SDK configuration update.
required: true
responses:
@@ -191256,13 +191317,13 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: rum_sdk_config
schema:
- $ref: "#/components/schemas/RumSdkConfigResponse"
+ $ref: '#/components/schemas/RumSdkConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -191270,7 +191331,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191329,7 +191390,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: snapshots
schema:
- $ref: "#/components/schemas/SnapshotArray"
+ $ref: '#/components/schemas/SnapshotArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191361,7 +191422,7 @@ paths:
view_name: /home
type: snapshots
schema:
- $ref: "#/components/schemas/SnapshotCreateRequest"
+ $ref: '#/components/schemas/SnapshotCreateRequest'
required: true
responses:
"201":
@@ -191379,7 +191440,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: snapshots
schema:
- $ref: "#/components/schemas/Snapshot"
+ $ref: '#/components/schemas/Snapshot'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191441,7 +191502,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: snapshots
schema:
- $ref: "#/components/schemas/SnapshotUpdateRequest"
+ $ref: '#/components/schemas/SnapshotUpdateRequest'
required: true
responses:
"200":
@@ -191459,7 +191520,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: snapshots
schema:
- $ref: "#/components/schemas/Snapshot"
+ $ref: '#/components/schemas/Snapshot'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191525,25 +191586,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/DatasetReportScheduleListResponse"
+ $ref: '#/components/schemas/DatasetReportScheduleListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191576,7 +191637,7 @@ paths:
timezone: "America/New_York"
type: report
schema:
- $ref: "#/components/schemas/PrintReportRequest"
+ $ref: '#/components/schemas/PrintReportRequest'
required: true
responses:
"200":
@@ -191601,31 +191662,31 @@ paths:
id: "11111111-2222-3333-4444-555555555555"
type: report
schema:
- $ref: "#/components/schemas/PrintReportResponse"
+ $ref: '#/components/schemas/PrintReportResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191668,7 +191729,7 @@ paths:
title: "Weekly Infrastructure Report"
type: schedule
schema:
- $ref: "#/components/schemas/ReportScheduleCreateRequest"
+ $ref: '#/components/schemas/ReportScheduleCreateRequest'
required: true
responses:
"201":
@@ -191712,25 +191773,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleResponse"
+ $ref: '#/components/schemas/ReportScheduleResponse'
description: CREATED
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191865,25 +191926,25 @@ paths:
total: 1
type: offset_limit
schema:
- $ref: "#/components/schemas/ReportScheduleListResponse"
+ $ref: '#/components/schemas/ReportScheduleListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -191904,7 +191965,7 @@ paths:
name: resource_type
required: true
schema:
- $ref: "#/components/schemas/ReportScheduleResourceType"
+ $ref: '#/components/schemas/ReportScheduleResourceType'
- description: The identifier of the resource to fetch report schedules for.
example: "abc-def-ghi"
in: path
@@ -191947,25 +192008,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleListResponse"
+ $ref: '#/components/schemas/ReportScheduleListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192023,25 +192084,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleResponse"
+ $ref: '#/components/schemas/ReportScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192098,25 +192159,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleResponse"
+ $ref: '#/components/schemas/ReportScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192164,7 +192225,7 @@ paths:
title: "Weekly Infrastructure Report"
type: schedule
schema:
- $ref: "#/components/schemas/ReportSchedulePatchRequest"
+ $ref: '#/components/schemas/ReportSchedulePatchRequest'
required: true
responses:
"200":
@@ -192208,25 +192269,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleResponse"
+ $ref: '#/components/schemas/ReportScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192264,7 +192325,7 @@ paths:
status: inactive
type: schedule
schema:
- $ref: "#/components/schemas/ReportScheduleToggleRequest"
+ $ref: '#/components/schemas/ReportScheduleToggleRequest'
required: true
responses:
"200":
@@ -192301,25 +192362,25 @@ paths:
id: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
type: users
schema:
- $ref: "#/components/schemas/ReportScheduleResponse"
+ $ref: '#/components/schemas/ReportScheduleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192375,7 +192436,7 @@ paths:
id: dashboard:abc-def-ghi
type: restriction_policy
schema:
- $ref: "#/components/schemas/RestrictionPolicyResponse"
+ $ref: '#/components/schemas/RestrictionPolicyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -192484,7 +192545,7 @@ paths:
id: dashboard:abc-def-ghi
type: restriction_policy
schema:
- $ref: "#/components/schemas/RestrictionPolicyUpdateRequest"
+ $ref: '#/components/schemas/RestrictionPolicyUpdateRequest'
description: Restriction policy payload
required: true
responses:
@@ -192503,7 +192564,7 @@ paths:
id: dashboard:abc-def-ghi
type: restriction_policy
schema:
- $ref: "#/components/schemas/RestrictionPolicyResponse"
+ $ref: '#/components/schemas/RestrictionPolicyResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -192538,7 +192599,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/RolesSort"
+ $ref: '#/components/schemas/RolesSort'
- description: Filter all roles by the given string.
in: query
name: filter
@@ -192568,13 +192629,13 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/RolesResponse"
+ $ref: '#/components/schemas/RolesResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192619,7 +192680,7 @@ paths:
name: developers
type: roles
schema:
- $ref: "#/components/schemas/RoleCreateRequest"
+ $ref: '#/components/schemas/RoleCreateRequest'
required: true
responses:
"200":
@@ -192634,19 +192695,19 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: roles
schema:
- $ref: "#/components/schemas/RoleCreateResponse"
+ $ref: '#/components/schemas/RoleCreateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192681,7 +192742,7 @@ paths:
id: 00000000-0000-0000-0000-000000000012
type: roles
schema:
- $ref: "#/components/schemas/RoleTemplateArray"
+ $ref: '#/components/schemas/RoleTemplateArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192708,13 +192769,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192746,19 +192807,19 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: roles
schema:
- $ref: "#/components/schemas/RoleResponse"
+ $ref: '#/components/schemas/RoleResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192790,7 +192851,7 @@ paths:
id: 00000000-0000-1111-0000-000000000000
type: roles
schema:
- $ref: "#/components/schemas/RoleUpdateRequest"
+ $ref: '#/components/schemas/RoleUpdateRequest'
required: true
responses:
"200":
@@ -192805,31 +192866,31 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: roles
schema:
- $ref: "#/components/schemas/RoleUpdateResponse"
+ $ref: '#/components/schemas/RoleUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192864,7 +192925,7 @@ paths:
name: cloned-role
type: roles
schema:
- $ref: "#/components/schemas/RoleCloneRequest"
+ $ref: '#/components/schemas/RoleCloneRequest'
required: true
responses:
"200":
@@ -192879,31 +192940,31 @@ paths:
id: 00000000-0000-0000-0000-000000000011
type: roles
schema:
- $ref: "#/components/schemas/RoleResponse"
+ $ref: '#/components/schemas/RoleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -192937,7 +192998,7 @@ paths:
id: 6f66600e-dd12-11e8-9e55-7f30fbb45e73
type: permissions
schema:
- $ref: "#/components/schemas/RelationshipToPermission"
+ $ref: '#/components/schemas/RelationshipToPermission'
required: true
responses:
"200":
@@ -192952,25 +193013,25 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: permissions
schema:
- $ref: "#/components/schemas/PermissionsResponse"
+ $ref: '#/components/schemas/PermissionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193006,19 +193067,19 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: permissions
schema:
- $ref: "#/components/schemas/PermissionsResponse"
+ $ref: '#/components/schemas/PermissionsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193047,7 +193108,7 @@ paths:
id: 6f66600e-dd12-11e8-9e55-7f30fbb45e73
type: permissions
schema:
- $ref: "#/components/schemas/RelationshipToPermission"
+ $ref: '#/components/schemas/RelationshipToPermission'
required: true
responses:
"200":
@@ -193062,25 +193123,25 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: permissions
schema:
- $ref: "#/components/schemas/PermissionsResponse"
+ $ref: '#/components/schemas/PermissionsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193114,7 +193175,7 @@ paths:
id: 00000000-0000-0000-2345-000000000000
type: users
schema:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
required: true
responses:
"200":
@@ -193130,25 +193191,25 @@ paths:
id: 00000000-0000-0000-0000-000000000010
type: users
schema:
- $ref: "#/components/schemas/UsersResponse"
+ $ref: '#/components/schemas/UsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193203,19 +193264,19 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: users
schema:
- $ref: "#/components/schemas/UsersResponse"
+ $ref: '#/components/schemas/UsersResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193243,7 +193304,7 @@ paths:
id: 00000000-0000-0000-2345-000000000000
type: users
schema:
- $ref: "#/components/schemas/RelationshipToUser"
+ $ref: '#/components/schemas/RelationshipToUser'
required: true
responses:
"200":
@@ -193259,25 +193320,25 @@ paths:
id: 00000000-0000-0000-0000-000000000009
type: users
schema:
- $ref: "#/components/schemas/UsersResponse"
+ $ref: '#/components/schemas/UsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -193330,7 +193391,7 @@ paths:
cursor: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
limit: 25
schema:
- $ref: "#/components/schemas/RUMAggregateRequest"
+ $ref: '#/components/schemas/RUMAggregateRequest'
required: true
responses:
"200":
@@ -193351,7 +193412,7 @@ paths:
request_id: abc-123
status: done
schema:
- $ref: "#/components/schemas/RUMAnalyticsAggregateResponse"
+ $ref: '#/components/schemas/RUMAnalyticsAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193391,7 +193452,7 @@ paths:
id: abc-123
type: rum_application
schema:
- $ref: "#/components/schemas/RUMApplicationsResponse"
+ $ref: '#/components/schemas/RUMApplicationsResponse'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -193421,7 +193482,7 @@ paths:
type: browser
type: rum_application_create
schema:
- $ref: "#/components/schemas/RUMApplicationCreateRequest"
+ $ref: '#/components/schemas/RUMApplicationCreateRequest'
required: true
responses:
"200":
@@ -193444,7 +193505,7 @@ paths:
id: abc-123
type: rum_application
schema:
- $ref: "#/components/schemas/RUMApplicationResponse"
+ $ref: '#/components/schemas/RUMApplicationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193476,7 +193537,7 @@ paths:
- id: 051601eb-54a0-abc0-03f9-cc02efa18892
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFiltersOrderRequest"
+ $ref: '#/components/schemas/RumRetentionFiltersOrderRequest'
description: New definition of the RUM retention filter.
required: true
responses:
@@ -193490,7 +193551,7 @@ paths:
- id: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFiltersOrderResponse"
+ $ref: '#/components/schemas/RumRetentionFiltersOrderResponse'
description: Ordered
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193529,7 +193590,7 @@ paths:
id: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFiltersResponse"
+ $ref: '#/components/schemas/RumRetentionFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -193564,7 +193625,7 @@ paths:
sample_rate: 50.5
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFilterCreateRequest"
+ $ref: '#/components/schemas/RumRetentionFilterCreateRequest'
description: The definition of the new RUM retention filter.
required: true
responses:
@@ -193584,7 +193645,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFilterResponse"
+ $ref: '#/components/schemas/RumRetentionFilterResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193634,7 +193695,7 @@ paths:
updated_by_handle: jane.doe@example.com
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFiltersResponse"
+ $ref: '#/components/schemas/RumExclusionFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -193668,7 +193729,7 @@ paths:
query: "@error.message:*extension*"
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFilterCreateRequest"
+ $ref: '#/components/schemas/RumExclusionFilterCreateRequest'
description: The definition of the new RUM exclusion filter.
required: true
responses:
@@ -193691,7 +193752,7 @@ paths:
updated_by_handle: jane.doe@example.com
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFilterResponse"
+ $ref: '#/components/schemas/RumExclusionFilterResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193761,7 +193822,7 @@ paths:
updated_by_handle: jane.doe@example.com
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFilterResponse"
+ $ref: '#/components/schemas/RumExclusionFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -193801,7 +193862,7 @@ paths:
id: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFilterUpdateRequest"
+ $ref: '#/components/schemas/RumExclusionFilterUpdateRequest'
description: New definition of the RUM exclusion filter.
required: true
responses:
@@ -193824,7 +193885,7 @@ paths:
updated_by_handle: jane.doe@example.com
type: exclusion_filters
schema:
- $ref: "#/components/schemas/RumExclusionFilterResponse"
+ $ref: '#/components/schemas/RumExclusionFilterResponse'
description: Updated
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -193892,7 +193953,7 @@ paths:
id: rum_apm_flat_sampling
type: permanent_retention_filters
schema:
- $ref: "#/components/schemas/RumPermanentRetentionFiltersResponse"
+ $ref: '#/components/schemas/RumPermanentRetentionFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -193928,7 +193989,7 @@ paths:
id: synthetics_sessions
type: permanent_retention_filters
schema:
- $ref: "#/components/schemas/RumPermanentRetentionFilterResponse"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -193963,7 +194024,7 @@ paths:
id: synthetics_sessions
type: permanent_retention_filters
schema:
- $ref: "#/components/schemas/RumPermanentRetentionFilterUpdateRequest"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterUpdateRequest'
description: New configuration of the permanent RUM retention filter.
required: true
responses:
@@ -193985,7 +194046,7 @@ paths:
id: synthetics_sessions
type: permanent_retention_filters
schema:
- $ref: "#/components/schemas/RumPermanentRetentionFilterResponse"
+ $ref: '#/components/schemas/RumPermanentRetentionFilterResponse'
description: Updated
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194046,7 +194107,7 @@ paths:
id: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFilterResponse"
+ $ref: '#/components/schemas/RumRetentionFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -194085,7 +194146,7 @@ paths:
id: 051601eb-54a0-abc0-03f9-cc02efa18892
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFilterUpdateRequest"
+ $ref: '#/components/schemas/RumRetentionFilterUpdateRequest'
description: New definition of the RUM retention filter.
required: true
responses:
@@ -194108,7 +194169,7 @@ paths:
id: "051601eb-54a0-abc0-03f9-cc02efa18892"
type: retention_filters
schema:
- $ref: "#/components/schemas/RumRetentionFilterResponse"
+ $ref: '#/components/schemas/RumRetentionFilterResponse'
description: Updated
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194179,7 +194240,7 @@ paths:
id: abc-123
type: rum_application
schema:
- $ref: "#/components/schemas/RUMApplicationResponse"
+ $ref: '#/components/schemas/RUMApplicationResponse'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -194217,7 +194278,7 @@ paths:
id: abcd1234-0000-0000-abcd-1234abcd5678
type: rum_application_update
schema:
- $ref: "#/components/schemas/RUMApplicationUpdateRequest"
+ $ref: '#/components/schemas/RUMApplicationUpdateRequest'
required: true
responses:
"200":
@@ -194240,7 +194301,7 @@ paths:
id: abc-123
type: rum_application
schema:
- $ref: "#/components/schemas/RUMApplicationResponse"
+ $ref: '#/components/schemas/RUMApplicationResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194250,7 +194311,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -194287,7 +194348,7 @@ paths:
id: "1234"
type: rum_config
schema:
- $ref: "#/components/schemas/RumConfigResponse"
+ $ref: '#/components/schemas/RumConfigResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -194316,7 +194377,7 @@ paths:
enforced_application_tags: false
type: rum_config
schema:
- $ref: "#/components/schemas/RumConfigUpdateRequest"
+ $ref: '#/components/schemas/RumConfigUpdateRequest'
description: New definition of the RUM configuration.
required: true
responses:
@@ -194340,7 +194401,7 @@ paths:
id: "1234"
type: rum_config
schema:
- $ref: "#/components/schemas/RumConfigResponse"
+ $ref: '#/components/schemas/RumConfigResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194372,7 +194433,7 @@ paths:
enforced_application_tags: true
type: rum_config
schema:
- $ref: "#/components/schemas/RumConfigCreateRequest"
+ $ref: '#/components/schemas/RumConfigCreateRequest'
description: The definition of the RUM configuration to create.
required: true
responses:
@@ -194396,7 +194457,7 @@ paths:
id: "1234"
type: rum_config
schema:
- $ref: "#/components/schemas/RumConfigResponse"
+ $ref: '#/components/schemas/RumConfigResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194440,7 +194501,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricsResponse"
+ $ref: '#/components/schemas/RumMetricsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -194478,7 +194539,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricCreateRequest"
+ $ref: '#/components/schemas/RumMetricCreateRequest'
description: The definition of the new RUM-based metric.
required: true
responses:
@@ -194505,7 +194566,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricResponse"
+ $ref: '#/components/schemas/RumMetricResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194568,7 +194629,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricResponse"
+ $ref: '#/components/schemas/RumMetricResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -194605,7 +194666,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricUpdateRequest"
+ $ref: '#/components/schemas/RumMetricUpdateRequest'
description: New definition of the RUM-based metric.
required: true
responses:
@@ -194632,7 +194693,7 @@ paths:
id: rum.sessions.web.count
type: rum_metrics
schema:
- $ref: "#/components/schemas/RumMetricResponse"
+ $ref: '#/components/schemas/RumMetricResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194663,25 +194724,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -194721,31 +194782,31 @@ paths:
id: cd73a516-a481-4af5-8352-9b577465c77b
type: rum_quota_config
schema:
- $ref: "#/components/schemas/RumRetentionQuotaConfigResponse"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -194783,7 +194844,7 @@ paths:
id: cd73a516-a481-4af5-8352-9b577465c77b
type: rum_quota_config
schema:
- $ref: "#/components/schemas/RumRetentionQuotaConfigUpdateRequest"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigUpdateRequest'
description: The definition of the RUM retention quota configuration to create or update.
required: true
responses:
@@ -194808,31 +194869,31 @@ paths:
id: cd73a516-a481-4af5-8352-9b577465c77b
type: rum_quota_config
schema:
- $ref: "#/components/schemas/RumRetentionQuotaConfigResponse"
+ $ref: '#/components/schemas/RumRetentionQuotaConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -194874,7 +194935,7 @@ paths:
id: "123"
type: teams_ownership_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingsResponse"
+ $ref: '#/components/schemas/TeamsOwnershipMappingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194909,7 +194970,7 @@ paths:
view_name: "/checkout"
type: teams_ownership_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingCreateRequest"
+ $ref: '#/components/schemas/TeamsOwnershipMappingCreateRequest'
description: The definition of the teams ownership mapping to create.
required: true
responses:
@@ -194932,7 +194993,7 @@ paths:
id: "123"
type: teams_ownership_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingResponse"
+ $ref: '#/components/schemas/TeamsOwnershipMappingResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -194978,7 +195039,7 @@ paths:
id: "456"
type: teams_ownership_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchRequest"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchRequest'
description: The list of add and remove operations to apply atomically.
required: true
responses:
@@ -195003,7 +195064,7 @@ paths:
type: teams_ownership_mappings
- {}
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingBatchResponse"
+ $ref: '#/components/schemas/TeamsOwnershipMappingBatchResponse'
description: OK
"400":
content:
@@ -195016,7 +195077,7 @@ paths:
status: "400"
title: "Bad Request"
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: |-
Bad Request. One or more operations failed validation, so none of the operations were applied.
Errors are returned in the JSON:API atomic operations error format rather than the standard error response.
@@ -195026,13 +195087,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found. One or more mappings requested for removal do not exist.
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict. One or more mappings requested for creation already exist.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195091,7 +195152,7 @@ paths:
id: "123"
type: teams_ownership_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipMappingResponse"
+ $ref: '#/components/schemas/TeamsOwnershipMappingResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -195137,7 +195198,7 @@ paths:
id: "3b1e2f7a9c4d6e8f0a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f"
type: teams_ownership_grouped_mappings
schema:
- $ref: "#/components/schemas/TeamsOwnershipRulesResponse"
+ $ref: '#/components/schemas/TeamsOwnershipRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -195191,7 +195252,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/RUMSort"
+ $ref: '#/components/schemas/RUMSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -195224,7 +195285,7 @@ paths:
id: abc-123
type: rum
schema:
- $ref: "#/components/schemas/RUMEventsResponse"
+ $ref: '#/components/schemas/RUMEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -195271,7 +195332,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/RUMSearchEventsRequest"
+ $ref: '#/components/schemas/RUMSearchEventsRequest'
required: true
responses:
"200":
@@ -195291,7 +195352,7 @@ paths:
request_id: abc-123
status: done
schema:
- $ref: "#/components/schemas/RUMEventsResponse"
+ $ref: '#/components/schemas/RUMEventsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -195320,7 +195381,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/RUMOperationCreateRequest"
+ $ref: '#/components/schemas/RUMOperationCreateRequest'
required: true
responses:
"200":
@@ -195362,19 +195423,19 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: operations
schema:
- $ref: "#/components/schemas/RUMOperationResponse"
+ $ref: '#/components/schemas/RUMOperationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict. An operation with this name already exists.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195436,19 +195497,19 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: operations
schema:
- $ref: "#/components/schemas/RUMOperationResponse"
+ $ref: '#/components/schemas/RUMOperationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195568,13 +195629,13 @@ paths:
total: 1
type: offset
schema:
- $ref: "#/components/schemas/RUMOperationsListResponse"
+ $ref: '#/components/schemas/RUMOperationsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195648,13 +195709,13 @@ paths:
offset: 0
total: 1
schema:
- $ref: "#/components/schemas/RUMOperationStrongLinksListResponse"
+ $ref: '#/components/schemas/RUMOperationStrongLinksListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195672,7 +195733,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/RUMOperationStrongLinkCreateRequest"
+ $ref: '#/components/schemas/RUMOperationStrongLinkCreateRequest'
required: true
responses:
"201":
@@ -195694,25 +195755,25 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890:feature-123"
type: strong_links
schema:
- $ref: "#/components/schemas/RUMOperationStrongLinkResponse"
+ $ref: '#/components/schemas/RUMOperationStrongLinkResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found. The referenced `operation_id` does not exist.
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict. A strong link between this operation and feature already exists.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195747,7 +195808,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195778,7 +195839,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/RUMOperationStrongLinkUpdateRequest"
+ $ref: '#/components/schemas/RUMOperationStrongLinkUpdateRequest'
required: true
responses:
"200":
@@ -195800,19 +195861,19 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890:feature-123"
type: strong_links
schema:
- $ref: "#/components/schemas/RUMOperationStrongLinkResponse"
+ $ref: '#/components/schemas/RUMOperationStrongLinkResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195841,7 +195902,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195902,13 +195963,13 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: operations
schema:
- $ref: "#/components/schemas/RUMOperationResponse"
+ $ref: '#/components/schemas/RUMOperationResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -195935,7 +195996,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/RUMOperationUpdateRequest"
+ $ref: '#/components/schemas/RUMOperationUpdateRequest'
required: true
responses:
"200":
@@ -195981,25 +196042,25 @@ paths:
id: "abc12345-1234-5678-abcd-ef1234567890"
type: operations
schema:
- $ref: "#/components/schemas/RUMOperationResponse"
+ $ref: '#/components/schemas/RUMOperationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict. An operation with this name already exists.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196030,7 +196091,7 @@ paths:
view_name: /account/login(/:type)
type: aggregated_long_tasks
schema:
- $ref: "#/components/schemas/AggregatedLongTasksRequest"
+ $ref: '#/components/schemas/AggregatedLongTasksRequest'
required: true
responses:
"201":
@@ -196074,19 +196135,19 @@ paths:
id: 2f0b3455
type: aggregated_long_tasks
schema:
- $ref: "#/components/schemas/AggregatedLongTasksResponse"
+ $ref: '#/components/schemas/AggregatedLongTasksResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196120,7 +196181,7 @@ paths:
view_name: /account/login(/:type)
type: aggregated_signals_problems
schema:
- $ref: "#/components/schemas/AggregatedSignalsProblemsRequest"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsRequest'
required: true
responses:
"201":
@@ -196157,19 +196218,19 @@ paths:
id: 2f0b3455
type: aggregated_signals_problems
schema:
- $ref: "#/components/schemas/AggregatedSignalsProblemsResponse"
+ $ref: '#/components/schemas/AggregatedSignalsProblemsResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196206,7 +196267,7 @@ paths:
view_name: /account/login(/:type)
type: aggregated_waterfall
schema:
- $ref: "#/components/schemas/AggregatedWaterfallRequest"
+ $ref: '#/components/schemas/AggregatedWaterfallRequest'
required: true
responses:
"201":
@@ -196255,19 +196316,19 @@ paths:
id: 2f0b3455
type: aggregated_waterfall
schema:
- $ref: "#/components/schemas/AggregatedWaterfallResponse"
+ $ref: '#/components/schemas/AggregatedWaterfallResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196325,7 +196386,7 @@ paths:
id: "123"
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/PlaylistArray"
+ $ref: '#/components/schemas/PlaylistArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196355,7 +196416,7 @@ paths:
name: My Playlist
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/Playlist"
+ $ref: '#/components/schemas/Playlist'
required: true
responses:
"201":
@@ -196370,7 +196431,7 @@ paths:
id: "123"
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/Playlist"
+ $ref: '#/components/schemas/Playlist'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196433,7 +196494,7 @@ paths:
id: "123"
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/Playlist"
+ $ref: '#/components/schemas/Playlist'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196472,7 +196533,7 @@ paths:
name: My Playlist
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/Playlist"
+ $ref: '#/components/schemas/Playlist'
required: true
responses:
"200":
@@ -196487,7 +196548,7 @@ paths:
id: "123"
type: rum_replay_playlist
schema:
- $ref: "#/components/schemas/Playlist"
+ $ref: '#/components/schemas/Playlist'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196522,7 +196583,7 @@ paths:
- id: 00000000-0000-0000-0000-000000000001
type: rum_replay_session
schema:
- $ref: "#/components/schemas/SessionIdArray"
+ $ref: '#/components/schemas/SessionIdArray'
required: true
responses:
"204":
@@ -196576,7 +196637,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: rum_replay_session
schema:
- $ref: "#/components/schemas/PlaylistsSessionArray"
+ $ref: '#/components/schemas/PlaylistsSessionArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196667,7 +196728,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: rum_replay_session
schema:
- $ref: "#/components/schemas/PlaylistsSession"
+ $ref: '#/components/schemas/PlaylistsSession'
description: OK
"201":
content:
@@ -196681,7 +196742,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: rum_replay_session
schema:
- $ref: "#/components/schemas/PlaylistsSession"
+ $ref: '#/components/schemas/PlaylistsSession'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196792,7 +196853,7 @@ paths:
id: abc-123
type: rum_replay_watcher
schema:
- $ref: "#/components/schemas/WatcherArray"
+ $ref: '#/components/schemas/WatcherArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196853,7 +196914,7 @@ paths:
timestamp: "2026-01-13T17:15:53.208340Z"
type: rum_replay_watch
schema:
- $ref: "#/components/schemas/Watch"
+ $ref: '#/components/schemas/Watch'
required: true
responses:
"201":
@@ -196870,7 +196931,7 @@ paths:
id: abc-123
type: rum_replay_watch
schema:
- $ref: "#/components/schemas/Watch"
+ $ref: '#/components/schemas/Watch'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196946,7 +197007,7 @@ paths:
id: abc-123
type: rum_replay_session
schema:
- $ref: "#/components/schemas/ViewershipHistorySessionArray"
+ $ref: '#/components/schemas/ViewershipHistorySessionArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -196992,13 +197053,13 @@ paths:
id: 8dd1cf3c-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/SAMLConfigurationsResponse"
+ $ref: '#/components/schemas/SAMLConfigurationsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -197024,7 +197085,7 @@ paths:
default:
value: {}
schema:
- $ref: "#/components/schemas/IdPMetadataFormData"
+ $ref: '#/components/schemas/IdPMetadataFormData'
required: true
responses:
"200":
@@ -197033,13 +197094,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -197088,19 +197149,19 @@ paths:
id: 8dd1cf3c-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/SAMLConfigurationResponse"
+ $ref: '#/components/schemas/SAMLConfigurationResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -197141,7 +197202,7 @@ paths:
type: roles
type: saml_configurations
schema:
- $ref: "#/components/schemas/SAMLConfigurationUpdateRequest"
+ $ref: '#/components/schemas/SAMLConfigurationUpdateRequest'
required: true
responses:
"200":
@@ -197173,31 +197234,31 @@ paths:
id: 8dd1cf3c-0c75-11ea-ad28-fb5701eabc7d
type: roles
schema:
- $ref: "#/components/schemas/SAMLConfigurationResponse"
+ $ref: '#/components/schemas/SAMLConfigurationResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -197265,7 +197326,7 @@ paths:
startIndex: 1
totalResults: 1
schema:
- $ref: "#/components/schemas/ListExternalUserGroupResponse"
+ $ref: '#/components/schemas/ListExternalUserGroupResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197321,7 +197382,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
required: true
responses:
"201":
@@ -197335,7 +197396,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197405,7 +197466,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197479,7 +197540,7 @@ paths:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
schema:
- $ref: "#/components/schemas/ExternalUserGroupPatchRequest"
+ $ref: '#/components/schemas/ExternalUserGroupPatchRequest'
required: true
responses:
"200":
@@ -197493,7 +197554,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197559,7 +197620,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
required: true
responses:
"200":
@@ -197573,7 +197634,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
schema:
- $ref: "#/components/schemas/ExternalUserGroup"
+ $ref: '#/components/schemas/ExternalUserGroup'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197631,7 +197692,7 @@ paths:
startIndex: 1
totalResults: 2
schema:
- $ref: "#/components/schemas/ListSCIMResourceTypesResponse"
+ $ref: '#/components/schemas/ListSCIMResourceTypesResponse'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -197677,7 +197738,7 @@ paths:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:ResourceType
schema:
- $ref: "#/components/schemas/SCIMResourceType"
+ $ref: '#/components/schemas/SCIMResourceType'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -197725,7 +197786,7 @@ paths:
startIndex: 1
totalResults: 2
schema:
- $ref: "#/components/schemas/ListSCIMSchemasResponse"
+ $ref: '#/components/schemas/ListSCIMSchemasResponse'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -197810,7 +197871,7 @@ paths:
resourceType: Schema
name: User
schema:
- $ref: "#/components/schemas/SCIMSchema"
+ $ref: '#/components/schemas/SCIMSchema'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -197891,7 +197952,7 @@ paths:
startIndex: 1
totalResults: 1
schema:
- $ref: "#/components/schemas/ListExternalUsersResponse"
+ $ref: '#/components/schemas/ListExternalUsersResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -197947,7 +198008,7 @@ paths:
title: Mr.
userName: john.doe@datadoghq.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
required: true
responses:
"201":
@@ -197971,7 +198032,7 @@ paths:
- urn:ietf:params:scim:schemas:core:2.0:User
userName: test@example.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -198052,7 +198113,7 @@ paths:
- urn:ietf:params:scim:schemas:core:2.0:User
userName: test@example.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -198117,7 +198178,7 @@ paths:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
schema:
- $ref: "#/components/schemas/ExternalUserPatchRequest"
+ $ref: '#/components/schemas/ExternalUserPatchRequest'
required: true
responses:
"200":
@@ -198141,7 +198202,7 @@ paths:
- urn:ietf:params:scim:schemas:core:2.0:User
userName: test@example.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -198210,7 +198271,7 @@ paths:
title: Mr.
userName: john.doe@datadoghq.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
required: true
responses:
"200":
@@ -198234,7 +198295,7 @@ paths:
- urn:ietf:params:scim:schemas:core:2.0:User
userName: test@example.com
schema:
- $ref: "#/components/schemas/ExternalUser"
+ $ref: '#/components/schemas/ExternalUser'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -198331,19 +198392,19 @@ paths:
offset: 0
total: 1
schema:
- $ref: "#/components/schemas/ListCampaignsResponse"
+ $ref: '#/components/schemas/ListCampaignsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -198382,7 +198443,7 @@ paths:
status: in_progress
type: campaign
schema:
- $ref: "#/components/schemas/CreateCampaignRequest"
+ $ref: '#/components/schemas/CreateCampaignRequest'
description: Campaign data.
required: true
responses:
@@ -198409,19 +198470,19 @@ paths:
type: rule
type: campaign
schema:
- $ref: "#/components/schemas/CampaignResponse"
+ $ref: '#/components/schemas/CampaignResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -198454,19 +198515,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -198549,25 +198610,25 @@ paths:
id: c2b79b87-327c-40fa-b726-228f1a60bbb4
type: score
schema:
- $ref: "#/components/schemas/CampaignResponse"
+ $ref: '#/components/schemas/CampaignResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -198614,7 +198675,7 @@ paths:
status: in_progress
type: campaign
schema:
- $ref: "#/components/schemas/UpdateCampaignRequest"
+ $ref: '#/components/schemas/UpdateCampaignRequest'
description: Campaign data.
required: true
responses:
@@ -198644,25 +198705,25 @@ paths:
type: rule
type: campaign
schema:
- $ref: "#/components/schemas/CampaignResponse"
+ $ref: '#/components/schemas/CampaignResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -198763,7 +198824,7 @@ paths:
links:
next: /api/v2/scorecard/outcomes?page%5Blimit%5D=100&page%5Boffset%5D=100
schema:
- $ref: "#/components/schemas/OutcomesResponse"
+ $ref: '#/components/schemas/OutcomesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -198802,7 +198863,7 @@ paths:
state: pass
type: batched-outcome
schema:
- $ref: "#/components/schemas/UpdateOutcomesAsyncRequest"
+ $ref: '#/components/schemas/UpdateOutcomesAsyncRequest'
description: Set of scorecard outcomes.
required: true
responses:
@@ -198846,7 +198907,7 @@ paths:
state: pass
type: batched-outcome
schema:
- $ref: "#/components/schemas/OutcomesBatchRequest"
+ $ref: '#/components/schemas/OutcomesBatchRequest'
description: Set of scorecard outcomes.
required: true
responses:
@@ -198873,7 +198934,7 @@ paths:
total_received: 1
total_staged: 1
schema:
- $ref: "#/components/schemas/OutcomesBatchResponse"
+ $ref: '#/components/schemas/OutcomesBatchResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -198991,7 +199052,7 @@ paths:
links:
next: /api/v2/scorecard/rules?include=scorecard&page%5Blimit%5D=100&page%5Boffset%5D=100
schema:
- $ref: "#/components/schemas/ListRulesResponse"
+ $ref: '#/components/schemas/ListRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199029,7 +199090,7 @@ paths:
scorecard_name: My Scorecard
type: rule
schema:
- $ref: "#/components/schemas/CreateRuleRequest"
+ $ref: '#/components/schemas/CreateRuleRequest'
description: Rule attributes.
required: true
responses:
@@ -199057,7 +199118,7 @@ paths:
type: scorecard
type: rule
schema:
- $ref: "#/components/schemas/CreateRuleResponse"
+ $ref: '#/components/schemas/CreateRuleResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199122,7 +199183,7 @@ paths:
scorecard_name: Updated Scorecard
type: rule
schema:
- $ref: "#/components/schemas/UpdateRuleRequest"
+ $ref: '#/components/schemas/UpdateRuleRequest'
description: Rule attributes.
required: true
responses:
@@ -199157,7 +199218,7 @@ paths:
type: scorecard
type: rule
schema:
- $ref: "#/components/schemas/UpdateRuleResponse"
+ $ref: '#/components/schemas/UpdateRuleResponse'
description: Rule updated successfully
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199235,13 +199296,13 @@ paths:
id: q8MQxk8TCqrHnWkx
type: scorecard
schema:
- $ref: "#/components/schemas/ListScorecardsResponse"
+ $ref: '#/components/schemas/ListScorecardsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199264,7 +199325,7 @@ paths:
name: aggregation
required: true
schema:
- $ref: "#/components/schemas/ScorecardScoresAggregation"
+ $ref: '#/components/schemas/ScorecardScoresAggregation'
- description: Filter scores by rule ID(s), comma-separated.
in: query
name: filter[rule][id]
@@ -199355,7 +199416,7 @@ paths:
offset: 0
total: 42
schema:
- $ref: "#/components/schemas/ListScorecardScoresResponse"
+ $ref: '#/components/schemas/ListScorecardScoresResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199390,7 +199451,7 @@ paths:
- 626a4e8e-64bd-409d-b80e-428f08ac0b62
type: seat-assignments
schema:
- $ref: "#/components/schemas/UnassignSeatsUserRequest"
+ $ref: '#/components/schemas/UnassignSeatsUserRequest'
required: true
responses:
"204":
@@ -199401,7 +199462,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199454,7 +199515,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: seat-users
schema:
- $ref: "#/components/schemas/SeatUserDataArray"
+ $ref: '#/components/schemas/SeatUserDataArray'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199462,7 +199523,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199493,7 +199554,7 @@ paths:
- ""
type: seat-assignments
schema:
- $ref: "#/components/schemas/AssignSeatsUserRequest"
+ $ref: '#/components/schemas/AssignSeatsUserRequest'
required: true
responses:
"201":
@@ -199510,7 +199571,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: seat-assignments
schema:
- $ref: "#/components/schemas/AssignSeatsUserResponse"
+ $ref: '#/components/schemas/AssignSeatsUserResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -199518,7 +199579,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199661,25 +199722,25 @@ paths:
queryId: "abc123def456"
totalRowCount: 1
schema:
- $ref: "#/components/schemas/SecurityEntityRiskScoresResponse"
+ $ref: '#/components/schemas/SecurityEntityRiskScoresResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199750,31 +199811,31 @@ paths:
id: "arn:aws:iam::123456789012:user/test-user"
type: SecurityEntityRiskScore
schema:
- $ref: "#/components/schemas/SecurityEntityRiskScoreResponse"
+ $ref: '#/components/schemas/SecurityEntityRiskScoreResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -199848,7 +199909,7 @@ paths:
meta:
num_services_with_appsec: 1
schema:
- $ref: "#/components/schemas/ApplicationSecurityServicesResponse"
+ $ref: '#/components/schemas/ApplicationSecurityServicesResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -199941,7 +200002,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/SecurityFindingsSort"
+ $ref: '#/components/schemas/SecurityFindingsSort'
responses:
"200":
content:
@@ -199963,7 +200024,7 @@ paths:
elapsed: 548
status: done
schema:
- $ref: "#/components/schemas/ListSecurityFindingsResponse"
+ $ref: '#/components/schemas/ListSecurityFindingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -200014,7 +200075,7 @@ paths:
type: "findings"
type: "assignee"
schema:
- $ref: "#/components/schemas/AssigneeRequest"
+ $ref: '#/components/schemas/AssigneeRequest'
required: true
responses:
"202":
@@ -200029,7 +200090,7 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: "assignee"
schema:
- $ref: "#/components/schemas/AssigneeResponse"
+ $ref: '#/components/schemas/AssigneeResponse'
description: Accepted
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -200121,7 +200182,7 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/DueDateRulesResponse"
+ $ref: '#/components/schemas/DueDateRulesResponse'
description: Successfully retrieved the list of due date rules
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200167,7 +200228,7 @@ paths:
query: "env:prod"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleCreateRequest"
+ $ref: '#/components/schemas/DueDateRuleCreateRequest'
required: true
responses:
"201":
@@ -200204,13 +200265,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleResponse"
+ $ref: '#/components/schemas/DueDateRuleResponse'
description: Successfully created the due date rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200218,7 +200279,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -200253,7 +200314,7 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleReorderRequest"
+ $ref: '#/components/schemas/DueDateRuleReorderRequest'
required: true
responses:
"200":
@@ -200268,13 +200329,13 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleReorderRequest"
+ $ref: '#/components/schemas/DueDateRuleReorderRequest'
description: Successfully reordered the due date rules
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200282,7 +200343,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -200384,7 +200445,7 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleResponse"
+ $ref: '#/components/schemas/DueDateRuleResponse'
description: Successfully retrieved the due date rule
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200443,7 +200504,7 @@ paths:
query: "env:prod"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleUpdateRequest"
+ $ref: '#/components/schemas/DueDateRuleUpdateRequest'
required: true
responses:
"200":
@@ -200482,13 +200543,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: due_date_rules
schema:
- $ref: "#/components/schemas/DueDateRuleResponse"
+ $ref: '#/components/schemas/DueDateRuleResponse'
description: Successfully updated the due date rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200498,7 +200559,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -200581,7 +200642,7 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/MuteRulesResponse"
+ $ref: '#/components/schemas/MuteRulesResponse'
description: Successfully retrieved the list of mute rules
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200624,7 +200685,7 @@ paths:
query: "env:dev team:platform @severity:low"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleCreateRequest"
+ $ref: '#/components/schemas/MuteRuleCreateRequest'
required: true
responses:
"201":
@@ -200658,13 +200719,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleResponse"
+ $ref: '#/components/schemas/MuteRuleResponse'
description: Successfully created the mute rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200672,7 +200733,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -200707,7 +200768,7 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleReorderRequest"
+ $ref: '#/components/schemas/MuteRuleReorderRequest'
required: true
responses:
"200":
@@ -200722,13 +200783,13 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleReorderRequest"
+ $ref: '#/components/schemas/MuteRuleReorderRequest'
description: Successfully reordered the mute rules
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200736,7 +200797,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -200835,7 +200896,7 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleResponse"
+ $ref: '#/components/schemas/MuteRuleResponse'
description: Successfully retrieved the mute rule
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200887,7 +200948,7 @@ paths:
query: "env:dev"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleUpdateRequest"
+ $ref: '#/components/schemas/MuteRuleUpdateRequest'
required: true
responses:
"200":
@@ -200919,13 +200980,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: mute_rules
schema:
- $ref: "#/components/schemas/MuteRuleResponse"
+ $ref: '#/components/schemas/MuteRuleResponse'
description: Successfully updated the mute rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -200935,7 +200996,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201018,7 +201079,7 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/SeverityModifierRulesResponse"
+ $ref: '#/components/schemas/SeverityModifierRulesResponse'
description: Successfully retrieved the list of severity modifier rules
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201063,7 +201124,7 @@ paths:
query: "env:dev"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleCreateRequest"
+ $ref: '#/components/schemas/SeverityModifierRuleCreateRequest'
required: true
responses:
"201":
@@ -201097,13 +201158,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleResponse'
description: Successfully created the severity modifier rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201111,7 +201172,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201146,7 +201207,7 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleReorderRequest"
+ $ref: '#/components/schemas/SeverityModifierRuleReorderRequest'
required: true
responses:
"200":
@@ -201161,13 +201222,13 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleReorderResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleReorderResponse'
description: Successfully reordered the severity modifier rules
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201175,7 +201236,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201218,7 +201279,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201280,7 +201341,7 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleResponse'
description: Successfully retrieved the severity modifier rule
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201290,7 +201351,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201339,7 +201400,7 @@ paths:
query: "env:dev"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleUpdateRequest"
+ $ref: '#/components/schemas/SeverityModifierRuleUpdateRequest'
required: true
responses:
"200":
@@ -201372,13 +201433,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: severity_modifier_rules
schema:
- $ref: "#/components/schemas/SeverityModifierRuleResponse"
+ $ref: '#/components/schemas/SeverityModifierRuleResponse'
description: Successfully updated the severity modifier rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201388,7 +201449,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201471,7 +201532,7 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/TicketCreationRulesResponse"
+ $ref: '#/components/schemas/TicketCreationRulesResponse'
description: Successfully retrieved the list of ticket creation rules
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201514,7 +201575,7 @@ paths:
query: "env:prod"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleCreateRequest"
+ $ref: '#/components/schemas/TicketCreationRuleCreateRequest'
required: true
responses:
"201":
@@ -201548,13 +201609,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleResponse"
+ $ref: '#/components/schemas/TicketCreationRuleResponse'
description: Successfully created the ticket creation rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201562,7 +201623,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201597,7 +201658,7 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleReorderRequest"
+ $ref: '#/components/schemas/TicketCreationRuleReorderRequest'
required: true
responses:
"200":
@@ -201612,13 +201673,13 @@ paths:
- id: "11111111-1111-1111-1111-111111111111"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleReorderRequest"
+ $ref: '#/components/schemas/TicketCreationRuleReorderRequest'
description: Successfully reordered the ticket creation rules
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201626,7 +201687,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201725,7 +201786,7 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleResponse"
+ $ref: '#/components/schemas/TicketCreationRuleResponse'
description: Successfully retrieved the ticket creation rule
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201779,7 +201840,7 @@ paths:
query: "env:prod"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleUpdateRequest"
+ $ref: '#/components/schemas/TicketCreationRuleUpdateRequest'
required: true
responses:
"200":
@@ -201813,13 +201874,13 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: ticket_creation_rules
schema:
- $ref: "#/components/schemas/TicketCreationRuleResponse"
+ $ref: '#/components/schemas/TicketCreationRuleResponse'
description: Successfully updated the ticket creation rule
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -201829,7 +201890,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -201870,7 +201931,7 @@ paths:
type: findings
type: cases
schema:
- $ref: "#/components/schemas/DetachCaseRequest"
+ $ref: '#/components/schemas/DetachCaseRequest'
required: true
responses:
"204":
@@ -201923,7 +201984,7 @@ paths:
id: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: cases
schema:
- $ref: "#/components/schemas/CreateCaseRequestArray"
+ $ref: '#/components/schemas/CreateCaseRequestArray'
required: true
responses:
"201":
@@ -201943,7 +202004,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponseArray"
+ $ref: '#/components/schemas/FindingCaseResponseArray'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -201993,7 +202054,7 @@ paths:
- id: ZGVmLTAwcC1pZXJ-aS0wZjhjNjMyZDNmMzRlZTgzNw==
type: cases
schema:
- $ref: "#/components/schemas/AttachCaseRequest"
+ $ref: '#/components/schemas/AttachCaseRequest'
required: true
responses:
"200":
@@ -202013,7 +202074,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponse"
+ $ref: '#/components/schemas/FindingCaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202061,7 +202122,7 @@ paths:
type: projects
type: jira_issues
schema:
- $ref: "#/components/schemas/AttachJiraIssueRequest"
+ $ref: '#/components/schemas/AttachJiraIssueRequest'
required: true
responses:
"200":
@@ -202081,7 +202142,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponse"
+ $ref: '#/components/schemas/FindingCaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202133,7 +202194,7 @@ paths:
id: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: jira_issues
schema:
- $ref: "#/components/schemas/CreateJiraIssueRequestArray"
+ $ref: '#/components/schemas/CreateJiraIssueRequestArray'
required: true
responses:
"201":
@@ -202153,7 +202214,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponseArray"
+ $ref: '#/components/schemas/FindingCaseResponseArray'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202202,7 +202263,7 @@ paths:
type: projects
type: linear_issues
schema:
- $ref: "#/components/schemas/AttachLinearIssueRequest"
+ $ref: '#/components/schemas/AttachLinearIssueRequest'
required: true
responses:
"200":
@@ -202222,7 +202283,7 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponse"
+ $ref: '#/components/schemas/FindingCaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202276,7 +202337,7 @@ paths:
type: projects
type: linear_issues
schema:
- $ref: "#/components/schemas/CreateLinearIssueRequestArray"
+ $ref: '#/components/schemas/CreateLinearIssueRequestArray'
required: true
responses:
"201":
@@ -202296,7 +202357,7 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponseArray"
+ $ref: '#/components/schemas/FindingCaseResponseArray'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202347,7 +202408,7 @@ paths:
type: "findings"
type: "mute"
schema:
- $ref: "#/components/schemas/MuteFindingsRequest"
+ $ref: '#/components/schemas/MuteFindingsRequest'
required: true
responses:
"202":
@@ -202360,7 +202421,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: mute
schema:
- $ref: "#/components/schemas/MuteFindingsResponse"
+ $ref: '#/components/schemas/MuteFindingsResponse'
description: Accepted
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202372,7 +202433,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Unprocessable Entity"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -202415,7 +202476,7 @@ paths:
limit: 25
sort: "@detection_changed_at"
schema:
- $ref: "#/components/schemas/SecurityFindingsSearchRequest"
+ $ref: '#/components/schemas/SecurityFindingsSearchRequest'
required: true
responses:
"200":
@@ -202438,7 +202499,7 @@ paths:
elapsed: 548
status: done
schema:
- $ref: "#/components/schemas/ListSecurityFindingsResponse"
+ $ref: '#/components/schemas/ListSecurityFindingsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202493,7 +202554,7 @@ paths:
type: projects
type: servicenow_tickets
schema:
- $ref: "#/components/schemas/AttachServiceNowTicketRequest"
+ $ref: '#/components/schemas/AttachServiceNowTicketRequest'
required: true
responses:
"200":
@@ -202513,7 +202574,7 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponse"
+ $ref: '#/components/schemas/FindingCaseResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202564,7 +202625,7 @@ paths:
type: projects
type: servicenow_tickets
schema:
- $ref: "#/components/schemas/CreateServiceNowTicketRequestArray"
+ $ref: '#/components/schemas/CreateServiceNowTicketRequestArray'
required: true
responses:
"201":
@@ -202584,7 +202645,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: cases
schema:
- $ref: "#/components/schemas/FindingCaseResponseArray"
+ $ref: '#/components/schemas/FindingCaseResponseArray'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -202652,7 +202713,7 @@ paths:
name: filter[asset_type]
required: false
schema:
- $ref: "#/components/schemas/AssetType"
+ $ref: '#/components/schemas/AssetType'
- description: The name of the asset for the SBOM request.
example: "github.com/datadog/datadog-agent"
in: query
@@ -202687,7 +202748,7 @@ paths:
name: filter[license_type]
required: false
schema:
- $ref: "#/components/schemas/SBOMComponentLicenseType"
+ $ref: '#/components/schemas/SBOMComponentLicenseType'
responses:
"200":
content:
@@ -202697,25 +202758,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListAssetsSBOMsResponse"
+ $ref: '#/components/schemas/ListAssetsSBOMsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad request: The server cannot process the request due to invalid syntax in the request."
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not found: asset not found"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -202742,7 +202803,7 @@ paths:
name: asset_type
required: true
schema:
- $ref: "#/components/schemas/AssetType"
+ $ref: '#/components/schemas/AssetType'
- description: The name of the asset for the SBOM request.
example: "github.com/datadog/datadog-agent"
in: query
@@ -202763,7 +202824,7 @@ paths:
name: ext:format
required: false
schema:
- $ref: "#/components/schemas/SBOMFormat"
+ $ref: '#/components/schemas/SBOMFormat'
responses:
"200":
content:
@@ -202786,25 +202847,25 @@ paths:
id: "github.com/datadog/datadog-agent"
type: sboms
schema:
- $ref: "#/components/schemas/GetSBOMResponse"
+ $ref: '#/components/schemas/GetSBOMResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad request: The server cannot process the request due to invalid syntax in the request."
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not found: asset not found"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -202890,7 +202951,7 @@ paths:
name: filter[asset.type]
required: false
schema:
- $ref: "#/components/schemas/CloudAssetType"
+ $ref: '#/components/schemas/CloudAssetType'
- description: The name of the scanned asset.
example: "i-0fc7edef1ab26d7ef"
in: query
@@ -202930,25 +202991,25 @@ paths:
id: "Host|i-0fc7edef1ab26d7ef"
type: scanned-assets-metadata
schema:
- $ref: "#/components/schemas/ScannedAssetsMetadata"
+ $ref: '#/components/schemas/ScannedAssetsMetadata'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad request: The server cannot process the request due to invalid syntax in the request."
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not found: asset not found"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -203028,7 +203089,7 @@ paths:
name: triage_state
required: false
schema:
- $ref: "#/components/schemas/IoCTriageState"
+ $ref: '#/components/schemas/IoCTriageState'
responses:
"200":
content:
@@ -203050,7 +203111,7 @@ paths:
id: abc-123
type: ioc_explorer_list_response
schema:
- $ref: "#/components/schemas/IoCExplorerListResponse"
+ $ref: '#/components/schemas/IoCExplorerListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203131,7 +203192,7 @@ paths:
id: abc-123
type: ioc_indicator_response
schema:
- $ref: "#/components/schemas/GetIoCIndicatorResponse"
+ $ref: '#/components/schemas/GetIoCIndicatorResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203170,7 +203231,7 @@ paths:
triage_state: reviewed
type: ioc_triage_state
schema:
- $ref: "#/components/schemas/IoCTriageWriteRequest"
+ $ref: '#/components/schemas/IoCTriageWriteRequest'
description: The triage state to set for the indicator.
required: true
responses:
@@ -203190,7 +203251,7 @@ paths:
id: abc-123
type: ioc_triage_state
schema:
- $ref: "#/components/schemas/IoCTriageWriteResponse"
+ $ref: '#/components/schemas/IoCTriageWriteResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203257,7 +203318,7 @@ paths:
time_aggregation: 86400
type: notification_rules
schema:
- $ref: "#/components/schemas/CreateNotificationRuleParameters"
+ $ref: '#/components/schemas/CreateNotificationRuleParameters'
description: |-
The body of the create notification rule request is composed of the rule type and the rule attributes:
the rule name, the selectors, the notification targets, and the rule enabled status.
@@ -203294,7 +203355,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Successfully created the notification rule.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203387,7 +203448,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Notification rule details.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203443,7 +203504,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/PatchNotificationRuleParameters"
+ $ref: '#/components/schemas/PatchNotificationRuleParameters'
required: true
responses:
"200":
@@ -203477,7 +203538,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Notification rule successfully patched.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -203526,7 +203587,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/STIXContentEncoding"
+ $ref: '#/components/schemas/STIXContentEncoding'
requestBody:
content:
application/json:
@@ -203546,7 +203607,7 @@ paths:
spec_version: "2.1"
type: bundle
schema:
- $ref: "#/components/schemas/STIXBundleRequest"
+ $ref: '#/components/schemas/STIXBundleRequest'
description: >-
A STIX 2.1 bundle containing indicator objects. The request body must not exceed 50 MB as received or 100 MB after decompression.
required: true
@@ -203565,13 +203626,13 @@ paths:
id: acme
type: threat-intel-stix-ingest
schema:
- $ref: "#/components/schemas/STIXIngestResponse"
+ $ref: '#/components/schemas/STIXIngestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
$ref: "#/components/responses/UnauthorizedResponse"
@@ -203581,25 +203642,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: The request body exceeds 50 MB as received or 100 MB after decompression.
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
"502":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: The STIX ingestion service returned an error while processing the request.
"503":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: The STIX ingestion service is temporarily unavailable.
security:
- apiKeyAuth: []
@@ -203733,7 +203794,7 @@ paths:
name: filter[type]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilityType"
+ $ref: '#/components/schemas/VulnerabilityType'
- description: Filter by vulnerability base (i.e. from the original advisory) severity score.
example: 5.5
in: query
@@ -203750,7 +203811,7 @@ paths:
name: filter[cvss.base.severity]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilitySeverity"
+ $ref: '#/components/schemas/VulnerabilitySeverity'
- description: Filter by vulnerability base CVSS vector.
example: "CVSS:3.0/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H"
in: query
@@ -203774,7 +203835,7 @@ paths:
name: filter[cvss.datadog.severity]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilitySeverity"
+ $ref: '#/components/schemas/VulnerabilitySeverity'
- description: Filter by vulnerability Datadog CVSS vector.
example: "CVSS:3.1/AV:L/AC:L/PR:L/UI:N/S:U/C:N/I:N/A:H/E:U/RL:X/RC:X/CR:X/IR:X/AR:X/MAV:L/MAC:H/MPR:L/MUI:N/MS:U/MC:N/MI:N/MA:H"
in: query
@@ -203788,14 +203849,14 @@ paths:
name: filter[status]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilityStatus"
+ $ref: '#/components/schemas/VulnerabilityStatus'
- description: Filter by the tool of the vulnerability.
example: SCA
in: query
name: filter[tool]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilityTool"
+ $ref: '#/components/schemas/VulnerabilityTool'
- description: Filter by library name.
example: linux-aws-5.15
in: query
@@ -203854,7 +203915,7 @@ paths:
name: filter[risks.epss.severity]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilitySeverity"
+ $ref: '#/components/schemas/VulnerabilitySeverity'
- description: Filter by language.
example: ubuntu
in: query
@@ -203868,7 +203929,7 @@ paths:
name: filter[ecosystem]
required: false
schema:
- $ref: "#/components/schemas/VulnerabilityEcosystem"
+ $ref: '#/components/schemas/VulnerabilityEcosystem'
- description: Filter by vulnerability location.
example: "com.example.Class:100"
in: query
@@ -203931,7 +203992,7 @@ paths:
name: filter[asset.type]
required: false
schema:
- $ref: "#/components/schemas/AssetType"
+ $ref: '#/components/schemas/AssetType'
- description: Filter by the first version of the asset this vulnerability has been detected on.
example: v1.15.1
in: query
@@ -204032,25 +204093,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListVulnerabilitiesResponse"
+ $ref: '#/components/schemas/ListVulnerabilitiesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad request: The server cannot process the request due to invalid syntax in the request."
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not found: There is no request associated with the provided token."
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -204120,7 +204181,7 @@ paths:
severity: high
vector: "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:C/C:H/I:H/A:N"
schema:
- $ref: "#/components/schemas/CycloneDXBom"
+ $ref: '#/components/schemas/CycloneDXBom'
required: true
responses:
"200":
@@ -204135,7 +204196,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -204202,7 +204263,7 @@ paths:
time_aggregation: 86400
type: notification_rules
schema:
- $ref: "#/components/schemas/CreateNotificationRuleParameters"
+ $ref: '#/components/schemas/CreateNotificationRuleParameters'
description: |-
The body of the create notification rule request is composed of the rule type and the rule attributes:
the rule name, the selectors, the notification targets, and the rule enabled status.
@@ -204240,7 +204301,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Successfully created the notification rule.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204334,7 +204395,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Notification rule details.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204390,7 +204451,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/PatchNotificationRuleParameters"
+ $ref: '#/components/schemas/PatchNotificationRuleParameters'
required: true
responses:
"200":
@@ -204425,7 +204486,7 @@ paths:
id: aaa-bbb-ccc
type: notification_rules
schema:
- $ref: "#/components/schemas/NotificationRuleResponse"
+ $ref: '#/components/schemas/NotificationRuleResponse'
description: Notification rule successfully patched.
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204496,7 +204557,7 @@ paths:
name: filter[type]
required: false
schema:
- $ref: "#/components/schemas/AssetType"
+ $ref: '#/components/schemas/AssetType'
- description: Filter by the first version of the asset since it has been vulnerable.
example: v1.15.1
in: query
@@ -204597,25 +204658,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ListVulnerableAssetsResponse"
+ $ref: '#/components/schemas/ListVulnerableAssetsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Bad request: The server cannot process the request due to invalid syntax in the request."
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Forbidden: Access denied"
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: "Not found: There is no request associated with the provided token."
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -204656,7 +204717,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRulesListResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -204689,7 +204750,7 @@ paths:
name: my_agent_rule
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleCreateRequest'
description: "The definition of the new agent rule"
required: true
responses:
@@ -204708,7 +204769,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204775,7 +204836,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -204813,7 +204874,7 @@ paths:
id: 3dd-0uc-h1s
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleUpdateRequest'
description: "New definition of the agent rule"
required: true
responses:
@@ -204832,7 +204893,7 @@ paths:
id: abc-123
type: agent_rule
schema:
- $ref: "#/components/schemas/CloudWorkloadSecurityAgentRuleResponse"
+ $ref: '#/components/schemas/CloudWorkloadSecurityAgentRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204873,7 +204934,7 @@ paths:
id: 4e2435a5-6670-4b8f-baff-46083cd1c250
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -204908,7 +204969,7 @@ paths:
- source:cloudtrail
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetCreateRequest'
description: The definition of the new critical asset.
required: true
responses:
@@ -204928,7 +204989,7 @@ paths:
id: 4e2435a5-6670-4b8f-baff-46083cd1c250
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -204971,7 +205032,7 @@ paths:
id: 4e2435a5-6670-4b8f-baff-46083cd1c250
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205034,7 +205095,7 @@ paths:
id: 4e2435a5-6670-4b8f-baff-46083cd1c250
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205074,7 +205135,7 @@ paths:
version: 1
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetUpdateRequest'
description: New definition of the critical asset. Supports partial updates.
required: true
responses:
@@ -205094,7 +205155,7 @@ paths:
id: 4e2435a5-6670-4b8f-baff-46083cd1c250
type: critical_assets
schema:
- $ref: "#/components/schemas/SecurityMonitoringCriticalAssetResponse"
+ $ref: '#/components/schemas/SecurityMonitoringCriticalAssetResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -205128,7 +205189,7 @@ paths:
name: filter[integration_type]
required: false
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationType"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationType'
responses:
"200":
content:
@@ -205150,7 +205211,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205194,7 +205255,7 @@ paths:
setting1: value1
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigCreateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigCreateRequest'
description: The definition of the new integration configuration.
required: true
responses:
@@ -205217,7 +205278,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -205269,7 +205330,7 @@ paths:
id: "123456"
type: entra_id_azure_app_registrations
schema:
- $ref: "#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringEntraIdAzureAppRegistrationsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205310,7 +205371,7 @@ paths:
admin_email: test@example.com
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationCredentialsValidateRequest'
description: The credentials to validate.
required: true
responses:
@@ -205396,7 +205457,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205436,7 +205497,7 @@ paths:
name: My GWS Integration (renamed)
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigUpdateRequest'
description: The fields to update on the integration configuration.
required: true
responses:
@@ -205460,7 +205521,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -205546,7 +205607,7 @@ paths:
name: My Entra ID Integration
type: activate_entra_id_request
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationActivateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationActivateRequest'
description: Optional configuration overrides for the integration to activate.
required: false
responses:
@@ -205568,7 +205629,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -205625,7 +205686,7 @@ paths:
id: 11111111-2222-3333-4444-555555555555
type: integration_config
schema:
- $ref: "#/components/schemas/SecurityMonitoringIntegrationConfigResponse"
+ $ref: '#/components/schemas/SecurityMonitoringIntegrationConfigResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205673,7 +205734,7 @@ paths:
- "@john.doe@email.com"
type: notification_rules
schema:
- $ref: "#/components/schemas/CreateNotificationRuleParameters"
+ $ref: '#/components/schemas/CreateNotificationRuleParameters'
required: true
responses:
"200":
@@ -205690,13 +205751,13 @@ paths:
id: rka-loa-zwu
type: notification_preview_response
schema:
- $ref: "#/components/schemas/NotificationRulePreviewResponse"
+ $ref: '#/components/schemas/NotificationRulePreviewResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205741,7 +205802,7 @@ paths:
id: 3dd-0uc-h1s
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFiltersResponse"
+ $ref: '#/components/schemas/SecurityFiltersResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205783,7 +205844,7 @@ paths:
query: service:api
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFilterCreateRequest"
+ $ref: '#/components/schemas/SecurityFilterCreateRequest'
description: The definition of the new security filter.
required: true
responses:
@@ -205807,7 +205868,7 @@ paths:
id: 3dd-0uc-h1s
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFilterResponse"
+ $ref: '#/components/schemas/SecurityFilterResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -205860,7 +205921,7 @@ paths:
id: "1"
type: security_filters_configuration
schema:
- $ref: "#/components/schemas/SecurityFilterVersionsResponse"
+ $ref: '#/components/schemas/SecurityFilterVersionsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205935,7 +205996,7 @@ paths:
id: 3dd-0uc-h1s
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFilterResponse"
+ $ref: '#/components/schemas/SecurityFilterResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -205978,7 +206039,7 @@ paths:
version: 1
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFilterUpdateRequest"
+ $ref: '#/components/schemas/SecurityFilterUpdateRequest'
description: New definition of the security filter.
required: true
responses:
@@ -206002,7 +206063,7 @@ paths:
id: 3dd-0uc-h1s
type: security_filters
schema:
- $ref: "#/components/schemas/SecurityFilterResponse"
+ $ref: '#/components/schemas/SecurityFilterResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -206043,7 +206104,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionSort"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionSort'
- description: Size for a given page. Use `-1` to return all items.
in: query
name: page[size]
@@ -206077,7 +206138,7 @@ paths:
pageSize: 10
totalCount: 1
schema:
- $ref: "#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringPaginatedSuppressionsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -206116,7 +206177,7 @@ paths:
- source:cloudtrail
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
description: The definition of the new suppression rule.
required: true
responses:
@@ -206135,7 +206196,7 @@ paths:
id: abc-123
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -206213,7 +206274,7 @@ paths:
thirdPartyCases: []
type: api_security
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
required: true
responses:
"200":
@@ -206231,7 +206292,7 @@ paths:
id: abc-123
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -206272,7 +206333,7 @@ paths:
id: 3dd-0uc-h1s
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -206314,7 +206375,7 @@ paths:
- source:cloudtrail
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionCreateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionCreateRequest'
required: true
responses:
"204":
@@ -206385,7 +206446,7 @@ paths:
id: 3dd-0uc-h1s
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -206428,7 +206489,7 @@ paths:
- source:cloudtrail
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionUpdateRequest'
description: New definition of the suppression rule. Supports partial updates.
required: true
responses:
@@ -206449,7 +206510,7 @@ paths:
id: 3dd-0uc-h1s
type: suppressions
schema:
- $ref: "#/components/schemas/SecurityMonitoringSuppressionResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSuppressionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -206499,7 +206560,7 @@ paths:
id: 3dd-0uc-h1s
type: suppression_version_history
schema:
- $ref: "#/components/schemas/GetSuppressionVersionHistoryResponse"
+ $ref: '#/components/schemas/GetSuppressionVersionHistoryResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -206546,19 +206607,19 @@ paths:
cloud_siem_index_incorrect: false
sku: add_on_2024
schema:
- $ref: "#/components/schemas/SecurityMonitoringContentPackStatesResponse"
+ $ref: '#/components/schemas/SecurityMonitoringContentPackStatesResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206601,13 +206662,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206649,13 +206710,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206751,19 +206812,19 @@ paths:
meta:
totalCount: 1
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetsListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206810,7 +206871,7 @@ paths:
description: A sample dataset used for detection rules.
type: datasetCreate
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetCreateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetCreateRequest'
required: true
responses:
"201":
@@ -206823,25 +206884,25 @@ paths:
id: 123e4567-e89b-12d3-a456-426614174000
type: dataset
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetCreateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetCreateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206879,7 +206940,7 @@ paths:
datasetIds:
- 123e4567-e89b-12d3-a456-426614174000
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependenciesRequest"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependenciesRequest'
required: true
responses:
"200":
@@ -206897,19 +206958,19 @@ paths:
id: 123e4567-e89b-12d3-a456-426614174000
type: datasetDependents
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetDependenciesResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetDependenciesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -206945,19 +207006,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -207017,25 +207078,25 @@ paths:
id: 123e4567-e89b-12d3-a456-426614174000
type: dataset
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -207085,7 +207146,7 @@ paths:
version: 1
type: datasetUpdate
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetUpdateRequest'
required: true
responses:
"204":
@@ -207094,25 +207155,25 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -207181,25 +207242,25 @@ paths:
id: 123e4567-e89b-12d3-a456-426614174000
type: dataset
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -207283,25 +207344,25 @@ paths:
id: 123e4567-e89b-12d3-a456-426614174000
type: dataset_version_history
schema:
- $ref: "#/components/schemas/SecurityMonitoringDatasetVersionHistoryResponse"
+ $ref: '#/components/schemas/SecurityMonitoringDatasetVersionHistoryResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -207408,7 +207469,7 @@ paths:
next_token: ""
total_count: 1
schema:
- $ref: "#/components/schemas/EntityContextResponse"
+ $ref: '#/components/schemas/EntityContextResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207498,7 +207559,7 @@ paths:
id: user@example.com
type: siem_entity_identity
schema:
- $ref: "#/components/schemas/SingleEntityContextResponse"
+ $ref: '#/components/schemas/SingleEntityContextResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207542,7 +207603,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleSort"
+ $ref: '#/components/schemas/SecurityMonitoringRuleSort'
responses:
"200":
content:
@@ -207557,7 +207618,7 @@ paths:
type: log_detection
meta: {}
schema:
- $ref: "#/components/schemas/SecurityMonitoringListRulesResponse"
+ $ref: '#/components/schemas/SecurityMonitoringListRulesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207613,7 +207674,7 @@ paths:
tags: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleCreatePayload'
required: true
responses:
"200":
@@ -207634,7 +207695,7 @@ paths:
tags: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207674,7 +207735,7 @@ paths:
id: bulk_delete
type: bulk_delete_rules
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeletePayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeletePayload'
required: true
responses:
"200":
@@ -207692,7 +207753,7 @@ paths:
id: bulk_delete_response
type: bulk_delete_response
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkDeleteResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkDeleteResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207736,7 +207797,7 @@ paths:
id: bulk_export
type: security_monitoring_rules_bulk_export
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleBulkExportPayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleBulkExportPayload'
required: true
responses:
"200":
@@ -207845,7 +207906,7 @@ paths:
thirdPartyCases: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertPayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertPayload'
required: true
responses:
"200":
@@ -207857,7 +207918,7 @@ paths:
ruleId: abc-123
terraformContent: 'resource "datadog_security_monitoring_rule" "example" {}'
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -207906,7 +207967,7 @@ paths:
id: convert_bulk
type: security_monitoring_rules_convert_bulk
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertBulkPayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertBulkPayload'
required: true
responses:
"200":
@@ -208015,7 +208076,7 @@ paths:
message: 2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World
service: payment
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest'
required: true
responses:
"200":
@@ -208027,7 +208088,7 @@ paths:
results:
- true
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208123,7 +208184,7 @@ paths:
thirdPartyCases: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleValidatePayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleValidatePayload'
required: true
responses:
"204":
@@ -208199,7 +208260,7 @@ paths:
tags: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
description: OK
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -208253,7 +208314,7 @@ paths:
query: "@test:true"
tags: []
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleUpdatePayload"
+ $ref: '#/components/schemas/SecurityMonitoringRuleUpdatePayload'
required: true
responses:
"200":
@@ -208274,7 +208335,7 @@ paths:
tags: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208322,7 +208383,7 @@ paths:
ruleId: abc-123
terraformContent: 'resource "datadog_security_monitoring_rule" "example" {}'
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleConvertResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleConvertResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208373,7 +208434,7 @@ paths:
tags: []
type: log_detection
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208451,7 +208512,7 @@ paths:
userIdentity:
assumed_role: fake assumed_role
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestRequest'
required: true
responses:
"200":
@@ -208463,7 +208524,7 @@ paths:
results:
- true
schema:
- $ref: "#/components/schemas/SecurityMonitoringRuleTestResponse"
+ $ref: '#/components/schemas/SecurityMonitoringRuleTestResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208510,7 +208571,7 @@ paths:
id: abc-123
type: GetRuleVersionHistoryResponse
schema:
- $ref: "#/components/schemas/GetRuleVersionHistoryResponse"
+ $ref: '#/components/schemas/GetRuleVersionHistoryResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208549,7 +208610,7 @@ paths:
name: status
required: false
schema:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionsStatusFilter"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionsStatusFilter'
- description: |-
The start of the time range, as an RFC3339 timestamp. When provided, the response includes
every subscription that was active at any point in `[start_timestamp, end_timestamp]`,
@@ -208590,7 +208651,7 @@ paths:
meta:
total_subscriptions: 1
schema:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionsResponse"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208637,7 +208698,7 @@ paths:
duration: 3d
type: subscription_requests
schema:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionCreateRequest"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionCreateRequest'
description: The content pack to subscribe to and the desired duration of the subscription.
required: true
responses:
@@ -208657,7 +208718,7 @@ paths:
id: "789"
type: subscriptions
schema:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionResponse"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208707,7 +208768,7 @@ paths:
duration: 3d
type: bulk_subscription_requests
schema:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionRequest"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionRequest'
description: The content packs to subscribe to and the desired duration of the subscriptions.
required: true
responses:
@@ -208729,7 +208790,7 @@ paths:
status: 200
type: subscriptions
schema:
- $ref: "#/components/schemas/SampleLogGenerationBulkSubscriptionResponse"
+ $ref: '#/components/schemas/SampleLogGenerationBulkSubscriptionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208784,7 +208845,7 @@ paths:
id: "789"
type: subscriptions
schema:
- $ref: "#/components/schemas/SampleLogGenerationSubscriptionResponse"
+ $ref: '#/components/schemas/SampleLogGenerationSubscriptionResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208842,7 +208903,7 @@ paths:
page:
after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -208885,7 +208946,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkAssigneeUpdateRequest'
description: Attributes describing the signal assignee updates.
required: true
responses:
@@ -208908,19 +208969,19 @@ paths:
status: done
type: status
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -208951,7 +209012,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkStateUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkStateUpdateRequest'
description: Attributes describing the signal state updates.
required: true
responses:
@@ -208974,19 +209035,19 @@ paths:
status: done
type: status
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -209017,7 +209078,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkUpdateRequest'
description: Attributes describing the signal updates.
required: true
responses:
@@ -209040,19 +209101,19 @@ paths:
status: done
type: status
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsBulkTriageUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -209090,7 +209151,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalListRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalListRequest'
required: false
responses:
"200":
@@ -209111,7 +209172,7 @@ paths:
page:
after: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209157,7 +209218,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -209195,7 +209256,7 @@ paths:
assignee:
uuid: 773b045d-ccf8-4808-bd3b-955ef6a8c940
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalAssigneeUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -209214,7 +209275,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209267,7 +209328,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: entities
schema:
- $ref: "#/components/schemas/SignalEntitiesResponse"
+ $ref: '#/components/schemas/SignalEntitiesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209310,7 +209371,7 @@ paths:
incident_ids:
- 2066
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalIncidentsUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -209329,7 +209390,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209378,7 +209439,7 @@ paths:
id: bxy-o8v-i1a
type: recommended_blog_posts
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -209419,7 +209480,7 @@ paths:
state: archived
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalStateUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateRequest'
description: Attributes describing the signal update.
required: true
responses:
@@ -209438,7 +209499,7 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209487,7 +209548,7 @@ paths:
id: bxy-o8v-i1a
type: recommended_blog_posts
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalSuggestedActionsResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -209528,7 +209589,7 @@ paths:
state: archived
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalUpdateRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalUpdateRequest'
description: Attributes describing the signal triage state or assignee update.
required: true
responses:
@@ -209547,25 +209608,25 @@ paths:
id: AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA
type: signal_metadata
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalTriageUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -209604,7 +209665,7 @@ paths:
- abc-123-def
type: bulk_export_resources
schema:
- $ref: "#/components/schemas/SecurityMonitoringTerraformBulkExportRequest"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformBulkExportRequest'
description: The resource IDs to export.
required: true
responses:
@@ -209672,7 +209733,7 @@ paths:
id: abc-123
type: convert_resource
schema:
- $ref: "#/components/schemas/SecurityMonitoringTerraformConvertRequest"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformConvertRequest'
description: The resource JSON to convert.
required: true
responses:
@@ -209690,7 +209751,7 @@ paths:
id: datadog_security_monitoring_suppression|abc-123
type: format_resource
schema:
- $ref: "#/components/schemas/SecurityMonitoringTerraformExportResponse"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformExportResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -209745,7 +209806,7 @@ paths:
id: datadog_security_monitoring_suppression|abc-123
type: format_resource
schema:
- $ref: "#/components/schemas/SecurityMonitoringTerraformExportResponse"
+ $ref: '#/components/schemas/SecurityMonitoringTerraformExportResponse'
description: OK
"403":
$ref: "#/components/responses/NotAuthorizedResponse"
@@ -209846,19 +209907,19 @@ paths:
is_pci_compliant: false
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGetConfigResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerGetConfigResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -209889,7 +209950,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerConfigRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerConfigRequest'
required: true
responses:
"200":
@@ -209901,19 +209962,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerReorderGroupsResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerReorderGroupsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -209959,7 +210020,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGroupCreateRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupCreateRequest'
required: true
responses:
"201":
@@ -209992,19 +210053,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerCreateGroupResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerCreateGroupResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210032,7 +210093,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteRequest'
required: true
responses:
"200":
@@ -210044,19 +210105,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGroupDeleteResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupDeleteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -210104,7 +210165,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateRequest'
required: true
responses:
"200":
@@ -210116,19 +210177,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerGroupUpdateResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerGroupUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -210196,7 +210257,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerRuleCreateRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleCreateRequest'
required: true
responses:
"201":
@@ -210233,19 +210294,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerCreateRuleResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerCreateRuleResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210273,7 +210334,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteRequest'
required: true
responses:
"200":
@@ -210285,19 +210346,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerRuleDeleteResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleDeleteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -210365,7 +210426,7 @@ paths:
meta:
version: 0
schema:
- $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateRequest"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateRequest'
required: true
responses:
"200":
@@ -210377,19 +210438,19 @@ paths:
meta:
version: 1
schema:
- $ref: "#/components/schemas/SensitiveDataScannerRuleUpdateResponse"
+ $ref: '#/components/schemas/SensitiveDataScannerRuleUpdateResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"404":
$ref: "#/components/responses/NotFoundResponse"
@@ -210428,19 +210489,19 @@ paths:
id: abc-123
type: sensitive_data_scanner_standard_pattern
schema:
- $ref: "#/components/schemas/SensitiveDataScannerStandardPatternsResponseData"
+ $ref: '#/components/schemas/SensitiveDataScannerStandardPatternsResponseData'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication Error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210474,7 +210535,7 @@ paths:
name: Content-Encoding
required: false
schema:
- $ref: "#/components/schemas/MetricContentEncoding"
+ $ref: '#/components/schemas/MetricContentEncoding'
requestBody:
content:
application/json:
@@ -210497,7 +210558,7 @@ paths:
x-variables:
NOW: $(date +%s)
schema:
- $ref: "#/components/schemas/MetricPayload"
+ $ref: '#/components/schemas/MetricPayload'
required: true
responses:
"202":
@@ -210508,31 +210569,31 @@ paths:
value:
errors: []
schema:
- $ref: "#/components/schemas/IntakePayloadAccepted"
+ $ref: '#/components/schemas/IntakePayloadAccepted'
description: Payload accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"408":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Request timeout
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Payload too large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210563,7 +210624,7 @@ paths:
- id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: users
schema:
- $ref: "#/components/schemas/ServiceAccountCreateRequest"
+ $ref: '#/components/schemas/ServiceAccountCreateRequest'
required: true
responses:
"201":
@@ -210579,19 +210640,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: users
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210635,25 +210696,25 @@ paths:
page:
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/ListServiceAccessTokensResponse"
+ $ref: '#/components/schemas/ListServiceAccessTokensResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210684,7 +210745,7 @@ paths:
- dashboards_write
type: service_access_tokens
schema:
- $ref: "#/components/schemas/ServiceAccountAccessTokenCreateRequest"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenCreateRequest'
required: true
responses:
"201":
@@ -210705,25 +210766,25 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: service_access_tokens
schema:
- $ref: "#/components/schemas/ServiceAccessTokenCreateResponse"
+ $ref: '#/components/schemas/ServiceAccessTokenCreateResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210750,13 +210811,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210792,19 +210853,19 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: service_access_tokens
schema:
- $ref: "#/components/schemas/ServiceAccessTokenResponse"
+ $ref: '#/components/schemas/ServiceAccessTokenResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210837,7 +210898,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: service_access_tokens
schema:
- $ref: "#/components/schemas/ServiceAccountAccessTokenUpdateRequest"
+ $ref: '#/components/schemas/ServiceAccountAccessTokenUpdateRequest'
required: true
responses:
"200":
@@ -210857,25 +210918,25 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: service_access_tokens
schema:
- $ref: "#/components/schemas/ServiceAccessTokenResponse"
+ $ref: '#/components/schemas/ServiceAccessTokenResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210914,25 +210975,25 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: application_keys
schema:
- $ref: "#/components/schemas/ListApplicationKeysResponse"
+ $ref: '#/components/schemas/ListApplicationKeysResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -210964,7 +211025,7 @@ paths:
- dashboards_public_share
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyCreateRequest"
+ $ref: '#/components/schemas/ApplicationKeyCreateRequest'
required: true
responses:
"201":
@@ -210980,19 +211041,19 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyResponse"
+ $ref: '#/components/schemas/ApplicationKeyResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -211019,13 +211080,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -211057,19 +211118,19 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: application_keys
schema:
- $ref: "#/components/schemas/PartialApplicationKeyResponse"
+ $ref: '#/components/schemas/PartialApplicationKeyResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -211103,7 +211164,7 @@ paths:
id: 00112233-4455-6677-8899-aabbccddeeff
type: application_keys
schema:
- $ref: "#/components/schemas/ApplicationKeyUpdateRequest"
+ $ref: '#/components/schemas/ApplicationKeyUpdateRequest'
required: true
responses:
"200":
@@ -211119,25 +211180,25 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: application_keys
schema:
- $ref: "#/components/schemas/PartialApplicationKeyResponse"
+ $ref: '#/components/schemas/PartialApplicationKeyResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -211174,7 +211235,7 @@ paths:
id: test-service
type: service_definitions
schema:
- $ref: "#/components/schemas/ServiceDefinitionsListResponse"
+ $ref: '#/components/schemas/ServiceDefinitionsListResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -211247,7 +211308,7 @@ paths:
tier: High
type: web
schema:
- $ref: "#/components/schemas/ServiceDefinitionsCreateRequest"
+ $ref: '#/components/schemas/ServiceDefinitionsCreateRequest'
description: Service Definition YAML/JSON.
required: true
responses:
@@ -211265,7 +211326,7 @@ paths:
id: abc-123
type: service_definitions
schema:
- $ref: "#/components/schemas/ServiceDefinitionCreateResponse"
+ $ref: '#/components/schemas/ServiceDefinitionCreateResponse'
description: CREATED
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211341,7 +211402,7 @@ paths:
id: test-service
type: service_definitions
schema:
- $ref: "#/components/schemas/ServiceDefinitionGetResponse"
+ $ref: '#/components/schemas/ServiceDefinitionGetResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211393,7 +211454,7 @@ paths:
id: abc-123
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211436,7 +211497,7 @@ paths:
limit: 25
sort: timestamp
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalListRequest"
+ $ref: '#/components/schemas/SecurityMonitoringSignalListRequest'
required: false
responses:
"200":
@@ -211454,7 +211515,7 @@ paths:
id: abc-123
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211502,7 +211563,7 @@ paths:
id: abc-123
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211567,7 +211628,7 @@ paths:
meta:
totalCount: 1
schema:
- $ref: "#/components/schemas/ListHistoricalJobsResponse"
+ $ref: '#/components/schemas/ListHistoricalJobsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211621,7 +211682,7 @@ paths:
type: log_detection
type: historicalDetectionsJobCreate
schema:
- $ref: "#/components/schemas/RunHistoricalJobRequest"
+ $ref: '#/components/schemas/RunHistoricalJobRequest'
required: true
responses:
"201":
@@ -211634,7 +211695,7 @@ paths:
id: abc-123
type: historicalDetectionsJob
schema:
- $ref: "#/components/schemas/JobCreateResponse"
+ $ref: '#/components/schemas/JobCreateResponse'
description: Status created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211683,7 +211744,7 @@ paths:
signalSeverity: critical
type: historicalDetectionsJobResultSignalConversion
schema:
- $ref: "#/components/schemas/ConvertJobResultsToSignalsRequest"
+ $ref: '#/components/schemas/ConvertJobResultsToSignalsRequest'
required: true
responses:
"204":
@@ -211765,7 +211826,7 @@ paths:
id: abc-123
type: historicalDetectionsJob
schema:
- $ref: "#/components/schemas/HistoricalJobResponse"
+ $ref: '#/components/schemas/HistoricalJobResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211854,7 +211915,7 @@ paths:
id: abc-123
type: signal
schema:
- $ref: "#/components/schemas/SecurityMonitoringSignalsListResponse"
+ $ref: '#/components/schemas/SecurityMonitoringSignalsListResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -211901,7 +211962,7 @@ paths:
timezone: America/New_York
to_ts: 1706803070
schema:
- $ref: "#/components/schemas/SloReportCreateRequest"
+ $ref: '#/components/schemas/SloReportCreateRequest'
description: Create SLO report job request body.
required: true
responses:
@@ -211915,19 +211976,19 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: report_id
schema:
- $ref: "#/components/schemas/SLOReportPostResponse"
+ $ref: '#/components/schemas/SLOReportPostResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -211972,19 +212033,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212020,25 +212081,25 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: report_id
schema:
- $ref: "#/components/schemas/SLOReportStatusGetResponse"
+ $ref: '#/components/schemas/SLOReportStatusGetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212085,25 +212146,25 @@ paths:
id: "00000000-0000-0000-0000-000000000000"
type: slo_status
schema:
- $ref: "#/components/schemas/SloStatusResponse"
+ $ref: '#/components/schemas/SloStatusResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212131,7 +212192,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/CreateSnapshotRequest"
+ $ref: '#/components/schemas/CreateSnapshotRequest'
required: true
responses:
"200":
@@ -212146,31 +212207,31 @@ paths:
id: 12345678-1234-5678-9abc-def123456789
type: create_snapshot
schema:
- $ref: "#/components/schemas/CreateSnapshotResponse"
+ $ref: '#/components/schemas/CreateSnapshotResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212196,7 +212257,7 @@ paths:
name: mapkind
required: true
schema:
- $ref: "#/components/schemas/SourcemapMapKind"
+ $ref: '#/components/schemas/SourcemapMapKind'
- description: |-
When set to `true`, returns the source maps that would be deleted
without performing the actual deletion. When set to `false`,
@@ -212377,19 +212438,19 @@ paths:
id: "5"
type: sourcemaps
schema:
- $ref: "#/components/schemas/SourcemapsResponse"
+ $ref: '#/components/schemas/SourcemapsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212397,7 +212458,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Delete source maps
tags:
@@ -212465,19 +212526,19 @@ paths:
id: path/to/sourcemap.js.map
type: sourcemap_files
schema:
- $ref: "#/components/schemas/SourcemapFileResponse"
+ $ref: '#/components/schemas/SourcemapFileResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212485,7 +212546,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get a JavaScript source map
tags:
@@ -212507,7 +212568,7 @@ paths:
in: query
name: mapkind
schema:
- $ref: "#/components/schemas/SourcemapMapKind"
+ $ref: '#/components/schemas/SourcemapMapKind'
- description: The number of results to return per page. Must be at least 1.
in: query
name: page[size]
@@ -212698,19 +212759,19 @@ paths:
has_more_results: false
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/ListSourcemapsResponse"
+ $ref: '#/components/schemas/ListSourcemapsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Request Entity Too Large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212718,7 +212779,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List source maps
tags:
@@ -212746,7 +212807,7 @@ paths:
name: mapkind
required: true
schema:
- $ref: "#/components/schemas/SourcemapMapKind"
+ $ref: '#/components/schemas/SourcemapMapKind'
- description: |-
When set to `true`, returns the source maps that would be restored
without performing the actual restoration. When set to `false`,
@@ -212927,19 +212988,19 @@ paths:
id: "5"
type: sourcemaps
schema:
- $ref: "#/components/schemas/SourcemapsResponse"
+ $ref: '#/components/schemas/SourcemapsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -212947,7 +213008,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Restore source maps
tags:
@@ -212976,7 +213037,7 @@ paths:
version: 1.0.0
type: service_repository_info
schema:
- $ref: "#/components/schemas/ServiceRepositoryInfoRequest"
+ $ref: '#/components/schemas/ServiceRepositoryInfoRequest'
required: true
responses:
"200":
@@ -212993,13 +213054,13 @@ paths:
id: my-web-service:1.0.0
type: service_repository_info
schema:
- $ref: "#/components/schemas/ServiceRepositoryInfoResponse"
+ $ref: '#/components/schemas/ServiceRepositoryInfoResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213007,7 +213068,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get service repository information
tags:
@@ -213061,7 +213122,7 @@ paths:
id: "dedupeactivecontexts:adp_dedupeactivecontexts_org2"
type: recommendation
schema:
- $ref: "#/components/schemas/RecommendationDocument"
+ $ref: '#/components/schemas/RecommendationDocument'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -213123,7 +213184,7 @@ paths:
id: "dedupeactivecontexts:adp_dedupeactivecontexts_org2"
type: recommendation
schema:
- $ref: "#/components/schemas/RecommendationDocument"
+ $ref: '#/components/schemas/RecommendationDocument'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -213175,7 +213236,7 @@ paths:
timezone: GMT
type: aggregate_request
schema:
- $ref: "#/components/schemas/SpansAggregateRequest"
+ $ref: '#/components/schemas/SpansAggregateRequest'
required: true
responses:
"200":
@@ -213196,7 +213257,7 @@ paths:
elapsed: 132
status: done
schema:
- $ref: "#/components/schemas/SpansAggregateResponse"
+ $ref: '#/components/schemas/SpansAggregateResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -213255,7 +213316,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/SpansSort"
+ $ref: '#/components/schemas/SpansSort'
- description: |-
List following results with a cursor provided in the previous query.
example: "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
@@ -213287,7 +213348,7 @@ paths:
id: abc-123
type: spans
schema:
- $ref: "#/components/schemas/SpansListResponse"
+ $ref: '#/components/schemas/SpansListResponse'
description: OK
"400":
$ref: "#/components/responses/SpansBadRequestResponse"
@@ -213341,7 +213402,7 @@ paths:
sort: timestamp
type: search_request
schema:
- $ref: "#/components/schemas/SpansListRequest"
+ $ref: '#/components/schemas/SpansListRequest'
required: true
responses:
"200":
@@ -213360,7 +213421,7 @@ paths:
elapsed: 132
status: done
schema:
- $ref: "#/components/schemas/SpansListResponse"
+ $ref: '#/components/schemas/SpansListResponse'
description: OK
"400":
$ref: "#/components/responses/SpansBadRequestResponse"
@@ -213537,7 +213598,7 @@ paths:
type: repository
repository: repository.json
schema:
- $ref: "#/components/schemas/RequestSchema"
+ $ref: '#/components/schemas/RequestSchema'
required: true
responses:
"200":
@@ -213550,7 +213611,7 @@ paths:
id: sourcemap-upload-id
type: sourcemap_upload
schema:
- $ref: "#/components/schemas/SourceMapUploadResponse"
+ $ref: '#/components/schemas/SourceMapUploadResponse'
description: OK
"202":
content:
@@ -213562,55 +213623,55 @@ paths:
id: sourcemap-upload-id
type: sourcemap_upload
schema:
- $ref: "#/components/schemas/SourceMapUploadResponse"
+ $ref: '#/components/schemas/SourceMapUploadResponse'
description: Accepted - the request has been accepted for processing.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Bad Request - Invalid request body or missing required fields.
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Unauthorized - Invalid or missing API key.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Forbidden - Insufficient permissions.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Not Found - The requested resource was not found.
"408":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Request Timeout - The request took too long to complete.
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Payload Too Large - File size exceeds the 500 MB limit.
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Too Many Requests - Rate limit exceeded.
"503":
content:
application/json:
schema:
- $ref: "#/components/schemas/SourceMapUploadError"
+ $ref: '#/components/schemas/SourceMapUploadError'
description: Service Unavailable - The service is temporarily unavailable.
security:
- apiKeyAuth: []
@@ -213675,7 +213736,7 @@ paths:
data:
type: scarequests
schema:
- $ref: "#/components/schemas/ScaRequest"
+ $ref: '#/components/schemas/ScaRequest'
required: true
responses:
"200":
@@ -213715,7 +213776,7 @@ paths:
resource_name: my-org/my-repo
type: mcpscanrequest
schema:
- $ref: "#/components/schemas/McpScanRequest"
+ $ref: '#/components/schemas/McpScanRequest'
required: true
responses:
"202":
@@ -213730,13 +213791,13 @@ paths:
id: 0190a3d4-1234-7000-8000-000000000000
type: mcpscanrequestresponse
schema:
- $ref: "#/components/schemas/McpScanRequestResponse"
+ $ref: '#/components/schemas/McpScanRequestResponse'
description: Accepted
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213772,13 +213833,13 @@ paths:
value:
vulnerabilities: []
schema:
- $ref: "#/components/schemas/ScanResultResponse"
+ $ref: '#/components/schemas/ScanResultResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213813,7 +213874,7 @@ paths:
id: 0190a3d4-1234-7000-8000-000000000000
type: licenserequest
schema:
- $ref: "#/components/schemas/LicensesListResponse"
+ $ref: '#/components/schemas/LicensesListResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213839,7 +213900,7 @@ paths:
data:
type: resolve-vulnerable-symbols-request
schema:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsRequest"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsRequest'
required: true
responses:
"200":
@@ -213856,7 +213917,7 @@ paths:
id: abc-123
type: resolve-vulnerable-symbols-response
schema:
- $ref: "#/components/schemas/ResolveVulnerableSymbolsResponse"
+ $ref: '#/components/schemas/ResolveVulnerableSymbolsResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213895,25 +213956,25 @@ paths:
id: "42"
type: ai_memory_violation_result
schema:
- $ref: "#/components/schemas/AiMemoryViolationResultsResponse"
+ $ref: '#/components/schemas/AiMemoryViolationResultsResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213921,7 +213982,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List AI memory violation results
tags:
@@ -213951,7 +214012,7 @@ paths:
id: violation-abc
type: ai_memory_violation_result
schema:
- $ref: "#/components/schemas/AiMemoryViolationResultRequest"
+ $ref: '#/components/schemas/AiMemoryViolationResultRequest'
required: true
responses:
"200":
@@ -213960,19 +214021,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -213980,7 +214041,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Create an AI memory violation result
tags:
@@ -214008,19 +214069,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Memory violation result not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214028,7 +214089,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Delete an AI memory violation result
tags:
@@ -214070,25 +214131,25 @@ paths:
id: my-ai-ruleset/my-ai-rule
type: ai_prompt
schema:
- $ref: "#/components/schemas/AiPromptsResponse"
+ $ref: '#/components/schemas/AiPromptsResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214096,7 +214157,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List AI prompts
tags:
@@ -214144,13 +214205,13 @@ paths:
id: my-ai-ruleset
type: ai_ruleset
schema:
- $ref: "#/components/schemas/AiCustomRulesetsResponse"
+ $ref: '#/components/schemas/AiCustomRulesetsResponse'
description: Successful response
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214158,7 +214219,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List AI custom rulesets
tags:
@@ -214184,7 +214245,7 @@ paths:
id: my-ai-ruleset
type: ai_ruleset
schema:
- $ref: "#/components/schemas/AiCustomRulesetRequest"
+ $ref: '#/components/schemas/AiCustomRulesetRequest'
required: true
responses:
"200":
@@ -214204,31 +214265,31 @@ paths:
id: my-ai-ruleset
type: ai_ruleset
schema:
- $ref: "#/components/schemas/AiCustomRulesetResponse"
+ $ref: '#/components/schemas/AiCustomRulesetResponse'
description: Successfully created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict - ruleset already exists
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition Failed - validation error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214236,7 +214297,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Create an AI custom ruleset
tags:
@@ -214264,19 +214325,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214284,7 +214345,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Delete an AI custom ruleset
tags:
@@ -214322,25 +214383,25 @@ paths:
id: my-ai-ruleset
type: ai_ruleset
schema:
- $ref: "#/components/schemas/AiCustomRulesetResponse"
+ $ref: '#/components/schemas/AiCustomRulesetResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214348,7 +214409,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get an AI custom ruleset
tags:
@@ -214382,7 +214443,7 @@ paths:
id: my-ai-ruleset
type: ai_ruleset
schema:
- $ref: "#/components/schemas/AiCustomRulesetUpdateRequest"
+ $ref: '#/components/schemas/AiCustomRulesetUpdateRequest'
required: true
responses:
"200":
@@ -214391,19 +214452,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition Failed - validation error or ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214411,7 +214472,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Update an AI custom ruleset
tags:
@@ -214443,7 +214504,7 @@ paths:
name: my-ai-rule
type: ai_rule
schema:
- $ref: "#/components/schemas/AiCustomRuleRequest"
+ $ref: '#/components/schemas/AiCustomRuleRequest'
required: true
responses:
"200":
@@ -214461,31 +214522,31 @@ paths:
id: my-ai-rule
type: ai_rule
schema:
- $ref: "#/components/schemas/AiCustomRuleResponse"
+ $ref: '#/components/schemas/AiCustomRuleResponse'
description: Successfully created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict - rule already exists
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition Failed - validation error or ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214493,7 +214554,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Create an AI custom rule
tags:
@@ -214528,19 +214589,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214548,7 +214609,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Delete an AI custom rule
tags:
@@ -214591,25 +214652,25 @@ paths:
id: my-ai-rule
type: ai_rule
schema:
- $ref: "#/components/schemas/AiCustomRuleResponse"
+ $ref: '#/components/schemas/AiCustomRuleResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214617,7 +214678,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get an AI custom rule
tags:
@@ -214690,25 +214751,25 @@ paths:
id: revision-abc-123
type: ai_rule_revision
schema:
- $ref: "#/components/schemas/AiCustomRuleRevisionsResponse"
+ $ref: '#/components/schemas/AiCustomRuleRevisionsResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214716,7 +214777,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: List AI custom rule revisions
tags:
@@ -214770,7 +214831,7 @@ paths:
id: revision-abc-123
type: ai_rule_revision
schema:
- $ref: "#/components/schemas/AiCustomRuleRevisionRequest"
+ $ref: '#/components/schemas/AiCustomRuleRevisionRequest'
required: true
responses:
"200":
@@ -214779,19 +214840,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214799,7 +214860,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Create an AI custom rule revision
tags:
@@ -214863,25 +214924,25 @@ paths:
id: revision-abc-123
type: ai_rule_revision
schema:
- $ref: "#/components/schemas/AiCustomRuleRevisionResponse"
+ $ref: '#/components/schemas/AiCustomRuleRevisionResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Revision not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214889,7 +214950,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
summary: Get an AI custom rule revision
tags:
@@ -214911,19 +214972,19 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/SastRulesetsResponse"
+ $ref: '#/components/schemas/SastRulesetsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214952,13 +215013,13 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/CustomRulesetListResponse"
+ $ref: '#/components/schemas/CustomRulesetListResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -214989,7 +215050,7 @@ paths:
name: my-custom-ruleset
type: custom_ruleset
schema:
- $ref: "#/components/schemas/CustomRulesetRequest"
+ $ref: '#/components/schemas/CustomRulesetRequest'
required: true
responses:
"200":
@@ -215004,31 +215065,31 @@ paths:
id: my-custom-ruleset
type: custom_ruleset
schema:
- $ref: "#/components/schemas/CustomRulesetResponse"
+ $ref: '#/components/schemas/CustomRulesetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition Failed
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215062,19 +215123,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215111,25 +215172,25 @@ paths:
id: my-ruleset
type: custom_ruleset
schema:
- $ref: "#/components/schemas/CustomRulesetResponse"
+ $ref: '#/components/schemas/CustomRulesetResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215164,7 +215225,7 @@ paths:
name: my-rule
type: custom_ruleset
schema:
- $ref: "#/components/schemas/CustomRulesetRequest"
+ $ref: '#/components/schemas/CustomRulesetRequest'
required: true
responses:
"200":
@@ -215184,25 +215245,25 @@ paths:
id: my-ruleset
type: custom_ruleset
schema:
- $ref: "#/components/schemas/CustomRulesetResponse"
+ $ref: '#/components/schemas/CustomRulesetResponse'
description: Successfully updated
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition failed - validation error or ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215231,7 +215292,7 @@ paths:
data:
type: custom_rule
schema:
- $ref: "#/components/schemas/CustomRuleRequest"
+ $ref: '#/components/schemas/CustomRuleRequest'
required: true
responses:
"200":
@@ -215252,31 +215313,31 @@ paths:
id: my-rule
type: custom_rule
schema:
- $ref: "#/components/schemas/CustomRuleResponse"
+ $ref: '#/components/schemas/CustomRuleResponse'
description: Successfully created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Conflict - rule already exists
"412":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Precondition failed - validation error or ruleset not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215309,19 +215370,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215365,25 +215426,25 @@ paths:
id: my-rule
type: custom_rule
schema:
- $ref: "#/components/schemas/CustomRuleResponse"
+ $ref: '#/components/schemas/CustomRuleResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215457,31 +215518,31 @@ paths:
id: revision-123
type: custom_rule_revision
schema:
- $ref: "#/components/schemas/CustomRuleRevisionsResponse"
+ $ref: '#/components/schemas/CustomRuleRevisionsResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: List Custom Rule Revisions
tags:
@@ -215542,7 +215603,7 @@ paths:
tree_sitter_query: "(call_expression) @call"
type: custom_rule_revision
schema:
- $ref: "#/components/schemas/CustomRuleRevisionRequest"
+ $ref: '#/components/schemas/CustomRuleRevisionRequest'
required: true
responses:
"200":
@@ -215551,19 +215612,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Rule not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215598,7 +215659,7 @@ paths:
data:
type: revert_custom_rule_revision_request
schema:
- $ref: "#/components/schemas/RevertCustomRuleRevisionRequest"
+ $ref: '#/components/schemas/RevertCustomRuleRevisionRequest'
required: true
responses:
"200":
@@ -215607,13 +215668,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215677,25 +215738,25 @@ paths:
id: revision-123
type: custom_rule_revision
schema:
- $ref: "#/components/schemas/CustomRuleRevisionResponse"
+ $ref: '#/components/schemas/CustomRuleRevisionResponse'
description: Successful response
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized - custom rules not enabled
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Revision not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215730,13 +215791,13 @@ paths:
id: python
type: defaultRulesetsPerLanguage
schema:
- $ref: "#/components/schemas/DefaultRulesetsPerLanguageResponse"
+ $ref: '#/components/schemas/DefaultRulesetsPerLanguageResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215765,7 +215826,7 @@ paths:
data:
type: get_multiple_rulesets_request
schema:
- $ref: "#/components/schemas/GetMultipleRulesetsRequest"
+ $ref: '#/components/schemas/GetMultipleRulesetsRequest'
required: true
responses:
"200":
@@ -215780,7 +215841,7 @@ paths:
id: abc-123
type: get_multiple_rulesets_response
schema:
- $ref: "#/components/schemas/GetMultipleRulesetsResponse"
+ $ref: '#/components/schemas/GetMultipleRulesetsResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215834,19 +215895,19 @@ paths:
id: python-best-practices
type: rulesets
schema:
- $ref: "#/components/schemas/SastRulesetResponse"
+ $ref: '#/components/schemas/SastRulesetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215883,7 +215944,7 @@ paths:
id: abc-123
type: secret_rule
schema:
- $ref: "#/components/schemas/SecretRuleArray"
+ $ref: '#/components/schemas/SecretRuleArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215916,7 +215977,7 @@ paths:
rules: []
type: analysis_request
schema:
- $ref: "#/components/schemas/AnalysisRequest"
+ $ref: '#/components/schemas/AnalysisRequest'
required: true
responses:
"200":
@@ -215932,19 +215993,19 @@ paths:
id: abc-123
type: server_request
schema:
- $ref: "#/components/schemas/AnalysisResponse"
+ $ref: '#/components/schemas/AnalysisResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -215977,7 +216038,7 @@ paths:
language: python
type: get_ast_request
schema:
- $ref: "#/components/schemas/GetAstRequest"
+ $ref: '#/components/schemas/GetAstRequest'
required: true
responses:
"200":
@@ -215991,19 +216052,19 @@ paths:
ast: {}
type: get_ast_response
schema:
- $ref: "#/components/schemas/GetAstResponse"
+ $ref: '#/components/schemas/GetAstResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216044,19 +216105,19 @@ paths:
id: python
type: get_node_types_response
schema:
- $ref: "#/components/schemas/NodeTypesResponse"
+ $ref: '#/components/schemas/NodeTypesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216099,13 +216160,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unauthorized
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216169,7 +216230,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: status_pages
schema:
- $ref: "#/components/schemas/StatusPageArray"
+ $ref: '#/components/schemas/StatusPageArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216230,7 +216291,7 @@ paths:
visualization_type: bars_and_uptime_percentage
type: status_pages
schema:
- $ref: "#/components/schemas/CreateStatusPageRequest"
+ $ref: '#/components/schemas/CreateStatusPageRequest'
required: true
responses:
"201":
@@ -216251,7 +216312,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: status_pages
schema:
- $ref: "#/components/schemas/StatusPage"
+ $ref: '#/components/schemas/StatusPage'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216331,7 +216392,7 @@ paths:
id: 00000000-0000-0000-0000-000000000005
type: degradations
schema:
- $ref: "#/components/schemas/DegradationArray"
+ $ref: '#/components/schemas/DegradationArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216407,7 +216468,7 @@ paths:
id: 00000000-0000-0000-0000-000000000016
type: maintenances
schema:
- $ref: "#/components/schemas/MaintenanceArray"
+ $ref: '#/components/schemas/MaintenanceArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216491,7 +216552,7 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: status_pages
schema:
- $ref: "#/components/schemas/StatusPage"
+ $ref: '#/components/schemas/StatusPage'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216550,7 +216611,7 @@ paths:
id: 1234abcd-12ab-34cd-56ef-123456abcdef
type: status_pages
schema:
- $ref: "#/components/schemas/PatchStatusPageRequest"
+ $ref: '#/components/schemas/PatchStatusPageRequest'
required: true
responses:
"200":
@@ -216571,7 +216632,7 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: status_pages
schema:
- $ref: "#/components/schemas/StatusPage"
+ $ref: '#/components/schemas/StatusPage'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216622,7 +216683,7 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: components
schema:
- $ref: "#/components/schemas/StatusPagesComponentArray"
+ $ref: '#/components/schemas/StatusPagesComponentArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216672,7 +216733,7 @@ paths:
data:
type: components
schema:
- $ref: "#/components/schemas/CreateComponentRequest"
+ $ref: '#/components/schemas/CreateComponentRequest'
required: true
responses:
"201":
@@ -216690,7 +216751,7 @@ paths:
id: 00000000-0000-0000-0000-000000000009
type: components
schema:
- $ref: "#/components/schemas/StatusPagesComponent"
+ $ref: '#/components/schemas/StatusPagesComponent'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216787,7 +216848,7 @@ paths:
id: 00000000-0000-0000-0000-000000000012
type: components
schema:
- $ref: "#/components/schemas/StatusPagesComponent"
+ $ref: '#/components/schemas/StatusPagesComponent'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216842,7 +216903,7 @@ paths:
id: 1234abcd-12ab-34cd-56ef-123456abcdef
type: components
schema:
- $ref: "#/components/schemas/PatchComponentRequest"
+ $ref: '#/components/schemas/PatchComponentRequest'
required: true
responses:
"200":
@@ -216860,7 +216921,7 @@ paths:
id: 00000000-0000-0000-0000-000000000011
type: components
schema:
- $ref: "#/components/schemas/StatusPagesComponent"
+ $ref: '#/components/schemas/StatusPagesComponent'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216914,7 +216975,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradation_templates
schema:
- $ref: "#/components/schemas/DegradationTemplateArray"
+ $ref: '#/components/schemas/DegradationTemplateArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -216961,7 +217022,7 @@ paths:
status: investigating
type: degradation_templates
schema:
- $ref: "#/components/schemas/CreateDegradationTemplateRequest"
+ $ref: '#/components/schemas/CreateDegradationTemplateRequest'
required: true
responses:
"201":
@@ -216983,7 +217044,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradation_templates
schema:
- $ref: "#/components/schemas/DegradationTemplate"
+ $ref: '#/components/schemas/DegradationTemplate'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217072,7 +217133,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradation_templates
schema:
- $ref: "#/components/schemas/DegradationTemplate"
+ $ref: '#/components/schemas/DegradationTemplate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217121,7 +217182,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradation_templates
schema:
- $ref: "#/components/schemas/PatchDegradationTemplateRequest"
+ $ref: '#/components/schemas/PatchDegradationTemplateRequest'
required: true
responses:
"200":
@@ -217143,7 +217204,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradation_templates
schema:
- $ref: "#/components/schemas/DegradationTemplate"
+ $ref: '#/components/schemas/DegradationTemplate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217196,7 +217257,7 @@ paths:
title: Elevated API Latency
type: degradations
schema:
- $ref: "#/components/schemas/CreateDegradationRequest"
+ $ref: '#/components/schemas/CreateDegradationRequest'
required: true
responses:
"201":
@@ -217219,7 +217280,7 @@ paths:
id: 00000000-0000-0000-0000-000000000010
type: degradations
schema:
- $ref: "#/components/schemas/Degradation"
+ $ref: '#/components/schemas/Degradation'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217277,7 +217338,7 @@ paths:
status: resolved
type: degradations
schema:
- $ref: "#/components/schemas/CreateBackfilledDegradationRequest"
+ $ref: '#/components/schemas/CreateBackfilledDegradationRequest'
required: true
responses:
"201":
@@ -217300,7 +217361,7 @@ paths:
id: 00000000-0000-0000-0000-000000000010
type: degradations
schema:
- $ref: "#/components/schemas/Degradation"
+ $ref: '#/components/schemas/Degradation'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217402,7 +217463,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: degradations
schema:
- $ref: "#/components/schemas/Degradation"
+ $ref: '#/components/schemas/Degradation'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217467,7 +217528,7 @@ paths:
id: 1234abcd-12ab-34cd-56ef-123456abcdef
type: degradations
schema:
- $ref: "#/components/schemas/PatchDegradationRequest"
+ $ref: '#/components/schemas/PatchDegradationRequest'
required: true
responses:
"200":
@@ -217490,7 +217551,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: degradations
schema:
- $ref: "#/components/schemas/Degradation"
+ $ref: '#/components/schemas/Degradation'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217590,7 +217651,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: degradation_updates
schema:
- $ref: "#/components/schemas/PatchDegradationUpdateRequest"
+ $ref: '#/components/schemas/PatchDegradationUpdateRequest'
required: true
responses:
"200":
@@ -217606,7 +217667,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: degradation_updates
schema:
- $ref: "#/components/schemas/DegradationUpdate"
+ $ref: '#/components/schemas/DegradationUpdate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217655,7 +217716,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: maintenance_templates
schema:
- $ref: "#/components/schemas/MaintenanceTemplateArray"
+ $ref: '#/components/schemas/MaintenanceTemplateArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217701,7 +217762,7 @@ paths:
scheduled_description: We will be performing maintenance on the API to improve performance.
type: maintenance_templates
schema:
- $ref: "#/components/schemas/CreateMaintenanceTemplateRequest"
+ $ref: '#/components/schemas/CreateMaintenanceTemplateRequest'
required: true
responses:
"201":
@@ -217722,7 +217783,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: maintenance_templates
schema:
- $ref: "#/components/schemas/MaintenanceTemplate"
+ $ref: '#/components/schemas/MaintenanceTemplate'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217810,7 +217871,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: maintenance_templates
schema:
- $ref: "#/components/schemas/MaintenanceTemplate"
+ $ref: '#/components/schemas/MaintenanceTemplate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217861,7 +217922,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: maintenance_templates
schema:
- $ref: "#/components/schemas/PatchMaintenanceTemplateRequest"
+ $ref: '#/components/schemas/PatchMaintenanceTemplateRequest'
required: true
responses:
"200":
@@ -217882,7 +217943,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: maintenance_templates
schema:
- $ref: "#/components/schemas/MaintenanceTemplate"
+ $ref: '#/components/schemas/MaintenanceTemplate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -217937,7 +217998,7 @@ paths:
title: API Maintenance
type: maintenances
schema:
- $ref: "#/components/schemas/CreateMaintenanceRequest"
+ $ref: '#/components/schemas/CreateMaintenanceRequest'
required: true
responses:
"201":
@@ -217959,7 +218020,7 @@ paths:
id: 00000000-0000-0000-0000-000000000015
type: maintenances
schema:
- $ref: "#/components/schemas/Maintenance"
+ $ref: '#/components/schemas/Maintenance'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218017,7 +218078,7 @@ paths:
status: completed
type: maintenances
schema:
- $ref: "#/components/schemas/CreateBackfilledMaintenanceRequest"
+ $ref: '#/components/schemas/CreateBackfilledMaintenanceRequest'
required: true
responses:
"201":
@@ -218039,7 +218100,7 @@ paths:
id: 00000000-0000-0000-0000-000000000015
type: maintenances
schema:
- $ref: "#/components/schemas/Maintenance"
+ $ref: '#/components/schemas/Maintenance'
description: Created
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218100,7 +218161,7 @@ paths:
id: 00000000-0000-0000-0000-000000000013
type: maintenances
schema:
- $ref: "#/components/schemas/Maintenance"
+ $ref: '#/components/schemas/Maintenance'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218162,7 +218223,7 @@ paths:
id: 1234abcd-12ab-34cd-56ef-123456abcdef
type: maintenances
schema:
- $ref: "#/components/schemas/PatchMaintenanceRequest"
+ $ref: '#/components/schemas/PatchMaintenanceRequest'
required: true
responses:
"200":
@@ -218184,7 +218245,7 @@ paths:
id: 00000000-0000-0000-0000-000000000014
type: maintenances
schema:
- $ref: "#/components/schemas/Maintenance"
+ $ref: '#/components/schemas/Maintenance'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218239,7 +218300,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: maintenance_updates
schema:
- $ref: "#/components/schemas/PatchMaintenanceUpdateRequest"
+ $ref: '#/components/schemas/PatchMaintenanceUpdateRequest'
required: true
responses:
"200":
@@ -218260,7 +218321,7 @@ paths:
id: 00000000-0000-0000-0000-000000000000
type: maintenance_updates
schema:
- $ref: "#/components/schemas/MaintenanceUpdate"
+ $ref: '#/components/schemas/MaintenanceUpdate'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218357,7 +218418,7 @@ paths:
value:
image: "screenshot.png"
schema:
- $ref: "#/components/schemas/StegadographyGetWidgetsRequest"
+ $ref: '#/components/schemas/StegadographyGetWidgetsRequest'
description: PNG image to extract watermarks from.
required: true
responses:
@@ -218376,25 +218437,25 @@ paths:
id: "abc123:0123456789abcdef"
type: widget
schema:
- $ref: "#/components/schemas/StegadographyGetWidgetsResponse"
+ $ref: '#/components/schemas/StegadographyGetWidgetsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"415":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Unsupported Media Type
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218402,7 +218463,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error
security:
- apiKeyAuth: []
@@ -218433,7 +218494,7 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/SyntheticsApiMultistepSubtestsResponse"
+ $ref: '#/components/schemas/SyntheticsApiMultistepSubtestsResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218472,13 +218533,13 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/SyntheticsApiMultistepParentTestsResponse"
+ $ref: '#/components/schemas/SyntheticsApiMultistepParentTestsResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218548,19 +218609,19 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimesResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218598,7 +218659,7 @@ paths:
timezone: Europe/Paris
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeRequest'
required: true
responses:
"201":
@@ -218634,19 +218695,19 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeResponse'
description: Created
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218678,19 +218739,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218748,25 +218809,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218812,7 +218873,7 @@ paths:
timezone: Europe/Paris
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeRequest"
+ $ref: '#/components/schemas/SyntheticsDowntimeRequest'
required: true
responses:
"200":
@@ -218848,25 +218909,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -218932,25 +218993,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219014,25 +219075,25 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: downtime
schema:
- $ref: "#/components/schemas/SyntheticsDowntimeResponse"
+ $ref: '#/components/schemas/SyntheticsDowntimeResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219060,7 +219121,7 @@ paths:
on_demand_concurrency_cap: 20
type: on_demand_concurrency_cap
schema:
- $ref: "#/components/schemas/OnDemandConcurrencyCapResponse"
+ $ref: '#/components/schemas/OnDemandConcurrencyCapResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219083,7 +219144,7 @@ paths:
value:
on_demand_concurrency_cap: 20
schema:
- $ref: "#/components/schemas/OnDemandConcurrencyCapAttributes"
+ $ref: '#/components/schemas/OnDemandConcurrencyCapAttributes'
description: .
required: true
responses:
@@ -219098,7 +219159,7 @@ paths:
on_demand_concurrency_cap: 20
type: on_demand_concurrency_cap
schema:
- $ref: "#/components/schemas/OnDemandConcurrencyCapResponse"
+ $ref: '#/components/schemas/OnDemandConcurrencyCapResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219134,7 +219195,7 @@ paths:
type: suite
type: suites
schema:
- $ref: "#/components/schemas/SuiteCreateEditRequest"
+ $ref: '#/components/schemas/SuiteCreateEditRequest'
required: true
responses:
"200":
@@ -219160,13 +219221,13 @@ paths:
id: 123-abc-456
type: suites
schema:
- $ref: "#/components/schemas/SyntheticsSuiteResponse"
+ $ref: '#/components/schemas/SyntheticsSuiteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219199,7 +219260,7 @@ paths:
- ""
type: delete_suites_request
schema:
- $ref: "#/components/schemas/DeletedSuitesRequestDeleteRequest"
+ $ref: '#/components/schemas/DeletedSuitesRequestDeleteRequest'
required: true
responses:
"200":
@@ -219215,13 +219276,13 @@ paths:
id: 123-abc-456
type: suites
schema:
- $ref: "#/components/schemas/DeletedSuitesResponse"
+ $ref: '#/components/schemas/DeletedSuitesResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219302,13 +219363,13 @@ paths:
id: abc-123
type: suites_search
schema:
- $ref: "#/components/schemas/SyntheticsSuiteSearchResponse"
+ $ref: '#/components/schemas/SyntheticsSuiteSearchResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219359,13 +219420,13 @@ paths:
id: 123-abc-456
type: suites
schema:
- $ref: "#/components/schemas/SyntheticsSuiteResponse"
+ $ref: '#/components/schemas/SyntheticsSuiteResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219411,7 +219472,7 @@ paths:
type: suite
type: suites
schema:
- $ref: "#/components/schemas/SuiteCreateEditRequest"
+ $ref: '#/components/schemas/SuiteCreateEditRequest'
description: New suite details to be saved.
required: true
responses:
@@ -219438,13 +219499,13 @@ paths:
id: 123-abc-456
type: suites
schema:
- $ref: "#/components/schemas/SyntheticsSuiteResponse"
+ $ref: '#/components/schemas/SyntheticsSuiteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219493,7 +219554,7 @@ paths:
path: /name
type: suites_json_patch
schema:
- $ref: "#/components/schemas/SuiteJsonPatchRequest"
+ $ref: '#/components/schemas/SuiteJsonPatchRequest'
description: JSON Patch document with operations to apply.
required: true
responses:
@@ -219520,13 +219581,13 @@ paths:
id: 123-abc-456
type: suites
schema:
- $ref: "#/components/schemas/SyntheticsSuiteResponse"
+ $ref: '#/components/schemas/SyntheticsSuiteResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219575,13 +219636,13 @@ paths:
name: status
required: false
schema:
- $ref: "#/components/schemas/SyntheticsTestResultStatus"
+ $ref: '#/components/schemas/SyntheticsTestResultStatus'
- description: Filter results by run type.
in: query
name: runType
required: false
schema:
- $ref: "#/components/schemas/SyntheticsTestResultRunType"
+ $ref: '#/components/schemas/SyntheticsTestResultRunType'
- description: Locations for which to query results.
in: query
name: probe_dc
@@ -219628,19 +219689,19 @@ paths:
type: test
type: result_summary
schema:
- $ref: "#/components/schemas/SyntheticsTestLatestResultsResponse"
+ $ref: '#/components/schemas/SyntheticsTestLatestResultsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219719,19 +219780,19 @@ paths:
type: test
type: result
schema:
- $ref: "#/components/schemas/SyntheticsTestResultResponse"
+ $ref: '#/components/schemas/SyntheticsTestResultResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219764,7 +219825,7 @@ paths:
- xyz-uvw-456
type: delete_tests_request
schema:
- $ref: "#/components/schemas/DeletedTestsRequestDeleteRequest"
+ $ref: '#/components/schemas/DeletedTestsRequestDeleteRequest'
required: true
responses:
"200":
@@ -219777,19 +219838,19 @@ paths:
- id: abc-def-123
type: delete_tests
schema:
- $ref: "#/components/schemas/DeletedTestsResponse"
+ $ref: '#/components/schemas/DeletedTestsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219843,19 +219904,19 @@ paths:
id: abc12345-1234-1234-1234-abc123456789
type: result
schema:
- $ref: "#/components/schemas/SyntheticsFastTestResult"
+ $ref: '#/components/schemas/SyntheticsFastTestResult'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219922,7 +219983,7 @@ paths:
type: network
type: network
schema:
- $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest"
+ $ref: '#/components/schemas/SyntheticsNetworkTestEditRequest'
required: true
responses:
"200":
@@ -219944,13 +220005,13 @@ paths:
id: abc-def-123
type: network_test
schema:
- $ref: "#/components/schemas/SyntheticsNetworkTestResponse"
+ $ref: '#/components/schemas/SyntheticsNetworkTestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -219998,19 +220059,19 @@ paths:
id: abc-def-123
type: network_test
schema:
- $ref: "#/components/schemas/SyntheticsNetworkTestResponse"
+ $ref: '#/components/schemas/SyntheticsNetworkTestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220083,7 +220144,7 @@ paths:
type: network
type: network
schema:
- $ref: "#/components/schemas/SyntheticsNetworkTestEditRequest"
+ $ref: '#/components/schemas/SyntheticsNetworkTestEditRequest'
description: New Network Path test details to be saved.
required: true
responses:
@@ -220106,19 +220167,19 @@ paths:
id: abc-def-123
type: network_test
schema:
- $ref: "#/components/schemas/SyntheticsNetworkTestResponse"
+ $ref: '#/components/schemas/SyntheticsNetworkTestResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220179,19 +220240,19 @@ paths:
type: test
type: result
schema:
- $ref: "#/components/schemas/SyntheticsPollTestResultsResponse"
+ $ref: '#/components/schemas/SyntheticsPollTestResultsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220230,7 +220291,7 @@ paths:
value:
bucketKey: api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json
schema:
- $ref: "#/components/schemas/SyntheticsTestFileDownloadRequest"
+ $ref: '#/components/schemas/SyntheticsTestFileDownloadRequest'
required: true
responses:
"200":
@@ -220241,25 +220302,25 @@ paths:
value:
presignedUrl: https://example.com/download
schema:
- $ref: "#/components/schemas/SyntheticsTestFileDownloadResponse"
+ $ref: '#/components/schemas/SyntheticsTestFileDownloadResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220301,7 +220362,7 @@ paths:
- md5: 1B2M2Y8AsgTpgAmY7PhCfg==
partNumber: 1
schema:
- $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequest"
+ $ref: '#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsRequest'
required: true
responses:
"200":
@@ -220313,25 +220374,25 @@ paths:
bucketKey: api-upload-file/abc-def-123/file.json
presignedUrls: []
schema:
- $ref: "#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsResponse"
+ $ref: '#/components/schemas/SyntheticsTestFileMultipartPresignedUrlsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220372,7 +220433,7 @@ paths:
key: org-123/api-upload-file/abc-def-123/2024-01-01T00:00:00_uuid.json
uploadId: upload-id-abc123
schema:
- $ref: "#/components/schemas/SyntheticsTestFileAbortMultipartUploadRequest"
+ $ref: '#/components/schemas/SyntheticsTestFileAbortMultipartUploadRequest'
required: true
responses:
"204":
@@ -220381,19 +220442,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220437,7 +220498,7 @@ paths:
PartNumber: 1
uploadId: upload-id-abc123
schema:
- $ref: "#/components/schemas/SyntheticsTestFileCompleteMultipartUploadRequest"
+ $ref: '#/components/schemas/SyntheticsTestFileCompleteMultipartUploadRequest'
required: true
responses:
"204":
@@ -220446,19 +220507,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220496,13 +220557,13 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/SyntheticsTestParentSuitesResponse"
+ $ref: '#/components/schemas/SyntheticsTestParentSuitesResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220549,13 +220610,13 @@ paths:
name: status
required: false
schema:
- $ref: "#/components/schemas/SyntheticsTestResultStatus"
+ $ref: '#/components/schemas/SyntheticsTestResultStatus'
- description: Filter results by run type.
in: query
name: runType
required: false
schema:
- $ref: "#/components/schemas/SyntheticsTestResultRunType"
+ $ref: '#/components/schemas/SyntheticsTestResultRunType'
- description: Locations for which to query results.
in: query
name: probe_dc
@@ -220599,19 +220660,19 @@ paths:
type: test
type: result_summary
schema:
- $ref: "#/components/schemas/SyntheticsTestLatestResultsResponse"
+ $ref: '#/components/schemas/SyntheticsTestLatestResultsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220687,19 +220748,19 @@ paths:
type: test
type: result
schema:
- $ref: "#/components/schemas/SyntheticsTestResultResponse"
+ $ref: '#/components/schemas/SyntheticsTestResultResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220751,19 +220812,19 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/SyntheticsTestVersionHistoryResponse"
+ $ref: '#/components/schemas/SyntheticsTestVersionHistoryResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220823,13 +220884,13 @@ paths:
public_id: abc-def-123
version_number: 1
schema:
- $ref: "#/components/schemas/SyntheticsTestVersionResponse"
+ $ref: '#/components/schemas/SyntheticsTestVersionResponse'
description: OK
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220878,7 +220939,7 @@ paths:
path: /name
type: global_variables_json_patch
schema:
- $ref: "#/components/schemas/GlobalVariableJsonPatchRequest"
+ $ref: '#/components/schemas/GlobalVariableJsonPatchRequest'
description: JSON Patch document with operations to apply.
required: true
responses:
@@ -220900,7 +220961,7 @@ paths:
id: abc-123
type: global_variables
schema:
- $ref: "#/components/schemas/GlobalVariableResponse"
+ $ref: '#/components/schemas/GlobalVariableResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -220953,7 +221014,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: ruleset
schema:
- $ref: "#/components/schemas/RulesetRespArray"
+ $ref: '#/components/schemas/RulesetRespArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -220991,7 +221052,7 @@ paths:
id: New Ruleset
type: create_ruleset
schema:
- $ref: "#/components/schemas/CreateRulesetRequest"
+ $ref: '#/components/schemas/CreateRulesetRequest'
required: true
responses:
"200":
@@ -221025,7 +221086,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: ruleset
schema:
- $ref: "#/components/schemas/RulesetResp"
+ $ref: '#/components/schemas/RulesetResp'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221056,7 +221117,7 @@ paths:
- id: f1e2d3c4-b5a6-9780-1234-567890abcdef
type: ruleset
schema:
- $ref: "#/components/schemas/ReorderRulesetResourceArray"
+ $ref: '#/components/schemas/ReorderRulesetResourceArray'
required: true
responses:
"204":
@@ -221093,7 +221154,7 @@ paths:
id: a7b8c9d0-1234-5678-9abc-def012345678
type: ruleset_status
schema:
- $ref: "#/components/schemas/RulesetStatusRespArray"
+ $ref: '#/components/schemas/RulesetStatusRespArray'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221121,7 +221182,7 @@ paths:
Query: example:query AND test:true
type: validate_query
schema:
- $ref: "#/components/schemas/RulesValidateQueryRequest"
+ $ref: '#/components/schemas/RulesValidateQueryRequest'
required: true
responses:
"200":
@@ -221135,7 +221196,7 @@ paths:
Canonical: canonical query representation
type: validate_response
schema:
- $ref: "#/components/schemas/RulesValidateQueryResponse"
+ $ref: '#/components/schemas/RulesValidateQueryResponse'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221215,7 +221276,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: ruleset
schema:
- $ref: "#/components/schemas/RulesetResp"
+ $ref: '#/components/schemas/RulesetResp'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221285,7 +221346,7 @@ paths:
table_name: http_status_codes
type: update_ruleset
schema:
- $ref: "#/components/schemas/UpdateRulesetRequest"
+ $ref: '#/components/schemas/UpdateRulesetRequest'
required: true
responses:
"200":
@@ -221313,7 +221374,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: ruleset
schema:
- $ref: "#/components/schemas/RulesetResp"
+ $ref: '#/components/schemas/RulesetResp'
description: OK
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221340,7 +221401,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/ListTeamsSort"
+ $ref: '#/components/schemas/ListTeamsSort'
- description: |-
Included related resources optionally requested. Allowed enum values: `team_links, user_team_permissions`
in: query
@@ -221348,7 +221409,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/ListTeamsInclude"
+ $ref: '#/components/schemas/ListTeamsInclude'
type: array
- description: Search query. Can be team name, team handle, or email of team member
in: query
@@ -221369,7 +221430,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/TeamsField"
+ $ref: '#/components/schemas/TeamsField'
type: array
responses:
"200":
@@ -221389,7 +221450,7 @@ paths:
offset: 0
total: 1
schema:
- $ref: "#/components/schemas/TeamsResponse"
+ $ref: '#/components/schemas/TeamsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221433,7 +221494,7 @@ paths:
data: []
type: team
schema:
- $ref: "#/components/schemas/TeamCreateRequest"
+ $ref: '#/components/schemas/TeamCreateRequest'
required: true
responses:
"201":
@@ -221449,7 +221510,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: team
schema:
- $ref: "#/components/schemas/TeamResponse"
+ $ref: '#/components/schemas/TeamResponse'
description: CREATED
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221457,7 +221518,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221510,7 +221571,7 @@ paths:
id: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: team_hierarchy_links
schema:
- $ref: "#/components/schemas/TeamHierarchyLinksResponse"
+ $ref: '#/components/schemas/TeamHierarchyLinksResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221554,7 +221615,7 @@ paths:
type: team
type: team_hierarchy_links
schema:
- $ref: "#/components/schemas/TeamHierarchyLinkCreateRequest"
+ $ref: '#/components/schemas/TeamHierarchyLinkCreateRequest'
required: true
responses:
"200":
@@ -221570,7 +221631,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_hierarchy_links
schema:
- $ref: "#/components/schemas/TeamHierarchyLinkResponse"
+ $ref: '#/components/schemas/TeamHierarchyLinkResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221578,7 +221639,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Conflict
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221617,7 +221678,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221660,7 +221721,7 @@ paths:
id: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: team_hierarchy_links
schema:
- $ref: "#/components/schemas/TeamHierarchyLinkResponse"
+ $ref: '#/components/schemas/TeamHierarchyLinkResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221668,7 +221729,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -221699,7 +221760,7 @@ paths:
- id: 12345678-1234-5678-9abc-123456789012
type: team_connection
schema:
- $ref: "#/components/schemas/TeamConnectionDeleteRequest"
+ $ref: '#/components/schemas/TeamConnectionDeleteRequest'
required: true
responses:
"204":
@@ -221789,7 +221850,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_connection
schema:
- $ref: "#/components/schemas/TeamConnectionsResponse"
+ $ref: '#/components/schemas/TeamConnectionsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -221838,7 +221899,7 @@ paths:
type: team
type: team_connection
schema:
- $ref: "#/components/schemas/TeamConnectionCreateRequest"
+ $ref: '#/components/schemas/TeamConnectionCreateRequest'
required: true
responses:
"201":
@@ -221854,7 +221915,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: team_connection
schema:
- $ref: "#/components/schemas/TeamConnectionsResponse"
+ $ref: '#/components/schemas/TeamConnectionsResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -221889,7 +221950,7 @@ paths:
name: filter[source]
required: true
schema:
- $ref: "#/components/schemas/TeamSyncAttributesSource"
+ $ref: '#/components/schemas/TeamSyncAttributesSource'
responses:
"200":
content:
@@ -221905,7 +221966,7 @@ paths:
type: link
type: team_sync_bulk
schema:
- $ref: "#/components/schemas/TeamSyncResponse"
+ $ref: '#/components/schemas/TeamSyncResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -221954,7 +222015,7 @@ paths:
type: link
type: team_sync_bulk
schema:
- $ref: "#/components/schemas/TeamSyncRequest"
+ $ref: '#/components/schemas/TeamSyncRequest'
required: true
responses:
"200":
@@ -221969,7 +222030,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Internal Server Error - Unexpected error during linking.
security:
- apiKeyAuth: []
@@ -222010,7 +222071,7 @@ paths:
required: false
schema:
items:
- $ref: "#/components/schemas/TeamsField"
+ $ref: '#/components/schemas/TeamsField'
type: array
responses:
"200":
@@ -222030,7 +222091,7 @@ paths:
offset: 0
total: 1
schema:
- $ref: "#/components/schemas/TeamsResponse"
+ $ref: '#/components/schemas/TeamsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222038,7 +222099,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222088,7 +222149,7 @@ paths:
id: aeadc05e-98a8-11ec-ac2c-da7ad0900001
type: member_teams
schema:
- $ref: "#/components/schemas/AddMemberTeamRequest"
+ $ref: '#/components/schemas/AddMemberTeamRequest'
required: true
responses:
"204":
@@ -222099,7 +222160,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222150,7 +222211,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222191,7 +222252,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222234,7 +222295,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: team
schema:
- $ref: "#/components/schemas/TeamResponse"
+ $ref: '#/components/schemas/TeamResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222242,7 +222303,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222290,7 +222351,7 @@ paths:
related: /api/v2/team/c75a4a8e-20c7-11ee-a3a5-da7ad0900002/links
type: team
schema:
- $ref: "#/components/schemas/TeamUpdateRequest"
+ $ref: '#/components/schemas/TeamUpdateRequest'
required: true
responses:
"200":
@@ -222306,13 +222367,13 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: team
schema:
- $ref: "#/components/schemas/TeamResponse"
+ $ref: '#/components/schemas/TeamResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222320,13 +222381,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222370,7 +222431,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinksResponse"
+ $ref: '#/components/schemas/TeamLinksResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222378,7 +222439,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222418,7 +222479,7 @@ paths:
url: https://example.com
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinkCreateRequest"
+ $ref: '#/components/schemas/TeamLinkCreateRequest'
required: true
responses:
"200":
@@ -222434,7 +222495,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinkResponse"
+ $ref: '#/components/schemas/TeamLinkResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222442,13 +222503,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222492,7 +222553,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222540,7 +222601,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinkResponse"
+ $ref: '#/components/schemas/TeamLinkResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222548,7 +222609,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222593,7 +222654,7 @@ paths:
url: https://example.com
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinkCreateRequest"
+ $ref: '#/components/schemas/TeamLinkCreateRequest'
required: true
responses:
"200":
@@ -222610,7 +222671,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: team_links
schema:
- $ref: "#/components/schemas/TeamLinkResponse"
+ $ref: '#/components/schemas/TeamLinkResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222618,7 +222679,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222654,7 +222715,7 @@ paths:
name: sort
required: false
schema:
- $ref: "#/components/schemas/GetTeamMembershipsSort"
+ $ref: '#/components/schemas/GetTeamMembershipsSort'
- description: Search query, can be user email or name
in: query
name: filter[keyword]
@@ -222674,7 +222735,7 @@ paths:
id: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamsResponse"
+ $ref: '#/components/schemas/UserTeamsResponse'
description: Represents a user's association to a team
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222682,7 +222743,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222736,7 +222797,7 @@ paths:
type: users
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamRequest"
+ $ref: '#/components/schemas/UserTeamRequest'
required: true
responses:
"200":
@@ -222751,7 +222812,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamResponse"
+ $ref: '#/components/schemas/UserTeamResponse'
description: Represents a user's association to a team
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222759,13 +222820,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222812,7 +222873,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222859,7 +222920,7 @@ paths:
role: admin
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamUpdateRequest"
+ $ref: '#/components/schemas/UserTeamUpdateRequest'
required: true
responses:
"200":
@@ -222874,13 +222935,13 @@ paths:
id: TeamMembership-aeadc05e-98a8-11ec-ac2c-da7ad0900001-38835
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamResponse"
+ $ref: '#/components/schemas/UserTeamResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222888,7 +222949,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222933,7 +222994,7 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRulesResponse"
+ $ref: '#/components/schemas/TeamNotificationRulesResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -222941,7 +223002,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -222982,7 +223043,7 @@ paths:
workspace: Datadog
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRuleRequest"
+ $ref: '#/components/schemas/TeamNotificationRuleRequest'
required: true
responses:
"201":
@@ -223001,7 +223062,7 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRuleResponse"
+ $ref: '#/components/schemas/TeamNotificationRuleResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -223009,13 +223070,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"409":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223057,7 +223118,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223106,7 +223167,7 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRuleResponse"
+ $ref: '#/components/schemas/TeamNotificationRuleResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -223114,7 +223175,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223162,7 +223223,7 @@ paths:
id: b8626d7e-cedd-11eb-abf5-da7ad0900001
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRuleRequest"
+ $ref: '#/components/schemas/TeamNotificationRuleRequest'
required: true
responses:
"200":
@@ -223181,7 +223242,7 @@ paths:
id: 00000000-0000-0000-0000-000000000004
type: team_notification_rules
schema:
- $ref: "#/components/schemas/TeamNotificationRuleResponse"
+ $ref: '#/components/schemas/TeamNotificationRuleResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -223189,7 +223250,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223232,7 +223293,7 @@ paths:
id: TeamPermission-abc-123-edit
type: team_permission_settings
schema:
- $ref: "#/components/schemas/TeamPermissionSettingsResponse"
+ $ref: '#/components/schemas/TeamPermissionSettingsResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -223240,7 +223301,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223285,7 +223346,7 @@ paths:
value: admins
type: team_permission_settings
schema:
- $ref: "#/components/schemas/TeamPermissionSettingUpdateRequest"
+ $ref: '#/components/schemas/TeamPermissionSettingUpdateRequest'
required: true
responses:
"200":
@@ -223302,7 +223363,7 @@ paths:
id: TeamPermission-abc-123-edit
type: team_permission_settings
schema:
- $ref: "#/components/schemas/TeamPermissionSettingResponse"
+ $ref: '#/components/schemas/TeamPermissionSettingResponse'
description: OK
"403":
$ref: "#/components/responses/ForbiddenResponse"
@@ -223310,7 +223371,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223346,7 +223407,7 @@ paths:
new_state: active
type: update_flaky_test_state_request
schema:
- $ref: "#/components/schemas/UpdateFlakyTestsRequest"
+ $ref: '#/components/schemas/UpdateFlakyTestsRequest'
required: true
responses:
"200":
@@ -223364,7 +223425,7 @@ paths:
id: abc-123
type: update_flaky_test_state_response
schema:
- $ref: "#/components/schemas/UpdateFlakyTestsResponse"
+ $ref: '#/components/schemas/UpdateFlakyTestsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -223418,7 +223479,7 @@ paths:
sort: failure_rate
type: search_flaky_tests_request
schema:
- $ref: "#/components/schemas/FlakyTestsSearchRequest"
+ $ref: '#/components/schemas/FlakyTestsSearchRequest'
required: false
responses:
"200":
@@ -223443,7 +223504,7 @@ paths:
pagination:
next_page: eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==
schema:
- $ref: "#/components/schemas/FlakyTestsSearchResponse"
+ $ref: '#/components/schemas/FlakyTestsSearchResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -223522,25 +223583,25 @@ paths:
id: "0000000000000000abc1230000000000"
type: trace
schema:
- $ref: "#/components/schemas/TraceResponse"
+ $ref: '#/components/schemas/TraceResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"413":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Payload Too Large
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -223593,25 +223654,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/UsageApplicationSecurityMonitoringResponse"
+ $ref: '#/components/schemas/UsageApplicationSecurityMonitoringResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -223658,25 +223719,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/BillingDimensionsMappingResponse"
+ $ref: '#/components/schemas/BillingDimensionsMappingResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -223727,25 +223788,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/CostByOrgResponse"
+ $ref: '#/components/schemas/CostByOrgResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -223812,7 +223873,7 @@ paths:
name: cost_aggregation
required: false
schema:
- $ref: "#/components/schemas/CostAggregationType"
+ $ref: '#/components/schemas/CostAggregationType'
- description: "Boolean to specify whether to include accounts connected to the current account as partner customers in the Datadog partner network program. Defaults to `false`."
in: query
name: include_connected_accounts
@@ -223829,25 +223890,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/CostByOrgResponse"
+ $ref: '#/components/schemas/CostByOrgResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -223909,25 +223970,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/CostByOrgResponse"
+ $ref: '#/components/schemas/CostByOrgResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224037,25 +224098,25 @@ paths:
- id: abc-123
type: usage_timeseries
schema:
- $ref: "#/components/schemas/HourlyUsageResponse"
+ $ref: '#/components/schemas/HourlyUsageResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224103,25 +224164,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/UsageLambdaTracedInvocationsResponse"
+ $ref: '#/components/schemas/UsageLambdaTracedInvocationsResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224169,25 +224230,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/UsageObservabilityPipelinesResponse"
+ $ref: '#/components/schemas/UsageObservabilityPipelinesResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224233,25 +224294,25 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/ProjectedCostResponse"
+ $ref: '#/components/schemas/ProjectedCostResponse'
description: OK
"400":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224324,19 +224385,19 @@ paths:
page:
next_cursor: eyJvZmZzZXQiOjEwMH0=
schema:
- $ref: "#/components/schemas/UsageQuotasListResponse"
+ $ref: '#/components/schemas/UsageQuotasListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224405,7 +224466,7 @@ paths:
usage_limit: 250000
type: quotas
schema:
- $ref: "#/components/schemas/UsageQuotasCreateRequest"
+ $ref: '#/components/schemas/UsageQuotasCreateRequest'
description: The usage quotas to create or update.
required: true
responses:
@@ -224429,19 +224490,19 @@ paths:
id: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTp1c2VyQGV4YW1wbGUuY29t"
type: quotas
schema:
- $ref: "#/components/schemas/UsageQuotasBulkResponse"
+ $ref: '#/components/schemas/UsageQuotasBulkResponse'
description: OK. The response includes each item's result; see each item's `error` attribute for any that failed to write.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224449,7 +224510,7 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Internal Server Error. Every item in the batch failed to write.
security:
- apiKeyAuth: []
@@ -224498,13 +224559,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224560,7 +224621,7 @@ paths:
id: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f"
type: quotas
schema:
- $ref: "#/components/schemas/UsageQuotaUpdateRequest"
+ $ref: '#/components/schemas/UsageQuotaUpdateRequest'
description: The usage quota fields to update. Omitting an attribute leaves its current value unchanged.
required: true
responses:
@@ -224580,25 +224641,25 @@ paths:
id: "MjAfYWlfY3JlZGl0c1911c2VyX2hhbmRsZTpfX0FMTF9f"
type: quotas
schema:
- $ref: "#/components/schemas/UsageQuotaResponse"
+ $ref: '#/components/schemas/UsageQuotaResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad Request. Returned if the request is malformed, or if the `id` in the request body does not match the `id` in the request path.
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224688,19 +224749,19 @@ paths:
id: all
type: usage_summary_available_fields
schema:
- $ref: "#/components/schemas/UsageSummaryAvailableFieldsResponse"
+ $ref: '#/components/schemas/UsageSummaryAvailableFieldsResponse'
description: OK.
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized.
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests.
security:
- apiKeyAuth: []
@@ -224731,19 +224792,19 @@ paths:
id: abc-123
type: usage_attribution_types
schema:
- $ref: "#/components/schemas/UsageAttributionTypesResponse"
+ $ref: '#/components/schemas/UsageAttributionTypesResponse'
description: OK
"403":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden - User is not authorized
"429":
content:
application/json;datetime-format=rfc3339:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Too many requests
security:
- apiKeyAuth: []
@@ -224817,13 +224878,13 @@ paths:
total_count: 1
total_filtered_count: 1
schema:
- $ref: "#/components/schemas/UserAuthorizedClientsResponse"
+ $ref: '#/components/schemas/UserAuthorizedClientsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224853,13 +224914,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224884,13 +224945,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224938,19 +224999,19 @@ paths:
type: users
type: user_authorized_clients
schema:
- $ref: "#/components/schemas/UserAuthorizedClientResponse"
+ $ref: '#/components/schemas/UserAuthorizedClientResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -224981,7 +225042,7 @@ paths:
type: users
type: user_invitations
schema:
- $ref: "#/components/schemas/UserInvitationsRequest"
+ $ref: '#/components/schemas/UserInvitationsRequest'
required: true
responses:
"201":
@@ -224999,19 +225060,19 @@ paths:
id: 00000000-0000-0000-0000-000000000007
type: user_invitations
schema:
- $ref: "#/components/schemas/UserInvitationsResponse"
+ $ref: '#/components/schemas/UserInvitationsResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225055,19 +225116,19 @@ paths:
id: 00000000-0000-0000-0000-000000000008
type: user_invitations
schema:
- $ref: "#/components/schemas/UserInvitationResponse"
+ $ref: '#/components/schemas/UserInvitationResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225111,7 +225172,7 @@ paths:
name: sort_dir
required: false
schema:
- $ref: "#/components/schemas/QuerySortOrder"
+ $ref: '#/components/schemas/QuerySortOrder'
- description: Filter all users by the given string. Defaults to no filtering.
in: query
name: filter
@@ -225146,19 +225207,19 @@ paths:
included: []
meta: {}
schema:
- $ref: "#/components/schemas/UsersResponse"
+ $ref: '#/components/schemas/UsersResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225198,7 +225259,7 @@ paths:
- id: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d
type: users
schema:
- $ref: "#/components/schemas/UserCreateRequest"
+ $ref: '#/components/schemas/UserCreateRequest'
required: true
responses:
"201":
@@ -225217,19 +225278,19 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225262,13 +225323,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225309,19 +225370,19 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225356,7 +225417,7 @@ paths:
id: 00000000-0000-feed-0000-000000000000
type: users
schema:
- $ref: "#/components/schemas/UserUpdateRequest"
+ $ref: '#/components/schemas/UserUpdateRequest'
required: true
responses:
"200":
@@ -225375,31 +225436,31 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"422":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unprocessable Entity
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225439,19 +225500,19 @@ paths:
id: "00000000-0000-0000-0000-000000000001"
type: identity_providers
schema:
- $ref: "#/components/schemas/UserOverrideIdentityProvidersResponse"
+ $ref: '#/components/schemas/UserOverrideIdentityProvidersResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225490,13 +225551,13 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225538,19 +225599,19 @@ paths:
type: users
included: []
schema:
- $ref: "#/components/schemas/UserResponse"
+ $ref: '#/components/schemas/UserResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225590,19 +225651,19 @@ paths:
id: 00000000-0000-0000-0000-000000000006
type: permissions
schema:
- $ref: "#/components/schemas/PermissionsResponse"
+ $ref: '#/components/schemas/PermissionsResponse'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225639,7 +225700,7 @@ paths:
- id: "00000000-0000-0000-0000-000000000001"
type: identity_providers
schema:
- $ref: "#/components/schemas/UpdateUserIdentityProvidersRequest"
+ $ref: '#/components/schemas/UpdateUserIdentityProvidersRequest'
required: true
responses:
"204":
@@ -225648,19 +225709,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Authentication error
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225702,13 +225763,13 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: team_memberships
schema:
- $ref: "#/components/schemas/UserTeamsResponse"
+ $ref: '#/components/schemas/UserTeamsResponse'
description: Represents a user's association to a team
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: API error response.
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225745,13 +225806,13 @@ paths:
id: "550e8400-e29b-41d4-a716-446655440000"
type: "validate_v2"
schema:
- $ref: "#/components/schemas/ValidateV2Response"
+ $ref: '#/components/schemas/ValidateV2Response'
description: OK
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225784,19 +225845,19 @@ paths:
value:
status: ok
schema:
- $ref: "#/components/schemas/ValidateAPIKeyResponse"
+ $ref: '#/components/schemas/ValidateAPIKeyResponse'
description: OK
"401":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Unauthorized
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225830,12 +225891,12 @@ paths:
name: experience_type
required: true
schema:
- $ref: "#/components/schemas/WidgetExperienceType"
+ $ref: '#/components/schemas/WidgetExperienceType'
- description: Filter widgets by widget type.
in: query
name: filter[widgetType]
schema:
- $ref: "#/components/schemas/WidgetType"
+ $ref: '#/components/schemas/WidgetType'
- description: Filter widgets by the email handle of the creator.
in: query
name: filter[creatorHandle]
@@ -225897,19 +225958,19 @@ paths:
value:
data: []
schema:
- $ref: "#/components/schemas/WidgetListResponse"
+ $ref: '#/components/schemas/WidgetListResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -225936,7 +225997,7 @@ paths:
name: experience_type
required: true
schema:
- $ref: "#/components/schemas/WidgetExperienceType"
+ $ref: '#/components/schemas/WidgetExperienceType'
requestBody:
content:
application/json:
@@ -225973,7 +226034,7 @@ paths:
tags: ["finops", "aws"]
type: widgets
schema:
- $ref: "#/components/schemas/CreateOrUpdateWidgetRequest"
+ $ref: '#/components/schemas/CreateOrUpdateWidgetRequest'
description: |-
Widget request body. The `definition` object's required fields vary
by `widget.definition.type`: every type requires `requests`, and
@@ -226002,19 +226063,19 @@ paths:
id: abc-123
type: widgets
schema:
- $ref: "#/components/schemas/WidgetResponse"
+ $ref: '#/components/schemas/WidgetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -226043,7 +226104,7 @@ paths:
name: experience_type
required: true
schema:
- $ref: "#/components/schemas/WidgetExperienceType"
+ $ref: '#/components/schemas/WidgetExperienceType'
- description: The UUID of the widget.
in: path
name: uuid
@@ -226058,19 +226119,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -226097,7 +226158,7 @@ paths:
name: experience_type
required: true
schema:
- $ref: "#/components/schemas/WidgetExperienceType"
+ $ref: '#/components/schemas/WidgetExperienceType'
- description: The UUID of the widget.
in: path
name: uuid
@@ -226125,25 +226186,25 @@ paths:
id: abc-123
type: widgets
schema:
- $ref: "#/components/schemas/WidgetResponse"
+ $ref: '#/components/schemas/WidgetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -226170,7 +226231,7 @@ paths:
name: experience_type
required: true
schema:
- $ref: "#/components/schemas/WidgetExperienceType"
+ $ref: '#/components/schemas/WidgetExperienceType'
- description: The UUID of the widget.
in: path
name: uuid
@@ -226214,7 +226275,7 @@ paths:
tags: ["finops", "aws"]
type: widgets
schema:
- $ref: "#/components/schemas/CreateOrUpdateWidgetRequest"
+ $ref: '#/components/schemas/CreateOrUpdateWidgetRequest'
description: |-
Widget request body. The `definition` object's required fields vary
by `widget.definition.type`; see `CreateWidget` above for a complete
@@ -226240,25 +226301,25 @@ paths:
id: abc-123
type: widgets
schema:
- $ref: "#/components/schemas/WidgetResponse"
+ $ref: '#/components/schemas/WidgetResponse'
description: OK
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/APIErrorResponse"
+ $ref: '#/components/schemas/APIErrorResponse'
description: Not Found
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
@@ -226373,7 +226434,7 @@ paths:
totalCount: 1
totalFilteredCount: 1
schema:
- $ref: "#/components/schemas/ListWorkflowsResponse"
+ $ref: '#/components/schemas/ListWorkflowsResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -226464,7 +226525,7 @@ paths:
- service:monitoring
type: workflows
schema:
- $ref: "#/components/schemas/CreateWorkflowRequest"
+ $ref: '#/components/schemas/CreateWorkflowRequest'
required: true
responses:
"201":
@@ -226481,25 +226542,25 @@ paths:
id: 00000000-0000-0000-0000-000000000001
type: workflows
schema:
- $ref: "#/components/schemas/CreateWorkflowResponse"
+ $ref: '#/components/schemas/CreateWorkflowResponse'
description: Successfully created a workflow.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Create a Workflow
tags:
@@ -226522,19 +226583,19 @@ paths:
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Delete an existing Workflow
tags:
@@ -226570,31 +226631,31 @@ paths:
id: 00000000-0000-0000-0000-000000000002
type: workflows
schema:
- $ref: "#/components/schemas/GetWorkflowResponse"
+ $ref: '#/components/schemas/GetWorkflowResponse'
description: Successfully got a workflow.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Get an existing Workflow
tags:
@@ -226677,7 +226738,7 @@ paths:
id: 22222222-2222-2222-2222-222222222222
type: workflows
schema:
- $ref: "#/components/schemas/UpdateWorkflowRequest"
+ $ref: '#/components/schemas/UpdateWorkflowRequest'
required: true
responses:
"200":
@@ -226693,31 +226754,31 @@ paths:
id: 00000000-0000-0000-0000-000000000003
type: workflows
schema:
- $ref: "#/components/schemas/UpdateWorkflowResponse"
+ $ref: '#/components/schemas/UpdateWorkflowResponse'
description: Successfully updated a workflow.
"400":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
"403":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
"404":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Not found
"429":
content:
application/json:
schema:
- $ref: "#/components/schemas/JSONAPIErrorResponse"
+ $ref: '#/components/schemas/JSONAPIErrorResponse'
description: Too many requests
summary: Update an existing Workflow
tags:
@@ -226748,7 +226809,7 @@ paths:
page:
totalCount: 1
schema:
- $ref: "#/components/schemas/WorkflowListInstancesResponse"
+ $ref: '#/components/schemas/WorkflowListInstancesResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -226784,7 +226845,7 @@ paths:
payload:
input: value
schema:
- $ref: "#/components/schemas/WorkflowInstanceCreateRequest"
+ $ref: '#/components/schemas/WorkflowInstanceCreateRequest'
required: true
responses:
"200":
@@ -226796,7 +226857,7 @@ paths:
data:
id: 00000000-0000-0000-0000-000000000005
schema:
- $ref: "#/components/schemas/WorkflowInstanceCreateResponse"
+ $ref: '#/components/schemas/WorkflowInstanceCreateResponse'
description: Created
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -226836,7 +226897,7 @@ paths:
attributes:
id: 00000000-0000-0000-0000-000000000006
schema:
- $ref: "#/components/schemas/WorklflowGetInstanceResponse"
+ $ref: '#/components/schemas/WorklflowGetInstanceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"
@@ -226876,7 +226937,7 @@ paths:
data:
id: 00000000-0000-0000-0000-000000000007
schema:
- $ref: "#/components/schemas/WorklflowCancelInstanceResponse"
+ $ref: '#/components/schemas/WorklflowCancelInstanceResponse'
description: OK
"400":
$ref: "#/components/responses/BadRequestResponse"