diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index ccc3331457df..a335034b00ae 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -951,7 +951,7 @@ components: schema: type: string ProjectIDPathParameter: - description: Project UUID + description: Project UUID. example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" in: path name: project_id @@ -2374,6 +2374,7 @@ components: - "amplify:ListBackendEnvironments" - "amplify:ListBranches" items: + description: An AWS IAM permission required for the Datadog integration. example: "account:GetContactInformation" type: string type: array @@ -2429,6 +2430,7 @@ components: lambdas: description: List of Datadog Lambda Log Forwarder ARNs in your AWS account. Defaults to `[]`. items: + description: The ARN of a Datadog Lambda Log Forwarder function. example: "arn:aws:lambda:us-east-1:123456789012:function:DatadogLambdaLogForwarder" type: string type: array @@ -2442,6 +2444,7 @@ components: services](https://docs.datadoghq.com/api/latest/aws-logs-integration/#get-list-of-aws-log-ready-services) endpoint. items: + description: An AWS service ID for which automatic log collection is enabled. example: s3 type: string type: array @@ -2501,6 +2504,7 @@ components: example: - "s3" items: + description: The name of an AWS service that can send logs to Datadog. example: "s3" type: string type: array @@ -2582,6 +2586,7 @@ components: - "AWS/ElasticMapReduce" - "AWS/Usage" items: + description: An AWS CloudWatch namespace to exclude from metrics collection. example: "AWS/SQS" type: string type: array @@ -2596,6 +2601,7 @@ components: example: - "AWS/EC2" items: + description: An AWS CloudWatch namespace to include in metrics collection. example: "AWS/EC2" type: string type: array @@ -2641,6 +2647,7 @@ components: example: - "AWS/ApiGateway" items: + description: An AWS CloudWatch namespace name. example: "AWS/ApiGateway" type: string type: array @@ -2738,6 +2745,7 @@ components: example: - "us-east-1" items: + description: An AWS region to include in metrics collection. example: "us-east-1" type: string type: array @@ -2774,6 +2782,7 @@ components: description: The AWS account IDs to be excluded from your billing dataset. This field is used when `include_new_accounts` is `true`. example: ["123456789123", "123456789143"] items: + description: An AWS account ID to exclude from the billing dataset. type: string type: array include_new_accounts: @@ -2785,6 +2794,7 @@ components: description: The AWS account IDs to be included in your billing dataset. This field is used when `include_new_accounts` is `false`. example: ["123456789123", "123456789143"] items: + description: An AWS account ID to include in the billing dataset. type: string type: array type: object @@ -3040,6 +3050,7 @@ components: tags: description: The tags of the connection group. items: + description: A tag for the connection group. type: string type: array type: object @@ -3458,24 +3469,30 @@ components: - $ref: "#/components/schemas/AnyValueBoolean" type: object AnyValueArray: + description: An array of arbitrary values. items: $ref: "#/components/schemas/AnyValueItem" type: array AnyValueBoolean: + description: A scalar boolean value. type: boolean 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" AnyValueNumber: + description: A scalar numeric value. format: double type: number AnyValueObject: additionalProperties: {} + description: An arbitrary object value with additional properties. type: object AnyValueString: + description: A scalar string value. type: string ApiID: description: API identifier. @@ -3888,6 +3905,7 @@ components: key_path: description: Specific path for the input. items: + description: A path segment for the input key. type: string type: array required: @@ -4020,6 +4038,7 @@ components: List of value to use with the condition. Only used with the phrase_match, !phrase_match, exact_match and !exact_match operator. items: + description: A value to match against in the condition. type: string type: array options: @@ -4501,6 +4520,7 @@ components: 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: + description: A parameter name matched by the exclusion filter in the HTTP query string or request body. example: "list.search.query" type: string type: array @@ -4650,6 +4670,7 @@ components: example: - "" items: + description: A cloud provider name. type: string type: array rejected: @@ -4689,6 +4710,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4712,6 +4734,7 @@ components: allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. items: + description: A tag key used to group cost allocations. type: string type: array based_on_costs: @@ -4731,6 +4754,7 @@ components: evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. items: + description: A tag key used to group cost evaluation. type: string type: array granularity: @@ -4760,6 +4784,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4816,6 +4841,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -4840,6 +4866,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5095,6 +5122,7 @@ components: example: - "" items: + description: A cloud provider name. type: string type: array rejected: @@ -5151,6 +5179,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5174,6 +5203,7 @@ components: allocated_by_tag_keys: description: The `strategy` `allocated_by_tag_keys`. items: + description: A tag key used to group cost allocations. type: string type: array based_on_costs: @@ -5193,6 +5223,7 @@ components: evaluate_grouped_by_tag_keys: description: The `strategy` `evaluate_grouped_by_tag_keys`. items: + description: A tag key used to group cost evaluation. type: string type: array granularity: @@ -5222,6 +5253,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5278,6 +5310,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5302,6 +5335,7 @@ components: values: description: The `items` `values`. items: + description: A filter value string. type: string nullable: true type: array @@ -5319,6 +5353,7 @@ components: x-enum-varnames: - ARBITRARY_RULE Argument: + description: A named argument for a custom static analysis rule. properties: description: description: Base64-encoded argument description @@ -5429,6 +5464,7 @@ components: example: - staging items: + description: An environment where the asset is deployed. example: staging type: string type: array @@ -5445,6 +5481,7 @@ components: example: - compute items: + description: A team that owns the asset. example: compute type: string type: array @@ -5535,12 +5572,14 @@ components: type: string type: object AssignSeatsUserRequest: + description: The request body for assigning seats to users for a product code. properties: data: $ref: "#/components/schemas/AssignSeatsUserRequestData" description: The data for the assign seats user request. type: object AssignSeatsUserRequestData: + description: The request data object containing attributes for assigning seats to users. properties: attributes: $ref: "#/components/schemas/AssignSeatsUserRequestDataAttributes" @@ -5556,6 +5595,7 @@ components: - attributes type: object AssignSeatsUserRequestDataAttributes: + description: Attributes specifying the product and users to whom seats will be assigned. properties: product_code: description: The product code for which to assign seats. @@ -5566,6 +5606,7 @@ components: example: - "" items: + description: A user UUID identifying a user to assign a seat to. type: string type: array required: @@ -5573,12 +5614,14 @@ components: - user_uuids type: object AssignSeatsUserResponse: + description: The response body returned after successfully assigning seats to users. properties: data: $ref: "#/components/schemas/AssignSeatsUserResponseData" description: The data for the assign seats user response. type: object AssignSeatsUserResponseData: + description: The response data object containing attributes of the seat assignment result. properties: attributes: $ref: "#/components/schemas/AssignSeatsUserResponseDataAttributes" @@ -5590,10 +5633,12 @@ components: $ref: "#/components/schemas/SeatAssignmentsDataType" type: object AssignSeatsUserResponseDataAttributes: + description: Attributes of the assign seats response, including the list of users assigned and the product code. properties: assigned_ids: description: The list of user IDs to which the seats were assigned. items: + description: A user UUID identifying a user to whom a seat was assigned. type: string type: array product_code: @@ -5677,6 +5722,7 @@ components: data: $ref: "#/components/schemas/AttachmentData" included: + description: A list of related objects included in the response. items: $ref: "#/components/schemas/AttachmentIncluded" type: array @@ -5685,10 +5731,12 @@ components: description: A list of incident attachments. properties: data: + description: An array of attachment data objects. items: $ref: "#/components/schemas/AttachmentData" type: array included: + description: A list of related objects included in the response. items: $ref: "#/components/schemas/AttachmentIncluded" type: array @@ -6243,21 +6291,21 @@ components: x-enum-varnames: - AUTHN_MAPPINGS AutoCloseInactiveCases: - description: Auto-close inactive cases settings + description: Auto-close inactive cases settings. properties: enabled: - description: Whether auto-close is enabled + description: Whether auto-close is enabled. type: boolean max_inactive_time_in_secs: - description: Maximum inactive time in seconds before auto-closing + description: Maximum inactive time in seconds before auto-closing. format: int64 type: integer type: object AutoTransitionAssignedCases: - description: Auto-transition assigned cases settings + description: Auto-transition assigned cases settings. properties: auto_transition_assigned_cases_on_self_assigned: - description: Whether to auto-transition cases when self-assigned + description: Whether to auto-transition cases when self-assigned. type: boolean type: object AwsAccountId: @@ -6302,6 +6350,7 @@ components: error_messages: description: The error messages for the AWS CUR config. items: + description: An error message string. type: string nullable: true type: array @@ -6520,6 +6569,7 @@ components: error_messages: description: The `attributes` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -6549,6 +6599,7 @@ components: excluded_accounts: description: The `account_filters` `excluded_accounts`. items: + description: An AWS account ID to exclude. type: string type: array include_new_accounts: @@ -6558,6 +6609,7 @@ components: included_accounts: description: The `account_filters` `included_accounts`. items: + description: An AWS account ID to include. type: string type: array type: object @@ -6977,6 +7029,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["processor-id"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -7073,6 +7126,7 @@ components: error_messages: description: The error messages for the Azure config. items: + description: An error message string. type: string nullable: true type: array @@ -7276,6 +7330,7 @@ components: description: The request body for deleting multiple rows from a reference table. properties: data: + description: List of row resources to delete from the reference table. items: $ref: "#/components/schemas/TableRowResourceIdentifier" maxItems: 200 @@ -7365,6 +7420,7 @@ components: description: The request body for creating or updating multiple rows into a reference table. properties: data: + description: List of row resources to create or update in the reference table. items: $ref: "#/components/schemas/BatchUpsertRowsRequestData" maxItems: 200 @@ -7378,6 +7434,7 @@ components: attributes: $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: @@ -7480,6 +7537,7 @@ components: - "apm_host_top99p" - "apm_host_sum" items: + description: A billing dimension key. example: apm_host_top99p type: string type: array @@ -7604,6 +7662,7 @@ components: format: int64 type: integer entries: + description: The list of monthly budget entries. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array @@ -7641,6 +7700,7 @@ components: type: string type: object BudgetValidationRequest: + description: The request object for validating a budget configuration before creating or updating it. example: data: attributes: @@ -7672,10 +7732,12 @@ components: $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" id: + description: The unique identifier of the budget to validate. type: string type: $ref: "#/components/schemas/BudgetWithEntriesDataType" @@ -7683,6 +7745,7 @@ components: - type type: object BudgetValidationResponse: + description: The response object for a budget validation request, containing the validation result data. example: data: attributes: @@ -7695,10 +7758,12 @@ components: $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" id: + description: The unique identifier of the budget being validated. type: string type: $ref: "#/components/schemas/BudgetValidationResponseDataType" @@ -7706,12 +7771,16 @@ components: - type type: object BudgetValidationResponseDataAttributes: + description: The attributes of a budget validation response, including any validation errors and the validity status. properties: errors: + description: A list of validation error messages for the budget. items: + description: A validation error message. type: string type: array valid: + description: Whether the budget configuration is valid. type: boolean type: object BudgetValidationResponseDataType: @@ -7744,56 +7813,75 @@ components: type: string type: object BudgetWithEntriesDataAttributes: + description: The attributes of a budget including all its monthly entries. properties: created_at: + description: The timestamp when the budget was created. format: int64 type: integer created_by: + description: The ID of the user that created the budget. type: string end_month: + description: The month when the budget ends, in YYYYMM format. format: int64 type: integer entries: + description: The list of monthly budget entries. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItems" type: array metrics_query: + description: The cost query used to track spending against the budget. type: string name: + description: The name of the budget. type: string org_id: + description: The ID of the organization the budget belongs to. format: int64 type: integer start_month: + description: The month when the budget starts, in YYYYMM format. format: int64 type: integer total_amount: + description: The total budget amount across all entries. format: double type: number updated_at: + description: The timestamp when the budget was last updated. format: int64 type: integer updated_by: + description: The ID of the user that last updated the budget. type: string type: object BudgetWithEntriesDataAttributesEntriesItems: + description: A single monthly budget entry defining the allocated amount and optional tag filters for a specific month. properties: amount: + description: The budgeted amount for this entry. format: double type: number month: + description: The month this budget entry applies to, in YYYYMM format. format: int64 type: integer tag_filters: + description: The list of tag filters that scope this budget entry to specific resources. items: $ref: "#/components/schemas/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems" type: array type: object BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems: + description: A tag filter used to scope a budget entry to specific resource tags. properties: tag_key: + description: The tag key to filter on. type: string tag_value: + description: The tag value to filter on. type: string type: object BudgetWithEntriesDataType: @@ -7830,6 +7918,7 @@ components: item_keys: description: List of primary keys identifying items to delete from datastore. Up to 100 items can be deleted in a single request. items: + description: A primary key identifying a datastore item to delete. type: string maxItems: 100 type: array @@ -8290,6 +8379,7 @@ components: - ubuntu-18.04 - n2.large items: + description: A label used to select or identify the node. type: string type: array name: @@ -9575,6 +9665,7 @@ components: - data type: object CaseManagementProjectData: + description: Data object representing a case management project. properties: id: description: Unique identifier of the case management project. @@ -9804,6 +9895,7 @@ components: CaseObjectAttributes: additionalProperties: items: + description: An attribute value. type: string type: array description: The definition of `CaseObjectAttributes` object. @@ -10540,6 +10632,7 @@ components: example: - "team-handle-1" items: + description: A team handle to request decisions from. type: string type: array start_date: @@ -10807,6 +10900,7 @@ components: ChangeRequestObjectAttributes: additionalProperties: items: + description: An attribute value. type: string type: array description: Custom attributes of the change request as key-value pairs. @@ -11262,6 +11356,7 @@ components: - gcp_iam_service_account - gcp_iam_policy items: + description: A cloud resource type identifier. type: string type: array required: @@ -11292,6 +11387,7 @@ components: defaultGroupByFields: description: The default group by fields. items: + description: A field name used for default grouping. type: string nullable: true type: array @@ -11302,6 +11398,7 @@ components: userGroupByFields: description: Fields to use to group findings by when sending signals. items: + description: A field name to group findings by. type: string nullable: true type: array @@ -11462,12 +11559,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11533,12 +11633,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11612,12 +11715,15 @@ components: hostTags: description: "The host tags defining where this policy is deployed" items: + description: "A host tag used to identify where this policy is deployed." type: string type: array hostTagsLists: description: "The host tags defining where this policy is deployed, the inner values are linked with AND, the outer values are linked with OR" items: + description: "A list of host tags linked with AND logic." items: + description: "A host tag used to filter the deployment scope." type: string type: array type: array @@ -11770,6 +11876,7 @@ components: blocking: description: "The blocking policies that the rule belongs to" items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array category: @@ -11798,6 +11905,7 @@ components: disabled: description: "The disabled policies that the rule belongs to" items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -11811,11 +11919,13 @@ components: filters: description: "The platforms the Agent rule is supported on" items: + description: "A platform filter that the Agent rule is supported on." type: string type: array monitoring: description: "The monitoring policies that the rule belongs to" items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array name: @@ -11825,6 +11935,7 @@ components: product_tags: description: "The list of product tags associated with the rule" items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -11864,6 +11975,7 @@ components: blocking: description: "The blocking policies that the rule belongs to." items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array description: @@ -11873,6 +11985,7 @@ components: disabled: description: "The disabled policies that the rule belongs to." items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -11886,11 +11999,13 @@ components: filters: description: "The platforms the Agent rule is supported on." items: + description: "A platform filter that the Agent rule is supported on." type: string type: array monitoring: description: "The monitoring policies that the rule belongs to." items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array name: @@ -11904,6 +12019,7 @@ components: product_tags: description: "The list of product tags associated with the rule." items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -11994,6 +12110,7 @@ components: blocking: description: "The blocking policies that the rule belongs to" items: + description: "The ID of a blocking policy that this rule belongs to." type: string type: array description: @@ -12003,6 +12120,7 @@ components: disabled: description: "The disabled policies that the rule belongs to" items: + description: "The ID of a disabled policy that this rule belongs to." type: string type: array enabled: @@ -12016,6 +12134,7 @@ components: monitoring: description: "The monitoring policies that the rule belongs to" items: + description: "The ID of a monitoring policy that this rule belongs to." type: string type: array policy_id: @@ -12025,6 +12144,7 @@ components: product_tags: description: "The list of product tags associated with the rule" items: + description: "A product tag associated with the rule." type: string type: array silent: @@ -12134,12 +12254,14 @@ components: description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12178,12 +12300,14 @@ components: description: An allowlist of resources, such as `web`, `dns`, `lb` (load balancer), `worker`, that restricts pulling metrics from those resources. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12240,12 +12364,14 @@ components: description: An allowlist of resources to restrict pulling metrics for including `'web', 'dns', 'lb' (load balancer), 'worker'`. example: ["web", "dns", "lb", "worker"] items: + description: A Cloudflare resource type (for example, `web`, `dns`, `lb`, `worker`). type: string type: array zones: description: An allowlist of zones to restrict pulling metrics for. example: ["zone_id_1", "zone_id_2"] items: + description: A Cloudflare zone ID to restrict pulling metrics for. type: string type: array required: @@ -12796,6 +12922,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12835,6 +12962,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12864,6 +12992,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12919,6 +13048,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -12971,6 +13101,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -13020,6 +13151,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Confluent resource. Can be a single key or a key-value pair separated by a colon. type: string type: array required: @@ -13144,6 +13276,7 @@ components: example: - "" items: + description: A tag string in `key:value` format. type: string type: array required: @@ -13228,6 +13361,7 @@ components: image_tags: description: List of image tags associated with the container image. items: + description: An image tag associated with the container. type: string nullable: true type: array @@ -13243,6 +13377,7 @@ components: tags: description: List of tags associated with the container. items: + description: A tag associated with the container. type: string type: array type: object @@ -13723,6 +13858,7 @@ components: example: - "" items: + description: A job result ID. type: string type: array notifications: @@ -13730,6 +13866,7 @@ components: example: - "" items: + description: A notification recipient handle. type: string type: array signalMessage: @@ -14207,6 +14344,7 @@ components: attributes: $ref: "#/components/schemas/CreateAttachmentRequestDataAttributes" id: + description: The unique identifier of the attachment. type: string type: $ref: "#/components/schemas/IncidentAttachmentType" @@ -14237,6 +14375,7 @@ components: description: List of requests to create cases for security findings. properties: data: + description: Array of case creation request data objects. items: $ref: "#/components/schemas/CreateCaseRequestData" type: array @@ -14289,6 +14428,7 @@ components: - project type: object CreateComponentRequest: + description: Request object for creating a component. example: data: attributes: @@ -14304,6 +14444,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestData" type: object CreateComponentRequestData: + description: The data object for creating a component. properties: attributes: $ref: "#/components/schemas/CreateComponentRequestDataAttributes" @@ -14349,6 +14490,7 @@ components: - type type: object CreateComponentRequestDataAttributesComponentsItems: + description: A component to be created within a group. properties: name: description: The name of the grouped component. @@ -14384,6 +14526,7 @@ components: description: The group to create the component within. type: object CreateComponentRequestDataRelationshipsGroup: + description: The group to create the component within. properties: data: $ref: "#/components/schemas/CreateComponentRequestDataRelationshipsGroupData" @@ -14391,6 +14534,7 @@ components: - data type: object CreateComponentRequestDataRelationshipsGroupData: + description: The data object identifying the group to create the component within. nullable: true properties: id: @@ -14405,6 +14549,7 @@ components: - id type: object CreateConnectionRequest: + description: Request body for creating a new data source connection for an entity. example: data: attributes: @@ -14429,10 +14574,12 @@ components: $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" id: + description: Unique identifier for the new connection resource. type: string type: $ref: "#/components/schemas/UpdateConnectionRequestDataType" @@ -14440,22 +14587,28 @@ components: - type type: object CreateConnectionRequestDataAttributes: + description: Attributes defining the data source connection, including join configuration and custom fields. properties: fields: + description: List of custom attribute fields to import from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array join_attribute: + description: The attribute in the data source used to join records with the entity. example: "" type: string join_type: + description: The type of join key used to link the data source to the entity (for example, email or user_id). example: "" type: string metadata: additionalProperties: type: string + description: Additional key-value metadata associated with the connection. type: object type: + description: The type of data source connection (for example, ref_table). example: "" type: string required: @@ -14464,22 +14617,30 @@ components: - type type: object CreateConnectionRequestDataAttributesFieldsItems: + description: Definition of a custom attribute field to import from a data source connection. properties: description: + description: Human-readable explanation of what the field represents. type: string display_name: + description: The human-readable label for the field shown in the UI. type: string groups: + description: List of group labels used to categorize the field. items: + description: A group label name for categorizing the field. type: string type: array id: + description: The unique identifier for the field within the connection. example: "" type: string source_name: + description: The name of the column or attribute in the source data system that maps to this field. example: "" type: string type: + description: The data type of the field (for example, string or number). example: "" type: string required: @@ -14570,6 +14731,7 @@ components: $ref: "#/components/schemas/DataDeletionResponseMeta" type: object CreateDegradationRequest: + description: Request object for creating a degradation. example: data: attributes: @@ -14585,6 +14747,7 @@ components: $ref: "#/components/schemas/CreateDegradationRequestData" type: object CreateDegradationRequestData: + description: The data object for creating a degradation. properties: attributes: $ref: "#/components/schemas/CreateDegradationRequestDataAttributes" @@ -14623,6 +14786,7 @@ components: - title type: object CreateDegradationRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -14630,6 +14794,7 @@ components: format: uuid type: string name: + description: The name of the component. readOnly: true type: string status: @@ -14898,6 +15063,7 @@ components: description: List of requests to create Jira issues for security findings. properties: data: + description: Array of Jira issue creation request data objects. items: $ref: "#/components/schemas/CreateJiraIssueRequestData" type: array @@ -14955,6 +15121,7 @@ components: - project type: object CreateMaintenanceRequest: + description: Request object for creating a maintenance. example: data: attributes: @@ -14973,6 +15140,7 @@ components: $ref: "#/components/schemas/CreateMaintenanceRequestData" type: object CreateMaintenanceRequestData: + description: The data object for creating a maintenance. properties: attributes: $ref: "#/components/schemas/CreateMaintenanceRequestDataAttributes" @@ -15016,6 +15184,7 @@ components: - title type: object CreateMaintenanceRequestDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -15430,6 +15599,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -15466,6 +15636,7 @@ components: x-enum-varnames: - CREATE_RULESET CreateStatusPageRequest: + description: Request object for creating a status page. example: data: attributes: @@ -15501,6 +15672,7 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestData" type: object CreateStatusPageRequestData: + description: The data object for creating a status page. properties: attributes: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributes" @@ -15577,6 +15749,7 @@ components: - visualization_type type: object CreateStatusPageRequestDataAttributesComponentsItems: + description: A component to be created on a status page. properties: components: description: If creating a component of type `group`, the components to create within the group. @@ -15601,6 +15774,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems: + description: A grouped component to be created within a status page component group. properties: id: description: The ID of the grouped component. @@ -15680,6 +15854,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array required: @@ -15823,6 +15998,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -15852,10 +16028,12 @@ components: x-enum-varnames: - REFERENCE_TABLE CreateTenancyConfigData: + 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" id: + description: The OCID of the OCI tenancy to configure. example: "" type: string type: @@ -15865,20 +16043,26 @@ components: - id type: object CreateTenancyConfigDataAttributes: + description: Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. properties: auth_credentials: $ref: "#/components/schemas/CreateTenancyConfigDataAttributesAuthCredentials" config_version: + description: Version number of the integration the tenancy is integrated with format: int64 nullable: true type: integer cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean dd_compartment_id: + description: The OCID of the OCI compartment used by the Datadog integration stack. type: string dd_stack_id: + description: The OCID of the OCI Resource Manager stack used by the Datadog integration. type: string home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). example: "" type: string logs_config: @@ -15888,8 +16072,10 @@ components: regions_config: $ref: "#/components/schemas/CreateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. example: "" type: string required: @@ -15898,57 +16084,80 @@ components: - user_ocid type: object CreateTenancyConfigDataAttributesAuthCredentials: + description: OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. properties: fingerprint: + description: The fingerprint of the OCI API signing key used for authentication. type: string private_key: + description: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. example: "" type: string required: - private_key type: object CreateTenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters to scope log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object CreateTenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters to scope metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names to exclude from metrics collection. items: + description: An OCI service name to exclude from metrics collection (for example, compute). type: string type: array type: object CreateTenancyConfigDataAttributesRegionsConfig: + description: Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object CreateTenancyConfigRequest: + description: Request body for creating a new OCI tenancy integration configuration. example: data: attributes: @@ -16050,6 +16259,7 @@ components: - "field_1" - "field_2" items: + description: A column header name from the CSV file. type: string type: array part_count: @@ -16109,6 +16319,7 @@ components: part_urls: description: The pre-signed URLs for uploading parts. These URLs expire after 5 minutes. items: + description: A pre-signed URL for uploading a single file part. type: string type: array type: object @@ -16269,6 +16480,7 @@ components: cluster_name: description: List of cluster names associated with the Agent. items: + description: A cluster name associated with the Agent. type: string type: array datadog_agent: @@ -16280,6 +16492,7 @@ components: envs: description: List of environments associated with the Agent. items: + description: An environment name associated with the Agent. type: string nullable: true type: array @@ -17562,6 +17775,7 @@ components: example: - '["def-000-abc"]' items: + description: A rule ID associated with the control. type: string type: array required: @@ -17689,6 +17903,7 @@ components: - name type: object CustomRule: + description: A custom static analysis rule within a ruleset. properties: created_at: description: Creation timestamp @@ -17721,11 +17936,13 @@ components: x-enum-varnames: - CUSTOM_RULE CustomRuleRequest: + description: Request body for creating or updating a custom rule. properties: data: $ref: "#/components/schemas/CustomRuleRequestData" type: object CustomRuleRequestData: + description: Data object for a custom rule create or update request. properties: attributes: $ref: "#/components/schemas/CustomRuleRequestDataAttributes" @@ -17736,12 +17953,14 @@ components: $ref: "#/components/schemas/CustomRuleDataType" type: object CustomRuleRequestDataAttributes: + description: Attributes for creating or updating a custom rule. properties: name: description: Rule name type: string type: object CustomRuleResponse: + description: Response containing a single custom rule. properties: data: $ref: "#/components/schemas/CustomRuleResponseData" @@ -17749,6 +17968,7 @@ components: - data type: object CustomRuleResponseData: + description: Data object returned in a custom rule response, including its ID, type, and attributes. properties: attributes: $ref: "#/components/schemas/CustomRule" @@ -17764,6 +17984,7 @@ components: - attributes type: object CustomRuleRevision: + description: A specific revision of a custom static analysis rule. properties: attributes: $ref: "#/components/schemas/CustomRuleRevisionAttributes" @@ -17779,6 +18000,7 @@ components: - attributes type: object CustomRuleRevisionAttributes: + description: Attributes of a custom rule revision, including code, metadata, and test cases. properties: arguments: description: Rule arguments @@ -17853,6 +18075,7 @@ components: - security - custom items: + description: A tag attached to the rule. type: string type: array tests: @@ -17914,6 +18137,7 @@ components: x-enum-varnames: - CUSTOM_RULE_REVISION CustomRuleRevisionInputAttributes: + description: Input attributes for creating or updating a custom rule revision. properties: arguments: description: Rule arguments @@ -17975,6 +18199,7 @@ components: - security - custom items: + description: A tag attached to the rule. type: string type: array tests: @@ -18006,11 +18231,13 @@ components: - is_testing type: object CustomRuleRevisionRequest: + description: Request body for creating a new custom rule revision. properties: data: $ref: "#/components/schemas/CustomRuleRevisionRequestData" type: object CustomRuleRevisionRequestData: + description: Data object for a custom rule revision create request. properties: attributes: $ref: "#/components/schemas/CustomRuleRevisionInputAttributes" @@ -18021,6 +18248,7 @@ components: $ref: "#/components/schemas/CustomRuleRevisionDataType" type: object CustomRuleRevisionResponse: + description: Response containing a single custom rule revision. properties: data: $ref: "#/components/schemas/CustomRuleRevision" @@ -18028,6 +18256,7 @@ components: - data type: object CustomRuleRevisionTest: + description: A test case associated with a custom rule revision, used to validate rule behavior. properties: annotation_count: description: Expected violation count @@ -18048,13 +18277,16 @@ components: - annotation_count type: object CustomRuleRevisionsResponse: + description: Response containing a paginated list of custom rule revisions. properties: data: + description: List of custom rule revisions. items: $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" @@ -18070,6 +18302,7 @@ components: - attributes type: object CustomRulesetAttributes: + description: Attributes of a custom ruleset, including its name, description, and rules. properties: created_at: description: Creation timestamp @@ -18114,11 +18347,13 @@ components: x-enum-varnames: - CUSTOM_RULESET CustomRulesetRequest: + description: Request body for creating or updating a custom ruleset. properties: data: $ref: "#/components/schemas/CustomRulesetRequestData" type: object CustomRulesetRequestData: + description: Data object for a custom ruleset create or update request. properties: attributes: $ref: "#/components/schemas/CustomRulesetRequestDataAttributes" @@ -18129,6 +18364,7 @@ components: $ref: "#/components/schemas/CustomRulesetDataType" type: object CustomRulesetRequestDataAttributes: + description: Attributes for creating or updating a custom ruleset. properties: description: description: Base64-encoded full description @@ -18147,6 +18383,7 @@ components: type: string type: object CustomRulesetResponse: + description: Response containing a single custom ruleset. properties: data: $ref: "#/components/schemas/CustomRuleset" @@ -18484,6 +18721,7 @@ components: description: Service names impacted by the incident. If possible, use names registered in the Service Catalog. Required when the team field is not provided. example: [shopist] items: + description: A service name impacted by the incident. type: string type: array severity: @@ -18658,6 +18896,7 @@ components: description: Service names impacted by the incident. example: ["shopist"] items: + description: A service name impacted by the incident. type: string type: array severity: @@ -19051,6 +19290,7 @@ components: example: - "" items: + description: A source key for the mapping rule. type: string type: array required: @@ -19421,6 +19661,7 @@ components: example: - "role:94172442-be03-11e9-a77a-3b7612558ac1" items: + description: An access principal identifier formatted as `principal_type:id`. example: "role:94172442-be03-11e9-a77a-3b7612558ac1" type: string type: array @@ -19456,6 +19697,7 @@ components: example: - "role:86245fce-0a4e-11f0-92bd-da7ad0900002" items: + description: An access principal identifier formatted as `principal_type:id`. example: "role:86245fce-0a4e-11f0-92bd-da7ad0900002" type: string type: array @@ -19693,6 +19935,7 @@ components: format: int64 type: integer Degradation: + description: Response object for a single degradation. properties: data: $ref: "#/components/schemas/DegradationData" @@ -19703,8 +19946,10 @@ components: type: array type: object DegradationArray: + description: Response object for a list of degradations. properties: data: + description: A list of degradation data objects. items: $ref: "#/components/schemas/DegradationData" type: array @@ -19719,6 +19964,7 @@ components: - data type: object DegradationData: + description: The data object for a degradation. properties: attributes: $ref: "#/components/schemas/DegradationDataAttributes" @@ -19766,6 +20012,7 @@ components: type: array type: object DegradationDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. @@ -19810,6 +20057,7 @@ components: x-enum-varnames: - INCIDENT DegradationDataAttributesUpdatesItems: + description: A status update recorded during a degradation. properties: components_affected: description: The components affected at the time of the update. @@ -19842,6 +20090,7 @@ components: $ref: "#/components/schemas/CreateDegradationRequestDataAttributesStatus" type: object DegradationDataAttributesUpdatesItemsComponentsAffectedItems: + description: A component affected at the time of a degradation update. properties: id: description: Identifier of the component affected at the time of the update. @@ -19873,6 +20122,7 @@ components: description: The status page the degradation belongs to. type: object DegradationDataRelationshipsCreatedByUser: + description: The Datadog user who created the degradation. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsCreatedByUserData" @@ -19880,6 +20130,7 @@ components: - data type: object DegradationDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the degradation. properties: id: description: The ID of the Datadog user who created the degradation. @@ -19892,6 +20143,7 @@ components: - id type: object DegradationDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the degradation. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsLastModifiedByUserData" @@ -19899,6 +20151,7 @@ components: - data type: object DegradationDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the degradation. properties: id: description: The ID of the Datadog user who last modified the degradation. @@ -19911,6 +20164,7 @@ components: - id type: object DegradationDataRelationshipsStatusPage: + description: The status page the degradation belongs to. properties: data: $ref: "#/components/schemas/DegradationDataRelationshipsStatusPageData" @@ -19918,6 +20172,7 @@ components: - data type: object DegradationDataRelationshipsStatusPageData: + description: The data object identifying the status page the degradation belongs to. properties: id: description: The ID of the status page. @@ -19931,6 +20186,7 @@ components: - id type: object DegradationIncluded: + description: An included resource related to a degradation or maintenance. oneOf: - $ref: "#/components/schemas/StatusPagesUser" - $ref: "#/components/schemas/StatusPageAsIncluded" @@ -20076,15 +20332,18 @@ components: - data type: object DeletedSuiteResponseData: + description: Data object for a deleted Synthetic test suite. properties: attributes: $ref: "#/components/schemas/DeletedSuiteResponseDataAttributes" id: + description: The public ID of the deleted Synthetic test suite. type: string type: $ref: "#/components/schemas/SyntheticsSuiteTypes" type: object DeletedSuiteResponseDataAttributes: + description: Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. properties: deleted_at: description: Deletion timestamp of the Synthetic suite ID. @@ -20094,10 +20353,12 @@ components: type: string type: object DeletedSuitesRequestDelete: + description: Data object for a bulk delete Synthetic test suites request. properties: attributes: $ref: "#/components/schemas/DeletedSuitesRequestDeleteAttributes" id: + description: An optional identifier for the delete request. type: string type: $ref: "#/components/schemas/DeletedSuitesRequestType" @@ -20105,19 +20366,24 @@ components: - attributes type: object DeletedSuitesRequestDeleteAttributes: + description: Attributes for a bulk delete Synthetic test suites request. properties: force_delete_dependencies: + description: Whether to force deletion of suites that have dependent resources. type: boolean public_ids: + description: List of public IDs of the Synthetic test suites to delete. example: - "" items: + description: The public ID of a Synthetic test suite to delete. type: string type: array required: - public_ids type: object DeletedSuitesRequestDeleteRequest: + description: Request body for bulk deleting Synthetic test suites. properties: data: $ref: "#/components/schemas/DeletedSuitesRequestDelete" @@ -20126,6 +20392,7 @@ components: type: object DeletedSuitesRequestType: default: delete_suites_request + description: Type for the bulk delete Synthetic suites request, `delete_suites_request`. enum: - delete_suites_request example: delete_suites_request @@ -20133,22 +20400,27 @@ components: x-enum-varnames: - DELETE_SUITES_REQUEST DeletedSuitesResponse: + description: Response containing the list of deleted Synthetic test suites. properties: data: + description: List of deleted Synthetic suite data objects. items: $ref: "#/components/schemas/DeletedSuiteResponseData" type: array type: object DeletedTestResponseData: + description: Data object for a deleted Synthetic test. properties: attributes: $ref: "#/components/schemas/DeletedTestResponseDataAttributes" id: + description: The public ID of the deleted Synthetic test. type: string type: $ref: "#/components/schemas/DeletedTestsResponseType" type: object DeletedTestResponseDataAttributes: + description: Attributes of a deleted Synthetic test, including deletion timestamp and public ID. properties: deleted_at: description: Deletion timestamp of the Synthetic test ID. @@ -20158,10 +20430,12 @@ components: type: string type: object DeletedTestsRequestDelete: + description: Data object for a bulk delete Synthetic tests request. properties: attributes: $ref: "#/components/schemas/DeletedTestsRequestDeleteAttributes" id: + description: An optional identifier for the delete request. type: string type: $ref: "#/components/schemas/DeletedTestsRequestType" @@ -20169,19 +20443,24 @@ components: - attributes type: object DeletedTestsRequestDeleteAttributes: + description: Attributes for a bulk delete Synthetic tests request. properties: force_delete_dependencies: + description: Whether to force deletion of tests that have dependent resources. type: boolean public_ids: + description: List of public IDs of the Synthetic tests to delete. example: - "" items: + description: The public ID of a Synthetic test to delete. type: string type: array required: - public_ids type: object DeletedTestsRequestDeleteRequest: + description: Request body for bulk deleting Synthetic tests. properties: data: $ref: "#/components/schemas/DeletedTestsRequestDelete" @@ -20190,6 +20469,7 @@ components: type: object DeletedTestsRequestType: default: delete_tests_request + description: Type for the bulk delete Synthetic tests request, `delete_tests_request`. enum: - delete_tests_request example: delete_tests_request @@ -20197,14 +20477,17 @@ components: x-enum-varnames: - DELETE_TESTS_REQUEST DeletedTestsResponse: + description: Response containing the list of deleted Synthetic tests. properties: data: + description: List of deleted Synthetic test data objects. items: $ref: "#/components/schemas/DeletedTestResponseData" type: array type: object DeletedTestsResponseType: default: delete_tests + description: Type for the bulk delete Synthetic tests response, `delete_tests`. enum: - delete_tests example: delete_tests @@ -20442,6 +20725,7 @@ components: description: Resources to exclude from faulty deployment detection. example: ["resource1", "resource2"] items: + description: A resource name to exclude from faulty deployment detection. type: string type: array type: object @@ -20719,6 +21003,7 @@ components: description: The list of device tags example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: + description: A tag string in `key:value` format. type: string type: array vendor: @@ -20824,6 +21109,7 @@ components: domains: description: The list of domains in the email domain allowlist. items: + description: An email domain in the allowlist. type: string type: array enabled: @@ -20864,6 +21150,7 @@ components: domains: description: The list of domains in the email domain allowlist. items: + description: An email domain in the allowlist. type: string type: array enabled: @@ -21460,6 +21747,7 @@ components: tags: description: The tags. items: + description: A tag string in the format key:value. type: string type: array type: object @@ -21522,8 +21810,10 @@ components: $ref: "#/components/schemas/EntityToSchema" type: object EntityResponseArray: + description: Response object containing an array of entity data items. properties: data: + description: Array of entity response data items. items: $ref: "#/components/schemas/PreviewEntityResponseData" type: array @@ -21536,30 +21826,42 @@ components: $ref: "#/components/schemas/EntityData" type: array EntityResponseDataAttributes: + description: Entity response attributes containing core entity metadata fields. properties: apiVersion: + description: The API version of the entity schema. type: string description: + description: A short description of the entity. type: string displayName: + description: The user-friendly display name of the entity. type: string kind: + description: The kind of the entity (e.g. service, datastore, queue). type: string name: + description: The unique name of the entity within its kind and namespace. type: string namespace: + description: The namespace the entity belongs to. type: string owner: + description: The owner of the entity, usually a team. type: string properties: additionalProperties: {} + description: Additional custom properties for the entity. type: object tags: + description: A set of custom tags assigned to the entity. items: + description: A tag string in the format key:value. type: string type: array type: object EntityResponseDataRelationships: + description: Entity relationships including incidents, oncalls, schemas, and related entities. properties: incidents: $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidents" @@ -21573,15 +21875,19 @@ components: $ref: "#/components/schemas/EntityResponseDataRelationshipsSchema" type: object EntityResponseDataRelationshipsIncidents: + description: Incidents relationship containing a list of incident resources associated with this entity. properties: data: + description: List of incident relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems" type: array type: object EntityResponseDataRelationshipsIncidentsDataItems: + description: Incident relationship data item containing the incident resource identifier and type. properties: id: + description: Incident resource unique identifier. example: "" type: string type: @@ -21600,15 +21906,19 @@ components: x-enum-varnames: - INCIDENT EntityResponseDataRelationshipsOncalls: + description: Oncalls relationship containing a list of oncall resources associated with this entity. properties: data: + description: List of oncall relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems" type: array type: object EntityResponseDataRelationshipsOncallsDataItems: + description: Oncall relationship data item containing the oncall resource identifier and type. properties: id: + description: Oncall resource unique identifier. example: "" type: string type: @@ -21627,6 +21937,7 @@ components: x-enum-varnames: - ONCALL EntityResponseDataRelationshipsRawSchema: + description: Raw schema relationship linking an entity to its raw schema resource. properties: data: $ref: "#/components/schemas/EntityResponseDataRelationshipsRawSchemaData" @@ -21634,8 +21945,10 @@ components: - data type: object EntityResponseDataRelationshipsRawSchemaData: + description: Raw schema relationship data containing the raw schema resource identifier and type. properties: id: + description: Raw schema unique identifier. example: "" type: string type: @@ -21654,15 +21967,19 @@ components: x-enum-varnames: - RAWSCHEMA EntityResponseDataRelationshipsRelatedEntities: + description: Related entities relationship containing a list of entity references related to this entity. properties: data: + description: List of related entity relationship data items. items: $ref: "#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems" type: array type: object EntityResponseDataRelationshipsRelatedEntitiesDataItems: + description: Related entity relationship data item containing the related entity resource identifier and type. properties: id: + description: Related entity unique identifier. example: "" type: string type: @@ -21681,6 +21998,7 @@ components: x-enum-varnames: - RELATEDENTITY EntityResponseDataRelationshipsSchema: + description: Schema relationship linking an entity to its associated schema resource. properties: data: $ref: "#/components/schemas/EntityResponseDataRelationshipsSchemaData" @@ -21688,8 +22006,10 @@ components: - data type: object EntityResponseDataRelationshipsSchemaData: + description: Schema relationship data containing the schema resource identifier and type. properties: id: + description: Entity schema unique identifier. example: "" type: string type: @@ -22008,6 +22328,7 @@ components: implementedBy: description: Services which implemented the API. items: + description: A service entity reference string. type: string type: array interface: @@ -22067,6 +22388,7 @@ components: paths: description: The paths (glob) to the source code of the service. items: + description: A glob pattern path to source code files. type: string type: array repositoryURL: @@ -22148,6 +22470,7 @@ components: tags: description: A list of APM entity tags that associates the APM Stats data with the entity. items: + description: An APM tag string in the format key:value. type: string type: array type: object @@ -22158,6 +22481,7 @@ components: fingerprints: description: A list of CI Fingerprints that associate CI Pipelines with the entity. items: + description: A CI pipeline fingerprint string. type: string type: array type: object @@ -22212,6 +22536,7 @@ components: componentOf: description: A list of components the datastore is a part of items: + description: A component entity reference string. type: string type: array lifecycle: @@ -22293,6 +22618,7 @@ components: description: A set of custom tags. example: [this:tag, that:tag] items: + description: A tag string in the format key:value. type: string type: array required: @@ -22407,6 +22733,7 @@ components: componentOf: description: A list of components the queue is a part of items: + description: A component entity reference string. type: string type: array lifecycle: @@ -22476,16 +22803,19 @@ components: componentOf: description: A list of components the service is a part of items: + description: A component entity reference string. type: string type: array dependsOn: description: A list of components the service depends on. items: + description: A component entity reference string. type: string type: array languages: description: The service's programming language. items: + description: A programming language name. type: string type: array lifecycle: @@ -22553,6 +22883,7 @@ components: components: description: A list of components belongs to the system. items: + description: A component entity reference string. type: string type: array lifecycle: @@ -23980,6 +24311,7 @@ components: type: string type: object FacetInfoRequest: + description: Request body for retrieving facet value information for a specified attribute with optional filtering. example: data: attributes: @@ -23996,10 +24328,12 @@ components: $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" id: + description: Unique identifier for the facet info request resource. type: string type: $ref: "#/components/schemas/FacetInfoRequestDataType" @@ -24007,11 +24341,14 @@ components: - type type: object FacetInfoRequestDataAttributes: + description: Attributes for the facet info request, specifying which facet to query and optional filters to apply. properties: facet_id: + description: The identifier of the facet attribute to retrieve value information for. example: "" type: string limit: + description: Maximum number of facet values to return in the response. example: 0 format: int64 type: integer @@ -24024,13 +24361,17 @@ components: - limit type: object FacetInfoRequestDataAttributesSearch: + description: Query-based search configuration for filtering the audience context when retrieving facet values. properties: query: + description: The filter expression used to scope the audience from which facet values are retrieved. type: string type: object FacetInfoRequestDataAttributesTermSearch: + description: Term-level search configuration for filtering facet values by an exact or partial term match. properties: value: + description: The term string to match against facet values. type: string type: object FacetInfoRequestDataType: @@ -24043,6 +24384,7 @@ components: x-enum-varnames: - USERS_FACET_INFO_REQUEST FacetInfoResponse: + description: Response containing facet information for an attribute, including its distinct values and occurrence counts. example: data: attributes: @@ -24065,10 +24407,12 @@ components: $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" id: + description: Unique identifier for the facet info response resource. type: string type: $ref: "#/components/schemas/FacetInfoResponseDataType" @@ -24076,32 +24420,41 @@ components: - type type: object FacetInfoResponseDataAttributes: + description: Attributes of the facet info response, containing the facet result data. properties: result: $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" values: + description: List of discrete facet values with their occurrence counts. items: $ref: "#/components/schemas/FacetInfoResponseDataAttributesResultValuesItems" type: array type: object FacetInfoResponseDataAttributesResultRange: + description: The numeric range of a facet attribute, representing the minimum and maximum observed values. properties: max: + description: The maximum observed value for the numeric facet attribute. type: object min: + description: The minimum observed value for the numeric facet attribute. type: object type: object FacetInfoResponseDataAttributesResultValuesItems: + description: A single facet value with its occurrence count in the dataset. properties: count: + description: The number of records that have this facet value. format: int64 type: integer value: + description: The facet value (for example, a browser name or country code). type: string type: object FacetInfoResponseDataType: @@ -24316,6 +24669,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Fastly service. type: string type: array required: @@ -24330,6 +24684,7 @@ components: - myTag - myTag2:myValue items: + description: A tag for the Fastly service. type: string type: array type: object @@ -24589,6 +24944,7 @@ components: example: - "@application.id:ABCD" items: + description: A tag-based filter expression using Datadog tag query syntax. example: "@application.id:ABCD" type: string type: array @@ -24652,6 +25008,7 @@ components: description: List of case responses. properties: data: + description: Array of case response data objects. items: $ref: "#/components/schemas/FindingCaseResponseData" type: array @@ -24688,8 +25045,10 @@ components: attributes: additionalProperties: items: + description: A custom attribute value string. type: string type: array + description: Custom attributes associated with the case as key-value pairs where values are string arrays. type: object closed_at: description: Timestamp of when the case was closed. @@ -24769,6 +25128,7 @@ components: description: Project in which the case was created. type: object FindingData: + description: Data object representing a security finding. properties: id: description: Unique identifier of the security finding. @@ -24968,6 +25328,7 @@ components: description: A list of security findings. properties: data: + description: Array of security finding data objects. items: $ref: "#/components/schemas/FindingData" type: array @@ -24998,12 +25359,14 @@ components: description: The name of the test's code owners as inferred from the repository configuration. example: ["@foo", "@bar"] items: + description: A code owner of the test as inferred from the repository configuration. type: string type: array envs: description: List of environments where this test has been flaky. example: prod items: + description: An environment name where this test has been flaky. type: string type: array first_flaked_branch: @@ -25079,6 +25442,7 @@ components: A test service is a group of tests associated with a project or repository. It contains all the individual tests for your code, optionally organized into test suites, which are like folders for your tests. example: ["foo", "bar"] items: + description: A test service name where this test has been flaky. type: string type: array suite: @@ -25345,11 +25709,13 @@ components: enabled_products: description: Datadog products enabled on the agent. items: + description: A Datadog product enabled on the agent. type: string type: array envs: description: Environments the agent is reporting from. items: + description: An environment name the agent is reporting from. type: string type: array first_seen_at: @@ -25363,6 +25729,7 @@ components: ip_addresses: description: IP addresses of the agent. items: + description: An IP address of the agent. type: string type: array is_single_step_instrumentation_enabled: @@ -25382,6 +25749,7 @@ components: otel_collector_versions: description: List of OpenTelemetry collector versions (if applicable). items: + description: An OpenTelemetry collector version string. type: string type: array pod_name: @@ -25398,6 +25766,7 @@ components: services: description: Services running on the agent. items: + description: A service name running on the agent. type: string type: array tags: @@ -25410,10 +25779,13 @@ components: type: string type: object FleetAgentAttributesTagsItems: + description: A key-value pair representing a tag associated with a Datadog Agent. properties: key: + description: The tag key. type: string value: + description: The tag value. type: string type: object FleetAgentInfo: @@ -25476,11 +25848,13 @@ components: enabled_products: description: Datadog products enabled on the agent. items: + description: A Datadog product enabled on the agent. type: string type: array env: description: Environments the agent is reporting from. items: + description: An environment name the agent is reporting from. type: string type: array first_seen_at: @@ -25494,6 +25868,7 @@ components: hostname_aliases: description: Alternative hostname list for the agent. items: + description: An alternative hostname alias for the agent. type: string type: array install_method_installer_version: @@ -25507,6 +25882,7 @@ components: ip_addresses: description: IP addresses of the agent. items: + description: An IP address of the agent. type: string type: array is_single_step_instrumentation_enabled: @@ -25530,6 +25906,7 @@ components: otel_collector_versions: description: List of OpenTelemetry collector versions (if applicable). items: + description: An OpenTelemetry collector version string. type: string type: array otel_collectors: @@ -25547,6 +25924,7 @@ components: region: description: Regions where the agent is running. items: + description: A region where the agent is running. type: string type: array remote_agent_management: @@ -25560,11 +25938,13 @@ components: services: description: Services running on the agent. items: + description: A service name running on the agent. type: string type: array tags: description: Tags associated with the agent. items: + description: A tag string assigned to the agent. type: string type: array team: @@ -25604,6 +25984,7 @@ components: - type type: object FleetAgentVersionAttributes: + description: Attributes of an available Datadog Agent version. properties: version: description: The Agent version string. @@ -25659,6 +26040,7 @@ components: - attributes type: object FleetAgentsResponseDataAttributes: + description: Attributes of the fleet agents response containing the list of agents. properties: agents: description: Array of agents matching the query criteria. @@ -26034,6 +26416,7 @@ components: error_messages: description: Error messages if the integration has issues. items: + description: An error message describing an issue with the integration. type: string type: array init_config: @@ -26269,6 +26652,7 @@ components: "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun". example: ["Mon", "Wed", "Fri"] items: + description: A day of the week (for example, "Mon", "Tue"). type: string type: array maintenance_window_duration: @@ -26975,6 +27359,7 @@ components: error_messages: description: The error messages for the Google Cloud Usage Cost config. items: + description: An error message string. type: string nullable: true type: array @@ -27310,6 +27695,7 @@ components: error_messages: description: The `attributes` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -27586,6 +27972,7 @@ components: description: A list of tags associated with the device. example: ["device_ip:1.2.3.4", "device_id:example:1.2.3.4"] items: + description: A tag string in `key:value` format. type: string type: array vendor: @@ -27659,6 +28046,7 @@ components: - CASE - TEAM_OWNERS GetMappingResponse: + description: Response containing the entity attribute mapping configuration including all available attributes and their properties. example: data: attributes: @@ -27699,10 +28087,12 @@ components: $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" id: + description: Unique identifier for the get mapping response resource. type: string type: $ref: "#/components/schemas/GetMappingResponseDataType" @@ -27710,27 +28100,37 @@ components: - type type: object GetMappingResponseDataAttributes: + description: Attributes of the get mapping response, containing the list of configured entity attributes. properties: attributes: + description: The list of entity attributes and their mapping configurations. items: $ref: "#/components/schemas/GetMappingResponseDataAttributesAttributesItems" type: array type: object GetMappingResponseDataAttributesAttributesItems: + description: Details of a single entity attribute including its mapping configuration and metadata. properties: attribute: + description: The attribute identifier as used in the entity data model. type: string description: + description: Human-readable explanation of what the attribute represents. type: string display_name: + description: The human-readable label for the attribute shown in the UI. type: string groups: + description: List of group labels used to categorize the attribute. items: + description: A group label name for categorizing the attribute. type: string type: array is_custom: + description: Whether this attribute is a custom user-defined attribute rather than a built-in one. type: boolean type: + description: The data type of the attribute (for example, string or number). type: string type: object GetMappingResponseDataType: @@ -27743,15 +28143,18 @@ components: x-enum-varnames: - GET_MAPPINGS_RESPONSE GetMultipleRulesetsRequest: + description: The request payload for retrieving rules for multiple rulesets in a single batch call. properties: data: $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" id: + description: An optional identifier for the get-multiple-rulesets request resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsRequestDataType" @@ -27759,13 +28162,18 @@ components: - type type: object GetMultipleRulesetsRequestDataAttributes: + description: The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. properties: include_testing_rules: + description: When true, rules that are available in testing mode are included in the response. type: boolean include_tests: + description: When true, test cases associated with each rule are included in the response. type: boolean rulesets: + description: The list of ruleset names to retrieve. items: + description: The name of a ruleset to include in the batch request. type: string type: array type: object @@ -27779,15 +28187,18 @@ components: x-enum-varnames: - GET_MULTIPLE_RULESETS_REQUEST GetMultipleRulesetsResponse: + description: The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules. properties: data: $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" id: + description: The unique identifier of the get-multiple-rulesets response resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataType" @@ -27795,32 +28206,41 @@ components: - type type: object GetMultipleRulesetsResponseDataAttributes: + description: The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. properties: rulesets: + description: The list of rulesets returned in response to the batch request. items: $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" description: + description: A detailed description of the ruleset's purpose and the types of issues it targets. type: string name: + description: The unique name of the ruleset. type: string rules: + description: The list of static analysis rules included in this ruleset. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems" type: array short_description: + description: A brief summary of the ruleset, suitable for display in listings. type: string required: - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsData: + description: The resource identifier and type for a ruleset. properties: id: + description: The unique identifier of the ruleset resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType" @@ -27837,76 +28257,106 @@ components: x-enum-varnames: - RULESETS GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems: + description: A static analysis rule within a ruleset, including its definition, metadata, and associated test cases. properties: arguments: + description: The list of configurable arguments accepted by this rule. items: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems" type: array category: + description: The category classifying the type of issue this rule detects (e.g., security, style, performance). type: string checksum: + description: A checksum of the rule definition used to detect changes. type: string code: + description: The rule implementation code used by the static analysis engine. type: string created_at: + description: The date and time when the rule was created. format: date-time type: string created_by: + description: The identifier of the user or system that created the rule. type: string cve: + description: The CVE identifier associated with the vulnerability this rule detects, if applicable. type: string cwe: + description: The CWE identifier associated with the weakness category this rule detects, if applicable. type: string data: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData" description: + description: A detailed explanation of what the rule detects and why it matters. type: string documentation_url: + description: A URL pointing to additional documentation for this rule. type: string entity_checked: + description: The code entity type (e.g., function, class, variable) that this rule inspects. type: string is_published: + description: Indicates whether the rule is publicly published and available to all users. type: boolean is_testing: + description: Indicates whether the rule is in testing mode and not yet promoted to production. type: boolean language: + description: The programming language this rule applies to. type: string last_updated_at: + description: The date and time when the rule was last modified. format: date-time type: string last_updated_by: + description: The identifier of the user or system that last updated the rule. type: string name: + description: The unique name identifying this rule within its ruleset. type: string regex: + description: A regular expression pattern used by the rule for pattern-based detection. type: string severity: + description: The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE). type: string short_description: + description: A brief summary of what the rule detects, suitable for display in listings. type: string should_use_ai_fix: + description: Indicates whether an AI-generated fix suggestion should be offered for findings from this rule. type: boolean tests: + description: The list of test cases used to validate the rule's behavior. items: $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. type: string type: + description: The rule type indicating the detection mechanism used (e.g., tree_sitter, regex). type: string required: - data type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems: + description: An argument parameter for a static analysis rule, with a name and description. properties: description: + description: A human-readable explanation of the argument's purpose and accepted values. type: string name: + description: The name of the rule argument. type: string type: object GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData: + description: The resource identifier and type for a static analysis rule. properties: id: + description: The unique identifier of the rule resource. type: string type: $ref: "#/components/schemas/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType" @@ -27923,15 +28373,19 @@ components: x-enum-varnames: - RULES GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems: + description: A test case associated with a static analysis rule, containing the source code and expected annotation count. properties: annotation_count: + description: The expected number of annotations (findings) the rule should produce when run against the test code. format: int64 maximum: 65535 minimum: 0 type: integer code: + description: The source code snippet used as input for the rule test. type: string filename: + description: The filename associated with the test code snippet. type: string type: object GetMultipleRulesetsResponseDataType: @@ -28175,6 +28629,7 @@ components: - analytics_dashboard_id type: object GlobalIncidentSettingsDataRequest: + description: Data object in the global incident settings request. properties: attributes: $ref: "#/components/schemas/GlobalIncidentSettingsAttributesRequest" @@ -28184,6 +28639,7 @@ components: - type type: object GlobalIncidentSettingsDataResponse: + description: Data object in the global incident settings response. properties: attributes: $ref: "#/components/schemas/GlobalIncidentSettingsAttributesResponse" @@ -28199,6 +28655,7 @@ components: - attributes type: object GlobalIncidentSettingsRequest: + description: Request payload for updating global incident settings. properties: data: $ref: "#/components/schemas/GlobalIncidentSettingsDataRequest" @@ -28206,6 +28663,7 @@ components: - data type: object GlobalIncidentSettingsResponse: + description: Response payload containing global incident settings. properties: data: $ref: "#/components/schemas/GlobalIncidentSettingsDataResponse" @@ -28240,6 +28698,7 @@ components: - data type: object GlobalVariableJsonPatchRequestData: + description: Data object for a JSON Patch request on a Synthetic global variable. properties: attributes: $ref: "#/components/schemas/GlobalVariableJsonPatchRequestDataAttributes" @@ -28247,6 +28706,7 @@ components: $ref: "#/components/schemas/GlobalVariableJsonPatchType" type: object GlobalVariableJsonPatchRequestDataAttributes: + description: Attributes for a JSON Patch request on a Synthetic global variable. properties: json_patch: description: JSON Patch operations following RFC 6902. @@ -28893,6 +29353,7 @@ components: - value type: object HamrOrgConnectionAttributesRequest: + description: Attributes for a HAMR organization connection request. properties: hamr_status: $ref: "#/components/schemas/HamrOrgConnectionStatus" @@ -28927,6 +29388,7 @@ components: - modified_by type: object HamrOrgConnectionAttributesResponse: + description: Attributes of a HAMR organization connection response. properties: hamr_status: $ref: "#/components/schemas/HamrOrgConnectionStatus" @@ -28966,6 +29428,7 @@ components: - modified_by type: object HamrOrgConnectionDataRequest: + description: Data object for a HAMR organization connection request. properties: attributes: $ref: "#/components/schemas/HamrOrgConnectionAttributesRequest" @@ -28981,6 +29444,7 @@ components: - attributes type: object HamrOrgConnectionDataResponse: + description: Data object for a HAMR organization connection response. properties: attributes: $ref: "#/components/schemas/HamrOrgConnectionAttributesResponse" @@ -28996,6 +29460,7 @@ components: - attributes type: object HamrOrgConnectionRequest: + description: Request payload for creating or updating a HAMR organization connection. properties: data: $ref: "#/components/schemas/HamrOrgConnectionDataRequest" @@ -29003,6 +29468,7 @@ components: - data type: object HamrOrgConnectionResponse: + description: Response payload for a HAMR organization connection. properties: data: $ref: "#/components/schemas/HamrOrgConnectionDataResponse" @@ -29395,6 +29861,7 @@ components: type: array type: object IncidentHandleAttributesFieldsSeverity: + description: Severity level associated with an incident handle. example: SEV-1 type: string IncidentHandleAttributesRequest: @@ -29435,6 +29902,7 @@ components: - modified_at type: object IncidentHandleDataRequest: + description: Data object representing an incident handle in a create or update request. properties: attributes: $ref: "#/components/schemas/IncidentHandleAttributesRequest" @@ -29451,6 +29919,7 @@ components: - attributes type: object IncidentHandleDataResponse: + description: Data object representing an incident handle in a response. properties: attributes: $ref: "#/components/schemas/IncidentHandleAttributesResponse" @@ -29468,6 +29937,7 @@ components: - attributes type: object 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" @@ -29477,6 +29947,7 @@ components: $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" @@ -29484,6 +29955,7 @@ components: - data type: object IncidentHandleRelationshipData: + description: Relationship data for an incident handle, containing the ID and type of the related resource. properties: id: description: The ID of the related resource @@ -29498,6 +29970,7 @@ components: - type type: object IncidentHandleRelationships: + description: Relationships associated with an incident handle response, including linked users and incident type. nullable: true properties: commander_user: @@ -29514,6 +29987,7 @@ components: - last_modified_by_user type: object IncidentHandleRelationshipsRequest: + description: Relationships to associate with an incident handle in a create or update request. nullable: true properties: commander_user: @@ -29524,6 +29998,7 @@ components: - incident_type type: object IncidentHandleRequest: + description: Request payload for creating or updating a global incident handle. properties: data: $ref: "#/components/schemas/IncidentHandleDataRequest" @@ -29531,6 +30006,7 @@ components: - data type: object IncidentHandleResponse: + description: Response payload for a single incident handle, including the handle data and related resources. properties: data: $ref: "#/components/schemas/IncidentHandleDataResponse" @@ -29548,6 +30024,7 @@ components: x-enum-varnames: - INCIDENTS_HANDLES IncidentHandlesResponse: + description: Response payload for a list of global incident handles, including handle data and related resources. properties: data: $ref: "#/components/schemas/IncidentHandlesResponseData" @@ -29557,6 +30034,7 @@ components: - data type: object IncidentHandlesResponseData: + description: Array of incident handle data objects returned in a list response. items: $ref: "#/components/schemas/IncidentHandleDataResponse" type: array @@ -30333,6 +30811,7 @@ components: description: The value(s) to compare against. Multiple values are `ORed` together. example: ["SEV-1", "SEV-2"] items: + description: A value to compare against the incident field. type: string type: array required: @@ -32219,6 +32698,7 @@ components: - "Category::Kubernetes" - "Category::Log Collection" items: + description: A category associated with the integration. type: string type: array description: @@ -32240,48 +32720,54 @@ components: - installed type: object IntegrationIncident: - description: Incident integration settings + description: Incident integration settings. properties: auto_escalation_query: - description: Query for auto-escalation + description: Query for auto-escalation. type: string default_incident_commander: - description: Default incident commander + description: Default incident commander. type: string enabled: - description: Whether incident integration is enabled + description: Whether incident integration is enabled. type: boolean field_mappings: + description: List of mappings between incident fields and case fields. items: $ref: "#/components/schemas/IntegrationIncidentFieldMappingsItems" type: array incident_type: - description: Incident type + description: Incident type. type: string severity_config: $ref: "#/components/schemas/IntegrationIncidentSeverityConfig" type: object IntegrationIncidentFieldMappingsItems: + description: Mapping between an incident user-defined field and a case field. properties: case_field: + description: The case field to map the incident field value to. type: string incident_user_defined_field_id: + description: The identifier of the incident user-defined field to map from. type: string type: object IntegrationIncidentSeverityConfig: + description: Severity configuration for mapping incident priorities to case priorities. properties: priority_mapping: additionalProperties: type: string + description: Mapping of incident severity values to case priority values. type: object type: object IntegrationJira: - description: Jira integration settings + description: Jira integration settings. properties: auto_creation: $ref: "#/components/schemas/IntegrationJiraAutoCreation" enabled: - description: Whether Jira integration is enabled + description: Whether Jira integration is enabled. type: boolean metadata: $ref: "#/components/schemas/IntegrationJiraMetadata" @@ -32289,34 +32775,46 @@ components: $ref: "#/components/schemas/IntegrationJiraSync" type: object IntegrationJiraAutoCreation: + description: Auto-creation settings for Jira issues from cases. properties: enabled: + description: Whether automatic Jira issue creation is enabled. type: boolean type: object IntegrationJiraMetadata: + description: Metadata for connecting a case management project to a Jira project. properties: account_id: + description: The Jira account identifier. type: string issue_type_id: + description: The Jira issue type identifier to use when creating issues. type: string project_id: + description: The Jira project identifier to associate with this case project. type: string type: object IntegrationJiraSync: + description: Synchronization configuration for Jira integration. properties: enabled: + description: Whether Jira field synchronization is enabled. type: boolean properties: $ref: "#/components/schemas/IntegrationJiraSyncProperties" type: object IntegrationJiraSyncDueDate: + description: Due date synchronization configuration for Jira integration. properties: jira_field_id: + description: The Jira field identifier used to store the due date. type: string sync_type: + description: The type of synchronization to apply for the due date field. type: string type: object IntegrationJiraSyncProperties: + description: Field synchronization properties for Jira integration. properties: assignee: $ref: "#/components/schemas/SyncProperty" @@ -32325,6 +32823,7 @@ components: custom_fields: additionalProperties: $ref: "#/components/schemas/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties" + description: Map of custom field identifiers to their sync configurations. type: object description: $ref: "#/components/schemas/SyncProperty" @@ -32338,8 +32837,10 @@ components: $ref: "#/components/schemas/SyncProperty" type: object IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties: + description: Synchronization configuration for a Jira custom field. properties: sync_type: + description: The type of synchronization to apply for this custom field. type: string value: $ref: "#/components/schemas/AnyValue" @@ -32353,85 +32854,99 @@ components: type: string type: object IntegrationMonitor: - description: Monitor integration settings + description: Monitor integration settings. properties: auto_resolve_enabled: - description: Whether auto-resolve is enabled + description: Whether auto-resolve is enabled. type: boolean case_type_id: - description: Case type ID for monitor integration + description: Case type ID for monitor integration. type: string enabled: - description: Whether monitor integration is enabled + description: Whether monitor integration is enabled. type: boolean handle: - description: Monitor handle + description: Monitor handle. type: string type: object IntegrationOnCall: - description: On-Call integration settings + description: On-Call integration settings. properties: auto_assign_on_call: - description: Whether to auto-assign on-call + description: Whether to auto-assign on-call. type: boolean enabled: - description: Whether On-Call integration is enabled + description: Whether On-Call integration is enabled. type: boolean escalation_queries: + description: List of escalation queries for routing cases to on-call responders. items: $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItems" type: array type: object IntegrationOnCallEscalationQueriesItems: + description: An On-Call escalation query entry used to route cases to on-call responders. properties: enabled: + description: Whether this escalation query is enabled. type: boolean id: + description: Unique identifier of the escalation query. type: string query: + description: The query used to match cases for escalation. type: string target: $ref: "#/components/schemas/IntegrationOnCallEscalationQueriesItemsTarget" type: object IntegrationOnCallEscalationQueriesItemsTarget: + description: The target recipient for an On-Call escalation query. properties: dynamic_team_paging: + description: Whether to use dynamic team paging for escalation. type: boolean team_id: + description: The identifier of the team to escalate to. type: string user_id: + description: The identifier of the user to escalate to. type: string type: object IntegrationServiceNow: - description: ServiceNow integration settings + description: ServiceNow integration settings. properties: assignment_group: - description: Assignment group + description: Assignment group. type: string auto_creation: $ref: "#/components/schemas/IntegrationServiceNowAutoCreation" enabled: - description: Whether ServiceNow integration is enabled + description: Whether ServiceNow integration is enabled. type: boolean instance_name: - description: ServiceNow instance name + description: ServiceNow instance name. type: string sync_config: $ref: "#/components/schemas/IntegrationServiceNowSyncConfig" type: object IntegrationServiceNowAutoCreation: + description: Auto-creation settings for ServiceNow incidents from cases. properties: enabled: + description: Whether automatic ServiceNow incident creation is enabled. type: boolean type: object IntegrationServiceNowSyncConfig: + description: Synchronization configuration for ServiceNow integration. properties: enabled: + description: Whether ServiceNow synchronization is enabled. type: boolean properties: $ref: "#/components/schemas/IntegrationServiceNowSyncConfig139772721534496" type: object IntegrationServiceNowSyncConfig139772721534496: + description: Field-level synchronization properties for ServiceNow integration. properties: comments: $ref: "#/components/schemas/SyncProperty" @@ -32441,16 +32956,20 @@ components: $ref: "#/components/schemas/SyncPropertyWithMapping" type: object IntegrationServiceNowSyncConfigPriority: + description: Priority synchronization configuration for ServiceNow integration. properties: impact_mapping: additionalProperties: type: string + description: Mapping of case priority values to ServiceNow impact values. type: object sync_type: + description: The type of synchronization to apply for priority. type: string urgency_mapping: additionalProperties: type: string + description: Mapping of case priority values to ServiceNow urgency values. type: object type: object IntegrationType: @@ -32482,6 +33001,7 @@ components: description: The interface IP addresses example: ["1.1.1.1", "1.1.1.2"] items: + description: An IP address assigned to the interface. type: string type: array mac_address: @@ -33882,6 +34402,7 @@ components: tags: description: Tags for generated signals. items: + description: A tag string in `key:value` format. type: string type: array thirdPartyCases: @@ -33928,6 +34449,7 @@ components: example: - "@sns-cloudtrail-results" items: + description: A notification recipient handle (for example, `@user` or `@channel`). type: string type: array to: @@ -34390,6 +34912,7 @@ components: example: - "rec-7c3f5a1b-9e2d-4f8a-b1c6-3d7e9f0a2b4c" items: + description: A record ID to delete. type: string type: array required: @@ -34422,6 +34945,7 @@ components: example: - "9f64e5c7-dc5a-45c8-a17c-1b85f0bec97d" items: + description: A dataset ID to delete. type: string type: array required: @@ -34454,6 +34978,7 @@ components: example: - "3fd6b5e0-8910-4b1c-a7d0-5b84de329012" items: + description: An experiment ID to delete. type: string type: array required: @@ -34486,6 +35011,7 @@ components: example: - "a33671aa-24fd-4dcd-9b33-a8ec7dde7751" items: + description: A project ID to delete. type: string type: array required: @@ -34707,6 +35233,7 @@ components: tags: description: List of tags associated with the metric. items: + description: A tag string in `key:value` format. type: string type: array timestamp_ms: @@ -34779,6 +35306,7 @@ components: tags: description: List of tags associated with the span. items: + description: A tag string in `key:value` format. type: string type: array trace_id: @@ -35305,6 +35833,7 @@ components: additional_names: description: Related library or package names (such as child packages or affected binary paths). items: + description: A related library or package name affected by the vulnerability. example: linux-tools-common type: string type: array @@ -35542,6 +36071,7 @@ components: - data type: object ListConnectionsResponse: + description: Response containing the list of all data source connections configured for an entity. example: data: attributes: @@ -35579,10 +36109,12 @@ components: $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" id: + description: Unique identifier for the list connections response resource. type: string type: $ref: "#/components/schemas/ListConnectionsResponseDataType" @@ -35590,44 +36122,58 @@ components: - type type: object ListConnectionsResponseDataAttributes: + description: Attributes of the list connections response, containing the collection of data source connections. properties: connections: + description: The list of data source connections configured for the entity. items: $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItems" type: array type: object ListConnectionsResponseDataAttributesConnectionsItems: + description: Details of a single data source connection, including its fields, join configuration, and audit metadata. properties: created_at: + description: Timestamp indicating when the connection was created. format: date-time type: string created_by: + description: Identifier of the user who created the connection. type: string fields: + description: List of custom attribute fields imported from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array id: + description: Unique identifier of the connection. type: string join: $ref: "#/components/schemas/ListConnectionsResponseDataAttributesConnectionsItemsJoin" metadata: additionalProperties: type: string + description: Additional key-value metadata associated with the connection. type: object type: + description: The type of data source connection (for example, ref_table). type: string updated_at: + description: Timestamp indicating when the connection was last updated. format: date-time type: string updated_by: + description: Identifier of the user who last updated the connection. type: string type: object ListConnectionsResponseDataAttributesConnectionsItemsJoin: + description: The join configuration describing how the data source is linked to the entity. properties: attribute: + description: The entity attribute used as the join key to link records from the data source. type: string type: + description: The type of join key used (for example, email or user_id). type: string type: object ListConnectionsResponseDataType: @@ -35664,8 +36210,10 @@ components: x-enum-varnames: - LIST_DEPLOYMENT_RULES ListDeploymentRulesResponseDataAttributes: + description: Attributes of the response for listing deployment rules. properties: rules: + description: The list of deployment rules. items: $ref: "#/components/schemas/DeploymentRuleResponseDataAttributes" type: array @@ -35861,6 +36409,7 @@ components: description: Response type for listing notification channels for a user properties: data: + description: Array of notification channel data objects. items: $ref: "#/components/schemas/NotificationChannelData" type: array @@ -35869,6 +36418,7 @@ components: description: Response type for listing notification rules for a user properties: data: + description: Array of notification rule data objects. items: $ref: "#/components/schemas/OnCallNotificationRuleData" type: array @@ -36022,6 +36572,7 @@ components: description: The list of tags example: ["tag:test", "tag:testbis"] items: + description: A tag string in `key:value` format. type: string type: array type: object @@ -37203,6 +37754,7 @@ components: - redirect_url type: object Maintenance: + description: Response object for a single maintenance. properties: data: $ref: "#/components/schemas/MaintenanceData" @@ -37213,8 +37765,10 @@ components: type: array type: object MaintenanceArray: + description: Response object for a list of maintenances. properties: data: + description: A list of maintenance data objects. items: $ref: "#/components/schemas/MaintenanceData" type: array @@ -37229,6 +37783,7 @@ components: - data type: object MaintenanceData: + description: The data object for a maintenance. properties: attributes: $ref: "#/components/schemas/MaintenanceDataAttributes" @@ -37289,6 +37844,7 @@ components: type: array type: object MaintenanceDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -37317,6 +37873,7 @@ components: - IN_PROGRESS - COMPLETED MaintenanceDataAttributesUpdatesItems: + description: An update made to a maintenance. properties: components_affected: description: The components affected at the time of the update. @@ -37354,6 +37911,7 @@ components: type: string type: object MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems: + description: A component affected at the time of a maintenance update. properties: id: description: Identifier of the component affected at the time of the update. @@ -37385,6 +37943,7 @@ components: description: The status page the maintenance belongs to. type: object MaintenanceDataRelationshipsCreatedByUser: + description: The Datadog user who created the maintenance. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsCreatedByUserData" @@ -37392,6 +37951,7 @@ components: - data type: object MaintenanceDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the maintenance. properties: id: description: The ID of the Datadog user who created the maintenance. @@ -37405,6 +37965,7 @@ components: - id type: object MaintenanceDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the maintenance. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsLastModifiedByUserData" @@ -37412,6 +37973,7 @@ components: - data type: object MaintenanceDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the maintenance. properties: id: description: The ID of the Datadog user who last modified the maintenance. @@ -37425,6 +37987,7 @@ components: - id type: object MaintenanceDataRelationshipsStatusPage: + description: The status page the maintenance belongs to. properties: data: $ref: "#/components/schemas/MaintenanceDataRelationshipsStatusPageData" @@ -37432,6 +37995,7 @@ components: - data type: object MaintenanceDataRelationshipsStatusPageData: + description: The data object identifying the status page associated with a maintenance. properties: id: description: The ID of the status page. @@ -38769,6 +39333,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array table: @@ -39323,6 +39888,7 @@ components: description: Valid values for the tag. example: ["prod", "staging"] items: + description: A valid tag value for the monitor configuration policy. maxLength: 255 type: string type: array @@ -39343,6 +39909,7 @@ components: description: Valid values for the tag. example: ["prod", "staging"] items: + description: A valid tag value for the monitor configuration policy. maxLength: 255 type: string type: array @@ -39524,6 +40091,7 @@ components: A list of tag key:value pairs (e.g. `team:product`). All tags must match (AND semantics). example: [team:product, host:abc] items: + description: A tag key:value pair to match against monitor notifications. maxLength: 255 type: string maxItems: 20 @@ -39913,6 +40481,7 @@ components: description: Available values for the variable. example: ["value1", "value2"] items: + description: An available value for the template variable. minLength: 1 type: string uniqueItems: true @@ -39921,6 +40490,7 @@ components: description: Default values of the template variable. example: ["defaultValue"] items: + description: A default value for the template variable. minLength: 0 type: string uniqueItems: true @@ -40620,6 +41190,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -40692,6 +41263,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_prefix: @@ -40996,6 +41568,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array region: @@ -41089,6 +41662,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -41214,6 +41788,7 @@ components: description: A list of IDs for components whose output is used as the input for this processor group. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input. type: string type: array processors: @@ -41298,6 +41873,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array tls: @@ -41512,6 +42088,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array routes: @@ -41572,6 +42149,7 @@ components: description: A list of component IDs whose output is used as the input for this component. example: ["metric-tags-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -41617,6 +42195,7 @@ components: description: A list of tag keys. example: ["env", "service", "version"] items: + description: A Datadog tag key to include or exclude. type: string type: array mode: @@ -41692,6 +42271,7 @@ components: description: A list of log field paths to check for duplicates. example: ["log.message", "log.error"] items: + description: A log field path to evaluate for duplicate values. type: string type: array id: @@ -41792,6 +42372,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -42031,6 +42612,7 @@ components: columns: description: List of column names to include from the reference table. If not provided, all columns are included. items: + description: The name of a column to include from the reference table. type: string type: array key_field: @@ -42225,6 +42807,7 @@ components: description: Optional fields used to group the metric series. example: ["service", "env"] items: + description: A log field name used to group the metric series. type: string type: array include: @@ -42322,6 +42905,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["parse-json-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array log_type: @@ -42381,6 +42965,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["datadog-agent-source"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_prefix: @@ -42468,6 +43053,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array project: @@ -42575,6 +43161,7 @@ components: description: A list of component IDs whose output is used as the input for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array password_key: @@ -42799,6 +43386,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array key_field: @@ -42959,6 +43547,7 @@ components: description: A list of Kafka topic names to subscribe to. The source ingests messages from each topic specified. example: ["topic1", "topic2"] items: + description: A Kafka topic name to subscribe to. type: string type: array type: @@ -43106,6 +43695,7 @@ components: description: A list of tag keys to include or exclude. example: ["env", "service", "version"] items: + description: A metric tag key to include or exclude based on the action. type: string type: array mode: @@ -43164,6 +43754,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["parse-json-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array license_key_key: @@ -43363,6 +43954,7 @@ components: example: - container items: + description: The name of an OCSF profile to apply to the event. type: string type: array version: @@ -43429,6 +44021,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -43760,6 +44353,7 @@ components: 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. items: + description: The name of a log field used to partition quota enforcement. type: string type: array too_many_buckets_action: @@ -43854,6 +44448,7 @@ components: description: A list of fields used to group log events for merging. example: ["log.user.id", "log.device.id"] items: + description: A log field path used to group events for aggregation. type: string type: array id: @@ -43948,6 +44543,7 @@ components: description: A list of field names to be removed from each log event. example: ["field1", "field2"] items: + description: The name of a field to remove from the log event. type: string type: array id: @@ -44061,6 +44657,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array keepalive: @@ -44137,6 +44734,7 @@ components: description: Optional list of fields to group events by. Each group is sampled independently. example: ["service", "host"] items: + description: A log field name used to group events for independent sampling. type: string minItems: 1 type: array @@ -44326,6 +44924,7 @@ components: description: A list of keywords to match near the sensitive pattern. example: ["ssn", "card", "account"] items: + description: A keyword string that reinforces detection when found near the sensitive pattern. type: string type: array proximity: @@ -44391,6 +44990,7 @@ components: description: Tags assigned to this rule for filtering and classification. example: ["pii", "ccn"] items: + description: A tag string used to classify and filter this sensitive data rule. type: string type: array required: @@ -44460,6 +45060,7 @@ components: example: - "" items: + description: A log field path to include or exclude from sensitive data scanning. type: string type: array required: [fields] @@ -44488,6 +45089,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array region: @@ -44552,6 +45154,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array mode: @@ -44899,6 +45502,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array sourcetype: @@ -45040,6 +45644,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array type: @@ -45133,6 +45738,7 @@ components: description: A list of component IDs whose output is used as the `input` for this component. example: ["filter-processor"] items: + description: The ID of a component whose output is used as input for this destination. type: string type: array keepalive: @@ -45217,6 +45823,7 @@ components: description: Optional list of fields used to group events before the threshold has been reached. example: ["log.user.id"] items: + description: A log field name used to group events for independent throttling. type: string type: array id: @@ -46632,6 +47239,7 @@ components: type: object PaginationMetaPageType: default: offset_limit + description: The pagination type used for offset-based pagination. enum: - offset_limit example: offset_limit @@ -46799,6 +47407,7 @@ components: type: string type: object PatchComponentRequest: + description: Request object for updating a component. example: data: attributes: @@ -46811,6 +47420,7 @@ components: $ref: "#/components/schemas/PatchComponentRequestData" type: object PatchComponentRequestData: + description: The data object for updating a component. properties: attributes: $ref: "#/components/schemas/PatchComponentRequestDataAttributes" @@ -46840,6 +47450,7 @@ components: type: integer type: object PatchDegradationRequest: + description: Request object for updating a degradation. example: data: attributes: @@ -46855,6 +47466,7 @@ components: $ref: "#/components/schemas/PatchDegradationRequestData" type: object PatchDegradationRequestData: + description: The data object for updating a degradation. properties: attributes: $ref: "#/components/schemas/PatchDegradationRequestDataAttributes" @@ -46894,6 +47506,7 @@ components: type: string type: object PatchDegradationRequestDataAttributesComponentsAffectedItems: + description: A component affected by a degradation. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -46901,6 +47514,7 @@ components: format: uuid type: string name: + description: The name of the component. readOnly: true type: string status: @@ -46940,6 +47554,7 @@ components: - data type: object PatchMaintenanceRequest: + description: Request object for updating a maintenance. example: data: attributes: @@ -46955,6 +47570,7 @@ components: $ref: "#/components/schemas/PatchMaintenanceRequestData" type: object PatchMaintenanceRequestData: + description: The data object for updating a maintenance. properties: attributes: $ref: "#/components/schemas/PatchMaintenanceRequestDataAttributes" @@ -47003,6 +47619,7 @@ components: type: string type: object PatchMaintenanceRequestDataAttributesComponentsAffectedItems: + description: A component affected by a maintenance. properties: id: description: The ID of the component. Must be a component of type `component`. @@ -47077,6 +47694,7 @@ components: $ref: "#/components/schemas/Version" type: object PatchStatusPageRequest: + description: Request object for updating a status page. example: data: attributes: @@ -47096,6 +47714,7 @@ components: $ref: "#/components/schemas/PatchStatusPageRequestData" type: object PatchStatusPageRequestData: + description: The data object for updating a status page. properties: attributes: $ref: "#/components/schemas/PatchStatusPageRequestDataAttributes" @@ -47205,6 +47824,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array type: object @@ -47326,6 +47946,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -47417,6 +48038,7 @@ components: x-enum-varnames: - PERMISSIONS Playlist: + description: A single RUM replay playlist resource returned by create, update, or get operations. properties: data: $ref: "#/components/schemas/PlaylistData" @@ -47424,8 +48046,10 @@ components: - data type: object PlaylistArray: + description: A list of RUM replay playlists returned by a list operation. properties: data: + description: Array of playlist data objects. items: $ref: "#/components/schemas/PlaylistData" type: array @@ -47433,10 +48057,12 @@ components: - data type: object PlaylistData: + description: Data object representing a RUM replay playlist, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/PlaylistDataAttributes" id: + description: Unique identifier of the playlist. type: string type: $ref: "#/components/schemas/PlaylistDataType" @@ -47444,39 +48070,51 @@ components: - type type: object PlaylistDataAttributes: + description: Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. properties: created_at: + description: Timestamp when the playlist was created. format: date-time type: string created_by: $ref: "#/components/schemas/PlaylistDataAttributesCreatedBy" description: + description: Optional human-readable description of the playlist's purpose or contents. type: string name: + description: Human-readable name of the playlist. example: My Playlist type: string session_count: + description: Number of replay sessions in the playlist. format: int64 type: integer updated_at: + description: Timestamp when the playlist was last updated. format: date-time type: string required: - name type: object PlaylistDataAttributesCreatedBy: + description: Information about the user who created the playlist. properties: handle: + description: Email handle of the user who created the playlist. example: john.doe@example.com type: string icon: + description: URL or identifier of the user's avatar icon. type: string id: + description: Unique identifier of the user who created the playlist. example: 00000000-0000-0000-0000-000000000001 type: string name: + description: Display name of the user who created the playlist. type: string uuid: + description: UUID of the user who created the playlist. example: 00000000-0000-0000-0000-000000000001 type: string required: @@ -47494,6 +48132,7 @@ components: x-enum-varnames: - RUM_REPLAY_PLAYLIST PlaylistsSession: + description: A single RUM replay session resource as it appears within a playlist context. properties: data: $ref: "#/components/schemas/PlaylistsSessionData" @@ -47501,8 +48140,10 @@ components: - data type: object PlaylistsSessionArray: + description: A list of RUM replay sessions belonging to a playlist. properties: data: + description: Array of playlist session data objects. items: $ref: "#/components/schemas/PlaylistsSessionData" type: array @@ -47510,10 +48151,12 @@ components: - data type: object PlaylistsSessionData: + description: Data object representing a session within a playlist, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/PlaylistsSessionDataAttributes" id: + description: Unique identifier of the RUM replay session. type: string type: $ref: "#/components/schemas/ViewershipHistorySessionDataType" @@ -47521,14 +48164,18 @@ components: - type type: object PlaylistsSessionDataAttributes: + description: Attributes of a session within a playlist, including the session event data and its replay track. properties: session_event: additionalProperties: {} + description: Raw event data associated with the replay session. type: object track: + description: Replay track identifier indicating which recording track the session belongs to. type: string type: object PostmortemAttachmentRequest: + description: Request body for creating a postmortem attachment. properties: data: $ref: "#/components/schemas/PostmortemAttachmentRequestData" @@ -47606,6 +48253,7 @@ components: x-enum-varnames: - MARKDOWN PostmortemTemplateAttributesRequest: + description: Attributes for creating or updating a postmortem template. properties: name: description: The name of the template @@ -47615,6 +48263,7 @@ components: - name type: object PostmortemTemplateAttributesResponse: + description: Attributes of a postmortem template returned in a response. properties: createdAt: description: When the template was created @@ -47636,6 +48285,7 @@ components: - modifiedAt type: object PostmortemTemplateDataRequest: + description: Data object for creating or updating a postmortem template. properties: attributes: $ref: "#/components/schemas/PostmortemTemplateAttributesRequest" @@ -47646,6 +48296,7 @@ components: - attributes type: object PostmortemTemplateDataResponse: + description: Data object for a postmortem template returned in a response. properties: attributes: $ref: "#/components/schemas/PostmortemTemplateAttributesResponse" @@ -47661,6 +48312,7 @@ components: - attributes type: object PostmortemTemplateRequest: + description: Request body for creating or updating a postmortem template. properties: data: $ref: "#/components/schemas/PostmortemTemplateDataRequest" @@ -47668,6 +48320,7 @@ components: - data type: object PostmortemTemplateResponse: + description: Response containing a single postmortem template. properties: data: $ref: "#/components/schemas/PostmortemTemplateDataResponse" @@ -47683,8 +48336,10 @@ components: x-enum-varnames: - POSTMORTEM_TEMPLATE PostmortemTemplatesResponse: + description: Response containing a list of postmortem templates. properties: data: + description: An array of postmortem template data objects. items: $ref: "#/components/schemas/PostmortemTemplateDataResponse" type: array @@ -47715,6 +48370,7 @@ components: description: List of tags to identify this powerpack. example: ["tag:foo1"] items: + description: A tag to identify this powerpack. maxLength: 80 type: string maxItems: 8 @@ -47980,10 +48636,12 @@ components: type: string type: object PreviewEntityResponseData: + description: Entity data returned in a preview response, including attributes, relationships, and type. properties: attributes: $ref: "#/components/schemas/EntityResponseDataAttributes" id: + description: Entity unique identifier. type: string relationships: $ref: "#/components/schemas/EntityResponseDataRelationships" @@ -48093,6 +48751,7 @@ components: indexes: description: Restrict the query to specific indexes. Max 1 entry. items: + description: Index name to restrict the query to. type: string maxItems: 1 type: array @@ -48341,17 +49000,22 @@ components: description: An interval definition in a timeseries response. properties: milliseconds: + description: The duration of each time bucket in milliseconds. format: int64 type: integer start_time: + description: The start of this interval as an epoch timestamp in milliseconds. format: int64 type: integer times: + description: Epoch timestamps (in milliseconds) for each bucket in this interval. items: + description: Epoch timestamp in milliseconds for a time bucket boundary. format: int64 type: integer type: array type: + description: The interval type (e.g., fixed or auto-computed bucket size). type: string type: object ProductAnalyticsOccurrenceFilter: @@ -48407,11 +49071,13 @@ components: description: Metadata for a Product Analytics query response. properties: request_id: + description: Unique identifier for the request, used for multi-step query continuation. type: string status: $ref: "#/components/schemas/ProductAnalyticsResponseMetaStatus" type: object ProductAnalyticsResponseMetaStatus: + description: The execution status of a Product Analytics query. enum: - done - running @@ -48433,12 +49099,15 @@ components: $ref: "#/components/schemas/ProductAnalyticsScalarColumnType" values: description: Column values. - items: {} + items: + description: A single cell value within the column (string for group-by columns, number for metric columns). type: array type: object ProductAnalyticsScalarColumnMeta: + description: Metadata associated with a scalar response column, including optional unit information. properties: unit: + description: Unit definitions for the column values, if applicable. items: $ref: "#/components/schemas/ProductAnalyticsUnit" nullable: true @@ -48462,8 +49131,10 @@ components: $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsScalarResponseAttributes: + description: Attributes of a scalar analytics response, containing the result columns. properties: columns: + description: The list of result columns, each containing values and metadata. items: $ref: "#/components/schemas/ProductAnalyticsScalarColumn" type: array @@ -48474,11 +49145,13 @@ components: attributes: $ref: "#/components/schemas/ProductAnalyticsScalarResponseAttributes" id: + description: Unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ProductAnalyticsScalarResponseType" type: object ProductAnalyticsScalarResponseType: + description: The resource type identifier for a scalar analytics response. enum: - scalar_response type: string @@ -48488,13 +49161,17 @@ components: description: A series in a timeseries response. properties: group_tags: + description: The group-by tag values that identify this series. items: + description: A tag value for a group-by facet. type: string type: array query_index: + description: The index of the query that produced this series. format: int64 type: integer unit: + description: Unit definitions for the series values. items: $ref: "#/components/schemas/ProductAnalyticsUnit" type: array @@ -48614,25 +49291,31 @@ components: $ref: "#/components/schemas/ProductAnalyticsResponseMeta" type: object ProductAnalyticsTimeseriesResponseAttributes: + description: Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. properties: intervals: + description: Interval definitions describing the time buckets used in the response. items: $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" type: array times: description: Timestamps for each data point (epoch milliseconds). items: + description: Epoch timestamp in milliseconds. format: int64 type: integer type: array values: description: Values for each series at each time point. items: + description: Array of numeric values for a single series across all time points. items: + description: Numeric value at a time point, or null if no data is available. format: double nullable: true type: number @@ -48640,15 +49323,18 @@ components: type: array type: object ProductAnalyticsTimeseriesResponseData: + description: Data object for a timeseries analytics response. properties: attributes: $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseAttributes" id: + description: Unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ProductAnalyticsTimeseriesResponseType" type: object ProductAnalyticsTimeseriesResponseType: + description: The resource type identifier for a timeseries analytics response. enum: - timeseries_response type: string @@ -48658,29 +49344,35 @@ components: description: A unit definition for metric values. properties: family: + description: The unit family (e.g., time, bytes). example: time type: string id: + description: Numeric identifier for the unit. format: int64 type: integer name: + description: The full name of the unit (e.g., nanosecond). example: nanosecond type: string plural: + description: Plural form of the unit name (e.g., nanoseconds). type: string scale_factor: + description: Conversion factor relative to the base unit of the family. format: double type: number short_name: + description: Abbreviated unit name (e.g., ns). type: string type: object Project: - description: A Project + description: A Project. properties: attributes: $ref: "#/components/schemas/ProjectAttributes" id: - description: The Project's identifier + description: The Project's identifier. example: aeadc05e-98a8-11ec-ac2c-da7ad0900001 type: string relationships: @@ -48693,56 +49385,64 @@ components: - attributes type: object ProjectAttributes: - description: Project attributes + description: Project attributes. properties: columns_config: $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array key: - description: The project's key + description: The project's key. example: CASEM type: string name: - description: Project's name + description: Project's name. example: "Security Investigation" type: string restricted: - description: Whether the project is restricted + description: Whether the project is restricted. type: boolean settings: $ref: "#/components/schemas/ProjectSettings" type: object ProjectColumnsConfig: - description: Project columns configuration + description: Project columns configuration. properties: columns: + description: List of column configurations for the project board view. items: $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" sort_field: + description: The field used to sort items in this column. type: string type: + description: The type of column. type: string type: object ProjectColumnsConfigColumnsItemsSort: + description: Sort configuration for a project board column. properties: ascending: + description: Whether to sort in ascending order. type: boolean priority: + description: The sort priority order for this column. format: int64 type: integer type: object ProjectCreate: - description: Project create + description: Project create. properties: attributes: $ref: "#/components/schemas/ProjectCreateAttributes" @@ -48753,30 +49453,31 @@ components: - type type: object ProjectCreateAttributes: - description: Project creation attributes + description: Project creation attributes. properties: enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array key: - description: Project's key. Cannot be "CASE" + description: Project's key. Cannot be "CASE". example: "SEC" type: string name: - description: Project name + description: Project name. example: "Security Investigation" type: string team_uuid: - description: Team UUID to associate with the project + description: Team UUID to associate with the project. type: string required: - name - key type: object ProjectCreateRequest: - description: Project create request + description: Project create request. properties: data: $ref: "#/components/schemas/ProjectCreate" @@ -48784,33 +49485,41 @@ components: - data type: object ProjectNotificationSettings: - description: Project notification settings + description: Project notification settings. properties: destinations: - description: Notification destinations (1=email, 2=slack, 3=in-app) + description: Notification destinations (1=email, 2=slack, 3=in-app). items: + description: Notification channel identifier (1=email, 2=slack, 3=in-app). type: integer type: array enabled: - description: Whether notifications are enabled + description: Whether notifications are enabled. type: boolean notify_on_case_assignment: + description: Whether to send a notification when a case is assigned. type: boolean notify_on_case_closed: + description: Whether to send a notification when a case is closed. type: boolean notify_on_case_comment: + description: Whether to send a notification when a comment is added to a case. type: boolean notify_on_case_comment_mention: + description: Whether to send a notification when a user is mentioned in a case comment. type: boolean notify_on_case_priority_change: + description: Whether to send a notification when a case's priority changes. type: boolean notify_on_case_status_change: + description: Whether to send a notification when a case's status changes. type: boolean notify_on_case_unassignment: + description: Whether to send a notification when a case is unassigned. type: boolean type: object ProjectRelationship: - description: Relationship to project + description: Relationship to project. properties: data: $ref: "#/components/schemas/ProjectRelationshipData" @@ -48818,10 +49527,10 @@ components: - data type: object ProjectRelationshipData: - description: Relationship to project object + description: Relationship to project object. properties: id: - description: A unique identifier that represents the project + description: A unique identifier that represents the project. example: "e555e290-ed65-49bd-ae18-8acbfcf18db7" type: string type: @@ -48831,7 +49540,7 @@ components: - type type: object ProjectRelationships: - description: Project relationships + description: Project relationships. properties: member_team: $ref: "#/components/schemas/RelationshipToTeamLinks" @@ -48840,7 +49549,7 @@ components: type: object ProjectResourceType: default: project - description: Project resource type + description: Project resource type. enum: - project example: project @@ -48848,13 +49557,13 @@ components: x-enum-varnames: - PROJECT ProjectResponse: - description: Project response + description: Project response. properties: data: $ref: "#/components/schemas/Project" type: object ProjectSettings: - description: Project settings + description: Project settings. properties: auto_close_inactive_cases: $ref: "#/components/schemas/AutoCloseInactiveCases" @@ -48874,7 +49583,7 @@ components: $ref: "#/components/schemas/ProjectNotificationSettings" type: object ProjectUpdate: - description: Project update + description: Project update. properties: attributes: $ref: "#/components/schemas/ProjectUpdateAttributes" @@ -48884,26 +49593,27 @@ components: - type type: object ProjectUpdateAttributes: - description: Project update attributes + description: Project update attributes. properties: columns_config: $ref: "#/components/schemas/ProjectColumnsConfig" enabled_custom_case_types: - description: List of enabled custom case type IDs + description: List of enabled custom case type IDs. items: + description: A custom case type identifier. type: string type: array name: - description: Project name + description: Project name. type: string settings: $ref: "#/components/schemas/ProjectSettings" team_uuid: - description: Team UUID to associate with the project + description: Team UUID to associate with the project. type: string type: object ProjectUpdateRequest: - description: Project update request + description: Project update request. properties: data: $ref: "#/components/schemas/ProjectUpdate" @@ -48972,10 +49682,10 @@ components: x-enum-varnames: - PROJECt_COST ProjectsResponse: - description: Response with projects + description: Response with projects. properties: data: - description: Projects response data + description: Projects response data. items: $ref: "#/components/schemas/Project" type: array @@ -49024,6 +49734,7 @@ components: - $ref: "#/components/schemas/DataTransform" - $ref: "#/components/schemas/StateVariable" QueryAccountRequest: + description: Request body for querying accounts with optional filtering, column selection, and sorting. example: data: attributes: @@ -49049,10 +49760,12 @@ components: $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" id: + description: Unique identifier for the query account request resource. type: string type: $ref: "#/components/schemas/QueryAccountRequestDataType" @@ -49060,26 +49773,35 @@ components: - type type: object QueryAccountRequestDataAttributes: + description: Attributes for filtering and shaping the account query results. properties: limit: + description: Maximum number of account records to return in the response. format: int64 type: integer query: + description: Filter expression using account attribute conditions to narrow results. type: string select_columns: + description: List of account attribute column names to include in the response. items: + description: Name of an account attribute column to include in the response. type: string type: array sort: $ref: "#/components/schemas/QueryAccountRequestDataAttributesSort" wildcard_search_term: + description: Free-text term used for wildcard search across account attribute values. type: string type: object QueryAccountRequestDataAttributesSort: + description: Sorting configuration specifying the field and direction for ordering query results. properties: field: + description: The attribute field name to sort results by. type: string order: + description: The sort direction, either ascending or descending. type: string type: object QueryAccountRequestDataType: @@ -49092,6 +49814,7 @@ components: x-enum-varnames: - QUERY_ACCOUNT_REQUEST QueryEventFilteredUsersRequest: + description: Request body for querying users filtered by user properties combined with event platform activity. example: data: attributes: @@ -49119,10 +49842,12 @@ components: $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" id: + description: Unique identifier for the query event filtered users request resource. type: string type: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataType" @@ -49130,34 +49855,45 @@ components: - type type: object QueryEventFilteredUsersRequestDataAttributes: + description: Attributes for filtering users by both user properties and event platform activity. properties: event_query: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQuery" include_row_count: + description: Whether to include the total count of matching users in the response. type: boolean limit: + description: Maximum number of user records to return in the response. format: int64 type: integer query: + description: Filter expression using user attribute conditions to narrow results. type: string select_columns: + description: List of user attribute column names to include in the response. items: + description: Name of a user attribute column to include in the response. type: string type: array type: object QueryEventFilteredUsersRequestDataAttributesEventQuery: + description: Event platform query used to filter users based on their event activity within a specified time window. properties: query: + description: The event platform query expression for filtering users by their event activity. type: string time_frame: $ref: "#/components/schemas/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame" type: object QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame: + description: The time window defining the start and end of the event query period as Unix timestamps. properties: end: + description: End of the time frame as a Unix timestamp in seconds. format: int64 type: integer start: + description: Start of the time frame as a Unix timestamp in seconds. format: int64 type: integer type: object @@ -49183,6 +49919,7 @@ components: - formula type: object QueryResponse: + description: Response containing the query results with matched records and total count. example: data: attributes: @@ -49228,10 +49965,12 @@ components: $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" id: + description: Unique identifier for the query response resource. type: string type: $ref: "#/components/schemas/QueryResponseDataType" @@ -49239,12 +49978,16 @@ components: - type type: object QueryResponseDataAttributes: + description: Attributes of the query response, containing the matched records and total count. properties: hits: + description: The list of matching records returned by the query, each as a map of attribute names to values. items: additionalProperties: {} + description: A single matched record represented as a map of attribute names to their values. type: array total: + description: Total number of records matching the query, regardless of the limit applied. format: int64 type: integer type: object @@ -49268,6 +50011,7 @@ components: - ASC - DESC QueryUsersRequest: + description: Request body for querying users with optional filtering, column selection, and sorting. example: data: attributes: @@ -49293,10 +50037,12 @@ components: $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" id: + description: Unique identifier for the query users request resource. type: string type: $ref: "#/components/schemas/QueryUsersRequestDataType" @@ -49304,26 +50050,35 @@ components: - type type: object QueryUsersRequestDataAttributes: + description: Attributes for filtering and shaping the user query results. properties: limit: + description: Maximum number of user records to return in the response. format: int64 type: integer query: + description: Filter expression using user attribute conditions to narrow results. type: string select_columns: + description: List of user attribute column names to include in the response. items: + description: Name of a user attribute column to include in the response. type: string type: array sort: $ref: "#/components/schemas/QueryUsersRequestDataAttributesSort" wildcard_search_term: + description: Free-text term used for wildcard search across user attribute values. type: string type: object QueryUsersRequestDataAttributesSort: + description: Sorting configuration specifying the field and direction for ordering user query results. properties: field: + description: The user attribute field name to sort results by. type: string order: + description: The sort direction, either ascending or descending. type: string type: object QueryUsersRequestDataType: @@ -50149,6 +50904,7 @@ components: description: Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components. properties: confidence_level: + description: The confidence level of the recommendation, expressed as a value between 0.0 (low confidence) and 1.0 (high confidence). format: double type: number driver: @@ -51036,15 +51792,18 @@ components: x-enum-varnames: - RULESET ResolveVulnerableSymbolsRequest: + description: The top-level request object for resolving vulnerable symbols in a set of packages. properties: data: $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" id: + description: An optional identifier for this request data object. type: string type: $ref: "#/components/schemas/ResolveVulnerableSymbolsRequestDataType" @@ -51052,14 +51811,18 @@ components: - type type: object ResolveVulnerableSymbolsRequestDataAttributes: + description: The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. properties: purls: + description: The list of Package URLs (PURLs) for which to resolve vulnerable symbols. items: + description: A Package URL (PURL) identifying a specific package and version. type: string type: array type: object ResolveVulnerableSymbolsRequestDataType: default: resolve-vulnerable-symbols-request + description: The type identifier for requests to resolve vulnerable symbols. enum: - resolve-vulnerable-symbols-request example: resolve-vulnerable-symbols-request @@ -51067,15 +51830,18 @@ components: x-enum-varnames: - RESOLVE_VULNERABLE_SYMBOLS_REQUEST ResolveVulnerableSymbolsResponse: + description: The top-level response object returned when resolving vulnerable symbols for a set of packages. properties: data: $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" id: + description: The unique identifier for this response data object. type: string type: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseDataType" @@ -51083,14 +51849,17 @@ components: - type type: object ResolveVulnerableSymbolsResponseDataAttributes: + description: The attributes of a response containing resolved vulnerable symbols, organized by package. properties: results: + description: The list of resolved vulnerable symbol results, one entry per queried package. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResults" type: array type: object ResolveVulnerableSymbolsResponseDataType: default: resolve-vulnerable-symbols-response + description: The type identifier for responses containing resolved vulnerable symbols. enum: - resolve-vulnerable-symbols-response example: resolve-vulnerable-symbols-response @@ -51098,30 +51867,40 @@ components: x-enum-varnames: - RESOLVE_VULNERABLE_SYMBOLS_RESPONSE ResolveVulnerableSymbolsResponseResults: + description: The result of resolving vulnerable symbols for a specific package, identified by its PURL. properties: purl: + description: The Package URL (PURL) uniquely identifying the package for which vulnerable symbols are resolved. type: string vulnerable_symbols: + description: The list of vulnerable symbol groups found in this package, organized by advisory. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbols: + description: A collection of vulnerable symbols associated with a specific security advisory. properties: advisory_id: + description: The identifier of the security advisory that describes the vulnerability. type: string symbols: + description: The list of symbols that are vulnerable according to this advisory. items: $ref: "#/components/schemas/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols" type: array type: object ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols: + description: A symbol identified as vulnerable within a dependency, including its name, type, and value. properties: name: + description: The name of the vulnerable symbol. type: string type: + description: The type classification of the vulnerable symbol (e.g., function, class, variable). type: string value: + description: The value or identifier associated with the vulnerable symbol. type: string type: object ResourceFilterAttributes: @@ -51781,11 +52560,13 @@ components: x-enum-varnames: - REVERT_CUSTOM_RULE_REVISION_REQUEST RevertCustomRuleRevisionRequest: + description: Request body for reverting a custom rule to a previous revision. properties: data: $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" @@ -51796,6 +52577,7 @@ components: $ref: "#/components/schemas/RevertCustomRuleRevisionDataType" type: object RevertCustomRuleRevisionRequestDataAttributes: + description: Attributes specifying the current and target revision IDs for a revert operation. properties: currentRevision: description: Current revision ID @@ -51842,6 +52624,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array user_count: @@ -51874,6 +52657,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array required: @@ -51910,6 +52694,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array required: @@ -52039,6 +52824,7 @@ components: Specify one of the following: "Datadog Admin Role", "Datadog Standard Role", or "Datadog Read Only Role". If empty or not specified, the role does not automatically inherit permissions from any managed role. items: + description: Name of a managed role to inherit permissions from. type: string type: array user_count: @@ -52795,6 +53581,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -53476,6 +54263,7 @@ components: dependsOn: description: The components that are dependencies of the ref component. items: + description: A package URL (purl) identifying a dependency of the component. example: pkg:golang/google.golang.org/grpc@1.68.1 type: string required: @@ -53707,15 +54495,18 @@ components: type: string type: object ScaRequest: + description: The top-level request object for submitting a Software Composition Analysis (SCA) scan result. properties: data: $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" id: + description: An optional identifier for this SCA request data object. type: string type: $ref: "#/components/schemas/ScaRequestDataType" @@ -53723,85 +54514,115 @@ components: - type type: object ScaRequestDataAttributes: + description: The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. properties: commit: $ref: "#/components/schemas/ScaRequestDataAttributesCommit" dependencies: + description: The list of dependencies discovered in the repository. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItems" type: array env: + description: The environment context in which the SCA scan was performed (e.g., production, staging). type: string files: + description: The list of dependency manifest files found in the repository. items: $ref: "#/components/schemas/ScaRequestDataAttributesFilesItems" type: array relations: + description: The dependency relations describing the inter-component dependency graph. items: $ref: "#/components/schemas/ScaRequestDataAttributesRelationsItems" type: array repository: $ref: "#/components/schemas/ScaRequestDataAttributesRepository" service: + description: The name of the service or application being analyzed. type: string tags: additionalProperties: type: string + description: A map of key-value tags providing additional metadata for the SCA scan. type: object vulnerabilities: + description: The list of vulnerabilities identified in the dependency graph. items: $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItems" type: array type: object ScaRequestDataAttributesCommit: + description: Metadata about the commit associated with the SCA scan, including author, committer, and branch information. properties: author_date: + description: The date when the commit was authored. type: string author_email: + description: The email address of the commit author. type: string author_name: + description: The full name of the commit author. type: string branch: + description: The branch name on which the commit was made. type: string committer_email: + description: The email address of the person who committed the change. type: string committer_name: + description: The full name of the person who committed the change. type: string sha: + description: The SHA hash uniquely identifying the commit. type: string type: object ScaRequestDataAttributesDependenciesItems: + description: A dependency found in the repository, including its identity, location, and reachability metadata. properties: exclusions: + description: A list of patterns or identifiers that should be excluded from analysis for this dependency. items: + description: An exclusion pattern or identifier. type: string type: array group: + description: The group or organization namespace of the dependency (e.g., Maven group ID). type: string is_dev: + description: Indicates whether this is a development-only dependency not used in production. type: boolean is_direct: + description: Indicates whether this is a direct dependency (as opposed to a transitive one). type: boolean language: + description: The programming language ecosystem of this dependency (e.g., java, python, javascript). type: string locations: + description: The list of source file locations where this dependency is declared. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItems" type: array name: + description: The name of the dependency package. type: string package_manager: + description: The package manager responsible for this dependency (e.g., maven, pip, npm). type: string purl: + description: The Package URL (PURL) uniquely identifying this dependency. type: string reachable_symbol_properties: + description: Properties describing symbols from this dependency that are reachable in the application code. items: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems" type: array version: + description: The version of the dependency. type: string type: object ScaRequestDataAttributesDependenciesItemsLocationsItems: + description: 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" @@ -53813,71 +54634,95 @@ components: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition" 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" file_name: + description: The name or path of the file containing this location. type: string start: $ref: "#/components/schemas/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition" type: object ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition: + description: A specific position (line and column) within a source file. properties: col: + description: The column number of the position within the line. format: int32 maximum: 2147483647 type: integer line: + description: The line number of the position within the file. format: int32 maximum: 2147483647 type: integer type: object ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems: + description: A key-value property describing a reachable symbol within a dependency. properties: name: + description: The name of the reachable symbol property. type: string value: + description: The value of the reachable symbol property. type: string type: object ScaRequestDataAttributesFilesItems: + description: A file entry in the repository associated with a dependency manifest. properties: name: + description: The name or path of the file within the repository. type: string purl: + description: The Package URL (PURL) associated with the dependency declared in this file. type: string type: object ScaRequestDataAttributesRelationsItems: + description: A dependency relation describing which other components a given component depends on. properties: depends_on: + description: The list of BOM references that this component directly depends on. items: + description: A BOM reference of a dependency. type: string type: array ref: + description: The BOM reference of the component that has dependencies. type: string type: object ScaRequestDataAttributesRepository: + description: Information about the source code repository being analyzed. properties: url: + description: The URL of the repository. type: string type: object ScaRequestDataAttributesVulnerabilitiesItems: + description: A vulnerability entry from the Software Bill of Materials (SBOM), describing a known security issue and the components it affects. properties: affects: + description: The list of components affected by this vulnerability. items: $ref: "#/components/schemas/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems" type: array bom_ref: + description: The unique BOM reference identifier for this vulnerability entry. type: string id: + description: The vulnerability identifier (e.g., CVE ID or similar). type: string type: object ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems: + description: A reference to a component affected by a vulnerability. properties: ref: + description: The BOM reference identifying the affected component. type: string type: object ScaRequestDataType: default: scarequests + description: The type identifier for SCA dependency analysis requests. enum: - scarequests example: scarequests @@ -54077,6 +54922,7 @@ components: example: - production items: + description: An origin identifier for the last successful scan of the asset. example: production type: string type: array @@ -54725,6 +55571,7 @@ components: x-enum-varnames: - SEAT_ASSIGNMENTS SeatUserData: + description: A seat user resource object containing its ID, type, and associated attributes. properties: attributes: $ref: "#/components/schemas/SeatUserDataAttributes" @@ -54738,6 +55585,7 @@ components: $ref: "#/components/schemas/SeatUserDataType" type: object SeatUserDataArray: + description: A paginated list of seat user resources with associated pagination metadata. properties: data: description: The list of seat users. @@ -54749,6 +55597,7 @@ components: description: The metadata of the seat users. type: object SeatUserDataAttributes: + description: Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. properties: assigned_at: description: The date and time the seat was assigned. @@ -54777,6 +55626,7 @@ components: x-enum-varnames: - SEAT_USERS SeatUserMeta: + description: Pagination metadata for the seat users list response. properties: cursor: description: The cursor for the seat users. @@ -54790,8 +55640,10 @@ components: type: string type: object SecretRuleArray: + description: A collection of secret detection rules returned by the list endpoint. properties: data: + description: The list of secret detection rules. items: $ref: "#/components/schemas/SecretRuleData" type: array @@ -54799,10 +55651,12 @@ components: - data type: object SecretRuleData: + description: The data object representing a secret detection rule, including its attributes and resource type. properties: attributes: $ref: "#/components/schemas/SecretRuleDataAttributes" id: + description: The unique identifier of the secret rule resource. type: string type: $ref: "#/components/schemas/SecretRuleDataType" @@ -54810,81 +55664,108 @@ components: - type type: object SecretRuleDataAttributes: + description: The attributes of a secret detection rule, including its pattern, priority, and validation configuration. properties: default_included_keywords: + description: A list of keywords that are included by default when scanning for secrets matching this rule. items: + description: A keyword used to narrow down secret detection to relevant contexts. type: string type: array description: + description: A detailed explanation of what type of secret this rule detects. type: string license: + description: The license under which this secret rule is distributed. type: string match_validation: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidation" name: + description: The unique name of the secret detection rule. type: string pattern: + description: The regular expression pattern used to identify potential secrets in source code or configuration. type: string priority: + description: The priority level of this rule, used to rank findings when multiple rules match. type: string sds_id: + description: The identifier of the corresponding Sensitive Data Scanner rule, if one exists. type: string validators: + description: A list of validator identifiers used to further confirm a detected secret is genuine. items: + description: A validator identifier applied to refine secret detection accuracy. type: string type: array type: object SecretRuleDataAttributesMatchValidation: + description: Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. properties: endpoint: + description: The URL endpoint to call when validating a detected secret. type: string hosts: + description: The list of hostnames to include when performing secret match validation. items: + description: A hostname used during match validation. type: string type: array http_method: + description: The HTTP method (e.g., GET, POST) to use when making the validation request. type: string invalid_http_status_code: + description: The HTTP status code ranges that indicate the detected secret is invalid or inactive. items: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems" type: array request_headers: additionalProperties: type: string + description: A map of HTTP header names to values to include in the validation request. type: object timeout_seconds: + description: The maximum number of seconds to wait for a response during validation before timing out. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: + description: The type of match validation to perform (e.g., http). type: string valid_http_status_code: + description: The HTTP status code ranges that indicate the detected secret is valid and active. items: $ref: "#/components/schemas/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems" type: array type: object SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems: + description: An HTTP status code range that indicates an invalid (unsuccessful) secret match during validation. properties: end: + description: The inclusive upper bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: + description: The inclusive lower bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer type: object SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems: + description: An HTTP status code range that indicates a valid (successful) secret match during validation. properties: end: + description: The inclusive upper bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 type: integer start: + description: The inclusive lower bound of the HTTP status code range. format: int64 maximum: 1.8446744073709551e+19 minimum: 0 @@ -54945,18 +55826,21 @@ components: description: Environment tags associated with the entity example: ["production", "us-east-1"] items: + description: An environment tag associated with the entity. type: string type: array mitreTactics: description: MITRE ATT&CK tactics detected example: ["Credential Access", "Privilege Escalation"] items: + description: Detected MITRE ATT&CK tactic type: string type: array mitreTechniques: description: MITRE ATT&CK techniques detected example: ["T1078", "T1098"] items: + description: Detected MITRE ATT&CK technique type: string type: array projectID: @@ -54967,12 +55851,14 @@ components: description: Services associated with the entity example: ["api-gateway", "lambda"] items: + description: A service name associated with the entity. type: string type: array sources: description: Data sources that detected this entity example: ["cloudtrail", "cloud-security-posture-management"] items: + description: A data source identifier. type: string type: array subscriptionID: @@ -55021,12 +55907,14 @@ components: description: Cloud providers associated with the entity example: ["aws"] items: + description: A cloud provider name. type: string type: array entityRoles: description: Roles associated with the entity example: ["Admin", "Developer"] items: + description: A role assigned to the entity. type: string type: array entityType: @@ -55134,6 +56022,7 @@ components: description: Response containing a list of entity risk scores properties: data: + description: Array of entity risk score objects. items: $ref: "#/components/schemas/SecurityEntityRiskScore" type: array @@ -55378,6 +56267,7 @@ components: - "team:platform" - "env:prod" items: + description: A tag associated with the security finding. type: string type: array timestamp: @@ -55689,6 +56579,7 @@ components: - team:database - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array update_author_id: @@ -55733,6 +56624,7 @@ components: - team:database - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array required: @@ -55821,6 +56713,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array version: @@ -56000,6 +56893,7 @@ components: - def-000-u7q - def-000-7dd items: + description: A rule ID to include in the bulk export. type: string minItems: 1 type: array @@ -56571,6 +57465,7 @@ components: results: description: "Assert results are returned in the same order as the rule query payloads.\nFor each payload, it returns True if the result matched the expected result,\nFalse otherwise." items: + description: Whether the rule query result matched the expected result. type: boolean type: array type: object @@ -57884,6 +58779,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array update_date: @@ -57942,6 +58838,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array required: @@ -58059,6 +58956,7 @@ components: - technique:T1110-brute-force - source:cloudtrail items: + description: A tag string in `key:value` format. type: string type: array version: @@ -58606,6 +59504,7 @@ components: The number of keywords in the list must be less than or equal to 30. example: ["email", "address", "login"] items: + description: A keyword to match within the defined proximity of the detected pattern. type: string type: array use_recommended_keywords: @@ -58707,6 +59606,7 @@ components: description: Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array. example: ["admin.name"] items: + description: An attribute path to exclude from the scan. type: string type: array included_keyword_configuration: @@ -58723,6 +59623,7 @@ components: If both are missing the whole event is scanned. example: ["admin"] items: + description: An attribute path to include in the scan. type: string type: array pattern: @@ -58739,6 +59640,7 @@ components: tags: description: List of tags. items: + description: A tag associated with the rule. type: string type: array text_replacement: @@ -58896,6 +59798,7 @@ components: included_keywords: description: List of included keywords. items: + description: A keyword used to increase match precision for the standard pattern. type: string type: array name: @@ -58914,6 +59817,7 @@ components: tags: description: List of tags. items: + description: A tag associated with the standard pattern. type: string type: array type: object @@ -58963,18 +59867,21 @@ components: description: List of strings to use for suppression of matches ending with these strings. example: ["@example.com", "another.example.com"] items: + description: A string suffix; matches ending with this value are suppressed. type: string type: array exact_match: description: List of strings to use for suppression of matches exactly matching these strings. example: ["admin@example.com", "user@example.com"] items: + description: A string value; matches exactly equal to this value are suppressed. type: string type: array starts_with: description: List of strings to use for suppression of matches starting with these strings. example: ["admin", "user"] items: + description: A string prefix; matches starting with this value are suppressed. type: string type: array type: object @@ -59191,6 +60098,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array required: @@ -59347,6 +60255,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -59424,6 +60333,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -59610,6 +60520,7 @@ components: description: A set of CI fingerprints. example: ["j88xdEy0J5lc", "eZ7LMljCk8vo"] items: + description: A CI pipeline fingerprint string. type: string type: array contacts: @@ -59636,6 +60547,7 @@ components: 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++"] items: + description: A programming language identifier. type: string type: array lifecycle: @@ -59653,6 +60565,7 @@ components: description: A set of custom tags. example: ["my:tag", "service:tag"] items: + description: A custom tag string in `key:value` format. type: string type: array team: @@ -59949,15 +60862,18 @@ components: type: array type: object ServiceList: + description: The response body for the service list endpoint. properties: data: $ref: "#/components/schemas/ServiceListData" type: object ServiceListData: + description: A single data item in the service list response. properties: attributes: $ref: "#/components/schemas/ServiceListDataAttributes" id: + description: The unique identifier of the service. type: string type: $ref: "#/components/schemas/ServiceListDataType" @@ -59965,21 +60881,28 @@ components: - type type: object ServiceListDataAttributes: + description: Attributes of a service list entry, containing metadata and a list of service names. properties: metadata: + description: A list of metadata items associated with the service. items: $ref: "#/components/schemas/ServiceListDataAttributesMetadataItems" type: array services: + description: A list of service names. items: + description: A single service name. type: string type: array type: object ServiceListDataAttributesMetadataItems: + description: An object containing metadata flags for a service, indicating whether it is traced by APM or monitored through Universal Service Monitoring. properties: isTraced: + description: Indicates whether the service is traced by APM. type: boolean isUsm: + description: Indicates whether the service uses Universal Service Monitoring. type: boolean type: object ServiceListDataType: @@ -60585,8 +61508,10 @@ components: - data type: object SessionIdArray: + description: A collection of session identifiers used for bulk add or remove operations on a playlist. properties: data: + description: Array of session identifier data objects. items: $ref: "#/components/schemas/SessionIdData" type: array @@ -60594,8 +61519,10 @@ components: - data type: object SessionIdData: + description: A session identifier data object used for bulk playlist operations. properties: id: + description: Unique identifier of the RUM replay session. example: 00000000-0000-0000-0000-000000000001 type: string type: @@ -60791,6 +61718,7 @@ components: additionalProperties: description: The values for each group by. items: + description: A group-by value. type: string type: array description: The key, value pairs for each group by. @@ -61090,13 +62018,16 @@ components: x-enum-varnames: - SLO_STATUS Snapshot: + description: A single heatmap snapshot resource returned by create or update operations. properties: data: $ref: "#/components/schemas/SnapshotData" type: object SnapshotArray: + description: A list of heatmap snapshots returned by a list operation. properties: data: + description: Array of heatmap snapshot data objects. items: $ref: "#/components/schemas/SnapshotData" type: array @@ -61104,6 +62035,7 @@ components: - data type: object SnapshotCreateRequest: + description: Request body for creating a heatmap snapshot. properties: data: $ref: "#/components/schemas/SnapshotCreateRequestData" @@ -61111,6 +62043,7 @@ components: - data type: object SnapshotCreateRequestData: + description: Data object for a heatmap snapshot creation request, containing the resource type and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotCreateRequestDataAttributes" @@ -61120,31 +62053,41 @@ components: - type type: object SnapshotCreateRequestDataAttributes: + description: Attributes for creating a heatmap snapshot, including the view, session, event, and device context. properties: application_id: + description: Unique identifier of the RUM application. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string device_type: + description: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). example: desktop type: string event_id: + description: Unique identifier of the RUM event associated with the snapshot. example: 11111111-2222-3333-4444-555555555555 type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. example: false type: boolean session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string snapshot_name: + description: Human-readable name for the snapshot. example: My Snapshot type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. example: 0 format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string view_name: + description: URL path or name of the view where the snapshot was captured. example: /home type: string required: @@ -61157,10 +62100,12 @@ components: - is_device_type_selected_by_user type: object SnapshotData: + description: Data object representing a heatmap snapshot, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotDataAttributes" id: + description: Unique identifier of the heatmap snapshot. readOnly: true type: string type: @@ -61169,50 +62114,67 @@ components: - type type: object SnapshotDataAttributes: + description: Attributes of a heatmap snapshot, including view context, device information, and audit metadata. properties: application_id: + description: Unique identifier of the RUM application. type: string created_at: + description: Timestamp when the snapshot was created. format: date-time readOnly: true type: string created_by: + description: Display name of the user who created the snapshot. readOnly: true type: string created_by_handle: + description: Email handle of the user who created the snapshot. readOnly: true type: string created_by_user_id: + description: Numeric identifier of the user who created the snapshot. format: int64 readOnly: true type: integer device_type: + description: Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). type: string event_id: + description: Unique identifier of the RUM event associated with the snapshot. type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. type: boolean modified_at: + description: Timestamp when the snapshot was last modified. format: date-time readOnly: true type: string org_id: + description: Numeric identifier of the organization that owns the snapshot. format: int64 readOnly: true type: integer session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string snapshot_name: + description: Human-readable name for the snapshot. type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string view_name: + description: URL path or name of the view where the snapshot was captured. type: string type: object SnapshotUpdateRequest: + description: Request body for updating a heatmap snapshot. properties: data: $ref: "#/components/schemas/SnapshotUpdateRequestData" @@ -61220,10 +62182,12 @@ components: - data type: object SnapshotUpdateRequestData: + description: Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/SnapshotUpdateRequestDataAttributes" id: + description: Unique identifier of the heatmap snapshot to update. example: 00000000-0000-0000-0000-000000000001 type: string type: @@ -61232,20 +62196,26 @@ components: - type type: object SnapshotUpdateRequestDataAttributes: + description: Attributes for updating a heatmap snapshot, including event, session, and view context. properties: event_id: + description: Unique identifier of the RUM event associated with the snapshot. example: 11111111-2222-3333-4444-555555555555 type: string is_device_type_selected_by_user: + description: Indicates whether the device type was explicitly selected by the user rather than auto-detected. example: false type: boolean session_id: + description: Unique identifier of the RUM session associated with the snapshot. type: string start: + description: Offset in milliseconds from the start of the session at which the snapshot was captured. example: 0 format: int64 type: integer view_id: + description: Unique identifier of the RUM view associated with the snapshot. type: string required: - event_id @@ -62309,6 +63279,7 @@ components: - type type: object StatusPage: + description: Response object for a single status page. properties: data: $ref: "#/components/schemas/StatusPageData" @@ -62319,8 +63290,10 @@ components: type: array type: object StatusPageArray: + description: Response object for a list of status pages. properties: data: + description: A list of status page data objects. items: $ref: "#/components/schemas/StatusPageData" type: array @@ -62335,6 +63308,7 @@ components: - data type: object StatusPageArrayIncluded: + description: An included resource related to a status page. oneOf: - $ref: "#/components/schemas/StatusPagesUser" StatusPageAsIncluded: @@ -62405,8 +63379,10 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageAsIncludedAttributesComponentsItems: + description: A component displayed on an included status page. properties: components: + description: If the component is of type `group`, the components within the group. items: $ref: "#/components/schemas/StatusPageAsIncludedAttributesComponentsItemsComponentsItems" type: array @@ -62428,6 +63404,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageAsIncludedAttributesComponentsItemsComponentsItems: + description: A grouped component within a status page component group. properties: id: description: The ID of the grouped component. @@ -62457,6 +63434,7 @@ components: description: The Datadog user who last modified the status page. type: object StatusPageAsIncludedRelationshipsCreatedByUser: + description: The Datadog user who created the status page. properties: data: $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsCreatedByUserData" @@ -62464,6 +63442,7 @@ components: - data type: object StatusPageAsIncludedRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the status page. properties: id: description: The ID of the Datadog user who created the status page. @@ -62476,6 +63455,7 @@ components: - id type: object StatusPageAsIncludedRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the status page. properties: data: $ref: "#/components/schemas/StatusPageAsIncludedRelationshipsLastModifiedByUserData" @@ -62483,6 +63463,7 @@ components: - data type: object StatusPageAsIncludedRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the status page. properties: id: description: The ID of the Datadog user who last modified the status page. @@ -62495,6 +63476,7 @@ components: - id type: object StatusPageData: + description: The data object for a status page. properties: attributes: $ref: "#/components/schemas/StatusPageDataAttributes" @@ -62565,6 +63547,7 @@ components: $ref: "#/components/schemas/CreateStatusPageRequestDataAttributesVisualizationType" type: object StatusPageDataAttributesComponentsItems: + description: A component displayed on a status page. properties: components: description: If the component is of type `group`, the components within the group. @@ -62588,6 +63571,7 @@ components: $ref: "#/components/schemas/CreateComponentRequestDataAttributesType" type: object StatusPageDataAttributesComponentsItemsComponentsItems: + description: A grouped component within a status page component group. properties: id: description: The ID of the component. @@ -62616,6 +63600,7 @@ components: description: The Datadog user who last modified the status page. type: object StatusPageDataRelationshipsCreatedByUser: + description: The Datadog user who created the status page. properties: data: $ref: "#/components/schemas/StatusPageDataRelationshipsCreatedByUserData" @@ -62623,6 +63608,7 @@ components: - data type: object StatusPageDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the status page. properties: id: description: The ID of the Datadog user who created the status page. @@ -62635,6 +63621,7 @@ components: - id type: object StatusPageDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the status page. properties: data: $ref: "#/components/schemas/StatusPageDataRelationshipsLastModifiedByUserData" @@ -62642,6 +63629,7 @@ components: - data type: object StatusPageDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the status page. properties: id: description: The ID of the Datadog user who last modified the status page. @@ -62663,6 +63651,7 @@ components: x-enum-varnames: - STATUS_PAGES StatusPagesComponent: + description: Response object for a single component. properties: data: $ref: "#/components/schemas/StatusPagesComponentData" @@ -62673,8 +63662,10 @@ components: type: array type: object StatusPagesComponentArray: + description: Response object for a list of components. properties: data: + description: A list of component data objects. items: $ref: "#/components/schemas/StatusPagesComponentData" type: array @@ -62687,11 +63678,13 @@ components: - data type: object StatusPagesComponentArrayIncluded: + description: An included resource related to a component. oneOf: - $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" @@ -62737,14 +63730,18 @@ components: - type type: object StatusPagesComponentDataAttributesComponentsItems: + description: A component within a component group. properties: id: + description: The ID of the component within the group. format: uuid readOnly: true type: string name: + description: The name of the component within the group. type: string position: + description: The zero-indexed position of the component within the group. format: int64 type: integer status: @@ -62785,6 +63782,7 @@ components: description: The status page the component belongs to. type: object StatusPagesComponentDataRelationshipsCreatedByUser: + description: The Datadog user who created the component. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsCreatedByUserData" @@ -62792,6 +63790,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the component. properties: id: description: The ID of the Datadog user who created the component. @@ -62804,6 +63803,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsGroup: + description: The group the component belongs to. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsGroupData" @@ -62811,6 +63811,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsGroupData: + description: The data object identifying the group the component belongs to. nullable: true properties: id: @@ -62825,6 +63826,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsLastModifiedByUser: + description: The Datadog user who last modified the component. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsLastModifiedByUserData" @@ -62832,6 +63834,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the component. properties: id: description: The ID of the Datadog user who last modified the component. @@ -62844,6 +63847,7 @@ components: - id type: object StatusPagesComponentDataRelationshipsStatusPage: + description: The status page the component belongs to. properties: data: $ref: "#/components/schemas/StatusPagesComponentDataRelationshipsStatusPageData" @@ -62851,6 +63855,7 @@ components: - data type: object StatusPagesComponentDataRelationshipsStatusPageData: + description: The data object identifying the status page the component belongs to. properties: id: description: The ID of the status page the component belongs to. @@ -62910,6 +63915,7 @@ components: - type type: object StatusPagesComponentGroupAttributesComponentsItems: + description: A component within a component group. properties: id: description: The ID of the grouped component. @@ -62973,6 +63979,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsCreatedByUserData: + description: The data object identifying the Datadog user who created the component group. properties: id: description: The ID of the Datadog user who created the component group. @@ -62993,9 +64000,11 @@ components: - data type: object StatusPagesComponentGroupRelationshipsGroupData: + description: The data object identifying the parent group of a component group. nullable: true properties: id: + description: The ID of the parent group. example: "1234abcd-12ab-34cd-56ef-123456abcdef" format: uuid type: string @@ -63014,6 +64023,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsLastModifiedByUserData: + description: The data object identifying the Datadog user who last modified the component group. properties: id: description: The ID of the Datadog user who last modified the component group. @@ -63034,6 +64044,7 @@ components: - data type: object StatusPagesComponentGroupRelationshipsStatusPageData: + description: The data object identifying the status page the component group belongs to. properties: id: description: The ID of the status page. @@ -63155,6 +64166,7 @@ components: type: number type: object SuiteCreateEdit: + description: Data object for creating or editing a Synthetic test suite. properties: attributes: $ref: "#/components/schemas/SyntheticsSuite" @@ -63165,6 +64177,7 @@ components: - type type: object SuiteCreateEditRequest: + description: Request body for creating or editing a Synthetic test suite. properties: data: $ref: "#/components/schemas/SuiteCreateEdit" @@ -63173,6 +64186,7 @@ components: type: object SuiteSearchResponseType: default: suites_search + description: Type for the Synthetics suites search response, `suites_search`. enum: - suites_search example: suites_search @@ -63206,23 +64220,27 @@ components: $ref: "#/components/schemas/SecurityMonitoringSuppressionAttributes" type: object SyncProperty: - description: Sync property configuration + description: Sync property configuration. properties: sync_type: + description: The direction and type of synchronization for this property. type: string type: object SyncPropertyWithMapping: - description: Sync property with mapping configuration + description: Sync property with mapping configuration. properties: mapping: additionalProperties: type: string + description: Map of source values to destination values for synchronization. type: object name_mapping: additionalProperties: type: string + description: Map of source names to display names used during synchronization. type: object sync_type: + description: The direction and type of synchronization for this property. type: string type: object SyntheticsGlobalVariable: @@ -63582,6 +64600,7 @@ components: $ref: "#/components/schemas/SyntheticsNetworkTestRequest" type: object SyntheticsNetworkTestEdit: + description: Data object for creating or editing a Network Path test. properties: attributes: $ref: "#/components/schemas/SyntheticsNetworkTest" @@ -63749,6 +64768,7 @@ components: type: string type: array tests: + description: Array of Synthetic tests included in the suite. items: $ref: "#/components/schemas/SyntheticsSuiteTest" type: array @@ -63801,6 +64821,7 @@ components: attributes: $ref: "#/components/schemas/SyntheticsSuiteSearchResponseDataAttributes" id: + description: The unique identifier of the suite search response data. format: uuid type: string type: @@ -63810,10 +64831,12 @@ components: description: Synthetics suite search response data attributes properties: suites: + description: List of Synthetic suites matching the search query. items: $ref: "#/components/schemas/SyntheticsSuite" type: array total: + description: Total number of Synthetic suites matching the search query. format: int32 maximum: 2147483647 type: integer @@ -63824,6 +64847,7 @@ components: alerting_criticality: $ref: "#/components/schemas/SyntheticsSuiteTestAlertingCriticality" public_id: + description: The public ID of the Synthetic test included in the suite. example: "" type: string required: @@ -64180,6 +65204,7 @@ components: - "tag_1" - "tag_2" items: + description: A tag associated with the reference table. type: string type: array updated_at: @@ -64330,6 +65355,7 @@ components: example: - "field_1" items: + description: A field name used as a primary key. type: string type: array required: @@ -64404,6 +65430,7 @@ components: description: Row resource containing a single row identifier. properties: id: + description: The primary key value that uniquely identifies the row to delete. example: "primary_key_value" type: string type: @@ -66024,6 +67051,7 @@ components: type: string type: object TenancyConfig: + description: Response containing a single OCI tenancy integration configuration. example: data: attributes: @@ -66061,10 +67089,12 @@ components: $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" id: + description: The OCID of the OCI tenancy. type: string type: $ref: "#/components/schemas/UpdateTenancyConfigDataType" @@ -66072,79 +67102,110 @@ components: - type type: object TenancyConfigDataAttributes: + description: Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. properties: billing_plan_id: + description: The identifier of the billing plan associated with the OCI tenancy. format: int32 maximum: 2147483647 type: integer config_version: + description: Version number of the integration the tenancy is integrated with format: int64 type: integer cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean dd_compartment_id: + description: The OCID of the OCI compartment used by the Datadog integration stack. type: string dd_stack_id: + description: The OCID of the OCI Resource Manager stack used by the Datadog integration. type: string home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). type: string logs_config: $ref: "#/components/schemas/TenancyConfigDataAttributesLogsConfig" metrics_config: $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" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean tenancy_name: + description: The human-readable name of the OCI tenancy. type: string user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. type: string type: object TenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters scoping log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object TenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters scoping metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names excluded from metrics collection. items: + description: An OCI service name excluded from metrics collection (for example, compute). type: string type: array type: object TenancyConfigDataAttributesRegionsConfig: + description: Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object TenancyConfigList: + description: Response containing a list of OCI tenancy integration configurations. example: data: - attributes: @@ -66179,6 +67240,7 @@ components: type: oci_tenancy properties: data: + description: List of OCI tenancy integration configuration objects. items: $ref: "#/components/schemas/TenancyConfigData" type: array @@ -66186,10 +67248,12 @@ components: - data type: object TenancyProductsData: + description: A single OCI tenancy product resource object containing the tenancy ID, type, and product attributes. properties: attributes: $ref: "#/components/schemas/TenancyProductsDataAttributes" id: + description: The OCID of the OCI tenancy. type: string type: $ref: "#/components/schemas/TenancyProductsDataType" @@ -66197,17 +67261,22 @@ components: - type type: object TenancyProductsDataAttributes: + description: Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. properties: products: + description: List of Datadog products and their enablement status for the tenancy. items: $ref: "#/components/schemas/TenancyProductsDataAttributesProductsItems" type: array type: object TenancyProductsDataAttributesProductsItems: + description: An individual Datadog product with its enablement status for a tenancy. properties: enabled: + description: Indicates whether the product is enabled for the tenancy. type: boolean product_key: + description: The unique key identifying the Datadog product (for example, CLOUD_SECURITY_POSTURE_MANAGEMENT). type: string type: object TenancyProductsDataType: @@ -66220,6 +67289,7 @@ components: x-enum-varnames: - OCI_TENANCY_PRODUCT TenancyProductsList: + description: Response containing a list of OCI tenancy product resources with their product enablement status. example: data: - attributes: @@ -66230,6 +67300,7 @@ components: type: oci_tenancy_product properties: data: + description: List of OCI tenancy product resource objects. items: $ref: "#/components/schemas/TenancyProductsData" type: array @@ -66624,7 +67695,7 @@ components: $ref: "#/components/schemas/TimeseriesResponseValuesList" type: object TimeseriesResponseSeries: - description: "" + 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" @@ -66797,6 +67868,7 @@ components: error_messages: description: The `items` `error_messages`. items: + description: An error message string. type: string nullable: true type: array @@ -66842,12 +67914,14 @@ components: x-enum-varnames: - AZURE_UC_CONFIGS UnassignSeatsUserRequest: + description: The request body for unassigning seats from users for a product code. properties: data: $ref: "#/components/schemas/UnassignSeatsUserRequestData" description: The data for the unassign seats user request. type: object UnassignSeatsUserRequestData: + description: The request data object containing attributes for unassigning seats from users. properties: attributes: $ref: "#/components/schemas/UnassignSeatsUserRequestDataAttributes" @@ -66863,6 +67937,7 @@ components: - attributes type: object UnassignSeatsUserRequestDataAttributes: + description: Attributes specifying the product and users from whom seats will be unassigned. properties: product_code: description: The product code for which to unassign seats. @@ -66873,6 +67948,7 @@ components: example: - "" items: + description: A user UUID identifying a user to unassign seats from. type: string type: array required: @@ -67167,6 +68243,7 @@ components: type: string type: object UpdateConnectionRequest: + description: Request body for updating an existing data source connection by adding, modifying, or removing fields. example: data: attributes: @@ -67194,10 +68271,12 @@ components: $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" id: + description: The unique identifier of the connection to update. example: "" type: string type: @@ -67207,33 +68286,45 @@ components: - id type: object UpdateConnectionRequestDataAttributes: + description: Attributes specifying the field modifications to apply to an existing connection. properties: fields_to_add: + description: New fields to add to the connection from the data source. items: $ref: "#/components/schemas/CreateConnectionRequestDataAttributesFieldsItems" type: array fields_to_delete: + description: Identifiers of existing fields to remove from the connection. items: + description: The identifier of a field to delete from the connection. type: string type: array fields_to_update: + description: Existing fields with updated metadata to apply to the connection. items: $ref: "#/components/schemas/UpdateConnectionRequestDataAttributesFieldsToUpdateItems" type: array type: object UpdateConnectionRequestDataAttributesFieldsToUpdateItems: + description: Specification for updating an existing field in a connection, including which field to modify and the new values. properties: field_id: + description: The identifier of the existing field to update. example: "" type: string updated_description: + description: The new description to set for the field. type: string updated_display_name: + description: The new human-readable display name to set for the field. type: string updated_field_id: + description: The new identifier to assign to the field, if renaming it. type: string updated_groups: + description: The updated list of group labels to associate with the field. items: + description: A group label name for categorizing the field. type: string type: array required: @@ -67926,6 +69017,7 @@ components: example: - "" items: + description: A source key for the reference table lookup. type: string type: array table_name: @@ -67962,10 +69054,12 @@ components: x-enum-varnames: - UPDATE_RULESET UpdateTenancyConfigData: + 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" id: + description: The OCID of the OCI tenancy to update. example: "" type: string type: @@ -67975,12 +69069,15 @@ components: - id type: object UpdateTenancyConfigDataAttributes: + 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" cost_collection_enabled: + description: Whether cost data collection from OCI is enabled for the tenancy. type: boolean home_region: + description: The home region of the OCI tenancy (for example, us-ashburn-1). type: string logs_config: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesLogsConfig" @@ -67989,58 +69086,82 @@ components: regions_config: $ref: "#/components/schemas/UpdateTenancyConfigDataAttributesRegionsConfig" resource_collection_enabled: + description: Whether resource collection from OCI is enabled for the tenancy. type: boolean user_ocid: + description: The OCID of the OCI user used by the Datadog integration for authentication. type: string type: object UpdateTenancyConfigDataAttributesAuthCredentials: + description: OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. properties: fingerprint: + description: The fingerprint of the OCI API signing key used for authentication. type: string private_key: + description: The PEM-encoded private key corresponding to the OCI API signing key fingerprint. example: "" type: string required: - private_key type: object UpdateTenancyConfigDataAttributesLogsConfig: + description: Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. properties: compartment_tag_filters: + description: List of compartment tag filters to scope log collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether log collection is enabled for the tenancy. type: boolean enabled_services: + description: List of OCI service names for which log collection is enabled. items: + description: An OCI service name for which log collection is enabled (for example, compute). type: string type: array type: object UpdateTenancyConfigDataAttributesMetricsConfig: + description: Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. properties: compartment_tag_filters: + description: List of compartment tag filters to scope metrics collection to specific compartments. items: + description: A compartment tag filter in key:value format (for example, datadog:true). type: string type: array enabled: + description: Whether metrics collection is enabled for the tenancy. type: boolean excluded_services: + description: List of OCI service names to exclude from metrics collection. items: + description: An OCI service name to exclude from metrics collection (for example, compute). type: string type: array type: object UpdateTenancyConfigDataAttributesRegionsConfig: + description: Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. properties: available: + description: List of OCI regions available for data collection in the tenancy. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array disabled: + description: List of OCI regions explicitly disabled for data collection. items: + description: An OCI region identifier (for example, us-phoenix-1). type: string type: array enabled: + description: List of OCI regions enabled for data collection. items: + description: An OCI region identifier (for example, us-ashburn-1). type: string type: array type: object @@ -68054,6 +69175,7 @@ components: x-enum-varnames: - OCI_TENANCY UpdateTenancyConfigRequest: + description: Request body for updating an existing OCI tenancy integration configuration. example: data: attributes: @@ -69113,8 +70235,10 @@ components: - UPDATE - DELETE ViewershipHistorySessionArray: + description: A list of RUM replay sessions from a user's viewership history. properties: data: + description: Array of viewership history session data objects. items: $ref: "#/components/schemas/ViewershipHistorySessionData" type: array @@ -69122,10 +70246,12 @@ components: - data type: object ViewershipHistorySessionData: + description: Data object representing a session in the viewership history, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/ViewershipHistorySessionDataAttributes" id: + description: Unique identifier of the RUM replay session. type: string type: $ref: "#/components/schemas/ViewershipHistorySessionDataType" @@ -69133,17 +70259,22 @@ components: - type type: object ViewershipHistorySessionDataAttributes: + description: Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. properties: event_id: + description: Unique identifier of the RUM event associated with the watched session. type: string last_watched_at: + description: Timestamp when the session was last watched by the user. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string session_event: additionalProperties: {} + description: Raw event data associated with the replay session. type: object track: + description: Replay track identifier indicating which recording track the session belongs to. type: string required: - last_watched_at @@ -69287,6 +70418,7 @@ components: example: - CVE-2023-0615 items: + description: A CVE identifier associated with the vulnerability. example: CVE-2023-0615 type: string type: array @@ -69328,6 +70460,7 @@ components: example: - agentless-scanner items: + description: The detection origin of the vulnerability (for example, the scanner type). example: agentless-scanner type: string type: array @@ -69339,6 +70472,7 @@ components: repo_digests: description: Vulnerability `repo_digest` list (when the vulnerability is related to `Image` asset). items: + description: A container image repository digest identifying the affected image. example: sha256:0ae7da091191787229d321e3638e39c319a97d6e20f927d465b519d699215bf7 type: string type: array @@ -69478,6 +70612,7 @@ components: example: - NIST items: + description: An exploit source reporting this vulnerability. example: NIST type: string type: array @@ -69634,6 +70769,7 @@ components: - X_PATH_INJECTION - XSS Watch: + description: A single RUM replay session watch resource returned by create operations. properties: data: $ref: "#/components/schemas/WatchData" @@ -69641,10 +70777,12 @@ components: - data type: object WatchData: + description: Data object representing a session watch record, including its identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/WatchDataAttributes" id: + description: Unique identifier of the watch record. type: string type: $ref: "#/components/schemas/WatchDataType" @@ -69652,16 +70790,21 @@ components: - type type: object WatchDataAttributes: + description: Attributes for recording a session watch event, including the application, event reference, and timestamp. properties: application_id: + description: Unique identifier of the RUM application containing the session. example: aaaaaaaa-1111-2222-3333-bbbbbbbbbbbb type: string data_source: + description: Data source type indicating the origin of the session data (e.g., rum or product_analytics). type: string event_id: + description: Unique identifier of the RUM event that was watched. example: 11111111-2222-3333-4444-555555555555 type: string timestamp: + description: Timestamp when the session was watched. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string @@ -69680,8 +70823,10 @@ components: x-enum-varnames: - RUM_REPLAY_WATCH WatcherArray: + description: A list of users who have watched a RUM replay session. properties: data: + description: Array of watcher data objects. items: $ref: "#/components/schemas/WatcherData" type: array @@ -69689,10 +70834,12 @@ components: - data type: object WatcherData: + description: Data object representing a session watcher, including their identifier, type, and attributes. properties: attributes: $ref: "#/components/schemas/WatcherDataAttributes" id: + description: Unique identifier of the watcher user. type: string type: $ref: "#/components/schemas/WatcherDataType" @@ -69700,19 +70847,25 @@ components: - type type: object WatcherDataAttributes: + description: Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. properties: handle: + description: Email handle of the user who watched the session. example: john.doe@example.com type: string icon: + description: URL or identifier of the watcher's avatar icon. type: string last_watched_at: + description: Timestamp when the watcher last viewed the session. example: "2026-01-13T17:15:53.208340Z" format: date-time type: string name: + description: Display name of the user who watched the session. type: string watch_count: + description: Total number of times the user has watched the session. example: 0 format: int32 maximum: 2147483647 @@ -69826,6 +70979,7 @@ components: tags: description: Tags of the workflow. items: + description: A tag string in `key:value` format. type: string type: array updatedAt: @@ -69896,6 +71050,7 @@ components: tags: description: Tags of the workflow. items: + description: A tag string in `key:value` format. type: string type: array updatedAt: @@ -70065,6 +71220,7 @@ components: example: - "AWS/AppSync" items: + description: An AWS X-Ray service name to include in traces collection. example: "AWS/AppSync" type: string type: array @@ -74329,7 +75485,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ProjectCreateRequest" - description: Project payload + description: Project payload. required: true responses: "201": @@ -74425,7 +75581,7 @@ paths: application/json: schema: $ref: "#/components/schemas/ProjectUpdateRequest" - description: Project payload + description: Project payload. required: true responses: "200": diff --git a/services/apm/src/v2/models/ServiceList.ts b/services/apm/src/v2/models/ServiceList.ts index daa8966ee803..7c93cab98c03 100644 --- a/services/apm/src/v2/models/ServiceList.ts +++ b/services/apm/src/v2/models/ServiceList.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ServiceListData } from "./ServiceListData"; +/** + * The response body for the service list endpoint. + */ export class ServiceList { + /** + * A single data item in the service list response. + */ "data"?: ServiceListData; /** * A container for additional, undeclared properties. diff --git a/services/apm/src/v2/models/ServiceListData.ts b/services/apm/src/v2/models/ServiceListData.ts index 62440f468ab6..7f06637e06ec 100644 --- a/services/apm/src/v2/models/ServiceListData.ts +++ b/services/apm/src/v2/models/ServiceListData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ServiceListDataAttributes } from "./ServiceListDataAttributes"; import { ServiceListDataType } from "./ServiceListDataType"; +/** + * A single data item in the service list response. + */ export class ServiceListData { + /** + * Attributes of a service list entry, containing metadata and a list of service names. + */ "attributes"?: ServiceListDataAttributes; + /** + * The unique identifier of the service. + */ "id"?: string; /** * Services list resource type. diff --git a/services/apm/src/v2/models/ServiceListDataAttributes.ts b/services/apm/src/v2/models/ServiceListDataAttributes.ts index 5c181cabe874..1d15097d258e 100644 --- a/services/apm/src/v2/models/ServiceListDataAttributes.ts +++ b/services/apm/src/v2/models/ServiceListDataAttributes.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ServiceListDataAttributesMetadataItems } from "./ServiceListDataAttributesMetadataItems"; +/** + * Attributes of a service list entry, containing metadata and a list of service names. + */ export class ServiceListDataAttributes { + /** + * A list of metadata items associated with the service. + */ "metadata"?: Array; + /** + * A list of service names. + */ "services"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/apm/src/v2/models/ServiceListDataAttributesMetadataItems.ts b/services/apm/src/v2/models/ServiceListDataAttributesMetadataItems.ts index 14d9bdef73f6..48a6cbf12ba9 100644 --- a/services/apm/src/v2/models/ServiceListDataAttributesMetadataItems.ts +++ b/services/apm/src/v2/models/ServiceListDataAttributesMetadataItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * An object containing metadata flags for a service, indicating whether it is traced by APM or monitored through Universal Service Monitoring. + */ export class ServiceListDataAttributesMetadataItems { + /** + * Indicates whether the service is traced by APM. + */ "isTraced"?: boolean; + /** + * Indicates whether the service uses Universal Service Monitoring. + */ "isUsm"?: boolean; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/CaseManagementApi.ts b/services/case_management/src/v2/CaseManagementApi.ts index 9a57c3cf3351..ec01c27680b2 100644 --- a/services/case_management/src/v2/CaseManagementApi.ts +++ b/services/case_management/src/v2/CaseManagementApi.ts @@ -4030,7 +4030,7 @@ export interface CaseManagementApiCreateCaseServiceNowTicketRequest { export interface CaseManagementApiCreateProjectRequest { /** - * Project payload + * Project payload. * @type ProjectCreateRequest */ body: ProjectCreateRequest; @@ -4077,7 +4077,7 @@ export interface CaseManagementApiDeleteCaseCustomAttributeRequest { export interface CaseManagementApiDeleteProjectRequest { /** - * Project UUID + * Project UUID. * @type string */ projectId: string; @@ -4106,7 +4106,7 @@ export interface CaseManagementApiGetCaseRequest { export interface CaseManagementApiGetProjectRequest { /** - * Project UUID + * Project UUID. * @type string */ projectId: string; @@ -4293,12 +4293,12 @@ export interface CaseManagementApiUpdatePriorityRequest { export interface CaseManagementApiUpdateProjectRequest { /** - * Project UUID + * Project UUID. * @type string */ projectId: string; /** - * Project payload + * Project payload. * @type ProjectUpdateRequest */ body: ProjectUpdateRequest; diff --git a/services/case_management/src/v2/models/AnyValueItem.ts b/services/case_management/src/v2/models/AnyValueItem.ts index bb1a0443dbe2..1e6bacc9b12f 100644 --- a/services/case_management/src/v2/models/AnyValueItem.ts +++ b/services/case_management/src/v2/models/AnyValueItem.ts @@ -1,5 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; +/** + * A single item in an array of arbitrary values, which can be a string, number, object, or boolean. + */ export type AnyValueItem = | string | number diff --git a/services/case_management/src/v2/models/AutoCloseInactiveCases.ts b/services/case_management/src/v2/models/AutoCloseInactiveCases.ts index 7e6219af7bd4..0c75a4c0f7c1 100644 --- a/services/case_management/src/v2/models/AutoCloseInactiveCases.ts +++ b/services/case_management/src/v2/models/AutoCloseInactiveCases.ts @@ -1,15 +1,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Auto-close inactive cases settings + * Auto-close inactive cases settings. */ export class AutoCloseInactiveCases { /** - * Whether auto-close is enabled + * Whether auto-close is enabled. */ "enabled"?: boolean; /** - * Maximum inactive time in seconds before auto-closing + * Maximum inactive time in seconds before auto-closing. */ "maxInactiveTimeInSecs"?: number; /** diff --git a/services/case_management/src/v2/models/AutoTransitionAssignedCases.ts b/services/case_management/src/v2/models/AutoTransitionAssignedCases.ts index febcb03c9f51..c076c9c5151b 100644 --- a/services/case_management/src/v2/models/AutoTransitionAssignedCases.ts +++ b/services/case_management/src/v2/models/AutoTransitionAssignedCases.ts @@ -1,11 +1,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Auto-transition assigned cases settings + * Auto-transition assigned cases settings. */ export class AutoTransitionAssignedCases { /** - * Whether to auto-transition cases when self-assigned + * Whether to auto-transition cases when self-assigned. */ "autoTransitionAssignedCasesOnSelfAssigned"?: boolean; /** diff --git a/services/case_management/src/v2/models/CaseCreateRelationships.ts b/services/case_management/src/v2/models/CaseCreateRelationships.ts index 1757cd3e1014..d0e20f147566 100644 --- a/services/case_management/src/v2/models/CaseCreateRelationships.ts +++ b/services/case_management/src/v2/models/CaseCreateRelationships.ts @@ -12,7 +12,7 @@ export class CaseCreateRelationships { */ "assignee"?: NullableUserRelationship; /** - * Relationship to project + * Relationship to project. */ "project": ProjectRelationship; /** diff --git a/services/case_management/src/v2/models/CaseRelationships.ts b/services/case_management/src/v2/models/CaseRelationships.ts index 63acf85294cc..aa4cb86cd780 100644 --- a/services/case_management/src/v2/models/CaseRelationships.ts +++ b/services/case_management/src/v2/models/CaseRelationships.ts @@ -20,7 +20,7 @@ export class CaseRelationships { */ "modifiedBy"?: NullableUserRelationship; /** - * Relationship to project + * Relationship to project. */ "project"?: ProjectRelationship; /** diff --git a/services/case_management/src/v2/models/IntegrationIncident.ts b/services/case_management/src/v2/models/IntegrationIncident.ts index 7311c0d270e8..cea8aee711eb 100644 --- a/services/case_management/src/v2/models/IntegrationIncident.ts +++ b/services/case_management/src/v2/models/IntegrationIncident.ts @@ -4,26 +4,32 @@ import { IntegrationIncidentFieldMappingsItems } from "./IntegrationIncidentFiel import { IntegrationIncidentSeverityConfig } from "./IntegrationIncidentSeverityConfig"; /** - * Incident integration settings + * Incident integration settings. */ export class IntegrationIncident { /** - * Query for auto-escalation + * Query for auto-escalation. */ "autoEscalationQuery"?: string; /** - * Default incident commander + * Default incident commander. */ "defaultIncidentCommander"?: string; /** - * Whether incident integration is enabled + * Whether incident integration is enabled. */ "enabled"?: boolean; + /** + * List of mappings between incident fields and case fields. + */ "fieldMappings"?: Array; /** - * Incident type + * Incident type. */ "incidentType"?: string; + /** + * Severity configuration for mapping incident priorities to case priorities. + */ "severityConfig"?: IntegrationIncidentSeverityConfig; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationIncidentFieldMappingsItems.ts b/services/case_management/src/v2/models/IntegrationIncidentFieldMappingsItems.ts index 7f92d865f010..9d27844fb30f 100644 --- a/services/case_management/src/v2/models/IntegrationIncidentFieldMappingsItems.ts +++ b/services/case_management/src/v2/models/IntegrationIncidentFieldMappingsItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Mapping between an incident user-defined field and a case field. + */ export class IntegrationIncidentFieldMappingsItems { + /** + * The case field to map the incident field value to. + */ "caseField"?: string; + /** + * The identifier of the incident user-defined field to map from. + */ "incidentUserDefinedFieldId"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationIncidentSeverityConfig.ts b/services/case_management/src/v2/models/IntegrationIncidentSeverityConfig.ts index ca6703417a18..b3679551c496 100644 --- a/services/case_management/src/v2/models/IntegrationIncidentSeverityConfig.ts +++ b/services/case_management/src/v2/models/IntegrationIncidentSeverityConfig.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Severity configuration for mapping incident priorities to case priorities. + */ export class IntegrationIncidentSeverityConfig { + /** + * Mapping of incident severity values to case priority values. + */ "priorityMapping"?: { [key: string]: string }; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJira.ts b/services/case_management/src/v2/models/IntegrationJira.ts index 0e75d4b412d1..4c7fc3af7665 100644 --- a/services/case_management/src/v2/models/IntegrationJira.ts +++ b/services/case_management/src/v2/models/IntegrationJira.ts @@ -5,15 +5,24 @@ import { IntegrationJiraMetadata } from "./IntegrationJiraMetadata"; import { IntegrationJiraSync } from "./IntegrationJiraSync"; /** - * Jira integration settings + * Jira integration settings. */ export class IntegrationJira { + /** + * Auto-creation settings for Jira issues from cases. + */ "autoCreation"?: IntegrationJiraAutoCreation; /** - * Whether Jira integration is enabled + * Whether Jira integration is enabled. */ "enabled"?: boolean; + /** + * Metadata for connecting a case management project to a Jira project. + */ "metadata"?: IntegrationJiraMetadata; + /** + * Synchronization configuration for Jira integration. + */ "sync"?: IntegrationJiraSync; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJiraAutoCreation.ts b/services/case_management/src/v2/models/IntegrationJiraAutoCreation.ts index e8e678249796..93173110c534 100644 --- a/services/case_management/src/v2/models/IntegrationJiraAutoCreation.ts +++ b/services/case_management/src/v2/models/IntegrationJiraAutoCreation.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Auto-creation settings for Jira issues from cases. + */ export class IntegrationJiraAutoCreation { + /** + * Whether automatic Jira issue creation is enabled. + */ "enabled"?: boolean; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJiraMetadata.ts b/services/case_management/src/v2/models/IntegrationJiraMetadata.ts index 59732befe41b..d891e7f558be 100644 --- a/services/case_management/src/v2/models/IntegrationJiraMetadata.ts +++ b/services/case_management/src/v2/models/IntegrationJiraMetadata.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Metadata for connecting a case management project to a Jira project. + */ export class IntegrationJiraMetadata { + /** + * The Jira account identifier. + */ "accountId"?: string; + /** + * The Jira issue type identifier to use when creating issues. + */ "issueTypeId"?: string; + /** + * The Jira project identifier to associate with this case project. + */ "projectId"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJiraSync.ts b/services/case_management/src/v2/models/IntegrationJiraSync.ts index 9aaa7782b398..3ea4c760b212 100644 --- a/services/case_management/src/v2/models/IntegrationJiraSync.ts +++ b/services/case_management/src/v2/models/IntegrationJiraSync.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IntegrationJiraSyncProperties } from "./IntegrationJiraSyncProperties"; +/** + * Synchronization configuration for Jira integration. + */ export class IntegrationJiraSync { + /** + * Whether Jira field synchronization is enabled. + */ "enabled"?: boolean; + /** + * Field synchronization properties for Jira integration. + */ "properties"?: IntegrationJiraSyncProperties; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJiraSyncDueDate.ts b/services/case_management/src/v2/models/IntegrationJiraSyncDueDate.ts index a9fa353c7d37..17efe5a07ccf 100644 --- a/services/case_management/src/v2/models/IntegrationJiraSyncDueDate.ts +++ b/services/case_management/src/v2/models/IntegrationJiraSyncDueDate.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Due date synchronization configuration for Jira integration. + */ export class IntegrationJiraSyncDueDate { + /** + * The Jira field identifier used to store the due date. + */ "jiraFieldId"?: string; + /** + * The type of synchronization to apply for the due date field. + */ "syncType"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationJiraSyncProperties.ts b/services/case_management/src/v2/models/IntegrationJiraSyncProperties.ts index e709f8516933..9a44a3ee4ab7 100644 --- a/services/case_management/src/v2/models/IntegrationJiraSyncProperties.ts +++ b/services/case_management/src/v2/models/IntegrationJiraSyncProperties.ts @@ -5,35 +5,44 @@ import { IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties } from ". import { SyncProperty } from "./SyncProperty"; import { SyncPropertyWithMapping } from "./SyncPropertyWithMapping"; +/** + * Field synchronization properties for Jira integration. + */ export class IntegrationJiraSyncProperties { /** - * Sync property configuration + * Sync property configuration. */ "assignee"?: SyncProperty; /** - * Sync property configuration + * Sync property configuration. */ "comments"?: SyncProperty; + /** + * Map of custom field identifiers to their sync configurations. + */ "customFields"?: { [ key: string ]: IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties; }; /** - * Sync property configuration + * Sync property configuration. */ "description"?: SyncProperty; + /** + * Due date synchronization configuration for Jira integration. + */ "dueDate"?: IntegrationJiraSyncDueDate; /** - * Sync property with mapping configuration + * Sync property with mapping configuration. */ "priority"?: SyncPropertyWithMapping; /** - * Sync property with mapping configuration + * Sync property with mapping configuration. */ "status"?: SyncPropertyWithMapping; /** - * Sync property configuration + * Sync property configuration. */ "title"?: SyncProperty; /** diff --git a/services/case_management/src/v2/models/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties.ts b/services/case_management/src/v2/models/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties.ts index 48a5a7f83c37..a68079269db3 100644 --- a/services/case_management/src/v2/models/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties.ts +++ b/services/case_management/src/v2/models/IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { AnyValue } from "./AnyValue"; +/** + * Synchronization configuration for a Jira custom field. + */ export class IntegrationJiraSyncPropertiesCustomFieldsAdditionalProperties { + /** + * The type of synchronization to apply for this custom field. + */ "syncType"?: string; /** * Represents any valid JSON value. diff --git a/services/case_management/src/v2/models/IntegrationMonitor.ts b/services/case_management/src/v2/models/IntegrationMonitor.ts index 6c3557c529d0..1fa74a863a99 100644 --- a/services/case_management/src/v2/models/IntegrationMonitor.ts +++ b/services/case_management/src/v2/models/IntegrationMonitor.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Monitor integration settings + * Monitor integration settings. */ export class IntegrationMonitor { /** - * Whether auto-resolve is enabled + * Whether auto-resolve is enabled. */ "autoResolveEnabled"?: boolean; /** - * Case type ID for monitor integration + * Case type ID for monitor integration. */ "caseTypeId"?: string; /** - * Whether monitor integration is enabled + * Whether monitor integration is enabled. */ "enabled"?: boolean; /** - * Monitor handle + * Monitor handle. */ "handle"?: string; /** diff --git a/services/case_management/src/v2/models/IntegrationOnCall.ts b/services/case_management/src/v2/models/IntegrationOnCall.ts index 856f3a1da1ce..cfff22a6a7c5 100644 --- a/services/case_management/src/v2/models/IntegrationOnCall.ts +++ b/services/case_management/src/v2/models/IntegrationOnCall.ts @@ -3,17 +3,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IntegrationOnCallEscalationQueriesItems } from "./IntegrationOnCallEscalationQueriesItems"; /** - * On-Call integration settings + * On-Call integration settings. */ export class IntegrationOnCall { /** - * Whether to auto-assign on-call + * Whether to auto-assign on-call. */ "autoAssignOnCall"?: boolean; /** - * Whether On-Call integration is enabled + * Whether On-Call integration is enabled. */ "enabled"?: boolean; + /** + * List of escalation queries for routing cases to on-call responders. + */ "escalationQueries"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItems.ts b/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItems.ts index 91f59d6d9ff6..c5d73e14063e 100644 --- a/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItems.ts +++ b/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItems.ts @@ -2,10 +2,25 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IntegrationOnCallEscalationQueriesItemsTarget } from "./IntegrationOnCallEscalationQueriesItemsTarget"; +/** + * An On-Call escalation query entry used to route cases to on-call responders. + */ export class IntegrationOnCallEscalationQueriesItems { + /** + * Whether this escalation query is enabled. + */ "enabled"?: boolean; + /** + * Unique identifier of the escalation query. + */ "id"?: string; + /** + * The query used to match cases for escalation. + */ "query"?: string; + /** + * The target recipient for an On-Call escalation query. + */ "target"?: IntegrationOnCallEscalationQueriesItemsTarget; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItemsTarget.ts b/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItemsTarget.ts index aec15798f555..b01b4f515af4 100644 --- a/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItemsTarget.ts +++ b/services/case_management/src/v2/models/IntegrationOnCallEscalationQueriesItemsTarget.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The target recipient for an On-Call escalation query. + */ export class IntegrationOnCallEscalationQueriesItemsTarget { + /** + * Whether to use dynamic team paging for escalation. + */ "dynamicTeamPaging"?: boolean; + /** + * The identifier of the team to escalate to. + */ "teamId"?: string; + /** + * The identifier of the user to escalate to. + */ "userId"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationServiceNow.ts b/services/case_management/src/v2/models/IntegrationServiceNow.ts index 7f7e8f081678..b8445817ffee 100644 --- a/services/case_management/src/v2/models/IntegrationServiceNow.ts +++ b/services/case_management/src/v2/models/IntegrationServiceNow.ts @@ -4,22 +4,28 @@ import { IntegrationServiceNowAutoCreation } from "./IntegrationServiceNowAutoCr import { IntegrationServiceNowSyncConfig } from "./IntegrationServiceNowSyncConfig"; /** - * ServiceNow integration settings + * ServiceNow integration settings. */ export class IntegrationServiceNow { /** - * Assignment group + * Assignment group. */ "assignmentGroup"?: string; + /** + * Auto-creation settings for ServiceNow incidents from cases. + */ "autoCreation"?: IntegrationServiceNowAutoCreation; /** - * Whether ServiceNow integration is enabled + * Whether ServiceNow integration is enabled. */ "enabled"?: boolean; /** - * ServiceNow instance name + * ServiceNow instance name. */ "instanceName"?: string; + /** + * Synchronization configuration for ServiceNow integration. + */ "syncConfig"?: IntegrationServiceNowSyncConfig; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationServiceNowAutoCreation.ts b/services/case_management/src/v2/models/IntegrationServiceNowAutoCreation.ts index e877bb91d88d..35b4dd5e1054 100644 --- a/services/case_management/src/v2/models/IntegrationServiceNowAutoCreation.ts +++ b/services/case_management/src/v2/models/IntegrationServiceNowAutoCreation.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Auto-creation settings for ServiceNow incidents from cases. + */ export class IntegrationServiceNowAutoCreation { + /** + * Whether automatic ServiceNow incident creation is enabled. + */ "enabled"?: boolean; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig.ts b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig.ts index 581934310ad7..108727ee68fa 100644 --- a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig.ts +++ b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IntegrationServiceNowSyncConfig139772721534496 } from "./IntegrationServiceNowSyncConfig139772721534496"; +/** + * Synchronization configuration for ServiceNow integration. + */ export class IntegrationServiceNowSyncConfig { + /** + * Whether ServiceNow synchronization is enabled. + */ "enabled"?: boolean; + /** + * Field-level synchronization properties for ServiceNow integration. + */ "properties"?: IntegrationServiceNowSyncConfig139772721534496; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig139772721534496.ts b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig139772721534496.ts index ae34aa07ac7e..5c6d9e5ef359 100644 --- a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig139772721534496.ts +++ b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfig139772721534496.ts @@ -4,14 +4,20 @@ import { IntegrationServiceNowSyncConfigPriority } from "./IntegrationServiceNow import { SyncProperty } from "./SyncProperty"; import { SyncPropertyWithMapping } from "./SyncPropertyWithMapping"; +/** + * Field-level synchronization properties for ServiceNow integration. + */ export class IntegrationServiceNowSyncConfig139772721534496 { /** - * Sync property configuration + * Sync property configuration. */ "comments"?: SyncProperty; + /** + * Priority synchronization configuration for ServiceNow integration. + */ "priority"?: IntegrationServiceNowSyncConfigPriority; /** - * Sync property with mapping configuration + * Sync property with mapping configuration. */ "status"?: SyncPropertyWithMapping; /** diff --git a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfigPriority.ts b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfigPriority.ts index 5cd21cc8fbde..0d5701baf545 100644 --- a/services/case_management/src/v2/models/IntegrationServiceNowSyncConfigPriority.ts +++ b/services/case_management/src/v2/models/IntegrationServiceNowSyncConfigPriority.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Priority synchronization configuration for ServiceNow integration. + */ export class IntegrationServiceNowSyncConfigPriority { + /** + * Mapping of case priority values to ServiceNow impact values. + */ "impactMapping"?: { [key: string]: string }; + /** + * The type of synchronization to apply for priority. + */ "syncType"?: string; + /** + * Mapping of case priority values to ServiceNow urgency values. + */ "urgencyMapping"?: { [key: string]: string }; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/Project.ts b/services/case_management/src/v2/models/Project.ts index 5471efc1abf7..c2adde4af47d 100644 --- a/services/case_management/src/v2/models/Project.ts +++ b/services/case_management/src/v2/models/Project.ts @@ -5,23 +5,23 @@ import { ProjectRelationships } from "./ProjectRelationships"; import { ProjectResourceType } from "./ProjectResourceType"; /** - * A Project + * A Project. */ export class Project { /** - * Project attributes + * Project attributes. */ "attributes": ProjectAttributes; /** - * The Project's identifier + * The Project's identifier. */ "id": string; /** - * Project relationships + * Project relationships. */ "relationships"?: ProjectRelationships; /** - * Project resource type + * Project resource type. */ "type": ProjectResourceType; /** diff --git a/services/case_management/src/v2/models/ProjectAttributes.ts b/services/case_management/src/v2/models/ProjectAttributes.ts index 7ed022e68409..9b40f64edc7b 100644 --- a/services/case_management/src/v2/models/ProjectAttributes.ts +++ b/services/case_management/src/v2/models/ProjectAttributes.ts @@ -4,31 +4,31 @@ import { ProjectColumnsConfig } from "./ProjectColumnsConfig"; import { ProjectSettings } from "./ProjectSettings"; /** - * Project attributes + * Project attributes. */ export class ProjectAttributes { /** - * Project columns configuration + * Project columns configuration. */ "columnsConfig"?: ProjectColumnsConfig; /** - * List of enabled custom case type IDs + * List of enabled custom case type IDs. */ "enabledCustomCaseTypes"?: Array; /** - * The project's key + * The project's key. */ "key"?: string; /** - * Project's name + * Project's name. */ "name"?: string; /** - * Whether the project is restricted + * Whether the project is restricted. */ "restricted"?: boolean; /** - * Project settings + * Project settings. */ "settings"?: ProjectSettings; /** diff --git a/services/case_management/src/v2/models/ProjectColumnsConfig.ts b/services/case_management/src/v2/models/ProjectColumnsConfig.ts index dd5dd394b418..521da0fb1ec6 100644 --- a/services/case_management/src/v2/models/ProjectColumnsConfig.ts +++ b/services/case_management/src/v2/models/ProjectColumnsConfig.ts @@ -3,9 +3,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectColumnsConfigColumnsItems } from "./ProjectColumnsConfigColumnsItems"; /** - * Project columns configuration + * Project columns configuration. */ export class ProjectColumnsConfig { + /** + * List of column configurations for the project board view. + */ "columns"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItems.ts b/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItems.ts index 5b84d0a5f9e4..34111648b205 100644 --- a/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItems.ts +++ b/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItems.ts @@ -2,9 +2,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectColumnsConfigColumnsItemsSort } from "./ProjectColumnsConfigColumnsItemsSort"; +/** + * Configuration for a single column in a project board view. + */ export class ProjectColumnsConfigColumnsItems { + /** + * Sort configuration for a project board column. + */ "sort"?: ProjectColumnsConfigColumnsItemsSort; + /** + * The field used to sort items in this column. + */ "sortField"?: string; + /** + * The type of column. + */ "type"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItemsSort.ts b/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItemsSort.ts index 85275ff63127..d0feb53ec475 100644 --- a/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItemsSort.ts +++ b/services/case_management/src/v2/models/ProjectColumnsConfigColumnsItemsSort.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Sort configuration for a project board column. + */ export class ProjectColumnsConfigColumnsItemsSort { + /** + * Whether to sort in ascending order. + */ "ascending"?: boolean; + /** + * The sort priority order for this column. + */ "priority"?: number; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/ProjectCreate.ts b/services/case_management/src/v2/models/ProjectCreate.ts index 39e5bac5ae4c..8086ff64d255 100644 --- a/services/case_management/src/v2/models/ProjectCreate.ts +++ b/services/case_management/src/v2/models/ProjectCreate.ts @@ -4,15 +4,15 @@ import { ProjectCreateAttributes } from "./ProjectCreateAttributes"; import { ProjectResourceType } from "./ProjectResourceType"; /** - * Project create + * Project create. */ export class ProjectCreate { /** - * Project creation attributes + * Project creation attributes. */ "attributes": ProjectCreateAttributes; /** - * Project resource type + * Project resource type. */ "type": ProjectResourceType; /** diff --git a/services/case_management/src/v2/models/ProjectCreateAttributes.ts b/services/case_management/src/v2/models/ProjectCreateAttributes.ts index 0585d26352a8..8478f58ae69c 100644 --- a/services/case_management/src/v2/models/ProjectCreateAttributes.ts +++ b/services/case_management/src/v2/models/ProjectCreateAttributes.ts @@ -1,23 +1,23 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Project creation attributes + * Project creation attributes. */ export class ProjectCreateAttributes { /** - * List of enabled custom case type IDs + * List of enabled custom case type IDs. */ "enabledCustomCaseTypes"?: Array; /** - * Project's key. Cannot be "CASE" + * Project's key. Cannot be "CASE". */ "key": string; /** - * Project name + * Project name. */ "name": string; /** - * Team UUID to associate with the project + * Team UUID to associate with the project. */ "teamUuid"?: string; /** diff --git a/services/case_management/src/v2/models/ProjectCreateRequest.ts b/services/case_management/src/v2/models/ProjectCreateRequest.ts index 55a228ab24db..e34e638df511 100644 --- a/services/case_management/src/v2/models/ProjectCreateRequest.ts +++ b/services/case_management/src/v2/models/ProjectCreateRequest.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectCreate } from "./ProjectCreate"; /** - * Project create request + * Project create request. */ export class ProjectCreateRequest { /** - * Project create + * Project create. */ "data": ProjectCreate; /** diff --git a/services/case_management/src/v2/models/ProjectNotificationSettings.ts b/services/case_management/src/v2/models/ProjectNotificationSettings.ts index 25bda8d36088..050ed9d20046 100644 --- a/services/case_management/src/v2/models/ProjectNotificationSettings.ts +++ b/services/case_management/src/v2/models/ProjectNotificationSettings.ts @@ -1,23 +1,44 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Project notification settings + * Project notification settings. */ export class ProjectNotificationSettings { /** - * Notification destinations (1=email, 2=slack, 3=in-app) + * Notification destinations (1=email, 2=slack, 3=in-app). */ "destinations"?: Array; /** - * Whether notifications are enabled + * Whether notifications are enabled. */ "enabled"?: boolean; + /** + * Whether to send a notification when a case is assigned. + */ "notifyOnCaseAssignment"?: boolean; + /** + * Whether to send a notification when a case is closed. + */ "notifyOnCaseClosed"?: boolean; + /** + * Whether to send a notification when a comment is added to a case. + */ "notifyOnCaseComment"?: boolean; + /** + * Whether to send a notification when a user is mentioned in a case comment. + */ "notifyOnCaseCommentMention"?: boolean; + /** + * Whether to send a notification when a case's priority changes. + */ "notifyOnCasePriorityChange"?: boolean; + /** + * Whether to send a notification when a case's status changes. + */ "notifyOnCaseStatusChange"?: boolean; + /** + * Whether to send a notification when a case is unassigned. + */ "notifyOnCaseUnassignment"?: boolean; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/ProjectRelationship.ts b/services/case_management/src/v2/models/ProjectRelationship.ts index 99a1bb72d1d5..d32fac838b1e 100644 --- a/services/case_management/src/v2/models/ProjectRelationship.ts +++ b/services/case_management/src/v2/models/ProjectRelationship.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectRelationshipData } from "./ProjectRelationshipData"; /** - * Relationship to project + * Relationship to project. */ export class ProjectRelationship { /** - * Relationship to project object + * Relationship to project object. */ "data": ProjectRelationshipData; /** diff --git a/services/case_management/src/v2/models/ProjectRelationshipData.ts b/services/case_management/src/v2/models/ProjectRelationshipData.ts index b73e2e4d845d..bfe7cb3567a9 100644 --- a/services/case_management/src/v2/models/ProjectRelationshipData.ts +++ b/services/case_management/src/v2/models/ProjectRelationshipData.ts @@ -3,15 +3,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectResourceType } from "./ProjectResourceType"; /** - * Relationship to project object + * Relationship to project object. */ export class ProjectRelationshipData { /** - * A unique identifier that represents the project + * A unique identifier that represents the project. */ "id": string; /** - * Project resource type + * Project resource type. */ "type": ProjectResourceType; /** diff --git a/services/case_management/src/v2/models/ProjectRelationships.ts b/services/case_management/src/v2/models/ProjectRelationships.ts index d55eefd67b7a..106139739eec 100644 --- a/services/case_management/src/v2/models/ProjectRelationships.ts +++ b/services/case_management/src/v2/models/ProjectRelationships.ts @@ -4,7 +4,7 @@ import { RelationshipToTeamLinks } from "./RelationshipToTeamLinks"; import { UsersRelationship } from "./UsersRelationship"; /** - * Project relationships + * Project relationships. */ export class ProjectRelationships { /** diff --git a/services/case_management/src/v2/models/ProjectResourceType.ts b/services/case_management/src/v2/models/ProjectResourceType.ts index adc5c09ec874..fef2c038e27c 100644 --- a/services/case_management/src/v2/models/ProjectResourceType.ts +++ b/services/case_management/src/v2/models/ProjectResourceType.ts @@ -1,7 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; /** - * Project resource type + * Project resource type. */ export type ProjectResourceType = typeof PROJECT | UnparsedObject; export const PROJECT = "project"; diff --git a/services/case_management/src/v2/models/ProjectResponse.ts b/services/case_management/src/v2/models/ProjectResponse.ts index d1a7b9e333a5..d707286bc2c1 100644 --- a/services/case_management/src/v2/models/ProjectResponse.ts +++ b/services/case_management/src/v2/models/ProjectResponse.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { Project } from "./Project"; /** - * Project response + * Project response. */ export class ProjectResponse { /** - * A Project + * A Project. */ "data"?: Project; /** diff --git a/services/case_management/src/v2/models/ProjectSettings.ts b/services/case_management/src/v2/models/ProjectSettings.ts index 98fdb09750a8..0b5999b42444 100644 --- a/services/case_management/src/v2/models/ProjectSettings.ts +++ b/services/case_management/src/v2/models/ProjectSettings.ts @@ -10,39 +10,39 @@ import { IntegrationServiceNow } from "./IntegrationServiceNow"; import { ProjectNotificationSettings } from "./ProjectNotificationSettings"; /** - * Project settings + * Project settings. */ export class ProjectSettings { /** - * Auto-close inactive cases settings + * Auto-close inactive cases settings. */ "autoCloseInactiveCases"?: AutoCloseInactiveCases; /** - * Auto-transition assigned cases settings + * Auto-transition assigned cases settings. */ "autoTransitionAssignedCases"?: AutoTransitionAssignedCases; /** - * Incident integration settings + * Incident integration settings. */ "integrationIncident"?: IntegrationIncident; /** - * Jira integration settings + * Jira integration settings. */ "integrationJira"?: IntegrationJira; /** - * Monitor integration settings + * Monitor integration settings. */ "integrationMonitor"?: IntegrationMonitor; /** - * On-Call integration settings + * On-Call integration settings. */ "integrationOnCall"?: IntegrationOnCall; /** - * ServiceNow integration settings + * ServiceNow integration settings. */ "integrationServiceNow"?: IntegrationServiceNow; /** - * Project notification settings + * Project notification settings. */ "notification"?: ProjectNotificationSettings; /** diff --git a/services/case_management/src/v2/models/ProjectUpdate.ts b/services/case_management/src/v2/models/ProjectUpdate.ts index fe03737a0ecf..da54dcd47d83 100644 --- a/services/case_management/src/v2/models/ProjectUpdate.ts +++ b/services/case_management/src/v2/models/ProjectUpdate.ts @@ -4,15 +4,15 @@ import { ProjectResourceType } from "./ProjectResourceType"; import { ProjectUpdateAttributes } from "./ProjectUpdateAttributes"; /** - * Project update + * Project update. */ export class ProjectUpdate { /** - * Project update attributes + * Project update attributes. */ "attributes"?: ProjectUpdateAttributes; /** - * Project resource type + * Project resource type. */ "type": ProjectResourceType; /** diff --git a/services/case_management/src/v2/models/ProjectUpdateAttributes.ts b/services/case_management/src/v2/models/ProjectUpdateAttributes.ts index f685fe3a7744..46b81dd367c0 100644 --- a/services/case_management/src/v2/models/ProjectUpdateAttributes.ts +++ b/services/case_management/src/v2/models/ProjectUpdateAttributes.ts @@ -4,27 +4,27 @@ import { ProjectColumnsConfig } from "./ProjectColumnsConfig"; import { ProjectSettings } from "./ProjectSettings"; /** - * Project update attributes + * Project update attributes. */ export class ProjectUpdateAttributes { /** - * Project columns configuration + * Project columns configuration. */ "columnsConfig"?: ProjectColumnsConfig; /** - * List of enabled custom case type IDs + * List of enabled custom case type IDs. */ "enabledCustomCaseTypes"?: Array; /** - * Project name + * Project name. */ "name"?: string; /** - * Project settings + * Project settings. */ "settings"?: ProjectSettings; /** - * Team UUID to associate with the project + * Team UUID to associate with the project. */ "teamUuid"?: string; /** diff --git a/services/case_management/src/v2/models/ProjectUpdateRequest.ts b/services/case_management/src/v2/models/ProjectUpdateRequest.ts index 8934c607474c..c739f084d8d8 100644 --- a/services/case_management/src/v2/models/ProjectUpdateRequest.ts +++ b/services/case_management/src/v2/models/ProjectUpdateRequest.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectUpdate } from "./ProjectUpdate"; /** - * Project update request + * Project update request. */ export class ProjectUpdateRequest { /** - * Project update + * Project update. */ "data": ProjectUpdate; /** diff --git a/services/case_management/src/v2/models/ProjectsResponse.ts b/services/case_management/src/v2/models/ProjectsResponse.ts index 525f4e120d02..f28c371477a3 100644 --- a/services/case_management/src/v2/models/ProjectsResponse.ts +++ b/services/case_management/src/v2/models/ProjectsResponse.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { Project } from "./Project"; /** - * Response with projects + * Response with projects. */ export class ProjectsResponse { /** - * Projects response data + * Projects response data. */ "data"?: Array; /** diff --git a/services/case_management/src/v2/models/SyncProperty.ts b/services/case_management/src/v2/models/SyncProperty.ts index 974b748fdc3a..93152aaa7946 100644 --- a/services/case_management/src/v2/models/SyncProperty.ts +++ b/services/case_management/src/v2/models/SyncProperty.ts @@ -1,9 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Sync property configuration + * Sync property configuration. */ export class SyncProperty { + /** + * The direction and type of synchronization for this property. + */ "syncType"?: string; /** * A container for additional, undeclared properties. diff --git a/services/case_management/src/v2/models/SyncPropertyWithMapping.ts b/services/case_management/src/v2/models/SyncPropertyWithMapping.ts index 6245ef23f235..85f7be34e7d4 100644 --- a/services/case_management/src/v2/models/SyncPropertyWithMapping.ts +++ b/services/case_management/src/v2/models/SyncPropertyWithMapping.ts @@ -1,11 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; /** - * Sync property with mapping configuration + * Sync property with mapping configuration. */ export class SyncPropertyWithMapping { + /** + * Map of source values to destination values for synchronization. + */ "mapping"?: { [key: string]: string }; + /** + * Map of source names to display names used during synchronization. + */ "nameMapping"?: { [key: string]: string }; + /** + * The direction and type of synchronization for this property. + */ "syncType"?: string; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetAttributes.ts b/services/cloud_cost_management/src/v2/models/BudgetAttributes.ts index 2acd0eef423a..58ff9523cb92 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetAttributes.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetAttributes.ts @@ -18,6 +18,9 @@ export class BudgetAttributes { * The month when the budget ends. */ "endMonth"?: number; + /** + * The list of monthly budget entries. + */ "entries"?: Array; /** * The cost query used to track against the budget. diff --git a/services/cloud_cost_management/src/v2/models/BudgetValidationRequest.ts b/services/cloud_cost_management/src/v2/models/BudgetValidationRequest.ts index 7e81db7ed5d7..03140bac0741 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetValidationRequest.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetValidationRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetValidationRequestData } from "./BudgetValidationRequestData"; +/** + * The request object for validating a budget configuration before creating or updating it. + */ export class BudgetValidationRequest { + /** + * The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate. + */ "data"?: BudgetValidationRequestData; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetValidationRequestData.ts b/services/cloud_cost_management/src/v2/models/BudgetValidationRequestData.ts index 2e0435ce4858..7ae841ca2ab6 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetValidationRequestData.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetValidationRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetWithEntriesDataAttributes } from "./BudgetWithEntriesDataAttributes"; import { BudgetWithEntriesDataType } from "./BudgetWithEntriesDataType"; +/** + * The data object for a budget validation request, containing the resource type, ID, and budget attributes to validate. + */ export class BudgetValidationRequestData { + /** + * The attributes of a budget including all its monthly entries. + */ "attributes"?: BudgetWithEntriesDataAttributes; + /** + * The unique identifier of the budget to validate. + */ "id"?: string; /** * Budget resource type. diff --git a/services/cloud_cost_management/src/v2/models/BudgetValidationResponse.ts b/services/cloud_cost_management/src/v2/models/BudgetValidationResponse.ts index fc3e328af829..5312968ceecb 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetValidationResponse.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetValidationResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetValidationResponseData } from "./BudgetValidationResponseData"; +/** + * The response object for a budget validation request, containing the validation result data. + */ export class BudgetValidationResponse { + /** + * The data object for a budget validation response, containing the resource type, ID, and validation attributes. + */ "data"?: BudgetValidationResponseData; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetValidationResponseData.ts b/services/cloud_cost_management/src/v2/models/BudgetValidationResponseData.ts index 5b039e1e4548..ccb1da32509c 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetValidationResponseData.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetValidationResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetValidationResponseDataAttributes } from "./BudgetValidationResponseDataAttributes"; import { BudgetValidationResponseDataType } from "./BudgetValidationResponseDataType"; +/** + * The data object for a budget validation response, containing the resource type, ID, and validation attributes. + */ export class BudgetValidationResponseData { + /** + * The attributes of a budget validation response, including any validation errors and the validity status. + */ "attributes"?: BudgetValidationResponseDataAttributes; + /** + * The unique identifier of the budget being validated. + */ "id"?: string; /** * Budget validation resource type. diff --git a/services/cloud_cost_management/src/v2/models/BudgetValidationResponseDataAttributes.ts b/services/cloud_cost_management/src/v2/models/BudgetValidationResponseDataAttributes.ts index f69682d4ea0c..4eadf5c23a2c 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetValidationResponseDataAttributes.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetValidationResponseDataAttributes.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The attributes of a budget validation response, including any validation errors and the validity status. + */ export class BudgetValidationResponseDataAttributes { + /** + * A list of validation error messages for the budget. + */ "errors"?: Array; + /** + * Whether the budget configuration is valid. + */ "valid"?: boolean; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributes.ts b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributes.ts index fe983982f39f..8051fb7d83cf 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributes.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributes.ts @@ -2,17 +2,53 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetWithEntriesDataAttributesEntriesItems } from "./BudgetWithEntriesDataAttributesEntriesItems"; +/** + * The attributes of a budget including all its monthly entries. + */ export class BudgetWithEntriesDataAttributes { + /** + * The timestamp when the budget was created. + */ "createdAt"?: number; + /** + * The ID of the user that created the budget. + */ "createdBy"?: string; + /** + * The month when the budget ends, in YYYYMM format. + */ "endMonth"?: number; + /** + * The list of monthly budget entries. + */ "entries"?: Array; + /** + * The cost query used to track spending against the budget. + */ "metricsQuery"?: string; + /** + * The name of the budget. + */ "name"?: string; + /** + * The ID of the organization the budget belongs to. + */ "orgId"?: number; + /** + * The month when the budget starts, in YYYYMM format. + */ "startMonth"?: number; + /** + * The total budget amount across all entries. + */ "totalAmount"?: number; + /** + * The timestamp when the budget was last updated. + */ "updatedAt"?: number; + /** + * The ID of the user that last updated the budget. + */ "updatedBy"?: string; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItems.ts b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItems.ts index e2bfebfdde59..a84ac7ee32a6 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItems.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItems.ts @@ -2,9 +2,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems } from "./BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems"; +/** + * A single monthly budget entry defining the allocated amount and optional tag filters for a specific month. + */ export class BudgetWithEntriesDataAttributesEntriesItems { + /** + * The budgeted amount for this entry. + */ "amount"?: number; + /** + * The month this budget entry applies to, in YYYYMM format. + */ "month"?: number; + /** + * The list of tag filters that scope this budget entry to specific resources. + */ "tagFilters"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems.ts b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems.ts index 902f0991b152..06b7baef7445 100644 --- a/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems.ts +++ b/services/cloud_cost_management/src/v2/models/BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A tag filter used to scope a budget entry to specific resource tags. + */ export class BudgetWithEntriesDataAttributesEntriesItemsTagFiltersItems { + /** + * The tag key to filter on. + */ "tagKey"?: string; + /** + * The tag value to filter on. + */ "tagValue"?: string; /** * A container for additional, undeclared properties. diff --git a/services/deployment_gates/src/v2/models/ListDeploymentRuleResponseData.ts b/services/deployment_gates/src/v2/models/ListDeploymentRuleResponseData.ts index 210bd23ee3ae..5988058b9118 100644 --- a/services/deployment_gates/src/v2/models/ListDeploymentRuleResponseData.ts +++ b/services/deployment_gates/src/v2/models/ListDeploymentRuleResponseData.ts @@ -7,6 +7,9 @@ import { ListDeploymentRulesResponseDataAttributes } from "./ListDeploymentRules * Data for a list of deployment rules. */ export class ListDeploymentRuleResponseData { + /** + * Attributes of the response for listing deployment rules. + */ "attributes": ListDeploymentRulesResponseDataAttributes; /** * Unique identifier of the deployment rule. diff --git a/services/deployment_gates/src/v2/models/ListDeploymentRulesResponseDataAttributes.ts b/services/deployment_gates/src/v2/models/ListDeploymentRulesResponseDataAttributes.ts index 58cbc9181d31..08a794423d55 100644 --- a/services/deployment_gates/src/v2/models/ListDeploymentRulesResponseDataAttributes.ts +++ b/services/deployment_gates/src/v2/models/ListDeploymentRulesResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeploymentRuleResponseDataAttributes } from "./DeploymentRuleResponseDataAttributes"; +/** + * Attributes of the response for listing deployment rules. + */ export class ListDeploymentRulesResponseDataAttributes { + /** + * The list of deployment rules. + */ "rules"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/entity_risk_scores/src/v2/models/SecurityEntityRiskScoresResponse.ts b/services/entity_risk_scores/src/v2/models/SecurityEntityRiskScoresResponse.ts index 3f0de34195e1..a1888bf30b8e 100644 --- a/services/entity_risk_scores/src/v2/models/SecurityEntityRiskScoresResponse.ts +++ b/services/entity_risk_scores/src/v2/models/SecurityEntityRiskScoresResponse.ts @@ -7,6 +7,9 @@ import { SecurityEntityRiskScoresMeta } from "./SecurityEntityRiskScoresMeta"; * Response containing a list of entity risk scores */ export class SecurityEntityRiskScoresResponse { + /** + * Array of entity risk score objects. + */ "data": Array; /** * Metadata for pagination diff --git a/services/error_tracking/src/v2/models/CaseRelationships.ts b/services/error_tracking/src/v2/models/CaseRelationships.ts index 63acf85294cc..aa4cb86cd780 100644 --- a/services/error_tracking/src/v2/models/CaseRelationships.ts +++ b/services/error_tracking/src/v2/models/CaseRelationships.ts @@ -20,7 +20,7 @@ export class CaseRelationships { */ "modifiedBy"?: NullableUserRelationship; /** - * Relationship to project + * Relationship to project. */ "project"?: ProjectRelationship; /** diff --git a/services/error_tracking/src/v2/models/IssueCaseRelationships.ts b/services/error_tracking/src/v2/models/IssueCaseRelationships.ts index df9f44e67094..bad85dc61c61 100644 --- a/services/error_tracking/src/v2/models/IssueCaseRelationships.ts +++ b/services/error_tracking/src/v2/models/IssueCaseRelationships.ts @@ -20,7 +20,7 @@ export class IssueCaseRelationships { */ "modifiedBy"?: NullableUserRelationship; /** - * Relationship to project + * Relationship to project. */ "project"?: ProjectRelationship; /** diff --git a/services/error_tracking/src/v2/models/ProjectRelationship.ts b/services/error_tracking/src/v2/models/ProjectRelationship.ts index 99a1bb72d1d5..d32fac838b1e 100644 --- a/services/error_tracking/src/v2/models/ProjectRelationship.ts +++ b/services/error_tracking/src/v2/models/ProjectRelationship.ts @@ -3,11 +3,11 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectRelationshipData } from "./ProjectRelationshipData"; /** - * Relationship to project + * Relationship to project. */ export class ProjectRelationship { /** - * Relationship to project object + * Relationship to project object. */ "data": ProjectRelationshipData; /** diff --git a/services/error_tracking/src/v2/models/ProjectRelationshipData.ts b/services/error_tracking/src/v2/models/ProjectRelationshipData.ts index b73e2e4d845d..bfe7cb3567a9 100644 --- a/services/error_tracking/src/v2/models/ProjectRelationshipData.ts +++ b/services/error_tracking/src/v2/models/ProjectRelationshipData.ts @@ -3,15 +3,15 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProjectResourceType } from "./ProjectResourceType"; /** - * Relationship to project object + * Relationship to project object. */ export class ProjectRelationshipData { /** - * A unique identifier that represents the project + * A unique identifier that represents the project. */ "id": string; /** - * Project resource type + * Project resource type. */ "type": ProjectResourceType; /** diff --git a/services/error_tracking/src/v2/models/ProjectResourceType.ts b/services/error_tracking/src/v2/models/ProjectResourceType.ts index adc5c09ec874..fef2c038e27c 100644 --- a/services/error_tracking/src/v2/models/ProjectResourceType.ts +++ b/services/error_tracking/src/v2/models/ProjectResourceType.ts @@ -1,7 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; /** - * Project resource type + * Project resource type. */ export type ProjectResourceType = typeof PROJECT | UnparsedObject; export const PROJECT = "project"; diff --git a/services/fleet_automation/src/v2/models/FleetAgentAttributesTagsItems.ts b/services/fleet_automation/src/v2/models/FleetAgentAttributesTagsItems.ts index 7ebcf6888a0e..10799376b651 100644 --- a/services/fleet_automation/src/v2/models/FleetAgentAttributesTagsItems.ts +++ b/services/fleet_automation/src/v2/models/FleetAgentAttributesTagsItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A key-value pair representing a tag associated with a Datadog Agent. + */ export class FleetAgentAttributesTagsItems { + /** + * The tag key. + */ "key"?: string; + /** + * The tag value. + */ "value"?: string; /** * A container for additional, undeclared properties. diff --git a/services/fleet_automation/src/v2/models/FleetAgentVersion.ts b/services/fleet_automation/src/v2/models/FleetAgentVersion.ts index 1ac174053612..9d292729e6d5 100644 --- a/services/fleet_automation/src/v2/models/FleetAgentVersion.ts +++ b/services/fleet_automation/src/v2/models/FleetAgentVersion.ts @@ -7,6 +7,9 @@ import { FleetAgentVersionResourceType } from "./FleetAgentVersionResourceType"; * Represents an available Datadog Agent version. */ export class FleetAgentVersion { + /** + * Attributes of an available Datadog Agent version. + */ "attributes"?: FleetAgentVersionAttributes; /** * Unique identifier for the Agent version (same as version). diff --git a/services/fleet_automation/src/v2/models/FleetAgentVersionAttributes.ts b/services/fleet_automation/src/v2/models/FleetAgentVersionAttributes.ts index 46a042caf4cb..f0efff22c7aa 100644 --- a/services/fleet_automation/src/v2/models/FleetAgentVersionAttributes.ts +++ b/services/fleet_automation/src/v2/models/FleetAgentVersionAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of an available Datadog Agent version. + */ export class FleetAgentVersionAttributes { /** * The Agent version string. diff --git a/services/fleet_automation/src/v2/models/FleetAgentsResponseData.ts b/services/fleet_automation/src/v2/models/FleetAgentsResponseData.ts index 0d2651fec2ad..4daf148638a4 100644 --- a/services/fleet_automation/src/v2/models/FleetAgentsResponseData.ts +++ b/services/fleet_automation/src/v2/models/FleetAgentsResponseData.ts @@ -6,6 +6,9 @@ import { FleetAgentsResponseDataAttributes } from "./FleetAgentsResponseDataAttr * The response data containing status and agents array. */ export class FleetAgentsResponseData { + /** + * Attributes of the fleet agents response containing the list of agents. + */ "attributes": FleetAgentsResponseDataAttributes; /** * Status identifier. diff --git a/services/fleet_automation/src/v2/models/FleetAgentsResponseDataAttributes.ts b/services/fleet_automation/src/v2/models/FleetAgentsResponseDataAttributes.ts index 7193036f086e..7b24cfefd6ac 100644 --- a/services/fleet_automation/src/v2/models/FleetAgentsResponseDataAttributes.ts +++ b/services/fleet_automation/src/v2/models/FleetAgentsResponseDataAttributes.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FleetAgentAttributes } from "./FleetAgentAttributes"; +/** + * Attributes of the fleet agents response containing the list of agents. + */ export class FleetAgentsResponseDataAttributes { /** * Array of agents matching the query criteria. diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesRequest.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesRequest.ts index cdcee6698202..11a26f4486cd 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesRequest.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesRequest.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionStatus } from "./HamrOrgConnectionStatus"; +/** + * Attributes for a HAMR organization connection request. + */ export class HamrOrgConnectionAttributesRequest { /** * Status of the HAMR connection: diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesResponse.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesResponse.ts index 4531a152ea39..569e34e44884 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesResponse.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionAttributesResponse.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionStatus } from "./HamrOrgConnectionStatus"; +/** + * Attributes of a HAMR organization connection response. + */ export class HamrOrgConnectionAttributesResponse { /** * Status of the HAMR connection: diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataRequest.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataRequest.ts index 88b1b0a80001..d3302a203b14 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataRequest.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataRequest.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionAttributesRequest } from "./HamrOrgConnectionAttributesRequest"; import { HamrOrgConnectionType } from "./HamrOrgConnectionType"; +/** + * Data object for a HAMR organization connection request. + */ export class HamrOrgConnectionDataRequest { + /** + * Attributes for a HAMR organization connection request. + */ "attributes": HamrOrgConnectionAttributesRequest; /** * The organization UUID for this HAMR connection. Must match the authenticated organization's UUID. diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataResponse.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataResponse.ts index 586772aa0a2d..5b9d53203a77 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataResponse.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionDataResponse.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionAttributesResponse } from "./HamrOrgConnectionAttributesResponse"; import { HamrOrgConnectionType } from "./HamrOrgConnectionType"; +/** + * Data object for a HAMR organization connection response. + */ export class HamrOrgConnectionDataResponse { + /** + * Attributes of a HAMR organization connection response. + */ "attributes": HamrOrgConnectionAttributesResponse; /** * The organization UUID for this HAMR connection. diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionRequest.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionRequest.ts index 49827a33b90e..052763b172eb 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionRequest.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionDataRequest } from "./HamrOrgConnectionDataRequest"; +/** + * Request payload for creating or updating a HAMR organization connection. + */ export class HamrOrgConnectionRequest { + /** + * Data object for a HAMR organization connection request. + */ "data": HamrOrgConnectionDataRequest; /** * A container for additional, undeclared properties. diff --git a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionResponse.ts b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionResponse.ts index 3390a42d7015..b6ec1d99f9e4 100644 --- a/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionResponse.ts +++ b/services/high_availability_multi_region/src/v2/models/HamrOrgConnectionResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { HamrOrgConnectionDataResponse } from "./HamrOrgConnectionDataResponse"; +/** + * Response payload for a HAMR organization connection. + */ export class HamrOrgConnectionResponse { + /** + * Data object for a HAMR organization connection response. + */ "data": HamrOrgConnectionDataResponse; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/Attachment.ts b/services/incidents/src/v2/models/Attachment.ts index 07eee225caea..84f4dfeb7f1f 100644 --- a/services/incidents/src/v2/models/Attachment.ts +++ b/services/incidents/src/v2/models/Attachment.ts @@ -11,6 +11,9 @@ export class Attachment { * Attachment data from a response. */ "data"?: AttachmentData; + /** + * A list of related objects included in the response. + */ "included"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/AttachmentArray.ts b/services/incidents/src/v2/models/AttachmentArray.ts index 2d5a00f24ca0..99128040b4b0 100644 --- a/services/incidents/src/v2/models/AttachmentArray.ts +++ b/services/incidents/src/v2/models/AttachmentArray.ts @@ -7,7 +7,13 @@ import { AttachmentIncluded } from "./AttachmentIncluded"; * A list of incident attachments. */ export class AttachmentArray { + /** + * An array of attachment data objects. + */ "data": Array; + /** + * A list of related objects included in the response. + */ "included"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/CreateAttachmentRequestData.ts b/services/incidents/src/v2/models/CreateAttachmentRequestData.ts index 7b8992d6439e..cd1cdd618a69 100644 --- a/services/incidents/src/v2/models/CreateAttachmentRequestData.ts +++ b/services/incidents/src/v2/models/CreateAttachmentRequestData.ts @@ -11,6 +11,9 @@ export class CreateAttachmentRequestData { * The attributes for creating an attachment. */ "attributes"?: CreateAttachmentRequestDataAttributes; + /** + * The unique identifier of the attachment. + */ "id"?: string; /** * The incident attachment resource type. diff --git a/services/incidents/src/v2/models/GlobalIncidentSettingsDataRequest.ts b/services/incidents/src/v2/models/GlobalIncidentSettingsDataRequest.ts index 3cc0d557d430..35e7e924425c 100644 --- a/services/incidents/src/v2/models/GlobalIncidentSettingsDataRequest.ts +++ b/services/incidents/src/v2/models/GlobalIncidentSettingsDataRequest.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GlobalIncidentSettingsAttributesRequest } from "./GlobalIncidentSettingsAttributesRequest"; import { GlobalIncidentSettingsType } from "./GlobalIncidentSettingsType"; +/** + * Data object in the global incident settings request. + */ export class GlobalIncidentSettingsDataRequest { /** * Global incident settings attributes diff --git a/services/incidents/src/v2/models/GlobalIncidentSettingsDataResponse.ts b/services/incidents/src/v2/models/GlobalIncidentSettingsDataResponse.ts index 8048bd460311..554e532f3763 100644 --- a/services/incidents/src/v2/models/GlobalIncidentSettingsDataResponse.ts +++ b/services/incidents/src/v2/models/GlobalIncidentSettingsDataResponse.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GlobalIncidentSettingsAttributesResponse } from "./GlobalIncidentSettingsAttributesResponse"; import { GlobalIncidentSettingsType } from "./GlobalIncidentSettingsType"; +/** + * Data object in the global incident settings response. + */ export class GlobalIncidentSettingsDataResponse { /** * Global incident settings attributes diff --git a/services/incidents/src/v2/models/GlobalIncidentSettingsRequest.ts b/services/incidents/src/v2/models/GlobalIncidentSettingsRequest.ts index 5b5a2b02c97e..78b921fef3c0 100644 --- a/services/incidents/src/v2/models/GlobalIncidentSettingsRequest.ts +++ b/services/incidents/src/v2/models/GlobalIncidentSettingsRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GlobalIncidentSettingsDataRequest } from "./GlobalIncidentSettingsDataRequest"; +/** + * Request payload for updating global incident settings. + */ export class GlobalIncidentSettingsRequest { + /** + * Data object in the global incident settings request. + */ "data": GlobalIncidentSettingsDataRequest; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/GlobalIncidentSettingsResponse.ts b/services/incidents/src/v2/models/GlobalIncidentSettingsResponse.ts index ea13e5b27b2e..a67eee41dfd7 100644 --- a/services/incidents/src/v2/models/GlobalIncidentSettingsResponse.ts +++ b/services/incidents/src/v2/models/GlobalIncidentSettingsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GlobalIncidentSettingsDataResponse } from "./GlobalIncidentSettingsDataResponse"; +/** + * Response payload containing global incident settings. + */ export class GlobalIncidentSettingsResponse { + /** + * Data object in the global incident settings response. + */ "data": GlobalIncidentSettingsDataResponse; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/IncidentHandleDataRequest.ts b/services/incidents/src/v2/models/IncidentHandleDataRequest.ts index 94640cc3c35e..27edd9d7a617 100644 --- a/services/incidents/src/v2/models/IncidentHandleDataRequest.ts +++ b/services/incidents/src/v2/models/IncidentHandleDataRequest.ts @@ -4,6 +4,9 @@ import { IncidentHandleAttributesRequest } from "./IncidentHandleAttributesReque import { IncidentHandleRelationshipsRequest } from "./IncidentHandleRelationshipsRequest"; import { IncidentHandleType } from "./IncidentHandleType"; +/** + * Data object representing an incident handle in a create or update request. + */ export class IncidentHandleDataRequest { /** * Incident handle attributes for requests @@ -13,6 +16,9 @@ export class IncidentHandleDataRequest { * The ID of the incident handle (required for PUT requests) */ "id"?: string; + /** + * Relationships to associate with an incident handle in a create or update request. + */ "relationships"?: IncidentHandleRelationshipsRequest; /** * Incident handle resource type diff --git a/services/incidents/src/v2/models/IncidentHandleDataResponse.ts b/services/incidents/src/v2/models/IncidentHandleDataResponse.ts index 3f4e6db68f42..b8465dd97d28 100644 --- a/services/incidents/src/v2/models/IncidentHandleDataResponse.ts +++ b/services/incidents/src/v2/models/IncidentHandleDataResponse.ts @@ -4,6 +4,9 @@ import { IncidentHandleAttributesResponse } from "./IncidentHandleAttributesResp import { IncidentHandleRelationships } from "./IncidentHandleRelationships"; import { IncidentHandleType } from "./IncidentHandleType"; +/** + * Data object representing an incident handle in a response. + */ export class IncidentHandleDataResponse { /** * Incident handle attributes for responses @@ -13,6 +16,9 @@ export class IncidentHandleDataResponse { * The ID of the incident handle */ "id": string; + /** + * Relationships associated with an incident handle response, including linked users and incident type. + */ "relationships"?: IncidentHandleRelationships; /** * Incident handle resource type diff --git a/services/incidents/src/v2/models/IncidentHandleIncludedItemResponse.ts b/services/incidents/src/v2/models/IncidentHandleIncludedItemResponse.ts index ae17c4fc5901..73d703540914 100644 --- a/services/incidents/src/v2/models/IncidentHandleIncludedItemResponse.ts +++ b/services/incidents/src/v2/models/IncidentHandleIncludedItemResponse.ts @@ -2,6 +2,10 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; import { IncidentTypeObject } from "./IncidentTypeObject"; import { IncidentUserData } from "./IncidentUserData"; + +/** + * A single included resource item in an incident handle response, which can be a user or an incident type. + */ export type IncidentHandleIncludedItemResponse = | IncidentUserData | IncidentTypeObject diff --git a/services/incidents/src/v2/models/IncidentHandleRelationship.ts b/services/incidents/src/v2/models/IncidentHandleRelationship.ts index 905915a15e9e..7bab8af6ec5d 100644 --- a/services/incidents/src/v2/models/IncidentHandleRelationship.ts +++ b/services/incidents/src/v2/models/IncidentHandleRelationship.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleRelationshipData } from "./IncidentHandleRelationshipData"; +/** + * A single relationship object for an incident handle, wrapping the related resource data. + */ export class IncidentHandleRelationship { + /** + * Relationship data for an incident handle, containing the ID and type of the related resource. + */ "data": IncidentHandleRelationshipData; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/IncidentHandleRelationshipData.ts b/services/incidents/src/v2/models/IncidentHandleRelationshipData.ts index 80f5cc1682d0..e4fbdd03c3da 100644 --- a/services/incidents/src/v2/models/IncidentHandleRelationshipData.ts +++ b/services/incidents/src/v2/models/IncidentHandleRelationshipData.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Relationship data for an incident handle, containing the ID and type of the related resource. + */ export class IncidentHandleRelationshipData { /** * The ID of the related resource diff --git a/services/incidents/src/v2/models/IncidentHandleRelationships.ts b/services/incidents/src/v2/models/IncidentHandleRelationships.ts index 3e6809ad6017..d730412fe556 100644 --- a/services/incidents/src/v2/models/IncidentHandleRelationships.ts +++ b/services/incidents/src/v2/models/IncidentHandleRelationships.ts @@ -2,10 +2,25 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleRelationship } from "./IncidentHandleRelationship"; +/** + * Relationships associated with an incident handle response, including linked users and incident type. + */ export class IncidentHandleRelationships { + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "commanderUser"?: IncidentHandleRelationship; + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "createdByUser": IncidentHandleRelationship; + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "incidentType": IncidentHandleRelationship; + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "lastModifiedByUser": IncidentHandleRelationship; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/IncidentHandleRelationshipsRequest.ts b/services/incidents/src/v2/models/IncidentHandleRelationshipsRequest.ts index 4b40f647593f..8021749f53c9 100644 --- a/services/incidents/src/v2/models/IncidentHandleRelationshipsRequest.ts +++ b/services/incidents/src/v2/models/IncidentHandleRelationshipsRequest.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleRelationship } from "./IncidentHandleRelationship"; +/** + * Relationships to associate with an incident handle in a create or update request. + */ export class IncidentHandleRelationshipsRequest { + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "commanderUser"?: IncidentHandleRelationship; + /** + * A single relationship object for an incident handle, wrapping the related resource data. + */ "incidentType": IncidentHandleRelationship; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/IncidentHandleRequest.ts b/services/incidents/src/v2/models/IncidentHandleRequest.ts index 5aecd89d44d8..5bcd4f743450 100644 --- a/services/incidents/src/v2/models/IncidentHandleRequest.ts +++ b/services/incidents/src/v2/models/IncidentHandleRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleDataRequest } from "./IncidentHandleDataRequest"; +/** + * Request payload for creating or updating a global incident handle. + */ export class IncidentHandleRequest { + /** + * Data object representing an incident handle in a create or update request. + */ "data": IncidentHandleDataRequest; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/IncidentHandleResponse.ts b/services/incidents/src/v2/models/IncidentHandleResponse.ts index 85ee8e3ff3c6..eb5dbfe9eaf7 100644 --- a/services/incidents/src/v2/models/IncidentHandleResponse.ts +++ b/services/incidents/src/v2/models/IncidentHandleResponse.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleDataResponse } from "./IncidentHandleDataResponse"; import { IncidentHandleIncludedItemResponse } from "./IncidentHandleIncludedItemResponse"; +/** + * Response payload for a single incident handle, including the handle data and related resources. + */ export class IncidentHandleResponse { + /** + * Data object representing an incident handle in a response. + */ "data": IncidentHandleDataResponse; /** * Included related resources diff --git a/services/incidents/src/v2/models/IncidentHandlesResponse.ts b/services/incidents/src/v2/models/IncidentHandlesResponse.ts index 58b19f0f2c3b..f989303ca356 100644 --- a/services/incidents/src/v2/models/IncidentHandlesResponse.ts +++ b/services/incidents/src/v2/models/IncidentHandlesResponse.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { IncidentHandleDataResponse } from "./IncidentHandleDataResponse"; import { IncidentHandleIncludedItemResponse } from "./IncidentHandleIncludedItemResponse"; +/** + * Response payload for a list of global incident handles, including handle data and related resources. + */ export class IncidentHandlesResponse { + /** + * Array of incident handle data objects returned in a list response. + */ "data": Array; /** * Included related resources diff --git a/services/incidents/src/v2/models/PostmortemAttachmentRequest.ts b/services/incidents/src/v2/models/PostmortemAttachmentRequest.ts index 792c344c964e..b2443a9ac3b9 100644 --- a/services/incidents/src/v2/models/PostmortemAttachmentRequest.ts +++ b/services/incidents/src/v2/models/PostmortemAttachmentRequest.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemAttachmentRequestData } from "./PostmortemAttachmentRequestData"; +/** + * Request body for creating a postmortem attachment. + */ export class PostmortemAttachmentRequest { /** * Postmortem attachment data diff --git a/services/incidents/src/v2/models/PostmortemTemplateAttributesRequest.ts b/services/incidents/src/v2/models/PostmortemTemplateAttributesRequest.ts index 773e2aab81fe..3b6bdcbeb874 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateAttributesRequest.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateAttributesRequest.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for creating or updating a postmortem template. + */ export class PostmortemTemplateAttributesRequest { /** * The name of the template diff --git a/services/incidents/src/v2/models/PostmortemTemplateAttributesResponse.ts b/services/incidents/src/v2/models/PostmortemTemplateAttributesResponse.ts index 8cb695b4adb6..140a43354fee 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateAttributesResponse.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateAttributesResponse.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a postmortem template returned in a response. + */ export class PostmortemTemplateAttributesResponse { /** * When the template was created diff --git a/services/incidents/src/v2/models/PostmortemTemplateDataRequest.ts b/services/incidents/src/v2/models/PostmortemTemplateDataRequest.ts index 289820affb29..6d25d9cedf12 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateDataRequest.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateDataRequest.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemTemplateAttributesRequest } from "./PostmortemTemplateAttributesRequest"; import { PostmortemTemplateType } from "./PostmortemTemplateType"; +/** + * Data object for creating or updating a postmortem template. + */ export class PostmortemTemplateDataRequest { + /** + * Attributes for creating or updating a postmortem template. + */ "attributes": PostmortemTemplateAttributesRequest; /** * Postmortem template resource type diff --git a/services/incidents/src/v2/models/PostmortemTemplateDataResponse.ts b/services/incidents/src/v2/models/PostmortemTemplateDataResponse.ts index bab7a9f902ea..4d7cd8b9b366 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateDataResponse.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateDataResponse.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemTemplateAttributesResponse } from "./PostmortemTemplateAttributesResponse"; import { PostmortemTemplateType } from "./PostmortemTemplateType"; +/** + * Data object for a postmortem template returned in a response. + */ export class PostmortemTemplateDataResponse { + /** + * Attributes of a postmortem template returned in a response. + */ "attributes": PostmortemTemplateAttributesResponse; /** * The ID of the template diff --git a/services/incidents/src/v2/models/PostmortemTemplateRequest.ts b/services/incidents/src/v2/models/PostmortemTemplateRequest.ts index 1f15b58d9233..a8e8f8ebf5fb 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateRequest.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemTemplateDataRequest } from "./PostmortemTemplateDataRequest"; +/** + * Request body for creating or updating a postmortem template. + */ export class PostmortemTemplateRequest { + /** + * Data object for creating or updating a postmortem template. + */ "data": PostmortemTemplateDataRequest; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/PostmortemTemplateResponse.ts b/services/incidents/src/v2/models/PostmortemTemplateResponse.ts index 6f6949df9a58..bdbb84be2328 100644 --- a/services/incidents/src/v2/models/PostmortemTemplateResponse.ts +++ b/services/incidents/src/v2/models/PostmortemTemplateResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemTemplateDataResponse } from "./PostmortemTemplateDataResponse"; +/** + * Response containing a single postmortem template. + */ export class PostmortemTemplateResponse { + /** + * Data object for a postmortem template returned in a response. + */ "data": PostmortemTemplateDataResponse; /** * A container for additional, undeclared properties. diff --git a/services/incidents/src/v2/models/PostmortemTemplatesResponse.ts b/services/incidents/src/v2/models/PostmortemTemplatesResponse.ts index 984c6303bee3..e6dcda649de5 100644 --- a/services/incidents/src/v2/models/PostmortemTemplatesResponse.ts +++ b/services/incidents/src/v2/models/PostmortemTemplatesResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PostmortemTemplateDataResponse } from "./PostmortemTemplateDataResponse"; +/** + * Response containing a list of postmortem templates. + */ export class PostmortemTemplatesResponse { + /** + * An array of postmortem template data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/llm_observability/src/v2/models/AnyValueItem.ts b/services/llm_observability/src/v2/models/AnyValueItem.ts index bb1a0443dbe2..1e6bacc9b12f 100644 --- a/services/llm_observability/src/v2/models/AnyValueItem.ts +++ b/services/llm_observability/src/v2/models/AnyValueItem.ts @@ -1,5 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; +/** + * A single item in an array of arbitrary values, which can be a string, number, object, or boolean. + */ export type AnyValueItem = | string | number diff --git a/services/metrics/src/v2/models/TimeseriesResponseSeries.ts b/services/metrics/src/v2/models/TimeseriesResponseSeries.ts index 12b94b5790d0..9bd2c5963df6 100644 --- a/services/metrics/src/v2/models/TimeseriesResponseSeries.ts +++ b/services/metrics/src/v2/models/TimeseriesResponseSeries.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { Unit } from "./Unit"; +/** + * A single series in a timeseries query response, containing the query index, unit information, and group tags. + */ export class TimeseriesResponseSeries { /** * List of tags that apply to a single response value. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigData.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigData.ts index 69001b658f57..a5bee138fc41 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigData.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateTenancyConfigDataAttributes } from "./CreateTenancyConfigDataAttributes"; import { UpdateTenancyConfigDataType } from "./UpdateTenancyConfigDataType"; +/** + * The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes. + */ export class CreateTenancyConfigData { + /** + * Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. + */ "attributes"?: CreateTenancyConfigDataAttributes; + /** + * The OCID of the OCI tenancy to configure. + */ "id": string; /** * OCI tenancy resource type. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributes.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributes.ts index 1b0908654cc1..fe9aa94adfab 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributes.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributes.ts @@ -5,17 +5,53 @@ import { CreateTenancyConfigDataAttributesLogsConfig } from "./CreateTenancyConf import { CreateTenancyConfigDataAttributesMetricsConfig } from "./CreateTenancyConfigDataAttributesMetricsConfig"; import { CreateTenancyConfigDataAttributesRegionsConfig } from "./CreateTenancyConfigDataAttributesRegionsConfig"; +/** + * Attributes for creating a new OCI tenancy integration configuration, including credentials, region settings, and collection options. + */ export class CreateTenancyConfigDataAttributes { + /** + * OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. + */ "authCredentials": CreateTenancyConfigDataAttributesAuthCredentials; + /** + * Version number of the integration the tenancy is integrated with + */ "configVersion"?: number; + /** + * Whether cost data collection from OCI is enabled for the tenancy. + */ "costCollectionEnabled"?: boolean; + /** + * The OCID of the OCI compartment used by the Datadog integration stack. + */ "ddCompartmentId"?: string; + /** + * The OCID of the OCI Resource Manager stack used by the Datadog integration. + */ "ddStackId"?: string; + /** + * The home region of the OCI tenancy (for example, us-ashburn-1). + */ "homeRegion": string; + /** + * Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. + */ "logsConfig"?: CreateTenancyConfigDataAttributesLogsConfig; + /** + * Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. + */ "metricsConfig"?: CreateTenancyConfigDataAttributesMetricsConfig; + /** + * Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. + */ "regionsConfig"?: CreateTenancyConfigDataAttributesRegionsConfig; + /** + * Whether resource collection from OCI is enabled for the tenancy. + */ "resourceCollectionEnabled"?: boolean; + /** + * The OCID of the OCI user used by the Datadog integration for authentication. + */ "userOcid": string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesAuthCredentials.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesAuthCredentials.ts index 710b88f93011..0672c3b0a715 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesAuthCredentials.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesAuthCredentials.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * OCI API signing key credentials used to authenticate the Datadog integration with the OCI tenancy. + */ export class CreateTenancyConfigDataAttributesAuthCredentials { + /** + * The fingerprint of the OCI API signing key used for authentication. + */ "fingerprint"?: string; + /** + * The PEM-encoded private key corresponding to the OCI API signing key fingerprint. + */ "privateKey": string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesLogsConfig.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesLogsConfig.ts index 159688653526..5f96deb60f93 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesLogsConfig.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesLogsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Log collection configuration for an OCI tenancy, controlling which compartments and services have log collection enabled. + */ export class CreateTenancyConfigDataAttributesLogsConfig { + /** + * List of compartment tag filters to scope log collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether log collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names for which log collection is enabled. + */ "enabledServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesMetricsConfig.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesMetricsConfig.ts index 061d2a2ffeb9..a658ef250ed2 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesMetricsConfig.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesMetricsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Metrics collection configuration for an OCI tenancy, controlling which compartments and services are included or excluded. + */ export class CreateTenancyConfigDataAttributesMetricsConfig { + /** + * List of compartment tag filters to scope metrics collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether metrics collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names to exclude from metrics collection. + */ "excludedServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesRegionsConfig.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesRegionsConfig.ts index 025d40d18635..514d401fefc4 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesRegionsConfig.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigDataAttributesRegionsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Region configuration for an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. + */ export class CreateTenancyConfigDataAttributesRegionsConfig { + /** + * List of OCI regions available for data collection in the tenancy. + */ "available"?: Array; + /** + * List of OCI regions explicitly disabled for data collection. + */ "disabled"?: Array; + /** + * List of OCI regions enabled for data collection. + */ "enabled"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/CreateTenancyConfigRequest.ts b/services/oci_integration/src/v2/models/CreateTenancyConfigRequest.ts index 28ce225147b2..f6daf989676e 100644 --- a/services/oci_integration/src/v2/models/CreateTenancyConfigRequest.ts +++ b/services/oci_integration/src/v2/models/CreateTenancyConfigRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateTenancyConfigData } from "./CreateTenancyConfigData"; +/** + * Request body for creating a new OCI tenancy integration configuration. + */ export class CreateTenancyConfigRequest { + /** + * The data object for creating a new OCI tenancy integration configuration, including the tenancy ID, type, and configuration attributes. + */ "data": CreateTenancyConfigData; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfig.ts b/services/oci_integration/src/v2/models/TenancyConfig.ts index 6b28ba20a97c..a0c0e86e2371 100644 --- a/services/oci_integration/src/v2/models/TenancyConfig.ts +++ b/services/oci_integration/src/v2/models/TenancyConfig.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyConfigData } from "./TenancyConfigData"; +/** + * Response containing a single OCI tenancy integration configuration. + */ export class TenancyConfig { + /** + * A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes. + */ "data"?: TenancyConfigData; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfigData.ts b/services/oci_integration/src/v2/models/TenancyConfigData.ts index c458ba24ad79..7f9667a88eb6 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigData.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyConfigDataAttributes } from "./TenancyConfigDataAttributes"; import { UpdateTenancyConfigDataType } from "./UpdateTenancyConfigDataType"; +/** + * A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes. + */ export class TenancyConfigData { + /** + * Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. + */ "attributes"?: TenancyConfigDataAttributes; + /** + * The OCID of the OCI tenancy. + */ "id"?: string; /** * OCI tenancy resource type. diff --git a/services/oci_integration/src/v2/models/TenancyConfigDataAttributes.ts b/services/oci_integration/src/v2/models/TenancyConfigDataAttributes.ts index b7ad50f1f216..cddf7611ddf0 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigDataAttributes.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigDataAttributes.ts @@ -4,19 +4,61 @@ import { TenancyConfigDataAttributesLogsConfig } from "./TenancyConfigDataAttrib import { TenancyConfigDataAttributesMetricsConfig } from "./TenancyConfigDataAttributesMetricsConfig"; import { TenancyConfigDataAttributesRegionsConfig } from "./TenancyConfigDataAttributesRegionsConfig"; +/** + * Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options. + */ export class TenancyConfigDataAttributes { + /** + * The identifier of the billing plan associated with the OCI tenancy. + */ "billingPlanId"?: number; + /** + * Version number of the integration the tenancy is integrated with + */ "configVersion"?: number; + /** + * Whether cost data collection from OCI is enabled for the tenancy. + */ "costCollectionEnabled"?: boolean; + /** + * The OCID of the OCI compartment used by the Datadog integration stack. + */ "ddCompartmentId"?: string; + /** + * The OCID of the OCI Resource Manager stack used by the Datadog integration. + */ "ddStackId"?: string; + /** + * The home region of the OCI tenancy (for example, us-ashburn-1). + */ "homeRegion"?: string; + /** + * Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. + */ "logsConfig"?: TenancyConfigDataAttributesLogsConfig; + /** + * Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. + */ "metricsConfig"?: TenancyConfigDataAttributesMetricsConfig; + /** + * The name of the parent OCI tenancy, if applicable. + */ "parentTenancyName"?: string; + /** + * Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. + */ "regionsConfig"?: TenancyConfigDataAttributesRegionsConfig; + /** + * Whether resource collection from OCI is enabled for the tenancy. + */ "resourceCollectionEnabled"?: boolean; + /** + * The human-readable name of the OCI tenancy. + */ "tenancyName"?: string; + /** + * The OCID of the OCI user used by the Datadog integration for authentication. + */ "userOcid"?: string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesLogsConfig.ts b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesLogsConfig.ts index c511c1fda88b..85cb0ff888fc 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesLogsConfig.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesLogsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled. + */ export class TenancyConfigDataAttributesLogsConfig { + /** + * List of compartment tag filters scoping log collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether log collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names for which log collection is enabled. + */ "enabledServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesMetricsConfig.ts b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesMetricsConfig.ts index 891edc3a962f..b4cfcd9155c2 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesMetricsConfig.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesMetricsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded. + */ export class TenancyConfigDataAttributesMetricsConfig { + /** + * List of compartment tag filters scoping metrics collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether metrics collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names excluded from metrics collection. + */ "excludedServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesRegionsConfig.ts b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesRegionsConfig.ts index 45852dc401f3..d2a80b89aead 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigDataAttributesRegionsConfig.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigDataAttributesRegionsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection. + */ export class TenancyConfigDataAttributesRegionsConfig { + /** + * List of OCI regions available for data collection in the tenancy. + */ "available"?: Array; + /** + * List of OCI regions explicitly disabled for data collection. + */ "disabled"?: Array; + /** + * List of OCI regions enabled for data collection. + */ "enabled"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyConfigList.ts b/services/oci_integration/src/v2/models/TenancyConfigList.ts index 97bac820ba3d..aa648e366697 100644 --- a/services/oci_integration/src/v2/models/TenancyConfigList.ts +++ b/services/oci_integration/src/v2/models/TenancyConfigList.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyConfigData } from "./TenancyConfigData"; +/** + * Response containing a list of OCI tenancy integration configurations. + */ export class TenancyConfigList { + /** + * List of OCI tenancy integration configuration objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyProductsData.ts b/services/oci_integration/src/v2/models/TenancyProductsData.ts index 242e4a3fc281..af3f8e723988 100644 --- a/services/oci_integration/src/v2/models/TenancyProductsData.ts +++ b/services/oci_integration/src/v2/models/TenancyProductsData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyProductsDataAttributes } from "./TenancyProductsDataAttributes"; import { TenancyProductsDataType } from "./TenancyProductsDataType"; +/** + * A single OCI tenancy product resource object containing the tenancy ID, type, and product attributes. + */ export class TenancyProductsData { + /** + * Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. + */ "attributes"?: TenancyProductsDataAttributes; + /** + * The OCID of the OCI tenancy. + */ "id"?: string; /** * OCI tenancy product resource type. diff --git a/services/oci_integration/src/v2/models/TenancyProductsDataAttributes.ts b/services/oci_integration/src/v2/models/TenancyProductsDataAttributes.ts index 6545f0b40cc8..1f48625d825e 100644 --- a/services/oci_integration/src/v2/models/TenancyProductsDataAttributes.ts +++ b/services/oci_integration/src/v2/models/TenancyProductsDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyProductsDataAttributesProductsItems } from "./TenancyProductsDataAttributesProductsItems"; +/** + * Attributes of an OCI tenancy product resource, containing the list of available products and their enablement status. + */ export class TenancyProductsDataAttributes { + /** + * List of Datadog products and their enablement status for the tenancy. + */ "products"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyProductsDataAttributesProductsItems.ts b/services/oci_integration/src/v2/models/TenancyProductsDataAttributesProductsItems.ts index 1cd728bb6e96..105aad52767a 100644 --- a/services/oci_integration/src/v2/models/TenancyProductsDataAttributesProductsItems.ts +++ b/services/oci_integration/src/v2/models/TenancyProductsDataAttributesProductsItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * An individual Datadog product with its enablement status for a tenancy. + */ export class TenancyProductsDataAttributesProductsItems { + /** + * Indicates whether the product is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * The unique key identifying the Datadog product (for example, CLOUD_SECURITY_POSTURE_MANAGEMENT). + */ "productKey"?: string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/TenancyProductsList.ts b/services/oci_integration/src/v2/models/TenancyProductsList.ts index d94afbdb9497..342ac67cb51a 100644 --- a/services/oci_integration/src/v2/models/TenancyProductsList.ts +++ b/services/oci_integration/src/v2/models/TenancyProductsList.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { TenancyProductsData } from "./TenancyProductsData"; +/** + * Response containing a list of OCI tenancy product resources with their product enablement status. + */ export class TenancyProductsList { + /** + * List of OCI tenancy product resource objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigData.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigData.ts index 4a245d0b1b8a..1961246ec50c 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigData.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { UpdateTenancyConfigDataAttributes } from "./UpdateTenancyConfigDataAttributes"; import { UpdateTenancyConfigDataType } from "./UpdateTenancyConfigDataType"; +/** + * The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes. + */ export class UpdateTenancyConfigData { + /** + * Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options. + */ "attributes"?: UpdateTenancyConfigDataAttributes; + /** + * The OCID of the OCI tenancy to update. + */ "id": string; /** * OCI tenancy resource type. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributes.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributes.ts index 0d28856c9970..13ec2f6975f7 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributes.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributes.ts @@ -5,14 +5,41 @@ import { UpdateTenancyConfigDataAttributesLogsConfig } from "./UpdateTenancyConf import { UpdateTenancyConfigDataAttributesMetricsConfig } from "./UpdateTenancyConfigDataAttributesMetricsConfig"; import { UpdateTenancyConfigDataAttributesRegionsConfig } from "./UpdateTenancyConfigDataAttributesRegionsConfig"; +/** + * Attributes for updating an existing OCI tenancy integration configuration, including optional credentials, region settings, and collection options. + */ export class UpdateTenancyConfigDataAttributes { + /** + * OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. + */ "authCredentials"?: UpdateTenancyConfigDataAttributesAuthCredentials; + /** + * Whether cost data collection from OCI is enabled for the tenancy. + */ "costCollectionEnabled"?: boolean; + /** + * The home region of the OCI tenancy (for example, us-ashburn-1). + */ "homeRegion"?: string; + /** + * Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. + */ "logsConfig"?: UpdateTenancyConfigDataAttributesLogsConfig; + /** + * Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. + */ "metricsConfig"?: UpdateTenancyConfigDataAttributesMetricsConfig; + /** + * Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. + */ "regionsConfig"?: UpdateTenancyConfigDataAttributesRegionsConfig; + /** + * Whether resource collection from OCI is enabled for the tenancy. + */ "resourceCollectionEnabled"?: boolean; + /** + * The OCID of the OCI user used by the Datadog integration for authentication. + */ "userOcid"?: string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesAuthCredentials.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesAuthCredentials.ts index 2a06cf46f032..61c867bef05a 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesAuthCredentials.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesAuthCredentials.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * OCI API signing key credentials used to update the Datadog integration's authentication with the OCI tenancy. + */ export class UpdateTenancyConfigDataAttributesAuthCredentials { + /** + * The fingerprint of the OCI API signing key used for authentication. + */ "fingerprint"?: string; + /** + * The PEM-encoded private key corresponding to the OCI API signing key fingerprint. + */ "privateKey": string; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesLogsConfig.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesLogsConfig.ts index 76969725c892..dd49c983cf71 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesLogsConfig.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesLogsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Log collection configuration for updating an OCI tenancy, controlling which compartments and services have log collection enabled. + */ export class UpdateTenancyConfigDataAttributesLogsConfig { + /** + * List of compartment tag filters to scope log collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether log collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names for which log collection is enabled. + */ "enabledServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesMetricsConfig.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesMetricsConfig.ts index a72eb9ddf41c..2142789d2b0c 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesMetricsConfig.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesMetricsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Metrics collection configuration for updating an OCI tenancy, controlling which compartments and services are included or excluded. + */ export class UpdateTenancyConfigDataAttributesMetricsConfig { + /** + * List of compartment tag filters to scope metrics collection to specific compartments. + */ "compartmentTagFilters"?: Array; + /** + * Whether metrics collection is enabled for the tenancy. + */ "enabled"?: boolean; + /** + * List of OCI service names to exclude from metrics collection. + */ "excludedServices"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesRegionsConfig.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesRegionsConfig.ts index d332a626ef6f..b9e6cb4efe01 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesRegionsConfig.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigDataAttributesRegionsConfig.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Region configuration for updating an OCI tenancy, specifying which regions are available, enabled, or disabled for data collection. + */ export class UpdateTenancyConfigDataAttributesRegionsConfig { + /** + * List of OCI regions available for data collection in the tenancy. + */ "available"?: Array; + /** + * List of OCI regions explicitly disabled for data collection. + */ "disabled"?: Array; + /** + * List of OCI regions enabled for data collection. + */ "enabled"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/oci_integration/src/v2/models/UpdateTenancyConfigRequest.ts b/services/oci_integration/src/v2/models/UpdateTenancyConfigRequest.ts index 06128ac4d40f..a9f274dead84 100644 --- a/services/oci_integration/src/v2/models/UpdateTenancyConfigRequest.ts +++ b/services/oci_integration/src/v2/models/UpdateTenancyConfigRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { UpdateTenancyConfigData } from "./UpdateTenancyConfigData"; +/** + * Request body for updating an existing OCI tenancy integration configuration. + */ export class UpdateTenancyConfigRequest { + /** + * The data object for updating an existing OCI tenancy integration configuration, including the tenancy ID, type, and updated attributes. + */ "data": UpdateTenancyConfigData; /** * A container for additional, undeclared properties. diff --git a/services/on_call/src/v2/models/ListNotificationChannelsResponse.ts b/services/on_call/src/v2/models/ListNotificationChannelsResponse.ts index 8bb3588f6da6..b4b10f28f3a0 100644 --- a/services/on_call/src/v2/models/ListNotificationChannelsResponse.ts +++ b/services/on_call/src/v2/models/ListNotificationChannelsResponse.ts @@ -6,6 +6,9 @@ import { NotificationChannelData } from "./NotificationChannelData"; * Response type for listing notification channels for a user */ export class ListNotificationChannelsResponse { + /** + * Array of notification channel data objects. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/on_call/src/v2/models/ListOnCallNotificationRulesResponse.ts b/services/on_call/src/v2/models/ListOnCallNotificationRulesResponse.ts index 3ab70b7ee35e..ad611d1916dd 100644 --- a/services/on_call/src/v2/models/ListOnCallNotificationRulesResponse.ts +++ b/services/on_call/src/v2/models/ListOnCallNotificationRulesResponse.ts @@ -7,6 +7,9 @@ import { OnCallNotificationRulesIncluded } from "./OnCallNotificationRulesInclud * Response type for listing notification rules for a user */ export class ListOnCallNotificationRulesResponse { + /** + * Array of notification rule data objects. + */ "data"?: Array; "included"?: Array; /** diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsInterval.ts b/services/product_analytics/src/v2/models/ProductAnalyticsInterval.ts index efb93da7b6cf..a60cd7aac20a 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsInterval.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsInterval.ts @@ -4,9 +4,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; * An interval definition in a timeseries response. */ export class ProductAnalyticsInterval { + /** + * The duration of each time bucket in milliseconds. + */ "milliseconds"?: number; + /** + * The start of this interval as an epoch timestamp in milliseconds. + */ "startTime"?: number; + /** + * Epoch timestamps (in milliseconds) for each bucket in this interval. + */ "times"?: Array; + /** + * The interval type (e.g., fixed or auto-computed bucket size). + */ "type"?: string; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsResponseMeta.ts b/services/product_analytics/src/v2/models/ProductAnalyticsResponseMeta.ts index 639829647323..554b4b76104d 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsResponseMeta.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsResponseMeta.ts @@ -6,7 +6,13 @@ import { ProductAnalyticsResponseMetaStatus } from "./ProductAnalyticsResponseMe * Metadata for a Product Analytics query response. */ export class ProductAnalyticsResponseMeta { + /** + * Unique identifier for the request, used for multi-step query continuation. + */ "requestId"?: string; + /** + * The execution status of a Product Analytics query. + */ "status"?: ProductAnalyticsResponseMetaStatus; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsResponseMetaStatus.ts b/services/product_analytics/src/v2/models/ProductAnalyticsResponseMetaStatus.ts index b5c2df08a7a0..a75339eeda37 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsResponseMetaStatus.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsResponseMetaStatus.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The execution status of a Product Analytics query. + */ export type ProductAnalyticsResponseMetaStatus = | typeof DONE | typeof RUNNING diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumn.ts b/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumn.ts index fed140fd849a..f6ac23e7312a 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumn.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumn.ts @@ -7,6 +7,9 @@ import { ProductAnalyticsScalarColumnType } from "./ProductAnalyticsScalarColumn * A column in a scalar response. */ export class ProductAnalyticsScalarColumn { + /** + * Metadata associated with a scalar response column, including optional unit information. + */ "meta"?: ProductAnalyticsScalarColumnMeta; /** * Column name (facet name for group-by, or "query"). diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumnMeta.ts b/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumnMeta.ts index 30a904312569..f4587f5acd93 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumnMeta.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsScalarColumnMeta.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProductAnalyticsUnit } from "./ProductAnalyticsUnit"; +/** + * Metadata associated with a scalar response column, including optional unit information. + */ export class ProductAnalyticsScalarColumnMeta { + /** + * Unit definitions for the column values, if applicable. + */ "unit"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseAttributes.ts b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseAttributes.ts index 86f038d71c86..3d6db13d8cb1 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseAttributes.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProductAnalyticsScalarColumn } from "./ProductAnalyticsScalarColumn"; +/** + * Attributes of a scalar analytics response, containing the result columns. + */ export class ProductAnalyticsScalarResponseAttributes { + /** + * The list of result columns, each containing values and metadata. + */ "columns"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseData.ts b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseData.ts index f9d633514ca6..9576c8143535 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseData.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseData.ts @@ -7,8 +7,17 @@ import { ProductAnalyticsScalarResponseType } from "./ProductAnalyticsScalarResp * Data object for a scalar response. */ export class ProductAnalyticsScalarResponseData { + /** + * Attributes of a scalar analytics response, containing the result columns. + */ "attributes"?: ProductAnalyticsScalarResponseAttributes; + /** + * Unique identifier for this response data object. + */ "id"?: string; + /** + * The resource type identifier for a scalar analytics response. + */ "type"?: ProductAnalyticsScalarResponseType; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseType.ts b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseType.ts index 08eaad564f52..46cd4cd21828 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseType.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsScalarResponseType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The resource type identifier for a scalar analytics response. + */ export type ProductAnalyticsScalarResponseType = | typeof SCALAR_RESPONSE | UnparsedObject; diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsSerie.ts b/services/product_analytics/src/v2/models/ProductAnalyticsSerie.ts index be03faa90a13..874151a0832c 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsSerie.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsSerie.ts @@ -6,8 +6,17 @@ import { ProductAnalyticsUnit } from "./ProductAnalyticsUnit"; * A series in a timeseries response. */ export class ProductAnalyticsSerie { + /** + * The group-by tag values that identify this series. + */ "groupTags"?: Array; + /** + * The index of the query that produced this series. + */ "queryIndex"?: number; + /** + * Unit definitions for the series values. + */ "unit"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponse.ts b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponse.ts index 195906c0eada..f4fb6beb6ec8 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponse.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponse.ts @@ -7,6 +7,9 @@ import { ProductAnalyticsTimeseriesResponseData } from "./ProductAnalyticsTimese * Response for a timeseries analytics query. */ export class ProductAnalyticsTimeseriesResponse { + /** + * Data object for a timeseries analytics response. + */ "data"?: ProductAnalyticsTimeseriesResponseData; /** * Metadata for a Product Analytics query response. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseAttributes.ts b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseAttributes.ts index 63af83deb2c1..421b848dc163 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseAttributes.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseAttributes.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProductAnalyticsInterval } from "./ProductAnalyticsInterval"; import { ProductAnalyticsSerie } from "./ProductAnalyticsSerie"; +/** + * Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. + */ export class ProductAnalyticsTimeseriesResponseAttributes { + /** + * Interval definitions describing the time buckets used in the response. + */ "intervals"?: Array; + /** + * The list of series, each corresponding to a query or group-by combination. + */ "series"?: Array; /** * Timestamps for each data point (epoch milliseconds). diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseData.ts b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseData.ts index 38e0e6c12668..9a5a26605a92 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseData.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseData.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ProductAnalyticsTimeseriesResponseAttributes } from "./ProductAnalyticsTimeseriesResponseAttributes"; import { ProductAnalyticsTimeseriesResponseType } from "./ProductAnalyticsTimeseriesResponseType"; +/** + * Data object for a timeseries analytics response. + */ export class ProductAnalyticsTimeseriesResponseData { + /** + * Attributes of a timeseries analytics response, containing series data, timestamps, and interval definitions. + */ "attributes"?: ProductAnalyticsTimeseriesResponseAttributes; + /** + * Unique identifier for this response data object. + */ "id"?: string; + /** + * The resource type identifier for a timeseries analytics response. + */ "type"?: ProductAnalyticsTimeseriesResponseType; /** * A container for additional, undeclared properties. diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseType.ts b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseType.ts index a4fc36b79706..181b4fe7cde5 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseType.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsTimeseriesResponseType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The resource type identifier for a timeseries analytics response. + */ export type ProductAnalyticsTimeseriesResponseType = | typeof TIMESERIES_RESPONSE | UnparsedObject; diff --git a/services/product_analytics/src/v2/models/ProductAnalyticsUnit.ts b/services/product_analytics/src/v2/models/ProductAnalyticsUnit.ts index f9a3d59e81ca..d1e74cdc80c9 100644 --- a/services/product_analytics/src/v2/models/ProductAnalyticsUnit.ts +++ b/services/product_analytics/src/v2/models/ProductAnalyticsUnit.ts @@ -4,11 +4,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; * A unit definition for metric values. */ export class ProductAnalyticsUnit { + /** + * The unit family (e.g., time, bytes). + */ "family"?: string; + /** + * Numeric identifier for the unit. + */ "id"?: number; + /** + * The full name of the unit (e.g., nanosecond). + */ "name"?: string; + /** + * Plural form of the unit name (e.g., nanoseconds). + */ "plural"?: string; + /** + * Conversion factor relative to the base unit of the family. + */ "scaleFactor"?: number; + /** + * Abbreviated unit name (e.g., ns). + */ "shortName"?: string; /** * A container for additional, undeclared properties. diff --git a/services/reference_tables/src/v2/models/BatchDeleteRowsRequestArray.ts b/services/reference_tables/src/v2/models/BatchDeleteRowsRequestArray.ts index 79b38d088064..f79189d052f5 100644 --- a/services/reference_tables/src/v2/models/BatchDeleteRowsRequestArray.ts +++ b/services/reference_tables/src/v2/models/BatchDeleteRowsRequestArray.ts @@ -6,6 +6,9 @@ import { TableRowResourceIdentifier } from "./TableRowResourceIdentifier"; * The request body for deleting multiple rows from a reference table. */ export class BatchDeleteRowsRequestArray { + /** + * List of row resources to delete from the reference table. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/reference_tables/src/v2/models/BatchUpsertRowsRequestArray.ts b/services/reference_tables/src/v2/models/BatchUpsertRowsRequestArray.ts index e20a957a7f92..7e356da678dc 100644 --- a/services/reference_tables/src/v2/models/BatchUpsertRowsRequestArray.ts +++ b/services/reference_tables/src/v2/models/BatchUpsertRowsRequestArray.ts @@ -6,6 +6,9 @@ import { BatchUpsertRowsRequestData } from "./BatchUpsertRowsRequestData"; * The request body for creating or updating multiple rows into a reference table. */ export class BatchUpsertRowsRequestArray { + /** + * List of row resources to create or update in the reference table. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/reference_tables/src/v2/models/BatchUpsertRowsRequestData.ts b/services/reference_tables/src/v2/models/BatchUpsertRowsRequestData.ts index 9b973efeaaf3..24e6b832d14f 100644 --- a/services/reference_tables/src/v2/models/BatchUpsertRowsRequestData.ts +++ b/services/reference_tables/src/v2/models/BatchUpsertRowsRequestData.ts @@ -11,6 +11,9 @@ export class BatchUpsertRowsRequestData { * Attributes containing row data values for row creation or update operations. */ "attributes"?: BatchUpsertRowsRequestDataAttributes; + /** + * The primary key value that uniquely identifies the row to create or update. + */ "id": string; /** * Row resource type. diff --git a/services/reference_tables/src/v2/models/TableRowResourceIdentifier.ts b/services/reference_tables/src/v2/models/TableRowResourceIdentifier.ts index 750714af7802..c05ddbce77d1 100644 --- a/services/reference_tables/src/v2/models/TableRowResourceIdentifier.ts +++ b/services/reference_tables/src/v2/models/TableRowResourceIdentifier.ts @@ -6,6 +6,9 @@ import { TableRowResourceDataType } from "./TableRowResourceDataType"; * Row resource containing a single row identifier. */ export class TableRowResourceIdentifier { + /** + * The primary key value that uniquely identifies the row to delete. + */ "id": string; /** * Row resource type. diff --git a/services/rum_audience_management/src/v2/models/CreateConnectionRequest.ts b/services/rum_audience_management/src/v2/models/CreateConnectionRequest.ts index 2f08c841b572..fa80ed7816b3 100644 --- a/services/rum_audience_management/src/v2/models/CreateConnectionRequest.ts +++ b/services/rum_audience_management/src/v2/models/CreateConnectionRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateConnectionRequestData } from "./CreateConnectionRequestData"; +/** + * Request body for creating a new data source connection for an entity. + */ export class CreateConnectionRequest { + /** + * The data object containing the resource type and attributes for creating a new connection. + */ "data"?: CreateConnectionRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/CreateConnectionRequestData.ts b/services/rum_audience_management/src/v2/models/CreateConnectionRequestData.ts index 64b136847cb9..e159380061a4 100644 --- a/services/rum_audience_management/src/v2/models/CreateConnectionRequestData.ts +++ b/services/rum_audience_management/src/v2/models/CreateConnectionRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateConnectionRequestDataAttributes } from "./CreateConnectionRequestDataAttributes"; import { UpdateConnectionRequestDataType } from "./UpdateConnectionRequestDataType"; +/** + * The data object containing the resource type and attributes for creating a new connection. + */ export class CreateConnectionRequestData { + /** + * Attributes defining the data source connection, including join configuration and custom fields. + */ "attributes"?: CreateConnectionRequestDataAttributes; + /** + * Unique identifier for the new connection resource. + */ "id"?: string; /** * Connection id resource type. diff --git a/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributes.ts index da38b533d2bf..8d39f3ee39c8 100644 --- a/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributes.ts @@ -2,11 +2,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateConnectionRequestDataAttributesFieldsItems } from "./CreateConnectionRequestDataAttributesFieldsItems"; +/** + * Attributes defining the data source connection, including join configuration and custom fields. + */ export class CreateConnectionRequestDataAttributes { + /** + * List of custom attribute fields to import from the data source. + */ "fields"?: Array; + /** + * The attribute in the data source used to join records with the entity. + */ "joinAttribute": string; + /** + * The type of join key used to link the data source to the entity (for example, email or user_id). + */ "joinType": string; + /** + * Additional key-value metadata associated with the connection. + */ "metadata"?: { [key: string]: string }; + /** + * The type of data source connection (for example, ref_table). + */ "type": string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributesFieldsItems.ts b/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributesFieldsItems.ts index b24110ce8062..6928352e8d02 100644 --- a/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributesFieldsItems.ts +++ b/services/rum_audience_management/src/v2/models/CreateConnectionRequestDataAttributesFieldsItems.ts @@ -1,11 +1,32 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Definition of a custom attribute field to import from a data source connection. + */ export class CreateConnectionRequestDataAttributesFieldsItems { + /** + * Human-readable explanation of what the field represents. + */ "description"?: string; + /** + * The human-readable label for the field shown in the UI. + */ "displayName"?: string; + /** + * List of group labels used to categorize the field. + */ "groups"?: Array; + /** + * The unique identifier for the field within the connection. + */ "id": string; + /** + * The name of the column or attribute in the source data system that maps to this field. + */ "sourceName": string; + /** + * The data type of the field (for example, string or number). + */ "type": string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoRequest.ts b/services/rum_audience_management/src/v2/models/FacetInfoRequest.ts index 7cbb126f8fa0..cab0dc0bbd58 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoRequest.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoRequestData } from "./FacetInfoRequestData"; +/** + * Request body for retrieving facet value information for a specified attribute with optional filtering. + */ export class FacetInfoRequest { + /** + * The data object containing the resource type and attributes for the facet info request. + */ "data"?: FacetInfoRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoRequestData.ts b/services/rum_audience_management/src/v2/models/FacetInfoRequestData.ts index eb399a1c2626..5c1be7cc3193 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoRequestData.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoRequestDataAttributes } from "./FacetInfoRequestDataAttributes"; import { FacetInfoRequestDataType } from "./FacetInfoRequestDataType"; +/** + * The data object containing the resource type and attributes for the facet info request. + */ export class FacetInfoRequestData { + /** + * Attributes for the facet info request, specifying which facet to query and optional filters to apply. + */ "attributes"?: FacetInfoRequestDataAttributes; + /** + * Unique identifier for the facet info request resource. + */ "id"?: string; /** * Users facet info request resource type. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributes.ts index 4d1fb1d8ded5..c9ed07466592 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributes.ts @@ -3,10 +3,25 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoRequestDataAttributesSearch } from "./FacetInfoRequestDataAttributesSearch"; import { FacetInfoRequestDataAttributesTermSearch } from "./FacetInfoRequestDataAttributesTermSearch"; +/** + * Attributes for the facet info request, specifying which facet to query and optional filters to apply. + */ export class FacetInfoRequestDataAttributes { + /** + * The identifier of the facet attribute to retrieve value information for. + */ "facetId": string; + /** + * Maximum number of facet values to return in the response. + */ "limit": number; + /** + * Query-based search configuration for filtering the audience context when retrieving facet values. + */ "search"?: FacetInfoRequestDataAttributesSearch; + /** + * Term-level search configuration for filtering facet values by an exact or partial term match. + */ "termSearch"?: FacetInfoRequestDataAttributesTermSearch; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesSearch.ts b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesSearch.ts index 008dd6439c6f..dba6ab816392 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesSearch.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesSearch.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Query-based search configuration for filtering the audience context when retrieving facet values. + */ export class FacetInfoRequestDataAttributesSearch { + /** + * The filter expression used to scope the audience from which facet values are retrieved. + */ "query"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesTermSearch.ts b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesTermSearch.ts index 028987bf990f..2b877060baa9 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesTermSearch.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoRequestDataAttributesTermSearch.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Term-level search configuration for filtering facet values by an exact or partial term match. + */ export class FacetInfoRequestDataAttributesTermSearch { + /** + * The term string to match against facet values. + */ "value"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponse.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponse.ts index 7ec9987fc9c9..94edfaf88fe6 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponse.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoResponseData } from "./FacetInfoResponseData"; +/** + * Response containing facet information for an attribute, including its distinct values and occurrence counts. + */ export class FacetInfoResponse { + /** + * The data object containing the resource type and attributes for the facet info response. + */ "data"?: FacetInfoResponseData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponseData.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponseData.ts index 184823aa686b..744dbae415bf 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponseData.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoResponseDataAttributes } from "./FacetInfoResponseDataAttributes"; import { FacetInfoResponseDataType } from "./FacetInfoResponseDataType"; +/** + * The data object containing the resource type and attributes for the facet info response. + */ export class FacetInfoResponseData { + /** + * Attributes of the facet info response, containing the facet result data. + */ "attributes"?: FacetInfoResponseDataAttributes; + /** + * Unique identifier for the facet info response resource. + */ "id"?: string; /** * Users facet info resource type. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributes.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributes.ts index 44f0d0faa4bc..80cdb973e30c 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoResponseDataAttributesResult } from "./FacetInfoResponseDataAttributesResult"; +/** + * Attributes of the facet info response, containing the facet result data. + */ export class FacetInfoResponseDataAttributes { + /** + * The facet query result containing discrete value counts or a numeric range for the requested facet. + */ "result"?: FacetInfoResponseDataAttributesResult; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResult.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResult.ts index d873e9ed8958..b466703edaa6 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResult.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResult.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FacetInfoResponseDataAttributesResultRange } from "./FacetInfoResponseDataAttributesResultRange"; import { FacetInfoResponseDataAttributesResultValuesItems } from "./FacetInfoResponseDataAttributesResultValuesItems"; +/** + * The facet query result containing discrete value counts or a numeric range for the requested facet. + */ export class FacetInfoResponseDataAttributesResult { + /** + * The numeric range of a facet attribute, representing the minimum and maximum observed values. + */ "range"?: FacetInfoResponseDataAttributesResultRange; + /** + * List of discrete facet values with their occurrence counts. + */ "values"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultRange.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultRange.ts index ce03a5a7d18f..279fb4363f79 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultRange.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultRange.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The numeric range of a facet attribute, representing the minimum and maximum observed values. + */ export class FacetInfoResponseDataAttributesResultRange { + /** + * The maximum observed value for the numeric facet attribute. + */ "max"?: any; + /** + * The minimum observed value for the numeric facet attribute. + */ "min"?: any; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultValuesItems.ts b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultValuesItems.ts index 0d818e0a4cb1..6dfcafaabdd0 100644 --- a/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultValuesItems.ts +++ b/services/rum_audience_management/src/v2/models/FacetInfoResponseDataAttributesResultValuesItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A single facet value with its occurrence count in the dataset. + */ export class FacetInfoResponseDataAttributesResultValuesItems { + /** + * The number of records that have this facet value. + */ "count"?: number; + /** + * The facet value (for example, a browser name or country code). + */ "value"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/GetMappingResponse.ts b/services/rum_audience_management/src/v2/models/GetMappingResponse.ts index f4e263c5d02d..72ecf6bcc757 100644 --- a/services/rum_audience_management/src/v2/models/GetMappingResponse.ts +++ b/services/rum_audience_management/src/v2/models/GetMappingResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMappingResponseData } from "./GetMappingResponseData"; +/** + * Response containing the entity attribute mapping configuration including all available attributes and their properties. + */ export class GetMappingResponse { + /** + * The data object containing the resource type and attributes for the get mapping response. + */ "data"?: GetMappingResponseData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/GetMappingResponseData.ts b/services/rum_audience_management/src/v2/models/GetMappingResponseData.ts index ba08a897ad9d..78eb52aeea18 100644 --- a/services/rum_audience_management/src/v2/models/GetMappingResponseData.ts +++ b/services/rum_audience_management/src/v2/models/GetMappingResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMappingResponseDataAttributes } from "./GetMappingResponseDataAttributes"; import { GetMappingResponseDataType } from "./GetMappingResponseDataType"; +/** + * The data object containing the resource type and attributes for the get mapping response. + */ export class GetMappingResponseData { + /** + * Attributes of the get mapping response, containing the list of configured entity attributes. + */ "attributes"?: GetMappingResponseDataAttributes; + /** + * Unique identifier for the get mapping response resource. + */ "id"?: string; /** * Get mappings response resource type. diff --git a/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributes.ts b/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributes.ts index 20f3256bb4de..02f5ab7cf595 100644 --- a/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMappingResponseDataAttributesAttributesItems } from "./GetMappingResponseDataAttributesAttributesItems"; +/** + * Attributes of the get mapping response, containing the list of configured entity attributes. + */ export class GetMappingResponseDataAttributes { + /** + * The list of entity attributes and their mapping configurations. + */ "attributes"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributesAttributesItems.ts b/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributesAttributesItems.ts index 4c9b9c9ed50c..e560a7c19813 100644 --- a/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributesAttributesItems.ts +++ b/services/rum_audience_management/src/v2/models/GetMappingResponseDataAttributesAttributesItems.ts @@ -1,11 +1,32 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Details of a single entity attribute including its mapping configuration and metadata. + */ export class GetMappingResponseDataAttributesAttributesItems { + /** + * The attribute identifier as used in the entity data model. + */ "attribute"?: string; + /** + * Human-readable explanation of what the attribute represents. + */ "description"?: string; + /** + * The human-readable label for the attribute shown in the UI. + */ "displayName"?: string; + /** + * List of group labels used to categorize the attribute. + */ "groups"?: Array; + /** + * Whether this attribute is a custom user-defined attribute rather than a built-in one. + */ "isCustom"?: boolean; + /** + * The data type of the attribute (for example, string or number). + */ "type"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/ListConnectionsResponse.ts b/services/rum_audience_management/src/v2/models/ListConnectionsResponse.ts index eb40d0eb29d5..c0b3551e074a 100644 --- a/services/rum_audience_management/src/v2/models/ListConnectionsResponse.ts +++ b/services/rum_audience_management/src/v2/models/ListConnectionsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ListConnectionsResponseData } from "./ListConnectionsResponseData"; +/** + * Response containing the list of all data source connections configured for an entity. + */ export class ListConnectionsResponse { + /** + * The data object containing the resource type and attributes for the list connections response. + */ "data"?: ListConnectionsResponseData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/ListConnectionsResponseData.ts b/services/rum_audience_management/src/v2/models/ListConnectionsResponseData.ts index 71bfd6df877e..04c7582d2dd5 100644 --- a/services/rum_audience_management/src/v2/models/ListConnectionsResponseData.ts +++ b/services/rum_audience_management/src/v2/models/ListConnectionsResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ListConnectionsResponseDataAttributes } from "./ListConnectionsResponseDataAttributes"; import { ListConnectionsResponseDataType } from "./ListConnectionsResponseDataType"; +/** + * The data object containing the resource type and attributes for the list connections response. + */ export class ListConnectionsResponseData { + /** + * Attributes of the list connections response, containing the collection of data source connections. + */ "attributes"?: ListConnectionsResponseDataAttributes; + /** + * Unique identifier for the list connections response resource. + */ "id"?: string; /** * List connections response resource type. diff --git a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributes.ts b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributes.ts index c8f630bc2e0d..d6e3d2e8cd85 100644 --- a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ListConnectionsResponseDataAttributesConnectionsItems } from "./ListConnectionsResponseDataAttributesConnectionsItems"; +/** + * Attributes of the list connections response, containing the collection of data source connections. + */ export class ListConnectionsResponseDataAttributes { + /** + * The list of data source connections configured for the entity. + */ "connections"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItems.ts b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItems.ts index 1c494f2989ad..6da19e633b0d 100644 --- a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItems.ts +++ b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItems.ts @@ -3,15 +3,45 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateConnectionRequestDataAttributesFieldsItems } from "./CreateConnectionRequestDataAttributesFieldsItems"; import { ListConnectionsResponseDataAttributesConnectionsItemsJoin } from "./ListConnectionsResponseDataAttributesConnectionsItemsJoin"; +/** + * Details of a single data source connection, including its fields, join configuration, and audit metadata. + */ export class ListConnectionsResponseDataAttributesConnectionsItems { + /** + * Timestamp indicating when the connection was created. + */ "createdAt"?: Date; + /** + * Identifier of the user who created the connection. + */ "createdBy"?: string; + /** + * List of custom attribute fields imported from the data source. + */ "fields"?: Array; + /** + * Unique identifier of the connection. + */ "id"?: string; + /** + * The join configuration describing how the data source is linked to the entity. + */ "join"?: ListConnectionsResponseDataAttributesConnectionsItemsJoin; + /** + * Additional key-value metadata associated with the connection. + */ "metadata"?: { [key: string]: string }; + /** + * The type of data source connection (for example, ref_table). + */ "type"?: string; + /** + * Timestamp indicating when the connection was last updated. + */ "updatedAt"?: Date; + /** + * Identifier of the user who last updated the connection. + */ "updatedBy"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItemsJoin.ts b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItemsJoin.ts index 1ad598830fef..7a623e68d75e 100644 --- a/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItemsJoin.ts +++ b/services/rum_audience_management/src/v2/models/ListConnectionsResponseDataAttributesConnectionsItemsJoin.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The join configuration describing how the data source is linked to the entity. + */ export class ListConnectionsResponseDataAttributesConnectionsItemsJoin { + /** + * The entity attribute used as the join key to link records from the data source. + */ "attribute"?: string; + /** + * The type of join key used (for example, email or user_id). + */ "type"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryAccountRequest.ts b/services/rum_audience_management/src/v2/models/QueryAccountRequest.ts index caa5b997867f..462972603c32 100644 --- a/services/rum_audience_management/src/v2/models/QueryAccountRequest.ts +++ b/services/rum_audience_management/src/v2/models/QueryAccountRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryAccountRequestData } from "./QueryAccountRequestData"; +/** + * Request body for querying accounts with optional filtering, column selection, and sorting. + */ export class QueryAccountRequest { + /** + * The data object containing the resource type and attributes for querying accounts. + */ "data"?: QueryAccountRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryAccountRequestData.ts b/services/rum_audience_management/src/v2/models/QueryAccountRequestData.ts index 7474b716ea7a..fb63b665cfd9 100644 --- a/services/rum_audience_management/src/v2/models/QueryAccountRequestData.ts +++ b/services/rum_audience_management/src/v2/models/QueryAccountRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryAccountRequestDataAttributes } from "./QueryAccountRequestDataAttributes"; import { QueryAccountRequestDataType } from "./QueryAccountRequestDataType"; +/** + * The data object containing the resource type and attributes for querying accounts. + */ export class QueryAccountRequestData { + /** + * Attributes for filtering and shaping the account query results. + */ "attributes"?: QueryAccountRequestDataAttributes; + /** + * Unique identifier for the query account request resource. + */ "id"?: string; /** * Query account request resource type. diff --git a/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributes.ts index bf27f80e859e..db8d97608041 100644 --- a/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributes.ts @@ -2,11 +2,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryAccountRequestDataAttributesSort } from "./QueryAccountRequestDataAttributesSort"; +/** + * Attributes for filtering and shaping the account query results. + */ export class QueryAccountRequestDataAttributes { + /** + * Maximum number of account records to return in the response. + */ "limit"?: number; + /** + * Filter expression using account attribute conditions to narrow results. + */ "query"?: string; + /** + * List of account attribute column names to include in the response. + */ "selectColumns"?: Array; + /** + * Sorting configuration specifying the field and direction for ordering query results. + */ "sort"?: QueryAccountRequestDataAttributesSort; + /** + * Free-text term used for wildcard search across account attribute values. + */ "wildcardSearchTerm"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributesSort.ts b/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributesSort.ts index 962bf635df52..379fa9b30979 100644 --- a/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributesSort.ts +++ b/services/rum_audience_management/src/v2/models/QueryAccountRequestDataAttributesSort.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Sorting configuration specifying the field and direction for ordering query results. + */ export class QueryAccountRequestDataAttributesSort { + /** + * The attribute field name to sort results by. + */ "field"?: string; + /** + * The sort direction, either ascending or descending. + */ "order"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequest.ts b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequest.ts index 9bbe6447f0ab..760fc1a26fb2 100644 --- a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequest.ts +++ b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryEventFilteredUsersRequestData } from "./QueryEventFilteredUsersRequestData"; +/** + * Request body for querying users filtered by user properties combined with event platform activity. + */ export class QueryEventFilteredUsersRequest { + /** + * The data object containing the resource type and attributes for querying event-filtered users. + */ "data"?: QueryEventFilteredUsersRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestData.ts b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestData.ts index 36f3f2f95243..97628cbd0106 100644 --- a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestData.ts +++ b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryEventFilteredUsersRequestDataAttributes } from "./QueryEventFilteredUsersRequestDataAttributes"; import { QueryEventFilteredUsersRequestDataType } from "./QueryEventFilteredUsersRequestDataType"; +/** + * The data object containing the resource type and attributes for querying event-filtered users. + */ export class QueryEventFilteredUsersRequestData { + /** + * Attributes for filtering users by both user properties and event platform activity. + */ "attributes"?: QueryEventFilteredUsersRequestDataAttributes; + /** + * Unique identifier for the query event filtered users request resource. + */ "id"?: string; /** * Query event filtered users request resource type. diff --git a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributes.ts index bc0728eae63b..2c5f057b15de 100644 --- a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributes.ts @@ -2,11 +2,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryEventFilteredUsersRequestDataAttributesEventQuery } from "./QueryEventFilteredUsersRequestDataAttributesEventQuery"; +/** + * Attributes for filtering users by both user properties and event platform activity. + */ export class QueryEventFilteredUsersRequestDataAttributes { + /** + * Event platform query used to filter users based on their event activity within a specified time window. + */ "eventQuery"?: QueryEventFilteredUsersRequestDataAttributesEventQuery; + /** + * Whether to include the total count of matching users in the response. + */ "includeRowCount"?: boolean; + /** + * Maximum number of user records to return in the response. + */ "limit"?: number; + /** + * Filter expression using user attribute conditions to narrow results. + */ "query"?: string; + /** + * List of user attribute column names to include in the response. + */ "selectColumns"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQuery.ts b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQuery.ts index bc29f15f6f1f..0e62b7c4b50c 100644 --- a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQuery.ts +++ b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQuery.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame } from "./QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame"; +/** + * Event platform query used to filter users based on their event activity within a specified time window. + */ export class QueryEventFilteredUsersRequestDataAttributesEventQuery { + /** + * The event platform query expression for filtering users by their event activity. + */ "query"?: string; + /** + * The time window defining the start and end of the event query period as Unix timestamps. + */ "timeFrame"?: QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame.ts b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame.ts index 411870fe947a..092266013119 100644 --- a/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame.ts +++ b/services/rum_audience_management/src/v2/models/QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The time window defining the start and end of the event query period as Unix timestamps. + */ export class QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame { + /** + * End of the time frame as a Unix timestamp in seconds. + */ "end"?: number; + /** + * Start of the time frame as a Unix timestamp in seconds. + */ "start"?: number; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryResponse.ts b/services/rum_audience_management/src/v2/models/QueryResponse.ts index 6b27983c9177..6b0e39f4264b 100644 --- a/services/rum_audience_management/src/v2/models/QueryResponse.ts +++ b/services/rum_audience_management/src/v2/models/QueryResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryResponseData } from "./QueryResponseData"; +/** + * Response containing the query results with matched records and total count. + */ export class QueryResponse { + /** + * The data object containing the resource type and attributes of the query response. + */ "data"?: QueryResponseData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryResponseData.ts b/services/rum_audience_management/src/v2/models/QueryResponseData.ts index 2d44f2b78edd..1962aa16f53b 100644 --- a/services/rum_audience_management/src/v2/models/QueryResponseData.ts +++ b/services/rum_audience_management/src/v2/models/QueryResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryResponseDataAttributes } from "./QueryResponseDataAttributes"; import { QueryResponseDataType } from "./QueryResponseDataType"; +/** + * The data object containing the resource type and attributes of the query response. + */ export class QueryResponseData { + /** + * Attributes of the query response, containing the matched records and total count. + */ "attributes"?: QueryResponseDataAttributes; + /** + * Unique identifier for the query response resource. + */ "id"?: string; /** * Query response resource type. diff --git a/services/rum_audience_management/src/v2/models/QueryResponseDataAttributes.ts b/services/rum_audience_management/src/v2/models/QueryResponseDataAttributes.ts index baafb4f4f1e4..dcbbe2432324 100644 --- a/services/rum_audience_management/src/v2/models/QueryResponseDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/QueryResponseDataAttributes.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of the query response, containing the matched records and total count. + */ export class QueryResponseDataAttributes { + /** + * The list of matching records returned by the query, each as a map of attribute names to values. + */ "hits"?: Array<{ [key: string]: any }>; + /** + * Total number of records matching the query, regardless of the limit applied. + */ "total"?: number; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryUsersRequest.ts b/services/rum_audience_management/src/v2/models/QueryUsersRequest.ts index 3169248d794e..a70143dd3a61 100644 --- a/services/rum_audience_management/src/v2/models/QueryUsersRequest.ts +++ b/services/rum_audience_management/src/v2/models/QueryUsersRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryUsersRequestData } from "./QueryUsersRequestData"; +/** + * Request body for querying users with optional filtering, column selection, and sorting. + */ export class QueryUsersRequest { + /** + * The data object containing the resource type and attributes for querying users. + */ "data"?: QueryUsersRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryUsersRequestData.ts b/services/rum_audience_management/src/v2/models/QueryUsersRequestData.ts index d1eb5c978373..a5f044794a49 100644 --- a/services/rum_audience_management/src/v2/models/QueryUsersRequestData.ts +++ b/services/rum_audience_management/src/v2/models/QueryUsersRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryUsersRequestDataAttributes } from "./QueryUsersRequestDataAttributes"; import { QueryUsersRequestDataType } from "./QueryUsersRequestDataType"; +/** + * The data object containing the resource type and attributes for querying users. + */ export class QueryUsersRequestData { + /** + * Attributes for filtering and shaping the user query results. + */ "attributes"?: QueryUsersRequestDataAttributes; + /** + * Unique identifier for the query users request resource. + */ "id"?: string; /** * Query users request resource type. diff --git a/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributes.ts index 89da58da2f61..df618ff98c8f 100644 --- a/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributes.ts @@ -2,11 +2,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { QueryUsersRequestDataAttributesSort } from "./QueryUsersRequestDataAttributesSort"; +/** + * Attributes for filtering and shaping the user query results. + */ export class QueryUsersRequestDataAttributes { + /** + * Maximum number of user records to return in the response. + */ "limit"?: number; + /** + * Filter expression using user attribute conditions to narrow results. + */ "query"?: string; + /** + * List of user attribute column names to include in the response. + */ "selectColumns"?: Array; + /** + * Sorting configuration specifying the field and direction for ordering user query results. + */ "sort"?: QueryUsersRequestDataAttributesSort; + /** + * Free-text term used for wildcard search across user attribute values. + */ "wildcardSearchTerm"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributesSort.ts b/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributesSort.ts index 2cf0580fc546..b8c614c49624 100644 --- a/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributesSort.ts +++ b/services/rum_audience_management/src/v2/models/QueryUsersRequestDataAttributesSort.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Sorting configuration specifying the field and direction for ordering user query results. + */ export class QueryUsersRequestDataAttributesSort { + /** + * The user attribute field name to sort results by. + */ "field"?: string; + /** + * The sort direction, either ascending or descending. + */ "order"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/UpdateConnectionRequest.ts b/services/rum_audience_management/src/v2/models/UpdateConnectionRequest.ts index 28948b7672a1..7d0ca7834170 100644 --- a/services/rum_audience_management/src/v2/models/UpdateConnectionRequest.ts +++ b/services/rum_audience_management/src/v2/models/UpdateConnectionRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { UpdateConnectionRequestData } from "./UpdateConnectionRequestData"; +/** + * Request body for updating an existing data source connection by adding, modifying, or removing fields. + */ export class UpdateConnectionRequest { + /** + * The data object containing the resource identifier and attributes for updating an existing connection. + */ "data"?: UpdateConnectionRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestData.ts b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestData.ts index 08b5fe8a4051..f77ff2e8b81a 100644 --- a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestData.ts +++ b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { UpdateConnectionRequestDataAttributes } from "./UpdateConnectionRequestDataAttributes"; import { UpdateConnectionRequestDataType } from "./UpdateConnectionRequestDataType"; +/** + * The data object containing the resource identifier and attributes for updating an existing connection. + */ export class UpdateConnectionRequestData { + /** + * Attributes specifying the field modifications to apply to an existing connection. + */ "attributes"?: UpdateConnectionRequestDataAttributes; + /** + * The unique identifier of the connection to update. + */ "id": string; /** * Connection id resource type. diff --git a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributes.ts b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributes.ts index 8b61377b9b4c..67830a099d6d 100644 --- a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributes.ts +++ b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributes.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateConnectionRequestDataAttributesFieldsItems } from "./CreateConnectionRequestDataAttributesFieldsItems"; import { UpdateConnectionRequestDataAttributesFieldsToUpdateItems } from "./UpdateConnectionRequestDataAttributesFieldsToUpdateItems"; +/** + * Attributes specifying the field modifications to apply to an existing connection. + */ export class UpdateConnectionRequestDataAttributes { + /** + * New fields to add to the connection from the data source. + */ "fieldsToAdd"?: Array; + /** + * Identifiers of existing fields to remove from the connection. + */ "fieldsToDelete"?: Array; + /** + * Existing fields with updated metadata to apply to the connection. + */ "fieldsToUpdate"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributesFieldsToUpdateItems.ts b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributesFieldsToUpdateItems.ts index 8f5ba8dc89ee..e9240a2560b3 100644 --- a/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributesFieldsToUpdateItems.ts +++ b/services/rum_audience_management/src/v2/models/UpdateConnectionRequestDataAttributesFieldsToUpdateItems.ts @@ -1,10 +1,28 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Specification for updating an existing field in a connection, including which field to modify and the new values. + */ export class UpdateConnectionRequestDataAttributesFieldsToUpdateItems { + /** + * The identifier of the existing field to update. + */ "fieldId": string; + /** + * The new description to set for the field. + */ "updatedDescription"?: string; + /** + * The new human-readable display name to set for the field. + */ "updatedDisplayName"?: string; + /** + * The new identifier to assign to the field, if renaming it. + */ "updatedFieldId"?: string; + /** + * The updated list of group labels to associate with the field. + */ "updatedGroups"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/Snapshot.ts b/services/rum_replay_heatmaps/src/v2/models/Snapshot.ts index 10fd81a9d919..40d05360442b 100644 --- a/services/rum_replay_heatmaps/src/v2/models/Snapshot.ts +++ b/services/rum_replay_heatmaps/src/v2/models/Snapshot.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotData } from "./SnapshotData"; +/** + * A single heatmap snapshot resource returned by create or update operations. + */ export class Snapshot { + /** + * Data object representing a heatmap snapshot, including its identifier, type, and attributes. + */ "data"?: SnapshotData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotArray.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotArray.ts index 6a31d524319a..3d2e56a96f6c 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotArray.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotData } from "./SnapshotData"; +/** + * A list of heatmap snapshots returned by a list operation. + */ export class SnapshotArray { + /** + * Array of heatmap snapshot data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequest.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequest.ts index 566e362f1dd7..436a0036e8be 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequest.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotCreateRequestData } from "./SnapshotCreateRequestData"; +/** + * Request body for creating a heatmap snapshot. + */ export class SnapshotCreateRequest { + /** + * Data object for a heatmap snapshot creation request, containing the resource type and attributes. + */ "data": SnapshotCreateRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestData.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestData.ts index ddd6fde9713e..3bff5e3b2eb3 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestData.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotCreateRequestDataAttributes } from "./SnapshotCreateRequestDataAttributes"; import { SnapshotUpdateRequestDataType } from "./SnapshotUpdateRequestDataType"; +/** + * Data object for a heatmap snapshot creation request, containing the resource type and attributes. + */ export class SnapshotCreateRequestData { + /** + * Attributes for creating a heatmap snapshot, including the view, session, event, and device context. + */ "attributes"?: SnapshotCreateRequestDataAttributes; /** * Snapshots resource type. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestDataAttributes.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestDataAttributes.ts index 5f78f588fd8c..44bbe8a6438a 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestDataAttributes.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotCreateRequestDataAttributes.ts @@ -1,14 +1,44 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for creating a heatmap snapshot, including the view, session, event, and device context. + */ export class SnapshotCreateRequestDataAttributes { + /** + * Unique identifier of the RUM application. + */ "applicationId": string; + /** + * Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). + */ "deviceType": string; + /** + * Unique identifier of the RUM event associated with the snapshot. + */ "eventId": string; + /** + * Indicates whether the device type was explicitly selected by the user rather than auto-detected. + */ "isDeviceTypeSelectedByUser": boolean; + /** + * Unique identifier of the RUM session associated with the snapshot. + */ "sessionId"?: string; + /** + * Human-readable name for the snapshot. + */ "snapshotName": string; + /** + * Offset in milliseconds from the start of the session at which the snapshot was captured. + */ "start": number; + /** + * Unique identifier of the RUM view associated with the snapshot. + */ "viewId"?: string; + /** + * URL path or name of the view where the snapshot was captured. + */ "viewName": string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotData.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotData.ts index 1693aa18e73a..f2d2bfbd4d02 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotData.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotDataAttributes } from "./SnapshotDataAttributes"; import { SnapshotUpdateRequestDataType } from "./SnapshotUpdateRequestDataType"; +/** + * Data object representing a heatmap snapshot, including its identifier, type, and attributes. + */ export class SnapshotData { + /** + * Attributes of a heatmap snapshot, including view context, device information, and audit metadata. + */ "attributes"?: SnapshotDataAttributes; + /** + * Unique identifier of the heatmap snapshot. + */ "id"?: string; /** * Snapshots resource type. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotDataAttributes.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotDataAttributes.ts index e342aeb0b2bf..8c9678401642 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotDataAttributes.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotDataAttributes.ts @@ -1,20 +1,68 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a heatmap snapshot, including view context, device information, and audit metadata. + */ export class SnapshotDataAttributes { + /** + * Unique identifier of the RUM application. + */ "applicationId"?: string; + /** + * Timestamp when the snapshot was created. + */ "createdAt"?: Date; + /** + * Display name of the user who created the snapshot. + */ "createdBy"?: string; + /** + * Email handle of the user who created the snapshot. + */ "createdByHandle"?: string; + /** + * Numeric identifier of the user who created the snapshot. + */ "createdByUserId"?: number; + /** + * Device type used when capturing the snapshot (e.g., desktop, mobile, tablet). + */ "deviceType"?: string; + /** + * Unique identifier of the RUM event associated with the snapshot. + */ "eventId"?: string; + /** + * Indicates whether the device type was explicitly selected by the user rather than auto-detected. + */ "isDeviceTypeSelectedByUser"?: boolean; + /** + * Timestamp when the snapshot was last modified. + */ "modifiedAt"?: Date; + /** + * Numeric identifier of the organization that owns the snapshot. + */ "orgId"?: number; + /** + * Unique identifier of the RUM session associated with the snapshot. + */ "sessionId"?: string; + /** + * Human-readable name for the snapshot. + */ "snapshotName"?: string; + /** + * Offset in milliseconds from the start of the session at which the snapshot was captured. + */ "start"?: number; + /** + * Unique identifier of the RUM view associated with the snapshot. + */ "viewId"?: string; + /** + * URL path or name of the view where the snapshot was captured. + */ "viewName"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequest.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequest.ts index 62ce7ab45dc6..d46c6114c75f 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequest.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotUpdateRequestData } from "./SnapshotUpdateRequestData"; +/** + * Request body for updating a heatmap snapshot. + */ export class SnapshotUpdateRequest { + /** + * Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. + */ "data": SnapshotUpdateRequestData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestData.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestData.ts index e6a83e4949be..880221a62445 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestData.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SnapshotUpdateRequestDataAttributes } from "./SnapshotUpdateRequestDataAttributes"; import { SnapshotUpdateRequestDataType } from "./SnapshotUpdateRequestDataType"; +/** + * Data object for a heatmap snapshot update request, containing the resource identifier, type, and attributes. + */ export class SnapshotUpdateRequestData { + /** + * Attributes for updating a heatmap snapshot, including event, session, and view context. + */ "attributes"?: SnapshotUpdateRequestDataAttributes; + /** + * Unique identifier of the heatmap snapshot to update. + */ "id"?: string; /** * Snapshots resource type. diff --git a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestDataAttributes.ts b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestDataAttributes.ts index 1cf4277e102b..80e6b7152b4f 100644 --- a/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestDataAttributes.ts +++ b/services/rum_replay_heatmaps/src/v2/models/SnapshotUpdateRequestDataAttributes.ts @@ -1,10 +1,28 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for updating a heatmap snapshot, including event, session, and view context. + */ export class SnapshotUpdateRequestDataAttributes { + /** + * Unique identifier of the RUM event associated with the snapshot. + */ "eventId": string; + /** + * Indicates whether the device type was explicitly selected by the user rather than auto-detected. + */ "isDeviceTypeSelectedByUser": boolean; + /** + * Unique identifier of the RUM session associated with the snapshot. + */ "sessionId"?: string; + /** + * Offset in milliseconds from the start of the session at which the snapshot was captured. + */ "start": number; + /** + * Unique identifier of the RUM view associated with the snapshot. + */ "viewId"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/Playlist.ts b/services/rum_replay_playlists/src/v2/models/Playlist.ts index e538d04b647b..e3e2ecff0c83 100644 --- a/services/rum_replay_playlists/src/v2/models/Playlist.ts +++ b/services/rum_replay_playlists/src/v2/models/Playlist.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistData } from "./PlaylistData"; +/** + * A single RUM replay playlist resource returned by create, update, or get operations. + */ export class Playlist { + /** + * Data object representing a RUM replay playlist, including its identifier, type, and attributes. + */ "data": PlaylistData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistArray.ts b/services/rum_replay_playlists/src/v2/models/PlaylistArray.ts index 1774e741e7a9..422cf436c63c 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistArray.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistData } from "./PlaylistData"; +/** + * A list of RUM replay playlists returned by a list operation. + */ export class PlaylistArray { + /** + * Array of playlist data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistData.ts b/services/rum_replay_playlists/src/v2/models/PlaylistData.ts index 0d706c753f09..59f19eca5707 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistData.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistDataAttributes } from "./PlaylistDataAttributes"; import { PlaylistDataType } from "./PlaylistDataType"; +/** + * Data object representing a RUM replay playlist, including its identifier, type, and attributes. + */ export class PlaylistData { + /** + * Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. + */ "attributes"?: PlaylistDataAttributes; + /** + * Unique identifier of the playlist. + */ "id"?: string; /** * Rum replay playlist resource type. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributes.ts b/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributes.ts index 650b54d4ad0b..fad6ec229484 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributes.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributes.ts @@ -2,12 +2,33 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistDataAttributesCreatedBy } from "./PlaylistDataAttributesCreatedBy"; +/** + * Attributes of a RUM replay playlist, including its name, description, session count, and audit timestamps. + */ export class PlaylistDataAttributes { + /** + * Timestamp when the playlist was created. + */ "createdAt"?: Date; + /** + * Information about the user who created the playlist. + */ "createdBy"?: PlaylistDataAttributesCreatedBy; + /** + * Optional human-readable description of the playlist's purpose or contents. + */ "description"?: string; + /** + * Human-readable name of the playlist. + */ "name": string; + /** + * Number of replay sessions in the playlist. + */ "sessionCount"?: number; + /** + * Timestamp when the playlist was last updated. + */ "updatedAt"?: Date; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributesCreatedBy.ts b/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributesCreatedBy.ts index a3d523f34c22..1d4d2b7988db 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributesCreatedBy.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistDataAttributesCreatedBy.ts @@ -1,10 +1,28 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Information about the user who created the playlist. + */ export class PlaylistDataAttributesCreatedBy { + /** + * Email handle of the user who created the playlist. + */ "handle": string; + /** + * URL or identifier of the user's avatar icon. + */ "icon"?: string; + /** + * Unique identifier of the user who created the playlist. + */ "id": string; + /** + * Display name of the user who created the playlist. + */ "name"?: string; + /** + * UUID of the user who created the playlist. + */ "uuid": string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistsSession.ts b/services/rum_replay_playlists/src/v2/models/PlaylistsSession.ts index 9d2e98c7d55c..3a3bf2aebbfd 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistsSession.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistsSession.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistsSessionData } from "./PlaylistsSessionData"; +/** + * A single RUM replay session resource as it appears within a playlist context. + */ export class PlaylistsSession { + /** + * Data object representing a session within a playlist, including its identifier, type, and attributes. + */ "data": PlaylistsSessionData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionArray.ts b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionArray.ts index bfc41917eec9..104d873c54ec 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionArray.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistsSessionData } from "./PlaylistsSessionData"; +/** + * A list of RUM replay sessions belonging to a playlist. + */ export class PlaylistsSessionArray { + /** + * Array of playlist session data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionData.ts b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionData.ts index 159795938cce..de9006bf36fb 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionData.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PlaylistsSessionDataAttributes } from "./PlaylistsSessionDataAttributes"; import { ViewershipHistorySessionDataType } from "./ViewershipHistorySessionDataType"; +/** + * Data object representing a session within a playlist, including its identifier, type, and attributes. + */ export class PlaylistsSessionData { + /** + * Attributes of a session within a playlist, including the session event data and its replay track. + */ "attributes"?: PlaylistsSessionDataAttributes; + /** + * Unique identifier of the RUM replay session. + */ "id"?: string; /** * Rum replay session resource type. diff --git a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionDataAttributes.ts b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionDataAttributes.ts index 148ecbffadd1..2b9756a1290a 100644 --- a/services/rum_replay_playlists/src/v2/models/PlaylistsSessionDataAttributes.ts +++ b/services/rum_replay_playlists/src/v2/models/PlaylistsSessionDataAttributes.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a session within a playlist, including the session event data and its replay track. + */ export class PlaylistsSessionDataAttributes { + /** + * Raw event data associated with the replay session. + */ "sessionEvent"?: { [key: string]: any }; + /** + * Replay track identifier indicating which recording track the session belongs to. + */ "track"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/SessionIdArray.ts b/services/rum_replay_playlists/src/v2/models/SessionIdArray.ts index 6d3a5d8c7e10..a70b90d0d566 100644 --- a/services/rum_replay_playlists/src/v2/models/SessionIdArray.ts +++ b/services/rum_replay_playlists/src/v2/models/SessionIdArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SessionIdData } from "./SessionIdData"; +/** + * A collection of session identifiers used for bulk add or remove operations on a playlist. + */ export class SessionIdArray { + /** + * Array of session identifier data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_playlists/src/v2/models/SessionIdData.ts b/services/rum_replay_playlists/src/v2/models/SessionIdData.ts index d94bbc770a11..a0c659f007eb 100644 --- a/services/rum_replay_playlists/src/v2/models/SessionIdData.ts +++ b/services/rum_replay_playlists/src/v2/models/SessionIdData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ViewershipHistorySessionDataType } from "./ViewershipHistorySessionDataType"; +/** + * A session identifier data object used for bulk playlist operations. + */ export class SessionIdData { + /** + * Unique identifier of the RUM replay session. + */ "id"?: string; /** * Rum replay session resource type. diff --git a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionArray.ts b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionArray.ts index 1becd27942b0..7b9d07ea414b 100644 --- a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionArray.ts +++ b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ViewershipHistorySessionData } from "./ViewershipHistorySessionData"; +/** + * A list of RUM replay sessions from a user's viewership history. + */ export class ViewershipHistorySessionArray { + /** + * Array of viewership history session data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionData.ts b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionData.ts index 1871f87b694c..8d73f02b39bf 100644 --- a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionData.ts +++ b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ViewershipHistorySessionDataAttributes } from "./ViewershipHistorySessionDataAttributes"; import { ViewershipHistorySessionDataType } from "./ViewershipHistorySessionDataType"; +/** + * Data object representing a session in the viewership history, including its identifier, type, and attributes. + */ export class ViewershipHistorySessionData { + /** + * Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. + */ "attributes"?: ViewershipHistorySessionDataAttributes; + /** + * Unique identifier of the RUM replay session. + */ "id"?: string; /** * Rum replay session resource type. diff --git a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionDataAttributes.ts b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionDataAttributes.ts index 45a5a66942f3..4dfd2949cd89 100644 --- a/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionDataAttributes.ts +++ b/services/rum_replay_viewership/src/v2/models/ViewershipHistorySessionDataAttributes.ts @@ -1,9 +1,24 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a viewership history session entry, capturing when it was last watched and the associated event data. + */ export class ViewershipHistorySessionDataAttributes { + /** + * Unique identifier of the RUM event associated with the watched session. + */ "eventId"?: string; + /** + * Timestamp when the session was last watched by the user. + */ "lastWatchedAt": Date; + /** + * Raw event data associated with the replay session. + */ "sessionEvent"?: { [key: string]: any }; + /** + * Replay track identifier indicating which recording track the session belongs to. + */ "track"?: string; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_viewership/src/v2/models/Watch.ts b/services/rum_replay_viewership/src/v2/models/Watch.ts index 5345c5748441..3b2126a09dd3 100644 --- a/services/rum_replay_viewership/src/v2/models/Watch.ts +++ b/services/rum_replay_viewership/src/v2/models/Watch.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { WatchData } from "./WatchData"; +/** + * A single RUM replay session watch resource returned by create operations. + */ export class Watch { + /** + * Data object representing a session watch record, including its identifier, type, and attributes. + */ "data": WatchData; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_viewership/src/v2/models/WatchData.ts b/services/rum_replay_viewership/src/v2/models/WatchData.ts index 8aa7d5797a02..1e9deb6d7901 100644 --- a/services/rum_replay_viewership/src/v2/models/WatchData.ts +++ b/services/rum_replay_viewership/src/v2/models/WatchData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { WatchDataAttributes } from "./WatchDataAttributes"; import { WatchDataType } from "./WatchDataType"; +/** + * Data object representing a session watch record, including its identifier, type, and attributes. + */ export class WatchData { + /** + * Attributes for recording a session watch event, including the application, event reference, and timestamp. + */ "attributes"?: WatchDataAttributes; + /** + * Unique identifier of the watch record. + */ "id"?: string; /** * Rum replay watch resource type. diff --git a/services/rum_replay_viewership/src/v2/models/WatchDataAttributes.ts b/services/rum_replay_viewership/src/v2/models/WatchDataAttributes.ts index 9f494c0df703..f13cf939d775 100644 --- a/services/rum_replay_viewership/src/v2/models/WatchDataAttributes.ts +++ b/services/rum_replay_viewership/src/v2/models/WatchDataAttributes.ts @@ -1,9 +1,24 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for recording a session watch event, including the application, event reference, and timestamp. + */ export class WatchDataAttributes { + /** + * Unique identifier of the RUM application containing the session. + */ "applicationId": string; + /** + * Data source type indicating the origin of the session data (e.g., rum or product_analytics). + */ "dataSource"?: string; + /** + * Unique identifier of the RUM event that was watched. + */ "eventId": string; + /** + * Timestamp when the session was watched. + */ "timestamp": Date; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_viewership/src/v2/models/WatcherArray.ts b/services/rum_replay_viewership/src/v2/models/WatcherArray.ts index 7c54c5b5d132..4105cdef8e2a 100644 --- a/services/rum_replay_viewership/src/v2/models/WatcherArray.ts +++ b/services/rum_replay_viewership/src/v2/models/WatcherArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { WatcherData } from "./WatcherData"; +/** + * A list of users who have watched a RUM replay session. + */ export class WatcherArray { + /** + * Array of watcher data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/rum_replay_viewership/src/v2/models/WatcherData.ts b/services/rum_replay_viewership/src/v2/models/WatcherData.ts index d733b013f8a0..afa2b77fb953 100644 --- a/services/rum_replay_viewership/src/v2/models/WatcherData.ts +++ b/services/rum_replay_viewership/src/v2/models/WatcherData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { WatcherDataAttributes } from "./WatcherDataAttributes"; import { WatcherDataType } from "./WatcherDataType"; +/** + * Data object representing a session watcher, including their identifier, type, and attributes. + */ export class WatcherData { + /** + * Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. + */ "attributes"?: WatcherDataAttributes; + /** + * Unique identifier of the watcher user. + */ "id"?: string; /** * Rum replay watcher resource type. diff --git a/services/rum_replay_viewership/src/v2/models/WatcherDataAttributes.ts b/services/rum_replay_viewership/src/v2/models/WatcherDataAttributes.ts index e38f7e376c95..f63067684990 100644 --- a/services/rum_replay_viewership/src/v2/models/WatcherDataAttributes.ts +++ b/services/rum_replay_viewership/src/v2/models/WatcherDataAttributes.ts @@ -1,10 +1,28 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a user who has watched a RUM replay session, including contact information and watch statistics. + */ export class WatcherDataAttributes { + /** + * Email handle of the user who watched the session. + */ "handle": string; + /** + * URL or identifier of the watcher's avatar icon. + */ "icon"?: string; + /** + * Timestamp when the watcher last viewed the session. + */ "lastWatchedAt": Date; + /** + * Display name of the user who watched the session. + */ "name"?: string; + /** + * Total number of times the user has watched the session. + */ "watchCount": number; /** * A container for additional, undeclared properties. diff --git a/services/seats/src/v2/models/AssignSeatsUserRequest.ts b/services/seats/src/v2/models/AssignSeatsUserRequest.ts index c7675d1e2d70..3ecc1aa05ddb 100644 --- a/services/seats/src/v2/models/AssignSeatsUserRequest.ts +++ b/services/seats/src/v2/models/AssignSeatsUserRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { AssignSeatsUserRequestData } from "./AssignSeatsUserRequestData"; +/** + * The request body for assigning seats to users for a product code. + */ export class AssignSeatsUserRequest { + /** + * The request data object containing attributes for assigning seats to users. + */ "data"?: AssignSeatsUserRequestData; /** * A container for additional, undeclared properties. diff --git a/services/seats/src/v2/models/AssignSeatsUserRequestData.ts b/services/seats/src/v2/models/AssignSeatsUserRequestData.ts index cc5210b8b32f..93c1a31014bf 100644 --- a/services/seats/src/v2/models/AssignSeatsUserRequestData.ts +++ b/services/seats/src/v2/models/AssignSeatsUserRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { AssignSeatsUserRequestDataAttributes } from "./AssignSeatsUserRequestDataAttributes"; import { SeatAssignmentsDataType } from "./SeatAssignmentsDataType"; +/** + * The request data object containing attributes for assigning seats to users. + */ export class AssignSeatsUserRequestData { + /** + * Attributes specifying the product and users to whom seats will be assigned. + */ "attributes": AssignSeatsUserRequestDataAttributes; /** * The ID of the assign seats user request. diff --git a/services/seats/src/v2/models/AssignSeatsUserRequestDataAttributes.ts b/services/seats/src/v2/models/AssignSeatsUserRequestDataAttributes.ts index 59134e1aa625..6d87e09e375d 100644 --- a/services/seats/src/v2/models/AssignSeatsUserRequestDataAttributes.ts +++ b/services/seats/src/v2/models/AssignSeatsUserRequestDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes specifying the product and users to whom seats will be assigned. + */ export class AssignSeatsUserRequestDataAttributes { /** * The product code for which to assign seats. diff --git a/services/seats/src/v2/models/AssignSeatsUserResponse.ts b/services/seats/src/v2/models/AssignSeatsUserResponse.ts index b788e0f4ada8..24f728b76a35 100644 --- a/services/seats/src/v2/models/AssignSeatsUserResponse.ts +++ b/services/seats/src/v2/models/AssignSeatsUserResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { AssignSeatsUserResponseData } from "./AssignSeatsUserResponseData"; +/** + * The response body returned after successfully assigning seats to users. + */ export class AssignSeatsUserResponse { + /** + * The response data object containing attributes of the seat assignment result. + */ "data"?: AssignSeatsUserResponseData; /** * A container for additional, undeclared properties. diff --git a/services/seats/src/v2/models/AssignSeatsUserResponseData.ts b/services/seats/src/v2/models/AssignSeatsUserResponseData.ts index c26f5e98c872..793503c12e8c 100644 --- a/services/seats/src/v2/models/AssignSeatsUserResponseData.ts +++ b/services/seats/src/v2/models/AssignSeatsUserResponseData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { AssignSeatsUserResponseDataAttributes } from "./AssignSeatsUserResponseDataAttributes"; import { SeatAssignmentsDataType } from "./SeatAssignmentsDataType"; +/** + * The response data object containing attributes of the seat assignment result. + */ export class AssignSeatsUserResponseData { + /** + * Attributes of the assign seats response, including the list of users assigned and the product code. + */ "attributes"?: AssignSeatsUserResponseDataAttributes; /** * The ID of the assign seats user response. diff --git a/services/seats/src/v2/models/AssignSeatsUserResponseDataAttributes.ts b/services/seats/src/v2/models/AssignSeatsUserResponseDataAttributes.ts index b12482b3bf46..3a9956deadc3 100644 --- a/services/seats/src/v2/models/AssignSeatsUserResponseDataAttributes.ts +++ b/services/seats/src/v2/models/AssignSeatsUserResponseDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of the assign seats response, including the list of users assigned and the product code. + */ export class AssignSeatsUserResponseDataAttributes { /** * The list of user IDs to which the seats were assigned. diff --git a/services/seats/src/v2/models/SeatUserData.ts b/services/seats/src/v2/models/SeatUserData.ts index 2551bc0ab5e5..2dd3e1868297 100644 --- a/services/seats/src/v2/models/SeatUserData.ts +++ b/services/seats/src/v2/models/SeatUserData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SeatUserDataAttributes } from "./SeatUserDataAttributes"; import { SeatUserDataType } from "./SeatUserDataType"; +/** + * A seat user resource object containing its ID, type, and associated attributes. + */ export class SeatUserData { + /** + * Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. + */ "attributes"?: SeatUserDataAttributes; /** * The ID of the seat user. diff --git a/services/seats/src/v2/models/SeatUserDataArray.ts b/services/seats/src/v2/models/SeatUserDataArray.ts index 4c3b0452c7cb..254b86470000 100644 --- a/services/seats/src/v2/models/SeatUserDataArray.ts +++ b/services/seats/src/v2/models/SeatUserDataArray.ts @@ -3,11 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SeatUserData } from "./SeatUserData"; import { SeatUserMeta } from "./SeatUserMeta"; +/** + * A paginated list of seat user resources with associated pagination metadata. + */ export class SeatUserDataArray { /** * The list of seat users. */ "data"?: Array; + /** + * Pagination metadata for the seat users list response. + */ "meta"?: SeatUserMeta; /** * A container for additional, undeclared properties. diff --git a/services/seats/src/v2/models/SeatUserDataAttributes.ts b/services/seats/src/v2/models/SeatUserDataAttributes.ts index f7f329fcb0e4..32c89a3f2882 100644 --- a/services/seats/src/v2/models/SeatUserDataAttributes.ts +++ b/services/seats/src/v2/models/SeatUserDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a user assigned to a seat, including their email, name, and assignment timestamp. + */ export class SeatUserDataAttributes { /** * The date and time the seat was assigned. diff --git a/services/seats/src/v2/models/SeatUserMeta.ts b/services/seats/src/v2/models/SeatUserMeta.ts index 5f572543454a..2f59b95bd936 100644 --- a/services/seats/src/v2/models/SeatUserMeta.ts +++ b/services/seats/src/v2/models/SeatUserMeta.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Pagination metadata for the seat users list response. + */ export class SeatUserMeta { /** * The cursor for the seat users. diff --git a/services/seats/src/v2/models/UnassignSeatsUserRequest.ts b/services/seats/src/v2/models/UnassignSeatsUserRequest.ts index 32277c470103..50eb376a1c4d 100644 --- a/services/seats/src/v2/models/UnassignSeatsUserRequest.ts +++ b/services/seats/src/v2/models/UnassignSeatsUserRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { UnassignSeatsUserRequestData } from "./UnassignSeatsUserRequestData"; +/** + * The request body for unassigning seats from users for a product code. + */ export class UnassignSeatsUserRequest { + /** + * The request data object containing attributes for unassigning seats from users. + */ "data"?: UnassignSeatsUserRequestData; /** * A container for additional, undeclared properties. diff --git a/services/seats/src/v2/models/UnassignSeatsUserRequestData.ts b/services/seats/src/v2/models/UnassignSeatsUserRequestData.ts index 49119a5ee0ed..67bcad7e0db2 100644 --- a/services/seats/src/v2/models/UnassignSeatsUserRequestData.ts +++ b/services/seats/src/v2/models/UnassignSeatsUserRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SeatAssignmentsDataType } from "./SeatAssignmentsDataType"; import { UnassignSeatsUserRequestDataAttributes } from "./UnassignSeatsUserRequestDataAttributes"; +/** + * The request data object containing attributes for unassigning seats from users. + */ export class UnassignSeatsUserRequestData { + /** + * Attributes specifying the product and users from whom seats will be unassigned. + */ "attributes": UnassignSeatsUserRequestDataAttributes; /** * The ID of the unassign seats user request. diff --git a/services/seats/src/v2/models/UnassignSeatsUserRequestDataAttributes.ts b/services/seats/src/v2/models/UnassignSeatsUserRequestDataAttributes.ts index 6d35c14be629..dcf936e87745 100644 --- a/services/seats/src/v2/models/UnassignSeatsUserRequestDataAttributes.ts +++ b/services/seats/src/v2/models/UnassignSeatsUserRequestDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes specifying the product and users from whom seats will be unassigned. + */ export class UnassignSeatsUserRequestDataAttributes { /** * The product code for which to unassign seats. diff --git a/services/security_monitoring/src/v2/models/CaseManagementProject.ts b/services/security_monitoring/src/v2/models/CaseManagementProject.ts index 40d9b6cfb735..410ec4bcddab 100644 --- a/services/security_monitoring/src/v2/models/CaseManagementProject.ts +++ b/services/security_monitoring/src/v2/models/CaseManagementProject.ts @@ -6,6 +6,9 @@ import { CaseManagementProjectData } from "./CaseManagementProjectData"; * Case management project. */ export class CaseManagementProject { + /** + * Data object representing a case management project. + */ "data": CaseManagementProjectData; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/CaseManagementProjectData.ts b/services/security_monitoring/src/v2/models/CaseManagementProjectData.ts index 0c26b20f8481..f2ca05c7c8f4 100644 --- a/services/security_monitoring/src/v2/models/CaseManagementProjectData.ts +++ b/services/security_monitoring/src/v2/models/CaseManagementProjectData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CaseManagementProjectDataType } from "./CaseManagementProjectDataType"; +/** + * Data object representing a case management project. + */ export class CaseManagementProjectData { /** * Unique identifier of the case management project. diff --git a/services/security_monitoring/src/v2/models/CreateCaseRequestArray.ts b/services/security_monitoring/src/v2/models/CreateCaseRequestArray.ts index faa116057b17..5f06c5f924f1 100644 --- a/services/security_monitoring/src/v2/models/CreateCaseRequestArray.ts +++ b/services/security_monitoring/src/v2/models/CreateCaseRequestArray.ts @@ -6,6 +6,9 @@ import { CreateCaseRequestData } from "./CreateCaseRequestData"; * List of requests to create cases for security findings. */ export class CreateCaseRequestArray { + /** + * Array of case creation request data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/CreateJiraIssueRequestArray.ts b/services/security_monitoring/src/v2/models/CreateJiraIssueRequestArray.ts index 5fae480e6c42..946654d83139 100644 --- a/services/security_monitoring/src/v2/models/CreateJiraIssueRequestArray.ts +++ b/services/security_monitoring/src/v2/models/CreateJiraIssueRequestArray.ts @@ -6,6 +6,9 @@ import { CreateJiraIssueRequestData } from "./CreateJiraIssueRequestData"; * List of requests to create Jira issues for security findings. */ export class CreateJiraIssueRequestArray { + /** + * Array of Jira issue creation request data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/FindingCaseResponseArray.ts b/services/security_monitoring/src/v2/models/FindingCaseResponseArray.ts index d14e2d660601..4557718829e3 100644 --- a/services/security_monitoring/src/v2/models/FindingCaseResponseArray.ts +++ b/services/security_monitoring/src/v2/models/FindingCaseResponseArray.ts @@ -6,6 +6,9 @@ import { FindingCaseResponseData } from "./FindingCaseResponseData"; * List of case responses. */ export class FindingCaseResponseArray { + /** + * Array of case response data objects. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/FindingCaseResponseDataAttributes.ts b/services/security_monitoring/src/v2/models/FindingCaseResponseDataAttributes.ts index 043b5df22d99..64aea6e2d363 100644 --- a/services/security_monitoring/src/v2/models/FindingCaseResponseDataAttributes.ts +++ b/services/security_monitoring/src/v2/models/FindingCaseResponseDataAttributes.ts @@ -16,6 +16,9 @@ export class FindingCaseResponseDataAttributes { * Relationship to user. */ "assignedTo"?: RelationshipToUser; + /** + * Custom attributes associated with the case as key-value pairs where values are string arrays. + */ "attributes"?: { [key: string]: Array }; /** * Timestamp of when the case was closed. diff --git a/services/security_monitoring/src/v2/models/FindingData.ts b/services/security_monitoring/src/v2/models/FindingData.ts index 3d962bc3f9a5..8353ed12034a 100644 --- a/services/security_monitoring/src/v2/models/FindingData.ts +++ b/services/security_monitoring/src/v2/models/FindingData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { FindingDataType } from "./FindingDataType"; +/** + * Data object representing a security finding. + */ export class FindingData { /** * Unique identifier of the security finding. diff --git a/services/security_monitoring/src/v2/models/Findings.ts b/services/security_monitoring/src/v2/models/Findings.ts index dd671e7d61e7..08cb9e6d33b4 100644 --- a/services/security_monitoring/src/v2/models/Findings.ts +++ b/services/security_monitoring/src/v2/models/Findings.ts @@ -6,6 +6,9 @@ import { FindingData } from "./FindingData"; * A list of security findings. */ export class Findings { + /** + * Array of security finding data objects. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequest.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequest.ts index 4fab39f6cce9..1f1353917286 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequest.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsRequestData } from "./GetMultipleRulesetsRequestData"; +/** + * The request payload for retrieving rules for multiple rulesets in a single batch call. + */ export class GetMultipleRulesetsRequest { + /** + * The primary data object in the get-multiple-rulesets request, containing request attributes and resource type. + */ "data"?: GetMultipleRulesetsRequestData; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestData.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestData.ts index 66bb74859d3a..17fd8a8e45fd 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestData.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsRequestDataAttributes } from "./GetMultipleRulesetsRequestDataAttributes"; import { GetMultipleRulesetsRequestDataType } from "./GetMultipleRulesetsRequestDataType"; +/** + * The primary data object in the get-multiple-rulesets request, containing request attributes and resource type. + */ export class GetMultipleRulesetsRequestData { + /** + * The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. + */ "attributes"?: GetMultipleRulesetsRequestDataAttributes; + /** + * An optional identifier for the get-multiple-rulesets request resource. + */ "id"?: string; /** * Get multiple rulesets request resource type. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestDataAttributes.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestDataAttributes.ts index 6899e1793860..fdf68bed5d72 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestDataAttributes.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsRequestDataAttributes.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include. + */ export class GetMultipleRulesetsRequestDataAttributes { + /** + * When true, rules that are available in testing mode are included in the response. + */ "includeTestingRules"?: boolean; + /** + * When true, test cases associated with each rule are included in the response. + */ "includeTests"?: boolean; + /** + * The list of ruleset names to retrieve. + */ "rulesets"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponse.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponse.ts index f8913e5a788e..6b4067a0e523 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponse.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseData } from "./GetMultipleRulesetsResponseData"; +/** + * The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules. + */ export class GetMultipleRulesetsResponse { + /** + * The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type. + */ "data"?: GetMultipleRulesetsResponseData; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseData.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseData.ts index e436fed16501..313f3fccba12 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseData.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseDataAttributes } from "./GetMultipleRulesetsResponseDataAttributes"; import { GetMultipleRulesetsResponseDataType } from "./GetMultipleRulesetsResponseDataType"; +/** + * The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type. + */ export class GetMultipleRulesetsResponseData { + /** + * The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. + */ "attributes"?: GetMultipleRulesetsResponseDataAttributes; + /** + * The unique identifier of the get-multiple-rulesets response resource. + */ "id"?: string; /** * Get multiple rulesets response resource type. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributes.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributes.ts index 12919b101337..041d0b864474 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributes.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItems } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItems"; +/** + * The attributes of the get-multiple-rulesets response, containing the list of requested rulesets. + */ export class GetMultipleRulesetsResponseDataAttributes { + /** + * The list of rulesets returned in response to the batch request. + */ "rulesets"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItems.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItems.ts index a91b45f0b443..5c703ad8f2af 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItems.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItems.ts @@ -3,11 +3,29 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsData } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsData"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems"; +/** + * A ruleset returned in the response, containing its metadata and associated rules. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItems { + /** + * The resource identifier and type for a ruleset. + */ "data": GetMultipleRulesetsResponseDataAttributesRulesetsItemsData; + /** + * A detailed description of the ruleset's purpose and the types of issues it targets. + */ "description"?: string; + /** + * The unique name of the ruleset. + */ "name"?: string; + /** + * The list of static analysis rules included in this ruleset. + */ "rules"?: Array; + /** + * A brief summary of the ruleset, suitable for display in listings. + */ "shortDescription"?: string; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData.ts index 043f1d4a3763..54071102b175 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsDataType"; +/** + * The resource identifier and type for a ruleset. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItemsData { + /** + * The unique identifier of the ruleset resource. + */ "id"?: string; /** * Rulesets resource type. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems.ts index 956e6aa0d75c..5c455cfa672e 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems.ts @@ -4,31 +4,109 @@ import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumen import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems"; +/** + * A static analysis rule within a ruleset, including its definition, metadata, and associated test cases. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems { + /** + * The list of configurable arguments accepted by this rule. + */ "arguments"?: Array; + /** + * The category classifying the type of issue this rule detects (e.g., security, style, performance). + */ "category"?: string; + /** + * A checksum of the rule definition used to detect changes. + */ "checksum"?: string; + /** + * The rule implementation code used by the static analysis engine. + */ "code"?: string; + /** + * The date and time when the rule was created. + */ "createdAt"?: Date; + /** + * The identifier of the user or system that created the rule. + */ "createdBy"?: string; + /** + * The CVE identifier associated with the vulnerability this rule detects, if applicable. + */ "cve"?: string; + /** + * The CWE identifier associated with the weakness category this rule detects, if applicable. + */ "cwe"?: string; + /** + * The resource identifier and type for a static analysis rule. + */ "data": GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData; + /** + * A detailed explanation of what the rule detects and why it matters. + */ "description"?: string; + /** + * A URL pointing to additional documentation for this rule. + */ "documentationUrl"?: string; + /** + * The code entity type (e.g., function, class, variable) that this rule inspects. + */ "entityChecked"?: string; + /** + * Indicates whether the rule is publicly published and available to all users. + */ "isPublished"?: boolean; + /** + * Indicates whether the rule is in testing mode and not yet promoted to production. + */ "isTesting"?: boolean; + /** + * The programming language this rule applies to. + */ "language"?: string; + /** + * The date and time when the rule was last modified. + */ "lastUpdatedAt"?: Date; + /** + * The identifier of the user or system that last updated the rule. + */ "lastUpdatedBy"?: string; + /** + * The unique name identifying this rule within its ruleset. + */ "name"?: string; + /** + * A regular expression pattern used by the rule for pattern-based detection. + */ "regex"?: string; + /** + * The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE). + */ "severity"?: string; + /** + * A brief summary of what the rule detects, suitable for display in listings. + */ "shortDescription"?: string; + /** + * Indicates whether an AI-generated fix suggestion should be offered for findings from this rule. + */ "shouldUseAiFix"?: boolean; + /** + * The list of test cases used to validate the rule's behavior. + */ "tests"?: Array; + /** + * The Tree-sitter query expression used by the rule to match code patterns in the AST. + */ "treeSitterQuery"?: string; + /** + * The rule type indicating the detection mechanism used (e.g., tree_sitter, regex). + */ "type"?: string; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems.ts index 1c94a03a7cd1..b5c3a053327b 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * An argument parameter for a static analysis rule, with a name and description. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems { + /** + * A human-readable explanation of the argument's purpose and accepted values. + */ "description"?: string; + /** + * The name of the rule argument. + */ "name"?: string; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData.ts index 6426de0f21db..504792155beb 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType } from "./GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsDataType"; +/** + * The resource identifier and type for a static analysis rule. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData { + /** + * The unique identifier of the rule resource. + */ "id"?: string; /** * Rules resource type. diff --git a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems.ts b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems.ts index 190c26c87e5a..99cafbbb21c8 100644 --- a/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems.ts +++ b/services/security_monitoring/src/v2/models/GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A test case associated with a static analysis rule, containing the source code and expected annotation count. + */ export class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems { + /** + * The expected number of annotations (findings) the rule should produce when run against the test code. + */ "annotationCount"?: number; + /** + * The source code snippet used as input for the rule test. + */ "code"?: string; + /** + * The filename associated with the test code snippet. + */ "filename"?: string; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/SecretRuleArray.ts b/services/security_monitoring/src/v2/models/SecretRuleArray.ts index b3a7b3852be9..bab267e590f6 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleArray.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SecretRuleData } from "./SecretRuleData"; +/** + * A collection of secret detection rules returned by the list endpoint. + */ export class SecretRuleArray { + /** + * The list of secret detection rules. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/SecretRuleData.ts b/services/security_monitoring/src/v2/models/SecretRuleData.ts index a0470239b6af..d399695c890b 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleData.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SecretRuleDataAttributes } from "./SecretRuleDataAttributes"; import { SecretRuleDataType } from "./SecretRuleDataType"; +/** + * The data object representing a secret detection rule, including its attributes and resource type. + */ export class SecretRuleData { + /** + * The attributes of a secret detection rule, including its pattern, priority, and validation configuration. + */ "attributes"?: SecretRuleDataAttributes; + /** + * The unique identifier of the secret rule resource. + */ "id"?: string; /** * Secret rule resource type. diff --git a/services/security_monitoring/src/v2/models/SecretRuleDataAttributes.ts b/services/security_monitoring/src/v2/models/SecretRuleDataAttributes.ts index bb0bc9394ddb..8b589425cb03 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleDataAttributes.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleDataAttributes.ts @@ -2,15 +2,45 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SecretRuleDataAttributesMatchValidation } from "./SecretRuleDataAttributesMatchValidation"; +/** + * The attributes of a secret detection rule, including its pattern, priority, and validation configuration. + */ export class SecretRuleDataAttributes { + /** + * A list of keywords that are included by default when scanning for secrets matching this rule. + */ "defaultIncludedKeywords"?: Array; + /** + * A detailed explanation of what type of secret this rule detects. + */ "description"?: string; + /** + * The license under which this secret rule is distributed. + */ "license"?: string; + /** + * Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. + */ "matchValidation"?: SecretRuleDataAttributesMatchValidation; + /** + * The unique name of the secret detection rule. + */ "name"?: string; + /** + * The regular expression pattern used to identify potential secrets in source code or configuration. + */ "pattern"?: string; + /** + * The priority level of this rule, used to rank findings when multiple rules match. + */ "priority"?: string; + /** + * The identifier of the corresponding Sensitive Data Scanner rule, if one exists. + */ "sdsId"?: string; + /** + * A list of validator identifiers used to further confirm a detected secret is genuine. + */ "validators"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidation.ts b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidation.ts index dddca910fd10..79d71555c3ec 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidation.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidation.ts @@ -3,14 +3,41 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems } from "./SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems"; import { SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems } from "./SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems"; +/** + * Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response. + */ export class SecretRuleDataAttributesMatchValidation { + /** + * The URL endpoint to call when validating a detected secret. + */ "endpoint"?: string; + /** + * The list of hostnames to include when performing secret match validation. + */ "hosts"?: Array; + /** + * The HTTP method (e.g., GET, POST) to use when making the validation request. + */ "httpMethod"?: string; + /** + * The HTTP status code ranges that indicate the detected secret is invalid or inactive. + */ "invalidHttpStatusCode"?: Array; + /** + * A map of HTTP header names to values to include in the validation request. + */ "requestHeaders"?: { [key: string]: string }; + /** + * The maximum number of seconds to wait for a response during validation before timing out. + */ "timeoutSeconds"?: number; + /** + * The type of match validation to perform (e.g., http). + */ "type"?: string; + /** + * The HTTP status code ranges that indicate the detected secret is valid and active. + */ "validHttpStatusCode"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems.ts b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems.ts index 1fc190511efc..4f12c2f24a42 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * An HTTP status code range that indicates an invalid (unsuccessful) secret match during validation. + */ export class SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems { + /** + * The inclusive upper bound of the HTTP status code range. + */ "end"?: number; + /** + * The inclusive lower bound of the HTTP status code range. + */ "start"?: number; /** * A container for additional, undeclared properties. diff --git a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems.ts b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems.ts index a4bd22c637bd..dd0a0afaf63a 100644 --- a/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems.ts +++ b/services/security_monitoring/src/v2/models/SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * An HTTP status code range that indicates a valid (successful) secret match during validation. + */ export class SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems { + /** + * The inclusive upper bound of the HTTP status code range. + */ "end"?: number; + /** + * The inclusive lower bound of the HTTP status code range. + */ "start"?: number; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseArray.ts b/services/software_catalog/src/v2/models/EntityResponseArray.ts index 9f40a532e21c..20af9408e8c4 100644 --- a/services/software_catalog/src/v2/models/EntityResponseArray.ts +++ b/services/software_catalog/src/v2/models/EntityResponseArray.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PreviewEntityResponseData } from "./PreviewEntityResponseData"; +/** + * Response object containing an array of entity data items. + */ export class EntityResponseArray { + /** + * Array of entity response data items. + */ "data": Array; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataAttributes.ts b/services/software_catalog/src/v2/models/EntityResponseDataAttributes.ts index 16b34a593459..0a525cb42429 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataAttributes.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataAttributes.ts @@ -1,14 +1,44 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Entity response attributes containing core entity metadata fields. + */ export class EntityResponseDataAttributes { + /** + * The API version of the entity schema. + */ "apiVersion"?: string; + /** + * A short description of the entity. + */ "description"?: string; + /** + * The user-friendly display name of the entity. + */ "displayName"?: string; + /** + * The kind of the entity (e.g. service, datastore, queue). + */ "kind"?: string; + /** + * The unique name of the entity within its kind and namespace. + */ "name"?: string; + /** + * The namespace the entity belongs to. + */ "namespace"?: string; + /** + * The owner of the entity, usually a team. + */ "owner"?: string; + /** + * Additional custom properties for the entity. + */ "properties"?: { [key: string]: any }; + /** + * A set of custom tags assigned to the entity. + */ "tags"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationships.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationships.ts index b6a43b5c0df9..6eb01d3a27ac 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationships.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationships.ts @@ -6,11 +6,29 @@ import { EntityResponseDataRelationshipsRawSchema } from "./EntityResponseDataRe import { EntityResponseDataRelationshipsRelatedEntities } from "./EntityResponseDataRelationshipsRelatedEntities"; import { EntityResponseDataRelationshipsSchema } from "./EntityResponseDataRelationshipsSchema"; +/** + * Entity relationships including incidents, oncalls, schemas, and related entities. + */ export class EntityResponseDataRelationships { + /** + * Incidents relationship containing a list of incident resources associated with this entity. + */ "incidents"?: EntityResponseDataRelationshipsIncidents; + /** + * Oncalls relationship containing a list of oncall resources associated with this entity. + */ "oncalls"?: EntityResponseDataRelationshipsOncalls; + /** + * Raw schema relationship linking an entity to its raw schema resource. + */ "rawSchema"?: EntityResponseDataRelationshipsRawSchema; + /** + * Related entities relationship containing a list of entity references related to this entity. + */ "relatedEntities"?: EntityResponseDataRelationshipsRelatedEntities; + /** + * Schema relationship linking an entity to its associated schema resource. + */ "schema"?: EntityResponseDataRelationshipsSchema; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidents.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidents.ts index eca90ec350c5..05157657ff9b 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidents.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidents.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsIncidentsDataItems } from "./EntityResponseDataRelationshipsIncidentsDataItems"; +/** + * Incidents relationship containing a list of incident resources associated with this entity. + */ export class EntityResponseDataRelationshipsIncidents { + /** + * List of incident relationship data items. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidentsDataItems.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidentsDataItems.ts index 549ed6b9e893..ec82f24f9efb 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidentsDataItems.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsIncidentsDataItems.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsIncidentsDataItemsType } from "./EntityResponseDataRelationshipsIncidentsDataItemsType"; +/** + * Incident relationship data item containing the incident resource identifier and type. + */ export class EntityResponseDataRelationshipsIncidentsDataItems { + /** + * Incident resource unique identifier. + */ "id": string; /** * Incident resource type. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncalls.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncalls.ts index 8314b400ec04..c4e74b471d19 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncalls.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncalls.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsOncallsDataItems } from "./EntityResponseDataRelationshipsOncallsDataItems"; +/** + * Oncalls relationship containing a list of oncall resources associated with this entity. + */ export class EntityResponseDataRelationshipsOncalls { + /** + * List of oncall relationship data items. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncallsDataItems.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncallsDataItems.ts index d8da01ec2282..4d36aee8951c 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncallsDataItems.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsOncallsDataItems.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsOncallsDataItemsType } from "./EntityResponseDataRelationshipsOncallsDataItemsType"; +/** + * Oncall relationship data item containing the oncall resource identifier and type. + */ export class EntityResponseDataRelationshipsOncallsDataItems { + /** + * Oncall resource unique identifier. + */ "id": string; /** * Oncall resource type. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchema.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchema.ts index 15c1a9841714..d71a60af7a09 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchema.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchema.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsRawSchemaData } from "./EntityResponseDataRelationshipsRawSchemaData"; +/** + * Raw schema relationship linking an entity to its raw schema resource. + */ export class EntityResponseDataRelationshipsRawSchema { + /** + * Raw schema relationship data containing the raw schema resource identifier and type. + */ "data": EntityResponseDataRelationshipsRawSchemaData; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchemaData.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchemaData.ts index 8e2025fc3cd4..5df6527567d2 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchemaData.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRawSchemaData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsRawSchemaDataType } from "./EntityResponseDataRelationshipsRawSchemaDataType"; +/** + * Raw schema relationship data containing the raw schema resource identifier and type. + */ export class EntityResponseDataRelationshipsRawSchemaData { + /** + * Raw schema unique identifier. + */ "id": string; /** * Raw schema resource type. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntities.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntities.ts index 400e0d9b0b1e..53e1eeeca013 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntities.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntities.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsRelatedEntitiesDataItems } from "./EntityResponseDataRelationshipsRelatedEntitiesDataItems"; +/** + * Related entities relationship containing a list of entity references related to this entity. + */ export class EntityResponseDataRelationshipsRelatedEntities { + /** + * List of related entity relationship data items. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntitiesDataItems.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntitiesDataItems.ts index fd3e73d19d8a..c08a9da85c73 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntitiesDataItems.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsRelatedEntitiesDataItems.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsRelatedEntitiesDataItemsType } from "./EntityResponseDataRelationshipsRelatedEntitiesDataItemsType"; +/** + * Related entity relationship data item containing the related entity resource identifier and type. + */ export class EntityResponseDataRelationshipsRelatedEntitiesDataItems { + /** + * Related entity unique identifier. + */ "id": string; /** * Related entity resource type. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchema.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchema.ts index b8b4bbe815e8..5e79256403d7 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchema.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchema.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsSchemaData } from "./EntityResponseDataRelationshipsSchemaData"; +/** + * Schema relationship linking an entity to its associated schema resource. + */ export class EntityResponseDataRelationshipsSchema { + /** + * Schema relationship data containing the schema resource identifier and type. + */ "data": EntityResponseDataRelationshipsSchemaData; /** * A container for additional, undeclared properties. diff --git a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchemaData.ts b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchemaData.ts index ad47e56abbe1..132f2b99e230 100644 --- a/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchemaData.ts +++ b/services/software_catalog/src/v2/models/EntityResponseDataRelationshipsSchemaData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { EntityResponseDataRelationshipsSchemaDataType } from "./EntityResponseDataRelationshipsSchemaDataType"; +/** + * Schema relationship data containing the schema resource identifier and type. + */ export class EntityResponseDataRelationshipsSchemaData { + /** + * Entity schema unique identifier. + */ "id": string; /** * Schema resource type. diff --git a/services/software_catalog/src/v2/models/PreviewEntityResponseData.ts b/services/software_catalog/src/v2/models/PreviewEntityResponseData.ts index fae8b43ef32d..0ca629e89452 100644 --- a/services/software_catalog/src/v2/models/PreviewEntityResponseData.ts +++ b/services/software_catalog/src/v2/models/PreviewEntityResponseData.ts @@ -4,9 +4,21 @@ import { EntityResponseDataAttributes } from "./EntityResponseDataAttributes"; import { EntityResponseDataRelationships } from "./EntityResponseDataRelationships"; import { EntityResponseDataType } from "./EntityResponseDataType"; +/** + * Entity data returned in a preview response, including attributes, relationships, and type. + */ export class PreviewEntityResponseData { + /** + * Entity response attributes containing core entity metadata fields. + */ "attributes"?: EntityResponseDataAttributes; + /** + * Entity unique identifier. + */ "id"?: string; + /** + * Entity relationships including incidents, oncalls, schemas, and related entities. + */ "relationships"?: EntityResponseDataRelationships; /** * Entity resource type. diff --git a/services/spa/src/v2/models/RecommendationAttributes.ts b/services/spa/src/v2/models/RecommendationAttributes.ts index 90db9452006b..6124ca45c37a 100644 --- a/services/spa/src/v2/models/RecommendationAttributes.ts +++ b/services/spa/src/v2/models/RecommendationAttributes.ts @@ -6,6 +6,9 @@ import { ComponentRecommendation } from "./ComponentRecommendation"; * Attributes of the SPA Recommendation resource. Contains recommendations for both driver and executor components. */ export class RecommendationAttributes { + /** + * The confidence level of the recommendation, expressed as a value between 0.0 (low confidence) and 1.0 (high confidence). + */ "confidenceLevel"?: number; /** * Resource recommendation for a single Spark component (driver or executor). Contains estimation data used to patch Spark job specs. diff --git a/services/static_analysis/src/v2/models/Argument.ts b/services/static_analysis/src/v2/models/Argument.ts index 205b8a352608..ececa7a92c02 100644 --- a/services/static_analysis/src/v2/models/Argument.ts +++ b/services/static_analysis/src/v2/models/Argument.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A named argument for a custom static analysis rule. + */ export class Argument { /** * Base64-encoded argument description diff --git a/services/static_analysis/src/v2/models/CustomRule.ts b/services/static_analysis/src/v2/models/CustomRule.ts index 318cec90d94e..a2c011d3e840 100644 --- a/services/static_analysis/src/v2/models/CustomRule.ts +++ b/services/static_analysis/src/v2/models/CustomRule.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevision } from "./CustomRuleRevision"; +/** + * A custom static analysis rule within a ruleset. + */ export class CustomRule { /** * Creation timestamp @@ -11,6 +14,9 @@ export class CustomRule { * Creator identifier */ "createdBy": string; + /** + * A specific revision of a custom static analysis rule. + */ "lastRevision": CustomRuleRevision; /** * Rule name diff --git a/services/static_analysis/src/v2/models/CustomRuleRequest.ts b/services/static_analysis/src/v2/models/CustomRuleRequest.ts index 81ae5de4b175..9a16990f489d 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRequest.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRequestData } from "./CustomRuleRequestData"; +/** + * Request body for creating or updating a custom rule. + */ export class CustomRuleRequest { + /** + * Data object for a custom rule create or update request. + */ "data"?: CustomRuleRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRuleRequestData.ts b/services/static_analysis/src/v2/models/CustomRuleRequestData.ts index 7b7ac8417cea..540e5033152d 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRequestData.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleDataType } from "./CustomRuleDataType"; import { CustomRuleRequestDataAttributes } from "./CustomRuleRequestDataAttributes"; +/** + * Data object for a custom rule create or update request. + */ export class CustomRuleRequestData { + /** + * Attributes for creating or updating a custom rule. + */ "attributes"?: CustomRuleRequestDataAttributes; /** * Rule identifier diff --git a/services/static_analysis/src/v2/models/CustomRuleRequestDataAttributes.ts b/services/static_analysis/src/v2/models/CustomRuleRequestDataAttributes.ts index 3c63618f6230..77bfc2a766ce 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRequestDataAttributes.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRequestDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for creating or updating a custom rule. + */ export class CustomRuleRequestDataAttributes { /** * Rule name diff --git a/services/static_analysis/src/v2/models/CustomRuleResponse.ts b/services/static_analysis/src/v2/models/CustomRuleResponse.ts index db3c2e5a716a..078862b36a6d 100644 --- a/services/static_analysis/src/v2/models/CustomRuleResponse.ts +++ b/services/static_analysis/src/v2/models/CustomRuleResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleResponseData } from "./CustomRuleResponseData"; +/** + * Response containing a single custom rule. + */ export class CustomRuleResponse { + /** + * Data object returned in a custom rule response, including its ID, type, and attributes. + */ "data": CustomRuleResponseData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRuleResponseData.ts b/services/static_analysis/src/v2/models/CustomRuleResponseData.ts index 2bb36771a5e4..b8b15ad99bf1 100644 --- a/services/static_analysis/src/v2/models/CustomRuleResponseData.ts +++ b/services/static_analysis/src/v2/models/CustomRuleResponseData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRule } from "./CustomRule"; import { CustomRuleDataType } from "./CustomRuleDataType"; +/** + * Data object returned in a custom rule response, including its ID, type, and attributes. + */ export class CustomRuleResponseData { + /** + * A custom static analysis rule within a ruleset. + */ "attributes": CustomRule; /** * Rule identifier diff --git a/services/static_analysis/src/v2/models/CustomRuleRevision.ts b/services/static_analysis/src/v2/models/CustomRuleRevision.ts index ba826457ea4c..055e7694b256 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevision.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevision.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevisionAttributes } from "./CustomRuleRevisionAttributes"; import { CustomRuleRevisionDataType } from "./CustomRuleRevisionDataType"; +/** + * A specific revision of a custom static analysis rule. + */ export class CustomRuleRevision { + /** + * Attributes of a custom rule revision, including code, metadata, and test cases. + */ "attributes": CustomRuleRevisionAttributes; /** * Revision identifier diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionAttributes.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionAttributes.ts index 8daab18de68d..d3f3ed27ee63 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionAttributes.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionAttributes.ts @@ -6,6 +6,9 @@ import { CustomRuleRevisionAttributesSeverity } from "./CustomRuleRevisionAttrib import { CustomRuleRevisionTest } from "./CustomRuleRevisionTest"; import { Language } from "./Language"; +/** + * Attributes of a custom rule revision, including code, metadata, and test cases. + */ export class CustomRuleRevisionAttributes { /** * Rule arguments diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionInputAttributes.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionInputAttributes.ts index a7e06d88c597..b4cd0e8c94e1 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionInputAttributes.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionInputAttributes.ts @@ -6,6 +6,9 @@ import { CustomRuleRevisionAttributesSeverity } from "./CustomRuleRevisionAttrib import { CustomRuleRevisionTest } from "./CustomRuleRevisionTest"; import { Language } from "./Language"; +/** + * Input attributes for creating or updating a custom rule revision. + */ export class CustomRuleRevisionInputAttributes { /** * Rule arguments diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionRequest.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionRequest.ts index 08327b727cf5..fbf89cea8090 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionRequest.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevisionRequestData } from "./CustomRuleRevisionRequestData"; +/** + * Request body for creating a new custom rule revision. + */ export class CustomRuleRevisionRequest { + /** + * Data object for a custom rule revision create request. + */ "data"?: CustomRuleRevisionRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionRequestData.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionRequestData.ts index d2c38dadef86..f23f0032e4ee 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionRequestData.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevisionDataType } from "./CustomRuleRevisionDataType"; import { CustomRuleRevisionInputAttributes } from "./CustomRuleRevisionInputAttributes"; +/** + * Data object for a custom rule revision create request. + */ export class CustomRuleRevisionRequestData { + /** + * Input attributes for creating or updating a custom rule revision. + */ "attributes"?: CustomRuleRevisionInputAttributes; /** * Revision identifier diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionResponse.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionResponse.ts index b41609ec0ea6..0c3b8c54aab5 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionResponse.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevision } from "./CustomRuleRevision"; +/** + * Response containing a single custom rule revision. + */ export class CustomRuleRevisionResponse { + /** + * A specific revision of a custom static analysis rule. + */ "data": CustomRuleRevision; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionTest.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionTest.ts index 10104675c907..ff6b9a0f0f7b 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionTest.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionTest.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A test case associated with a custom rule revision, used to validate rule behavior. + */ export class CustomRuleRevisionTest { /** * Expected violation count diff --git a/services/static_analysis/src/v2/models/CustomRuleRevisionsResponse.ts b/services/static_analysis/src/v2/models/CustomRuleRevisionsResponse.ts index 18a25f3c45c9..7db334a12e1c 100644 --- a/services/static_analysis/src/v2/models/CustomRuleRevisionsResponse.ts +++ b/services/static_analysis/src/v2/models/CustomRuleRevisionsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleRevision } from "./CustomRuleRevision"; +/** + * Response containing a paginated list of custom rule revisions. + */ export class CustomRuleRevisionsResponse { + /** + * List of custom rule revisions. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRuleset.ts b/services/static_analysis/src/v2/models/CustomRuleset.ts index 759fc7822092..a332ff42636b 100644 --- a/services/static_analysis/src/v2/models/CustomRuleset.ts +++ b/services/static_analysis/src/v2/models/CustomRuleset.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRulesetAttributes } from "./CustomRulesetAttributes"; import { CustomRulesetDataType } from "./CustomRulesetDataType"; +/** + * A custom static analysis ruleset containing a set of user-defined rules. + */ export class CustomRuleset { + /** + * Attributes of a custom ruleset, including its name, description, and rules. + */ "attributes": CustomRulesetAttributes; /** * Ruleset identifier diff --git a/services/static_analysis/src/v2/models/CustomRulesetAttributes.ts b/services/static_analysis/src/v2/models/CustomRulesetAttributes.ts index e2180de348ec..f11cdbd8d4ec 100644 --- a/services/static_analysis/src/v2/models/CustomRulesetAttributes.ts +++ b/services/static_analysis/src/v2/models/CustomRulesetAttributes.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRule } from "./CustomRule"; +/** + * Attributes of a custom ruleset, including its name, description, and rules. + */ export class CustomRulesetAttributes { /** * Creation timestamp diff --git a/services/static_analysis/src/v2/models/CustomRulesetRequest.ts b/services/static_analysis/src/v2/models/CustomRulesetRequest.ts index 0e1823224210..57d1059632f0 100644 --- a/services/static_analysis/src/v2/models/CustomRulesetRequest.ts +++ b/services/static_analysis/src/v2/models/CustomRulesetRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRulesetRequestData } from "./CustomRulesetRequestData"; +/** + * Request body for creating or updating a custom ruleset. + */ export class CustomRulesetRequest { + /** + * Data object for a custom ruleset create or update request. + */ "data"?: CustomRulesetRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/CustomRulesetRequestData.ts b/services/static_analysis/src/v2/models/CustomRulesetRequestData.ts index 1f782651b80d..24059a931b50 100644 --- a/services/static_analysis/src/v2/models/CustomRulesetRequestData.ts +++ b/services/static_analysis/src/v2/models/CustomRulesetRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRulesetDataType } from "./CustomRulesetDataType"; import { CustomRulesetRequestDataAttributes } from "./CustomRulesetRequestDataAttributes"; +/** + * Data object for a custom ruleset create or update request. + */ export class CustomRulesetRequestData { + /** + * Attributes for creating or updating a custom ruleset. + */ "attributes"?: CustomRulesetRequestDataAttributes; /** * Ruleset identifier diff --git a/services/static_analysis/src/v2/models/CustomRulesetRequestDataAttributes.ts b/services/static_analysis/src/v2/models/CustomRulesetRequestDataAttributes.ts index a795b9108c83..9e5195b7b95f 100644 --- a/services/static_analysis/src/v2/models/CustomRulesetRequestDataAttributes.ts +++ b/services/static_analysis/src/v2/models/CustomRulesetRequestDataAttributes.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRule } from "./CustomRule"; +/** + * Attributes for creating or updating a custom ruleset. + */ export class CustomRulesetRequestDataAttributes { /** * Base64-encoded full description diff --git a/services/static_analysis/src/v2/models/CustomRulesetResponse.ts b/services/static_analysis/src/v2/models/CustomRulesetResponse.ts index 4059b52d44b7..ba0b85b9b686 100644 --- a/services/static_analysis/src/v2/models/CustomRulesetResponse.ts +++ b/services/static_analysis/src/v2/models/CustomRulesetResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CustomRuleset } from "./CustomRuleset"; +/** + * Response containing a single custom ruleset. + */ export class CustomRulesetResponse { + /** + * A custom static analysis ruleset containing a set of user-defined rules. + */ "data": CustomRuleset; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequest.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequest.ts index afb0df98e99d..53e20e8db5d1 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequest.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsRequestData } from "./ResolveVulnerableSymbolsRequestData"; +/** + * The top-level request object for resolving vulnerable symbols in a set of packages. + */ export class ResolveVulnerableSymbolsRequest { + /** + * The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type. + */ "data"?: ResolveVulnerableSymbolsRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestData.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestData.ts index a22f8bdd3744..df0a6f2955f1 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestData.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestData.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsRequestDataAttributes } from "./ResolveVulnerableSymbolsRequestDataAttributes"; import { ResolveVulnerableSymbolsRequestDataType } from "./ResolveVulnerableSymbolsRequestDataType"; +/** + * The data object in a request to resolve vulnerable symbols, containing the package PURLs and request type. + */ export class ResolveVulnerableSymbolsRequestData { + /** + * The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. + */ "attributes"?: ResolveVulnerableSymbolsRequestDataAttributes; + /** + * An optional identifier for this request data object. + */ "id"?: string; + /** + * The type identifier for requests to resolve vulnerable symbols. + */ "type": ResolveVulnerableSymbolsRequestDataType; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataAttributes.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataAttributes.ts index 273dfdf4a8f8..b8fdae6e3288 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataAttributes.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataAttributes.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * The attributes of a request to resolve vulnerable symbols, containing the list of package PURLs to check. + */ export class ResolveVulnerableSymbolsRequestDataAttributes { + /** + * The list of Package URLs (PURLs) for which to resolve vulnerable symbols. + */ "purls"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataType.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataType.ts index 5962bbc1911f..37bc72a7a5cb 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataType.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsRequestDataType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The type identifier for requests to resolve vulnerable symbols. + */ export type ResolveVulnerableSymbolsRequestDataType = | typeof RESOLVE_VULNERABLE_SYMBOLS_REQUEST | UnparsedObject; diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponse.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponse.ts index a24d42eaf299..5f974b46cb01 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponse.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsResponseData } from "./ResolveVulnerableSymbolsResponseData"; +/** + * The top-level response object returned when resolving vulnerable symbols for a set of packages. + */ export class ResolveVulnerableSymbolsResponse { + /** + * The data object in a response for resolving vulnerable symbols, containing the result attributes and response type. + */ "data"?: ResolveVulnerableSymbolsResponseData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseData.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseData.ts index 3c495f72c178..853c212a74f0 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseData.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseData.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsResponseDataAttributes } from "./ResolveVulnerableSymbolsResponseDataAttributes"; import { ResolveVulnerableSymbolsResponseDataType } from "./ResolveVulnerableSymbolsResponseDataType"; +/** + * The data object in a response for resolving vulnerable symbols, containing the result attributes and response type. + */ export class ResolveVulnerableSymbolsResponseData { + /** + * The attributes of a response containing resolved vulnerable symbols, organized by package. + */ "attributes"?: ResolveVulnerableSymbolsResponseDataAttributes; + /** + * The unique identifier for this response data object. + */ "id"?: string; + /** + * The type identifier for responses containing resolved vulnerable symbols. + */ "type": ResolveVulnerableSymbolsResponseDataType; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataAttributes.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataAttributes.ts index 301eed01d0b2..36ecff22cf4d 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataAttributes.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataAttributes.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsResponseResults } from "./ResolveVulnerableSymbolsResponseResults"; +/** + * The attributes of a response containing resolved vulnerable symbols, organized by package. + */ export class ResolveVulnerableSymbolsResponseDataAttributes { + /** + * The list of resolved vulnerable symbol results, one entry per queried package. + */ "results"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataType.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataType.ts index 782ce72de7a9..41c3ebfbc6aa 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataType.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseDataType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The type identifier for responses containing resolved vulnerable symbols. + */ export type ResolveVulnerableSymbolsResponseDataType = | typeof RESOLVE_VULNERABLE_SYMBOLS_RESPONSE | UnparsedObject; diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResults.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResults.ts index 2e592d9968b8..3de136226ce1 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResults.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResults.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsResponseResultsVulnerableSymbols } from "./ResolveVulnerableSymbolsResponseResultsVulnerableSymbols"; +/** + * The result of resolving vulnerable symbols for a specific package, identified by its PURL. + */ export class ResolveVulnerableSymbolsResponseResults { + /** + * The Package URL (PURL) uniquely identifying the package for which vulnerable symbols are resolved. + */ "purl"?: string; + /** + * The list of vulnerable symbol groups found in this package, organized by advisory. + */ "vulnerableSymbols"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols.ts index 4caf0d234cd8..16a63629aa49 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbols.ts @@ -2,8 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols } from "./ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols"; +/** + * A collection of vulnerable symbols associated with a specific security advisory. + */ export class ResolveVulnerableSymbolsResponseResultsVulnerableSymbols { + /** + * The identifier of the security advisory that describes the vulnerability. + */ "advisoryId"?: string; + /** + * The list of symbols that are vulnerable according to this advisory. + */ "symbols"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols.ts b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols.ts index f919c5efb9fd..7207d669b61e 100644 --- a/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols.ts +++ b/services/static_analysis/src/v2/models/ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols.ts @@ -1,8 +1,20 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A symbol identified as vulnerable within a dependency, including its name, type, and value. + */ export class ResolveVulnerableSymbolsResponseResultsVulnerableSymbolsSymbols { + /** + * The name of the vulnerable symbol. + */ "name"?: string; + /** + * The type classification of the vulnerable symbol (e.g., function, class, variable). + */ "type"?: string; + /** + * The value or identifier associated with the vulnerable symbol. + */ "value"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequest.ts b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequest.ts index 2032351623ec..26d082427536 100644 --- a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequest.ts +++ b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { RevertCustomRuleRevisionRequestData } from "./RevertCustomRuleRevisionRequestData"; +/** + * Request body for reverting a custom rule to a previous revision. + */ export class RevertCustomRuleRevisionRequest { + /** + * Data object for a request to revert a custom rule to a previous revision. + */ "data"?: RevertCustomRuleRevisionRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestData.ts b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestData.ts index a7d33f75c665..c4dd7058e53c 100644 --- a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestData.ts +++ b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { RevertCustomRuleRevisionDataType } from "./RevertCustomRuleRevisionDataType"; import { RevertCustomRuleRevisionRequestDataAttributes } from "./RevertCustomRuleRevisionRequestDataAttributes"; +/** + * Data object for a request to revert a custom rule to a previous revision. + */ export class RevertCustomRuleRevisionRequestData { + /** + * Attributes specifying the current and target revision IDs for a revert operation. + */ "attributes"?: RevertCustomRuleRevisionRequestDataAttributes; /** * Request identifier diff --git a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestDataAttributes.ts b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestDataAttributes.ts index 41a80b5adeaf..c0bba8b657d5 100644 --- a/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestDataAttributes.ts +++ b/services/static_analysis/src/v2/models/RevertCustomRuleRevisionRequestDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes specifying the current and target revision IDs for a revert operation. + */ export class RevertCustomRuleRevisionRequestDataAttributes { /** * Current revision ID diff --git a/services/static_analysis/src/v2/models/ScaRequest.ts b/services/static_analysis/src/v2/models/ScaRequest.ts index 49afe3a02189..d6c3a8c7910e 100644 --- a/services/static_analysis/src/v2/models/ScaRequest.ts +++ b/services/static_analysis/src/v2/models/ScaRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestData } from "./ScaRequestData"; +/** + * The top-level request object for submitting a Software Composition Analysis (SCA) scan result. + */ export class ScaRequest { + /** + * The data object in an SCA request, containing the dependency graph attributes and request type. + */ "data"?: ScaRequestData; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestData.ts b/services/static_analysis/src/v2/models/ScaRequestData.ts index 46fbc53b4b65..c34d8662629b 100644 --- a/services/static_analysis/src/v2/models/ScaRequestData.ts +++ b/services/static_analysis/src/v2/models/ScaRequestData.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestDataAttributes } from "./ScaRequestDataAttributes"; import { ScaRequestDataType } from "./ScaRequestDataType"; +/** + * The data object in an SCA request, containing the dependency graph attributes and request type. + */ export class ScaRequestData { + /** + * The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. + */ "attributes"?: ScaRequestDataAttributes; + /** + * An optional identifier for this SCA request data object. + */ "id"?: string; + /** + * The type identifier for SCA dependency analysis requests. + */ "type": ScaRequestDataType; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributes.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributes.ts index f8c0eacc0969..9594d4b2b2e2 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributes.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributes.ts @@ -7,15 +7,45 @@ import { ScaRequestDataAttributesRelationsItems } from "./ScaRequestDataAttribut import { ScaRequestDataAttributesRepository } from "./ScaRequestDataAttributesRepository"; import { ScaRequestDataAttributesVulnerabilitiesItems } from "./ScaRequestDataAttributesVulnerabilitiesItems"; +/** + * The attributes of an SCA request, containing dependency graph data, vulnerability information, and repository context. + */ export class ScaRequestDataAttributes { + /** + * Metadata about the commit associated with the SCA scan, including author, committer, and branch information. + */ "commit"?: ScaRequestDataAttributesCommit; + /** + * The list of dependencies discovered in the repository. + */ "dependencies"?: Array; + /** + * The environment context in which the SCA scan was performed (e.g., production, staging). + */ "env"?: string; + /** + * The list of dependency manifest files found in the repository. + */ "files"?: Array; + /** + * The dependency relations describing the inter-component dependency graph. + */ "relations"?: Array; + /** + * Information about the source code repository being analyzed. + */ "repository"?: ScaRequestDataAttributesRepository; + /** + * The name of the service or application being analyzed. + */ "service"?: string; + /** + * A map of key-value tags providing additional metadata for the SCA scan. + */ "tags"?: { [key: string]: string }; + /** + * The list of vulnerabilities identified in the dependency graph. + */ "vulnerabilities"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesCommit.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesCommit.ts index 016c4395eb57..e964a3011ccd 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesCommit.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesCommit.ts @@ -1,12 +1,36 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Metadata about the commit associated with the SCA scan, including author, committer, and branch information. + */ export class ScaRequestDataAttributesCommit { + /** + * The date when the commit was authored. + */ "authorDate"?: string; + /** + * The email address of the commit author. + */ "authorEmail"?: string; + /** + * The full name of the commit author. + */ "authorName"?: string; + /** + * The branch name on which the commit was made. + */ "branch"?: string; + /** + * The email address of the person who committed the change. + */ "committerEmail"?: string; + /** + * The full name of the person who committed the change. + */ "committerName"?: string; + /** + * The SHA hash uniquely identifying the commit. + */ "sha"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItems.ts index e71e7f21ba3e..cdbd31a78743 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItems.ts @@ -3,17 +3,53 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestDataAttributesDependenciesItemsLocationsItems } from "./ScaRequestDataAttributesDependenciesItemsLocationsItems"; import { ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems } from "./ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems"; +/** + * A dependency found in the repository, including its identity, location, and reachability metadata. + */ export class ScaRequestDataAttributesDependenciesItems { + /** + * A list of patterns or identifiers that should be excluded from analysis for this dependency. + */ "exclusions"?: Array; + /** + * The group or organization namespace of the dependency (e.g., Maven group ID). + */ "group"?: string; + /** + * Indicates whether this is a development-only dependency not used in production. + */ "isDev"?: boolean; + /** + * Indicates whether this is a direct dependency (as opposed to a transitive one). + */ "isDirect"?: boolean; + /** + * The programming language ecosystem of this dependency (e.g., java, python, javascript). + */ "language"?: string; + /** + * The list of source file locations where this dependency is declared. + */ "locations"?: Array; + /** + * The name of the dependency package. + */ "name"?: string; + /** + * The package manager responsible for this dependency (e.g., maven, pip, npm). + */ "packageManager"?: string; + /** + * The Package URL (PURL) uniquely identifying this dependency. + */ "purl"?: string; + /** + * Properties describing symbols from this dependency that are reachable in the application code. + */ "reachableSymbolProperties"?: Array; + /** + * The version of the dependency. + */ "version"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItems.ts index 697acd83bc9c..fbb019fc47c2 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItems.ts @@ -2,10 +2,25 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition } from "./ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition"; +/** + * The source code location where a dependency is declared, including block, name, namespace, and version positions within the file. + */ export class ScaRequestDataAttributesDependenciesItemsLocationsItems { + /** + * A range within a file defined by a start and end position, along with the file name. + */ "block"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition; + /** + * A range within a file defined by a start and end position, along with the file name. + */ "name"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition; + /** + * A range within a file defined by a start and end position, along with the file name. + */ "namespace"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition; + /** + * A range within a file defined by a start and end position, along with the file name. + */ "version"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition.ts index b148de9a6816..2a780daca49a 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition.ts @@ -2,9 +2,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition } from "./ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition"; +/** + * A range within a file defined by a start and end position, along with the file name. + */ export class ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition { + /** + * A specific position (line and column) within a source file. + */ "end"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition; + /** + * The name or path of the file containing this location. + */ "fileName"?: string; + /** + * A specific position (line and column) within a source file. + */ "start"?: ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition.ts index 3c2160fe3195..c60274ad3594 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A specific position (line and column) within a source file. + */ export class ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition { + /** + * The column number of the position within the line. + */ "col"?: number; + /** + * The line number of the position within the file. + */ "line"?: number; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems.ts index ed46a88c959f..799150d26d67 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A key-value property describing a reachable symbol within a dependency. + */ export class ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems { + /** + * The name of the reachable symbol property. + */ "name"?: string; + /** + * The value of the reachable symbol property. + */ "value"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesFilesItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesFilesItems.ts index e8d2a2e8f367..707c768d62a4 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesFilesItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesFilesItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A file entry in the repository associated with a dependency manifest. + */ export class ScaRequestDataAttributesFilesItems { + /** + * The name or path of the file within the repository. + */ "name"?: string; + /** + * The Package URL (PURL) associated with the dependency declared in this file. + */ "purl"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesRelationsItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesRelationsItems.ts index c9dc14980c04..18a1f24af544 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesRelationsItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesRelationsItems.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A dependency relation describing which other components a given component depends on. + */ export class ScaRequestDataAttributesRelationsItems { + /** + * The list of BOM references that this component directly depends on. + */ "dependsOn"?: Array; + /** + * The BOM reference of the component that has dependencies. + */ "ref"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesRepository.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesRepository.ts index 09518d73dcdd..300717fcd746 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesRepository.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesRepository.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Information about the source code repository being analyzed. + */ export class ScaRequestDataAttributesRepository { + /** + * The URL of the repository. + */ "url"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItems.ts index 1de601c4c737..b7d6d470e002 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItems.ts @@ -2,9 +2,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems } from "./ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems"; +/** + * A vulnerability entry from the Software Bill of Materials (SBOM), describing a known security issue and the components it affects. + */ export class ScaRequestDataAttributesVulnerabilitiesItems { + /** + * The list of components affected by this vulnerability. + */ "affects"?: Array; + /** + * The unique BOM reference identifier for this vulnerability entry. + */ "bomRef"?: string; + /** + * The vulnerability identifier (e.g., CVE ID or similar). + */ "id"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems.ts b/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems.ts index 371dfe934fe4..55a54d1524ff 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems.ts @@ -1,6 +1,12 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * A reference to a component affected by a vulnerability. + */ export class ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems { + /** + * The BOM reference identifying the affected component. + */ "ref"?: string; /** * A container for additional, undeclared properties. diff --git a/services/static_analysis/src/v2/models/ScaRequestDataType.ts b/services/static_analysis/src/v2/models/ScaRequestDataType.ts index 6ea66996ca2a..b49e26a77a73 100644 --- a/services/static_analysis/src/v2/models/ScaRequestDataType.ts +++ b/services/static_analysis/src/v2/models/ScaRequestDataType.ts @@ -1,3 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The type identifier for SCA dependency analysis requests. + */ export type ScaRequestDataType = typeof SCAREQUESTS | UnparsedObject; export const SCAREQUESTS = "scarequests"; diff --git a/services/status_pages/src/v2/models/CreateComponentRequest.ts b/services/status_pages/src/v2/models/CreateComponentRequest.ts index fba3b207c8ca..9ca22aaf3c5d 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequest.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateComponentRequestData } from "./CreateComponentRequestData"; +/** + * Request object for creating a component. + */ export class CreateComponentRequest { + /** + * The data object for creating a component. + */ "data"?: CreateComponentRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateComponentRequestData.ts b/services/status_pages/src/v2/models/CreateComponentRequestData.ts index c081ad7c97d7..f3694d737abe 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequestData.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequestData.ts @@ -4,6 +4,9 @@ import { CreateComponentRequestDataAttributes } from "./CreateComponentRequestDa import { CreateComponentRequestDataRelationships } from "./CreateComponentRequestDataRelationships"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object for creating a component. + */ export class CreateComponentRequestData { /** * The supported attributes for creating a component. diff --git a/services/status_pages/src/v2/models/CreateComponentRequestDataAttributesComponentsItems.ts b/services/status_pages/src/v2/models/CreateComponentRequestDataAttributesComponentsItems.ts index 59069f7d97b0..a2289953bcd9 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequestDataAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequestDataAttributesComponentsItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A component to be created within a group. + */ export class CreateComponentRequestDataAttributesComponentsItems { /** * The name of the grouped component. diff --git a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationships.ts b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationships.ts index 089d1b6b9b37..d9a3fdfc2bd7 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationships.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationships.ts @@ -6,6 +6,9 @@ import { CreateComponentRequestDataRelationshipsGroup } from "./CreateComponentR * The supported relationships for creating a component. */ export class CreateComponentRequestDataRelationships { + /** + * The group to create the component within. + */ "group"?: CreateComponentRequestDataRelationshipsGroup; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroup.ts b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroup.ts index 1e5b7489fa0b..ac3bfb991aaf 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroup.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroup.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateComponentRequestDataRelationshipsGroupData } from "./CreateComponentRequestDataRelationshipsGroupData"; +/** + * The group to create the component within. + */ export class CreateComponentRequestDataRelationshipsGroup { + /** + * The data object identifying the group to create the component within. + */ "data": CreateComponentRequestDataRelationshipsGroupData | null; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroupData.ts b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroupData.ts index 0477f76eb90e..9fbc0f2b1b78 100644 --- a/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroupData.ts +++ b/services/status_pages/src/v2/models/CreateComponentRequestDataRelationshipsGroupData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object identifying the group to create the component within. + */ export class CreateComponentRequestDataRelationshipsGroupData { /** * The ID of the group. diff --git a/services/status_pages/src/v2/models/CreateDegradationRequest.ts b/services/status_pages/src/v2/models/CreateDegradationRequest.ts index 8a37e3be8ebb..76a53ab8796d 100644 --- a/services/status_pages/src/v2/models/CreateDegradationRequest.ts +++ b/services/status_pages/src/v2/models/CreateDegradationRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateDegradationRequestData } from "./CreateDegradationRequestData"; +/** + * Request object for creating a degradation. + */ export class CreateDegradationRequest { + /** + * The data object for creating a degradation. + */ "data"?: CreateDegradationRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateDegradationRequestData.ts b/services/status_pages/src/v2/models/CreateDegradationRequestData.ts index df15ecf923d0..700ec469f9fd 100644 --- a/services/status_pages/src/v2/models/CreateDegradationRequestData.ts +++ b/services/status_pages/src/v2/models/CreateDegradationRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateDegradationRequestDataAttributes } from "./CreateDegradationRequestDataAttributes"; import { PatchDegradationRequestDataType } from "./PatchDegradationRequestDataType"; +/** + * The data object for creating a degradation. + */ export class CreateDegradationRequestData { /** * The supported attributes for creating a degradation. diff --git a/services/status_pages/src/v2/models/CreateDegradationRequestDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/CreateDegradationRequestDataAttributesComponentsAffectedItems.ts index d1229dba426b..97bce4f979b8 100644 --- a/services/status_pages/src/v2/models/CreateDegradationRequestDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/CreateDegradationRequestDataAttributesComponentsAffectedItems.ts @@ -2,11 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataAttributesStatus } from "./StatusPagesComponentDataAttributesStatus"; +/** + * A component affected by a degradation. + */ export class CreateDegradationRequestDataAttributesComponentsAffectedItems { /** * The ID of the component. Must be a component of type `component`. */ "id": string; + /** + * The name of the component. + */ "name"?: string; /** * The status of the component. diff --git a/services/status_pages/src/v2/models/CreateMaintenanceRequest.ts b/services/status_pages/src/v2/models/CreateMaintenanceRequest.ts index aa2af982dc74..7413f06b3f64 100644 --- a/services/status_pages/src/v2/models/CreateMaintenanceRequest.ts +++ b/services/status_pages/src/v2/models/CreateMaintenanceRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateMaintenanceRequestData } from "./CreateMaintenanceRequestData"; +/** + * Request object for creating a maintenance. + */ export class CreateMaintenanceRequest { + /** + * The data object for creating a maintenance. + */ "data"?: CreateMaintenanceRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateMaintenanceRequestData.ts b/services/status_pages/src/v2/models/CreateMaintenanceRequestData.ts index 5c76e2f6f69b..21383ccfac24 100644 --- a/services/status_pages/src/v2/models/CreateMaintenanceRequestData.ts +++ b/services/status_pages/src/v2/models/CreateMaintenanceRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateMaintenanceRequestDataAttributes } from "./CreateMaintenanceRequestDataAttributes"; import { PatchMaintenanceRequestDataType } from "./PatchMaintenanceRequestDataType"; +/** + * The data object for creating a maintenance. + */ export class CreateMaintenanceRequestData { /** * The supported attributes for creating a maintenance. diff --git a/services/status_pages/src/v2/models/CreateMaintenanceRequestDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/CreateMaintenanceRequestDataAttributesComponentsAffectedItems.ts index 36ed1bd0c3e9..a31c311cd8ef 100644 --- a/services/status_pages/src/v2/models/CreateMaintenanceRequestDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/CreateMaintenanceRequestDataAttributesComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus } from "./PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"; +/** + * A component affected by a maintenance. + */ export class CreateMaintenanceRequestDataAttributesComponentsAffectedItems { /** * The ID of the component. Must be a component of type `component`. diff --git a/services/status_pages/src/v2/models/CreateStatusPageRequest.ts b/services/status_pages/src/v2/models/CreateStatusPageRequest.ts index aafcb46fb984..479d96e2bbfd 100644 --- a/services/status_pages/src/v2/models/CreateStatusPageRequest.ts +++ b/services/status_pages/src/v2/models/CreateStatusPageRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateStatusPageRequestData } from "./CreateStatusPageRequestData"; +/** + * Request object for creating a status page. + */ export class CreateStatusPageRequest { + /** + * The data object for creating a status page. + */ "data"?: CreateStatusPageRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/CreateStatusPageRequestData.ts b/services/status_pages/src/v2/models/CreateStatusPageRequestData.ts index bf797926cd0d..4d5516efba78 100644 --- a/services/status_pages/src/v2/models/CreateStatusPageRequestData.ts +++ b/services/status_pages/src/v2/models/CreateStatusPageRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateStatusPageRequestDataAttributes } from "./CreateStatusPageRequestDataAttributes"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object for creating a status page. + */ export class CreateStatusPageRequestData { /** * The supported attributes for creating a status page. diff --git a/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItems.ts b/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItems.ts index 5427bfc9addc..f487008906e1 100644 --- a/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItems.ts @@ -4,6 +4,9 @@ import { CreateComponentRequestDataAttributesType } from "./CreateComponentReque import { CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems } from "./CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; +/** + * A component to be created on a status page. + */ export class CreateStatusPageRequestDataAttributesComponentsItems { /** * If creating a component of type `group`, the components to create within the group. diff --git a/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems.ts b/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems.ts index fd4bf4f748b8..b99d3d78f240 100644 --- a/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems.ts +++ b/services/status_pages/src/v2/models/CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A grouped component to be created within a status page component group. + */ export class CreateStatusPageRequestDataAttributesComponentsItemsComponentsItems { /** * The ID of the grouped component. diff --git a/services/status_pages/src/v2/models/Degradation.ts b/services/status_pages/src/v2/models/Degradation.ts index 549b092e9723..0bc26046f4af 100644 --- a/services/status_pages/src/v2/models/Degradation.ts +++ b/services/status_pages/src/v2/models/Degradation.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DegradationData } from "./DegradationData"; import { DegradationIncluded } from "./DegradationIncluded"; +/** + * Response object for a single degradation. + */ export class Degradation { + /** + * The data object for a degradation. + */ "data"?: DegradationData; /** * The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/DegradationArray.ts b/services/status_pages/src/v2/models/DegradationArray.ts index 4f0be2b0106c..2af16012fcee 100644 --- a/services/status_pages/src/v2/models/DegradationArray.ts +++ b/services/status_pages/src/v2/models/DegradationArray.ts @@ -4,7 +4,13 @@ import { DegradationData } from "./DegradationData"; import { DegradationIncluded } from "./DegradationIncluded"; import { PaginationMeta } from "./PaginationMeta"; +/** + * Response object for a list of degradations. + */ export class DegradationArray { + /** + * A list of degradation data objects. + */ "data": Array; /** * The included related resources of a degradation. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/DegradationData.ts b/services/status_pages/src/v2/models/DegradationData.ts index 8a5e9cc77aa5..7fa6ab09963e 100644 --- a/services/status_pages/src/v2/models/DegradationData.ts +++ b/services/status_pages/src/v2/models/DegradationData.ts @@ -4,6 +4,9 @@ import { DegradationDataAttributes } from "./DegradationDataAttributes"; import { DegradationDataRelationships } from "./DegradationDataRelationships"; import { PatchDegradationRequestDataType } from "./PatchDegradationRequestDataType"; +/** + * The data object for a degradation. + */ export class DegradationData { /** * The attributes of a degradation. diff --git a/services/status_pages/src/v2/models/DegradationDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/DegradationDataAttributesComponentsAffectedItems.ts index 98e6d2bb58be..27798f5032d9 100644 --- a/services/status_pages/src/v2/models/DegradationDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/DegradationDataAttributesComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataAttributesStatus } from "./StatusPagesComponentDataAttributesStatus"; +/** + * A component affected by a degradation. + */ export class DegradationDataAttributesComponentsAffectedItems { /** * The ID of the component. diff --git a/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItems.ts b/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItems.ts index 4e81487b2fb9..44a1e56cb5cb 100644 --- a/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItems.ts +++ b/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItems.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { CreateDegradationRequestDataAttributesStatus } from "./CreateDegradationRequestDataAttributesStatus"; import { DegradationDataAttributesUpdatesItemsComponentsAffectedItems } from "./DegradationDataAttributesUpdatesItemsComponentsAffectedItems"; +/** + * A status update recorded during a degradation. + */ export class DegradationDataAttributesUpdatesItems { /** * The components affected at the time of the update. diff --git a/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItemsComponentsAffectedItems.ts b/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItemsComponentsAffectedItems.ts index d67dbe24078d..9916819f5289 100644 --- a/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItemsComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/DegradationDataAttributesUpdatesItemsComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataAttributesStatus } from "./StatusPagesComponentDataAttributesStatus"; +/** + * A component affected at the time of a degradation update. + */ export class DegradationDataAttributesUpdatesItemsComponentsAffectedItems { /** * Identifier of the component affected at the time of the update. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationships.ts b/services/status_pages/src/v2/models/DegradationDataRelationships.ts index afa35845e577..1a9455638bcc 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationships.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationships.ts @@ -8,8 +8,17 @@ import { DegradationDataRelationshipsStatusPage } from "./DegradationDataRelatio * The relationships of a degradation. */ export class DegradationDataRelationships { + /** + * The Datadog user who created the degradation. + */ "createdByUser"?: DegradationDataRelationshipsCreatedByUser; + /** + * The Datadog user who last modified the degradation. + */ "lastModifiedByUser"?: DegradationDataRelationshipsLastModifiedByUser; + /** + * The status page the degradation belongs to. + */ "statusPage"?: DegradationDataRelationshipsStatusPage; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUser.ts index c9b2893a6cc7..32af5422fbaa 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DegradationDataRelationshipsCreatedByUserData } from "./DegradationDataRelationshipsCreatedByUserData"; +/** + * The Datadog user who created the degradation. + */ export class DegradationDataRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the degradation. + */ "data": DegradationDataRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUserData.ts index 88c9dfbce9b4..3d8abe85c10d 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the degradation. + */ export class DegradationDataRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the degradation. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUser.ts index 1314719e14b0..fa80772de1eb 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DegradationDataRelationshipsLastModifiedByUserData } from "./DegradationDataRelationshipsLastModifiedByUserData"; +/** + * The Datadog user who last modified the degradation. + */ export class DegradationDataRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the degradation. + */ "data": DegradationDataRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUserData.ts index 5e0f9025ce17..d02a33d3f58c 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the degradation. + */ export class DegradationDataRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the degradation. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPage.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPage.ts index d472fde90c7c..61185dbee1e2 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPage.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPage.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DegradationDataRelationshipsStatusPageData } from "./DegradationDataRelationshipsStatusPageData"; +/** + * The status page the degradation belongs to. + */ export class DegradationDataRelationshipsStatusPage { + /** + * The data object identifying the status page the degradation belongs to. + */ "data": DegradationDataRelationshipsStatusPageData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPageData.ts b/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPageData.ts index f09fd57bafe9..29f3662d29bc 100644 --- a/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPageData.ts +++ b/services/status_pages/src/v2/models/DegradationDataRelationshipsStatusPageData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object identifying the status page the degradation belongs to. + */ export class DegradationDataRelationshipsStatusPageData { /** * The ID of the status page. diff --git a/services/status_pages/src/v2/models/DegradationIncluded.ts b/services/status_pages/src/v2/models/DegradationIncluded.ts index 4a2f50acccc1..56937d9861ee 100644 --- a/services/status_pages/src/v2/models/DegradationIncluded.ts +++ b/services/status_pages/src/v2/models/DegradationIncluded.ts @@ -2,6 +2,10 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; import { StatusPageAsIncluded } from "./StatusPageAsIncluded"; import { StatusPagesUser } from "./StatusPagesUser"; + +/** + * An included resource related to a degradation or maintenance. + */ export type DegradationIncluded = | StatusPagesUser | StatusPageAsIncluded diff --git a/services/status_pages/src/v2/models/Maintenance.ts b/services/status_pages/src/v2/models/Maintenance.ts index 4f75e27216e2..4fb3ad2e170b 100644 --- a/services/status_pages/src/v2/models/Maintenance.ts +++ b/services/status_pages/src/v2/models/Maintenance.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DegradationIncluded } from "./DegradationIncluded"; import { MaintenanceData } from "./MaintenanceData"; +/** + * Response object for a single maintenance. + */ export class Maintenance { + /** + * The data object for a maintenance. + */ "data"?: MaintenanceData; /** * The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/MaintenanceArray.ts b/services/status_pages/src/v2/models/MaintenanceArray.ts index d692e6fd7dbd..62b312ee49b5 100644 --- a/services/status_pages/src/v2/models/MaintenanceArray.ts +++ b/services/status_pages/src/v2/models/MaintenanceArray.ts @@ -4,7 +4,13 @@ import { DegradationIncluded } from "./DegradationIncluded"; import { MaintenanceData } from "./MaintenanceData"; import { PaginationMeta } from "./PaginationMeta"; +/** + * Response object for a list of maintenances. + */ export class MaintenanceArray { + /** + * A list of maintenance data objects. + */ "data": Array; /** * The included related resources of a maintenance. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/MaintenanceData.ts b/services/status_pages/src/v2/models/MaintenanceData.ts index 48f4307d042a..3cdbe039f40b 100644 --- a/services/status_pages/src/v2/models/MaintenanceData.ts +++ b/services/status_pages/src/v2/models/MaintenanceData.ts @@ -4,6 +4,9 @@ import { MaintenanceDataAttributes } from "./MaintenanceDataAttributes"; import { MaintenanceDataRelationships } from "./MaintenanceDataRelationships"; import { PatchMaintenanceRequestDataType } from "./PatchMaintenanceRequestDataType"; +/** + * The data object for a maintenance. + */ export class MaintenanceData { /** * The attributes of a maintenance. diff --git a/services/status_pages/src/v2/models/MaintenanceDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/MaintenanceDataAttributesComponentsAffectedItems.ts index 81cfe437070c..3b78260b3cf5 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataAttributesComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus } from "./PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"; +/** + * A component affected by a maintenance. + */ export class MaintenanceDataAttributesComponentsAffectedItems { /** * The ID of the component. Must be a component of type `component`. diff --git a/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItems.ts b/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItems.ts index f8aef60fc9b4..34568a84d077 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItems.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems } from "./MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems"; +/** + * An update made to a maintenance. + */ export class MaintenanceDataAttributesUpdatesItems { /** * The components affected at the time of the update. diff --git a/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems.ts b/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems.ts index 372d832a5f32..7cf7b45f4c2a 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus } from "./PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"; +/** + * A component affected at the time of a maintenance update. + */ export class MaintenanceDataAttributesUpdatesItemsComponentsAffectedItems { /** * Identifier of the component affected at the time of the update. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationships.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationships.ts index 51712517da2d..d78d90dbb119 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationships.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationships.ts @@ -8,8 +8,17 @@ import { MaintenanceDataRelationshipsStatusPage } from "./MaintenanceDataRelatio * The relationships of a maintenance. */ export class MaintenanceDataRelationships { + /** + * The Datadog user who created the maintenance. + */ "createdByUser"?: MaintenanceDataRelationshipsCreatedByUser; + /** + * The Datadog user who last modified the maintenance. + */ "lastModifiedByUser"?: MaintenanceDataRelationshipsLastModifiedByUser; + /** + * The status page the maintenance belongs to. + */ "statusPage"?: MaintenanceDataRelationshipsStatusPage; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUser.ts index 4b0f6f0277cb..ff89216de8f4 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { MaintenanceDataRelationshipsCreatedByUserData } from "./MaintenanceDataRelationshipsCreatedByUserData"; +/** + * The Datadog user who created the maintenance. + */ export class MaintenanceDataRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the maintenance. + */ "data": MaintenanceDataRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUserData.ts index a1b9c87ce422..12ba6da9f428 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the maintenance. + */ export class MaintenanceDataRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the maintenance. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUser.ts index 2b274c406c75..08309d62cf64 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { MaintenanceDataRelationshipsLastModifiedByUserData } from "./MaintenanceDataRelationshipsLastModifiedByUserData"; +/** + * The Datadog user who last modified the maintenance. + */ export class MaintenanceDataRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the maintenance. + */ "data": MaintenanceDataRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUserData.ts index f0ba8e166a73..3105274a8242 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the maintenance. + */ export class MaintenanceDataRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the maintenance. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPage.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPage.ts index f86252eee4c2..7849944343ab 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPage.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPage.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { MaintenanceDataRelationshipsStatusPageData } from "./MaintenanceDataRelationshipsStatusPageData"; +/** + * The status page the maintenance belongs to. + */ export class MaintenanceDataRelationshipsStatusPage { + /** + * The data object identifying the status page associated with a maintenance. + */ "data": MaintenanceDataRelationshipsStatusPageData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPageData.ts b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPageData.ts index 4d68f25a739d..e7b9d9bc4011 100644 --- a/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPageData.ts +++ b/services/status_pages/src/v2/models/MaintenanceDataRelationshipsStatusPageData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object identifying the status page associated with a maintenance. + */ export class MaintenanceDataRelationshipsStatusPageData { /** * The ID of the status page. diff --git a/services/status_pages/src/v2/models/PaginationMetaPage.ts b/services/status_pages/src/v2/models/PaginationMetaPage.ts index 5d430ed66e5f..4737b378b197 100644 --- a/services/status_pages/src/v2/models/PaginationMetaPage.ts +++ b/services/status_pages/src/v2/models/PaginationMetaPage.ts @@ -34,6 +34,9 @@ export class PaginationMetaPage { * Integer representing the total number of elements available. */ "total"?: number; + /** + * The pagination type used for offset-based pagination. + */ "type"?: PaginationMetaPageType; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/PaginationMetaPageType.ts b/services/status_pages/src/v2/models/PaginationMetaPageType.ts index af20d4d38173..f3658f3eb690 100644 --- a/services/status_pages/src/v2/models/PaginationMetaPageType.ts +++ b/services/status_pages/src/v2/models/PaginationMetaPageType.ts @@ -1,3 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * The pagination type used for offset-based pagination. + */ export type PaginationMetaPageType = typeof OFFSET_LIMIT | UnparsedObject; export const OFFSET_LIMIT = "offset_limit"; diff --git a/services/status_pages/src/v2/models/PatchComponentRequest.ts b/services/status_pages/src/v2/models/PatchComponentRequest.ts index 8dfae7778fc0..4d8647c9cc7b 100644 --- a/services/status_pages/src/v2/models/PatchComponentRequest.ts +++ b/services/status_pages/src/v2/models/PatchComponentRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchComponentRequestData } from "./PatchComponentRequestData"; +/** + * Request object for updating a component. + */ export class PatchComponentRequest { + /** + * The data object for updating a component. + */ "data"?: PatchComponentRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/PatchComponentRequestData.ts b/services/status_pages/src/v2/models/PatchComponentRequestData.ts index 93bd91ddf3ee..d717e8f024ac 100644 --- a/services/status_pages/src/v2/models/PatchComponentRequestData.ts +++ b/services/status_pages/src/v2/models/PatchComponentRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchComponentRequestDataAttributes } from "./PatchComponentRequestDataAttributes"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object for updating a component. + */ export class PatchComponentRequestData { /** * The supported attributes for updating a component. diff --git a/services/status_pages/src/v2/models/PatchDegradationRequest.ts b/services/status_pages/src/v2/models/PatchDegradationRequest.ts index 022c0e63cffe..e65cf4465eda 100644 --- a/services/status_pages/src/v2/models/PatchDegradationRequest.ts +++ b/services/status_pages/src/v2/models/PatchDegradationRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchDegradationRequestData } from "./PatchDegradationRequestData"; +/** + * Request object for updating a degradation. + */ export class PatchDegradationRequest { + /** + * The data object for updating a degradation. + */ "data"?: PatchDegradationRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/PatchDegradationRequestData.ts b/services/status_pages/src/v2/models/PatchDegradationRequestData.ts index 38066b284640..513cc32629e6 100644 --- a/services/status_pages/src/v2/models/PatchDegradationRequestData.ts +++ b/services/status_pages/src/v2/models/PatchDegradationRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchDegradationRequestDataAttributes } from "./PatchDegradationRequestDataAttributes"; import { PatchDegradationRequestDataType } from "./PatchDegradationRequestDataType"; +/** + * The data object for updating a degradation. + */ export class PatchDegradationRequestData { /** * The supported attributes for updating a degradation. diff --git a/services/status_pages/src/v2/models/PatchDegradationRequestDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/PatchDegradationRequestDataAttributesComponentsAffectedItems.ts index c2f0b374e595..c434f6424f00 100644 --- a/services/status_pages/src/v2/models/PatchDegradationRequestDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/PatchDegradationRequestDataAttributesComponentsAffectedItems.ts @@ -2,11 +2,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataAttributesStatus } from "./StatusPagesComponentDataAttributesStatus"; +/** + * A component affected by a degradation. + */ export class PatchDegradationRequestDataAttributesComponentsAffectedItems { /** * The ID of the component. Must be a component of type `component`. */ "id": string; + /** + * The name of the component. + */ "name"?: string; /** * The status of the component. diff --git a/services/status_pages/src/v2/models/PatchMaintenanceRequest.ts b/services/status_pages/src/v2/models/PatchMaintenanceRequest.ts index ef5eab18e702..3193e11b9b49 100644 --- a/services/status_pages/src/v2/models/PatchMaintenanceRequest.ts +++ b/services/status_pages/src/v2/models/PatchMaintenanceRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestData } from "./PatchMaintenanceRequestData"; +/** + * Request object for updating a maintenance. + */ export class PatchMaintenanceRequest { + /** + * The data object for updating a maintenance. + */ "data"?: PatchMaintenanceRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/PatchMaintenanceRequestData.ts b/services/status_pages/src/v2/models/PatchMaintenanceRequestData.ts index 0dfef4220a05..5602764e8dfe 100644 --- a/services/status_pages/src/v2/models/PatchMaintenanceRequestData.ts +++ b/services/status_pages/src/v2/models/PatchMaintenanceRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestDataAttributes } from "./PatchMaintenanceRequestDataAttributes"; import { PatchMaintenanceRequestDataType } from "./PatchMaintenanceRequestDataType"; +/** + * The data object for updating a maintenance. + */ export class PatchMaintenanceRequestData { /** * The supported attributes for updating a maintenance. diff --git a/services/status_pages/src/v2/models/PatchMaintenanceRequestDataAttributesComponentsAffectedItems.ts b/services/status_pages/src/v2/models/PatchMaintenanceRequestDataAttributesComponentsAffectedItems.ts index 55e4cf9eb1b2..2066ba08851e 100644 --- a/services/status_pages/src/v2/models/PatchMaintenanceRequestDataAttributesComponentsAffectedItems.ts +++ b/services/status_pages/src/v2/models/PatchMaintenanceRequestDataAttributesComponentsAffectedItems.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus } from "./PatchMaintenanceRequestDataAttributesComponentsAffectedItemsStatus"; +/** + * A component affected by a maintenance. + */ export class PatchMaintenanceRequestDataAttributesComponentsAffectedItems { /** * The ID of the component. Must be a component of type `component`. diff --git a/services/status_pages/src/v2/models/PatchStatusPageRequest.ts b/services/status_pages/src/v2/models/PatchStatusPageRequest.ts index 7b2dffe727b9..f5b7e664c445 100644 --- a/services/status_pages/src/v2/models/PatchStatusPageRequest.ts +++ b/services/status_pages/src/v2/models/PatchStatusPageRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchStatusPageRequestData } from "./PatchStatusPageRequestData"; +/** + * Request object for updating a status page. + */ export class PatchStatusPageRequest { + /** + * The data object for updating a status page. + */ "data"?: PatchStatusPageRequestData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/PatchStatusPageRequestData.ts b/services/status_pages/src/v2/models/PatchStatusPageRequestData.ts index 6ab188d7567e..5e300e0463ca 100644 --- a/services/status_pages/src/v2/models/PatchStatusPageRequestData.ts +++ b/services/status_pages/src/v2/models/PatchStatusPageRequestData.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { PatchStatusPageRequestDataAttributes } from "./PatchStatusPageRequestDataAttributes"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object for updating a status page. + */ export class PatchStatusPageRequestData { /** * The supported attributes for updating a status page. diff --git a/services/status_pages/src/v2/models/StatusPage.ts b/services/status_pages/src/v2/models/StatusPage.ts index 90dc1d5cbc7f..ff9c326c1fa8 100644 --- a/services/status_pages/src/v2/models/StatusPage.ts +++ b/services/status_pages/src/v2/models/StatusPage.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageArrayIncluded } from "./StatusPageArrayIncluded"; import { StatusPageData } from "./StatusPageData"; +/** + * Response object for a single status page. + */ export class StatusPage { + /** + * The data object for a status page. + */ "data"?: StatusPageData; /** * The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/StatusPageArray.ts b/services/status_pages/src/v2/models/StatusPageArray.ts index 146b66d7767c..4b0d7ee3655e 100644 --- a/services/status_pages/src/v2/models/StatusPageArray.ts +++ b/services/status_pages/src/v2/models/StatusPageArray.ts @@ -4,7 +4,13 @@ import { PaginationMeta } from "./PaginationMeta"; import { StatusPageArrayIncluded } from "./StatusPageArrayIncluded"; import { StatusPageData } from "./StatusPageData"; +/** + * Response object for a list of status pages. + */ export class StatusPageArray { + /** + * A list of status page data objects. + */ "data": Array; /** * The included related resources of a status page. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/StatusPageArrayIncluded.ts b/services/status_pages/src/v2/models/StatusPageArrayIncluded.ts index c4a2225a6619..162bb66f2132 100644 --- a/services/status_pages/src/v2/models/StatusPageArrayIncluded.ts +++ b/services/status_pages/src/v2/models/StatusPageArrayIncluded.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; import { StatusPagesUser } from "./StatusPagesUser"; + +/** + * An included resource related to a status page. + */ export type StatusPageArrayIncluded = StatusPagesUser | UnparsedObject; diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItems.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItems.ts index c4cc973a2619..4a1da39445c3 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItems.ts @@ -4,7 +4,13 @@ import { CreateComponentRequestDataAttributesType } from "./CreateComponentReque import { StatusPageAsIncludedAttributesComponentsItemsComponentsItems } from "./StatusPageAsIncludedAttributesComponentsItemsComponentsItems"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; +/** + * A component displayed on an included status page. + */ export class StatusPageAsIncludedAttributesComponentsItems { + /** + * If the component is of type `group`, the components within the group. + */ "components"?: Array; /** * The ID of the component. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItemsComponentsItems.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItemsComponentsItems.ts index 38bf1ca34769..a3e73c0a584e 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItemsComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedAttributesComponentsItemsComponentsItems.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A grouped component within a status page component group. + */ export class StatusPageAsIncludedAttributesComponentsItemsComponentsItems { /** * The ID of the grouped component. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationships.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationships.ts index 304b903e3a5d..06333bd1e43f 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationships.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationships.ts @@ -7,7 +7,13 @@ import { StatusPageAsIncludedRelationshipsLastModifiedByUser } from "./StatusPag * The relationships of a status page. */ export class StatusPageAsIncludedRelationships { + /** + * The Datadog user who created the status page. + */ "createdByUser"?: StatusPageAsIncludedRelationshipsCreatedByUser; + /** + * The Datadog user who last modified the status page. + */ "lastModifiedByUser"?: StatusPageAsIncludedRelationshipsLastModifiedByUser; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUser.ts index 7a019bc3ddc4..62fa2649e773 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageAsIncludedRelationshipsCreatedByUserData } from "./StatusPageAsIncludedRelationshipsCreatedByUserData"; +/** + * The Datadog user who created the status page. + */ export class StatusPageAsIncludedRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the status page. + */ "data": StatusPageAsIncludedRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUserData.ts index c7d382796892..e57e44f50c02 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the status page. + */ export class StatusPageAsIncludedRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the status page. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUser.ts index f961044d876f..e3658cfc8afa 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageAsIncludedRelationshipsLastModifiedByUserData } from "./StatusPageAsIncludedRelationshipsLastModifiedByUserData"; +/** + * The Datadog user who last modified the status page. + */ export class StatusPageAsIncludedRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the status page. + */ "data": StatusPageAsIncludedRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUserData.ts index 96b38ab7f811..9be03ebc4cfa 100644 --- a/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPageAsIncludedRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the status page. + */ export class StatusPageAsIncludedRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the status page. diff --git a/services/status_pages/src/v2/models/StatusPageData.ts b/services/status_pages/src/v2/models/StatusPageData.ts index 1e55d5940e20..267ccb8bc8f5 100644 --- a/services/status_pages/src/v2/models/StatusPageData.ts +++ b/services/status_pages/src/v2/models/StatusPageData.ts @@ -4,6 +4,9 @@ import { StatusPageDataAttributes } from "./StatusPageDataAttributes"; import { StatusPageDataRelationships } from "./StatusPageDataRelationships"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object for a status page. + */ export class StatusPageData { /** * The attributes of a status page. diff --git a/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItems.ts b/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItems.ts index a55a21ae7b56..6d6d20f41968 100644 --- a/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItems.ts @@ -4,6 +4,9 @@ import { CreateComponentRequestDataAttributesType } from "./CreateComponentReque import { StatusPageDataAttributesComponentsItemsComponentsItems } from "./StatusPageDataAttributesComponentsItemsComponentsItems"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; +/** + * A component displayed on a status page. + */ export class StatusPageDataAttributesComponentsItems { /** * If the component is of type `group`, the components within the group. diff --git a/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItemsComponentsItems.ts b/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItemsComponentsItems.ts index 0e6f1738dfa6..bd2089d674b2 100644 --- a/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItemsComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPageDataAttributesComponentsItemsComponentsItems.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A grouped component within a status page component group. + */ export class StatusPageDataAttributesComponentsItemsComponentsItems { /** * The ID of the component. diff --git a/services/status_pages/src/v2/models/StatusPageDataRelationships.ts b/services/status_pages/src/v2/models/StatusPageDataRelationships.ts index 895b36dd7651..fc041757efd4 100644 --- a/services/status_pages/src/v2/models/StatusPageDataRelationships.ts +++ b/services/status_pages/src/v2/models/StatusPageDataRelationships.ts @@ -7,7 +7,13 @@ import { StatusPageDataRelationshipsLastModifiedByUser } from "./StatusPageDataR * The relationships of a status page. */ export class StatusPageDataRelationships { + /** + * The Datadog user who created the status page. + */ "createdByUser"?: StatusPageDataRelationshipsCreatedByUser; + /** + * The Datadog user who last modified the status page. + */ "lastModifiedByUser"?: StatusPageDataRelationshipsLastModifiedByUser; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUser.ts index 667c1b2069bd..09dbd180510d 100644 --- a/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataRelationshipsCreatedByUserData } from "./StatusPageDataRelationshipsCreatedByUserData"; +/** + * The Datadog user who created the status page. + */ export class StatusPageDataRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the status page. + */ "data": StatusPageDataRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUserData.ts index c381f9c196f1..e811801c4215 100644 --- a/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPageDataRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the status page. + */ export class StatusPageDataRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the status page. diff --git a/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUser.ts index 832bf7808255..37ea7882cf63 100644 --- a/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataRelationshipsLastModifiedByUserData } from "./StatusPageDataRelationshipsLastModifiedByUserData"; +/** + * The Datadog user who last modified the status page. + */ export class StatusPageDataRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the status page. + */ "data": StatusPageDataRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUserData.ts index 4481e0dce998..e1c57b619a62 100644 --- a/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPageDataRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the status page. + */ export class StatusPageDataRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the status page. diff --git a/services/status_pages/src/v2/models/StatusPagesComponent.ts b/services/status_pages/src/v2/models/StatusPagesComponent.ts index e738923af7ed..26d0684e9d6e 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponent.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponent.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentArrayIncluded } from "./StatusPagesComponentArrayIncluded"; import { StatusPagesComponentData } from "./StatusPagesComponentData"; +/** + * Response object for a single component. + */ export class StatusPagesComponent { + /** + * The data object for a component. + */ "data"?: StatusPagesComponentData; /** * The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentArray.ts b/services/status_pages/src/v2/models/StatusPagesComponentArray.ts index 46893c2befcc..dc087f1bbb17 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentArray.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentArray.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentArrayIncluded } from "./StatusPagesComponentArrayIncluded"; import { StatusPagesComponentData } from "./StatusPagesComponentData"; +/** + * Response object for a list of components. + */ export class StatusPagesComponentArray { + /** + * A list of component data objects. + */ "data": Array; /** * The included related resources of a component. Client must explicitly request these resources by name in the `include` query parameter. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentArrayIncluded.ts b/services/status_pages/src/v2/models/StatusPagesComponentArrayIncluded.ts index e2ac084c04d9..b31c2d45b53b 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentArrayIncluded.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentArrayIncluded.ts @@ -3,6 +3,10 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; import { StatusPageAsIncluded } from "./StatusPageAsIncluded"; import { StatusPagesComponentGroup } from "./StatusPagesComponentGroup"; import { StatusPagesUser } from "./StatusPagesUser"; + +/** + * An included resource related to a component. + */ export type StatusPagesComponentArrayIncluded = | StatusPagesUser | StatusPageAsIncluded diff --git a/services/status_pages/src/v2/models/StatusPagesComponentData.ts b/services/status_pages/src/v2/models/StatusPagesComponentData.ts index ef4475dd6248..05937341d3f6 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentData.ts @@ -4,6 +4,9 @@ import { StatusPagesComponentDataAttributes } from "./StatusPagesComponentDataAt import { StatusPagesComponentDataRelationships } from "./StatusPagesComponentDataRelationships"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object for a component. + */ export class StatusPagesComponentData { /** * The attributes of a component. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataAttributesComponentsItems.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataAttributesComponentsItems.ts index 1bbcde5f88d9..5ed35b54c219 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataAttributesComponentsItems.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A component within a component group. + */ export class StatusPagesComponentDataAttributesComponentsItems { + /** + * The ID of the component within the group. + */ "id"?: string; + /** + * The name of the component within the group. + */ "name"?: string; + /** + * The zero-indexed position of the component within the group. + */ "position"?: number; /** * The status of the component. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationships.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationships.ts index d529051ff6e8..4c3f4a66ed33 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationships.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationships.ts @@ -9,9 +9,21 @@ import { StatusPagesComponentDataRelationshipsStatusPage } from "./StatusPagesCo * The relationships of a component. */ export class StatusPagesComponentDataRelationships { + /** + * The Datadog user who created the component. + */ "createdByUser"?: StatusPagesComponentDataRelationshipsCreatedByUser; + /** + * The group the component belongs to. + */ "group"?: StatusPagesComponentDataRelationshipsGroup; + /** + * The Datadog user who last modified the component. + */ "lastModifiedByUser"?: StatusPagesComponentDataRelationshipsLastModifiedByUser; + /** + * The status page the component belongs to. + */ "statusPage"?: StatusPagesComponentDataRelationshipsStatusPage; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUser.ts index 8581b7965f5a..c261a7478f84 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataRelationshipsCreatedByUserData } from "./StatusPagesComponentDataRelationshipsCreatedByUserData"; +/** + * The Datadog user who created the component. + */ export class StatusPagesComponentDataRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the component. + */ "data": StatusPagesComponentDataRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUserData.ts index ae2eaa3724c5..7de5b4a0b177 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the component. + */ export class StatusPagesComponentDataRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the component. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroup.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroup.ts index 7f9b622c9f76..abe2cc0655d9 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroup.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroup.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataRelationshipsGroupData } from "./StatusPagesComponentDataRelationshipsGroupData"; +/** + * The group the component belongs to. + */ export class StatusPagesComponentDataRelationshipsGroup { + /** + * The data object identifying the group the component belongs to. + */ "data": StatusPagesComponentDataRelationshipsGroupData | null; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroupData.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroupData.ts index f9171d9c5625..e5eab2ac7bde 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroupData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsGroupData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object identifying the group the component belongs to. + */ export class StatusPagesComponentDataRelationshipsGroupData { /** * The ID of the group the component belongs to. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUser.ts index f66326cf3836..94bb3644c965 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUser.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataRelationshipsLastModifiedByUserData } from "./StatusPagesComponentDataRelationshipsLastModifiedByUserData"; +/** + * The Datadog user who last modified the component. + */ export class StatusPagesComponentDataRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the component. + */ "data": StatusPagesComponentDataRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUserData.ts index c2ef4f80c083..6ae875cc1a5a 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the component. + */ export class StatusPagesComponentDataRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the component. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPage.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPage.ts index e746a0c79192..b6bb191f3f81 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPage.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPage.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentDataRelationshipsStatusPageData } from "./StatusPagesComponentDataRelationshipsStatusPageData"; +/** + * The status page the component belongs to. + */ export class StatusPagesComponentDataRelationshipsStatusPage { + /** + * The data object identifying the status page the component belongs to. + */ "data": StatusPagesComponentDataRelationshipsStatusPageData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPageData.ts b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPageData.ts index f88ae626072d..f30cf5da3695 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPageData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentDataRelationshipsStatusPageData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object identifying the status page the component belongs to. + */ export class StatusPagesComponentDataRelationshipsStatusPageData { /** * The ID of the status page the component belongs to. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupAttributesComponentsItems.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupAttributesComponentsItems.ts index 5f01995d26a1..a9d967e88fdd 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupAttributesComponentsItems.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupAttributesComponentsItems.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupAttributesComponentsItemsStatus } from "./StatusPagesComponentGroupAttributesComponentsItemsStatus"; import { StatusPagesComponentGroupAttributesComponentsItemsType } from "./StatusPagesComponentGroupAttributesComponentsItemsType"; +/** + * A component within a component group. + */ export class StatusPagesComponentGroupAttributesComponentsItems { /** * The ID of the grouped component. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUser.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUser.ts index e37fce5134bb..ed6edb9c8e41 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUser.ts @@ -6,6 +6,9 @@ import { StatusPagesComponentGroupRelationshipsCreatedByUserData } from "./Statu * The Datadog user who created the component group. */ export class StatusPagesComponentGroupRelationshipsCreatedByUser { + /** + * The data object identifying the Datadog user who created the component group. + */ "data": StatusPagesComponentGroupRelationshipsCreatedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUserData.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUserData.ts index a672c7ec2d24..d7cd982e716c 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsCreatedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who created the component group. + */ export class StatusPagesComponentGroupRelationshipsCreatedByUserData { /** * The ID of the Datadog user who created the component group. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroup.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroup.ts index d4e1d15cfd4a..8209dfbe5085 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroup.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroup.ts @@ -6,6 +6,9 @@ import { StatusPagesComponentGroupRelationshipsGroupData } from "./StatusPagesCo * The group the component group belongs to. */ export class StatusPagesComponentGroupRelationshipsGroup { + /** + * The data object identifying the parent group of a component group. + */ "data": StatusPagesComponentGroupRelationshipsGroupData | null; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroupData.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroupData.ts index e1d22c689924..b7cf736a70f0 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroupData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsGroupData.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesComponentGroupType } from "./StatusPagesComponentGroupType"; +/** + * The data object identifying the parent group of a component group. + */ export class StatusPagesComponentGroupRelationshipsGroupData { + /** + * The ID of the parent group. + */ "id": string; /** * Components resource type. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUser.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUser.ts index 415f3fcb59ea..c405c43695ee 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUser.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUser.ts @@ -6,6 +6,9 @@ import { StatusPagesComponentGroupRelationshipsLastModifiedByUserData } from "./ * The Datadog user who last modified the component group. */ export class StatusPagesComponentGroupRelationshipsLastModifiedByUser { + /** + * The data object identifying the Datadog user who last modified the component group. + */ "data": StatusPagesComponentGroupRelationshipsLastModifiedByUserData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUserData.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUserData.ts index 06a9eef5dca0..b318389d7541 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUserData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsLastModifiedByUserData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPagesUserType } from "./StatusPagesUserType"; +/** + * The data object identifying the Datadog user who last modified the component group. + */ export class StatusPagesComponentGroupRelationshipsLastModifiedByUserData { /** * The ID of the Datadog user who last modified the component group. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPage.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPage.ts index 4e5708e364ff..567ddab1bba8 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPage.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPage.ts @@ -6,6 +6,9 @@ import { StatusPagesComponentGroupRelationshipsStatusPageData } from "./StatusPa * The status page the component group belongs to. */ export class StatusPagesComponentGroupRelationshipsStatusPage { + /** + * The data object identifying the status page the component group belongs to. + */ "data": StatusPagesComponentGroupRelationshipsStatusPageData; /** * A container for additional, undeclared properties. diff --git a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPageData.ts b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPageData.ts index 3047ff3f56a9..7d35f83c8671 100644 --- a/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPageData.ts +++ b/services/status_pages/src/v2/models/StatusPagesComponentGroupRelationshipsStatusPageData.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { StatusPageDataType } from "./StatusPageDataType"; +/** + * The data object identifying the status page the component group belongs to. + */ export class StatusPagesComponentGroupRelationshipsStatusPageData { /** * The ID of the status page. diff --git a/services/synthetics/src/v2/models/DeletedSuiteResponseData.ts b/services/synthetics/src/v2/models/DeletedSuiteResponseData.ts index 84d76c9ccf08..440d3ac49f50 100644 --- a/services/synthetics/src/v2/models/DeletedSuiteResponseData.ts +++ b/services/synthetics/src/v2/models/DeletedSuiteResponseData.ts @@ -3,8 +3,17 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedSuiteResponseDataAttributes } from "./DeletedSuiteResponseDataAttributes"; import { SyntheticsSuiteTypes } from "./SyntheticsSuiteTypes"; +/** + * Data object for a deleted Synthetic test suite. + */ export class DeletedSuiteResponseData { + /** + * Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. + */ "attributes"?: DeletedSuiteResponseDataAttributes; + /** + * The public ID of the deleted Synthetic test suite. + */ "id"?: string; /** * Type for the Synthetics suites responses, `suites`. diff --git a/services/synthetics/src/v2/models/DeletedSuiteResponseDataAttributes.ts b/services/synthetics/src/v2/models/DeletedSuiteResponseDataAttributes.ts index 2729792f75fa..a2b675751cdb 100644 --- a/services/synthetics/src/v2/models/DeletedSuiteResponseDataAttributes.ts +++ b/services/synthetics/src/v2/models/DeletedSuiteResponseDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a deleted Synthetic test suite, including deletion timestamp and public ID. + */ export class DeletedSuiteResponseDataAttributes { /** * Deletion timestamp of the Synthetic suite ID. diff --git a/services/synthetics/src/v2/models/DeletedSuitesRequestDelete.ts b/services/synthetics/src/v2/models/DeletedSuitesRequestDelete.ts index 96e62d3f6d02..558a9d84f4f2 100644 --- a/services/synthetics/src/v2/models/DeletedSuitesRequestDelete.ts +++ b/services/synthetics/src/v2/models/DeletedSuitesRequestDelete.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedSuitesRequestDeleteAttributes } from "./DeletedSuitesRequestDeleteAttributes"; import { DeletedSuitesRequestType } from "./DeletedSuitesRequestType"; +/** + * Data object for a bulk delete Synthetic test suites request. + */ export class DeletedSuitesRequestDelete { + /** + * Attributes for a bulk delete Synthetic test suites request. + */ "attributes": DeletedSuitesRequestDeleteAttributes; + /** + * An optional identifier for the delete request. + */ "id"?: string; + /** + * Type for the bulk delete Synthetic suites request, `delete_suites_request`. + */ "type"?: DeletedSuitesRequestType; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteAttributes.ts b/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteAttributes.ts index d62e7151a9ef..8806f19060c6 100644 --- a/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteAttributes.ts +++ b/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteAttributes.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for a bulk delete Synthetic test suites request. + */ export class DeletedSuitesRequestDeleteAttributes { + /** + * Whether to force deletion of suites that have dependent resources. + */ "forceDeleteDependencies"?: boolean; + /** + * List of public IDs of the Synthetic test suites to delete. + */ "publicIds": Array; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteRequest.ts b/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteRequest.ts index 039eb736cc0d..8805dc74bbc6 100644 --- a/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteRequest.ts +++ b/services/synthetics/src/v2/models/DeletedSuitesRequestDeleteRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedSuitesRequestDelete } from "./DeletedSuitesRequestDelete"; +/** + * Request body for bulk deleting Synthetic test suites. + */ export class DeletedSuitesRequestDeleteRequest { + /** + * Data object for a bulk delete Synthetic test suites request. + */ "data": DeletedSuitesRequestDelete; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedSuitesRequestType.ts b/services/synthetics/src/v2/models/DeletedSuitesRequestType.ts index e939e8e89ce3..5f919f0f8842 100644 --- a/services/synthetics/src/v2/models/DeletedSuitesRequestType.ts +++ b/services/synthetics/src/v2/models/DeletedSuitesRequestType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * Type for the bulk delete Synthetic suites request, `delete_suites_request`. + */ export type DeletedSuitesRequestType = | typeof DELETE_SUITES_REQUEST | UnparsedObject; diff --git a/services/synthetics/src/v2/models/DeletedSuitesResponse.ts b/services/synthetics/src/v2/models/DeletedSuitesResponse.ts index 59aa69e5f57d..c91852eccd36 100644 --- a/services/synthetics/src/v2/models/DeletedSuitesResponse.ts +++ b/services/synthetics/src/v2/models/DeletedSuitesResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedSuiteResponseData } from "./DeletedSuiteResponseData"; +/** + * Response containing the list of deleted Synthetic test suites. + */ export class DeletedSuitesResponse { + /** + * List of deleted Synthetic suite data objects. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestResponseData.ts b/services/synthetics/src/v2/models/DeletedTestResponseData.ts index 59c26ab1b9a3..aae7c1cfeeda 100644 --- a/services/synthetics/src/v2/models/DeletedTestResponseData.ts +++ b/services/synthetics/src/v2/models/DeletedTestResponseData.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedTestResponseDataAttributes } from "./DeletedTestResponseDataAttributes"; import { DeletedTestsResponseType } from "./DeletedTestsResponseType"; +/** + * Data object for a deleted Synthetic test. + */ export class DeletedTestResponseData { + /** + * Attributes of a deleted Synthetic test, including deletion timestamp and public ID. + */ "attributes"?: DeletedTestResponseDataAttributes; + /** + * The public ID of the deleted Synthetic test. + */ "id"?: string; + /** + * Type for the bulk delete Synthetic tests response, `delete_tests`. + */ "type"?: DeletedTestsResponseType; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestResponseDataAttributes.ts b/services/synthetics/src/v2/models/DeletedTestResponseDataAttributes.ts index c48dffc22482..b5efdfd3e56a 100644 --- a/services/synthetics/src/v2/models/DeletedTestResponseDataAttributes.ts +++ b/services/synthetics/src/v2/models/DeletedTestResponseDataAttributes.ts @@ -1,5 +1,8 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes of a deleted Synthetic test, including deletion timestamp and public ID. + */ export class DeletedTestResponseDataAttributes { /** * Deletion timestamp of the Synthetic test ID. diff --git a/services/synthetics/src/v2/models/DeletedTestsRequestDelete.ts b/services/synthetics/src/v2/models/DeletedTestsRequestDelete.ts index 956335404e3e..3f10db4b49d0 100644 --- a/services/synthetics/src/v2/models/DeletedTestsRequestDelete.ts +++ b/services/synthetics/src/v2/models/DeletedTestsRequestDelete.ts @@ -3,9 +3,21 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedTestsRequestDeleteAttributes } from "./DeletedTestsRequestDeleteAttributes"; import { DeletedTestsRequestType } from "./DeletedTestsRequestType"; +/** + * Data object for a bulk delete Synthetic tests request. + */ export class DeletedTestsRequestDelete { + /** + * Attributes for a bulk delete Synthetic tests request. + */ "attributes": DeletedTestsRequestDeleteAttributes; + /** + * An optional identifier for the delete request. + */ "id"?: string; + /** + * Type for the bulk delete Synthetic tests request, `delete_tests_request`. + */ "type"?: DeletedTestsRequestType; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestsRequestDeleteAttributes.ts b/services/synthetics/src/v2/models/DeletedTestsRequestDeleteAttributes.ts index 0ad89b8666ba..e57e672a6fd1 100644 --- a/services/synthetics/src/v2/models/DeletedTestsRequestDeleteAttributes.ts +++ b/services/synthetics/src/v2/models/DeletedTestsRequestDeleteAttributes.ts @@ -1,7 +1,16 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; +/** + * Attributes for a bulk delete Synthetic tests request. + */ export class DeletedTestsRequestDeleteAttributes { + /** + * Whether to force deletion of tests that have dependent resources. + */ "forceDeleteDependencies"?: boolean; + /** + * List of public IDs of the Synthetic tests to delete. + */ "publicIds": Array; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestsRequestDeleteRequest.ts b/services/synthetics/src/v2/models/DeletedTestsRequestDeleteRequest.ts index 0fa4945b2bac..573c243211e2 100644 --- a/services/synthetics/src/v2/models/DeletedTestsRequestDeleteRequest.ts +++ b/services/synthetics/src/v2/models/DeletedTestsRequestDeleteRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedTestsRequestDelete } from "./DeletedTestsRequestDelete"; +/** + * Request body for bulk deleting Synthetic tests. + */ export class DeletedTestsRequestDeleteRequest { + /** + * Data object for a bulk delete Synthetic tests request. + */ "data": DeletedTestsRequestDelete; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestsRequestType.ts b/services/synthetics/src/v2/models/DeletedTestsRequestType.ts index 99ce56c4544d..890754af5a19 100644 --- a/services/synthetics/src/v2/models/DeletedTestsRequestType.ts +++ b/services/synthetics/src/v2/models/DeletedTestsRequestType.ts @@ -1,4 +1,8 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * Type for the bulk delete Synthetic tests request, `delete_tests_request`. + */ export type DeletedTestsRequestType = | typeof DELETE_TESTS_REQUEST | UnparsedObject; diff --git a/services/synthetics/src/v2/models/DeletedTestsResponse.ts b/services/synthetics/src/v2/models/DeletedTestsResponse.ts index 97ba968ecf2f..db000a64bc12 100644 --- a/services/synthetics/src/v2/models/DeletedTestsResponse.ts +++ b/services/synthetics/src/v2/models/DeletedTestsResponse.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { DeletedTestResponseData } from "./DeletedTestResponseData"; +/** + * Response containing the list of deleted Synthetic tests. + */ export class DeletedTestsResponse { + /** + * List of deleted Synthetic test data objects. + */ "data"?: Array; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/DeletedTestsResponseType.ts b/services/synthetics/src/v2/models/DeletedTestsResponseType.ts index 84609e6a65ff..af166248f073 100644 --- a/services/synthetics/src/v2/models/DeletedTestsResponseType.ts +++ b/services/synthetics/src/v2/models/DeletedTestsResponseType.ts @@ -1,3 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * Type for the bulk delete Synthetic tests response, `delete_tests`. + */ export type DeletedTestsResponseType = typeof DELETE_TESTS | UnparsedObject; export const DELETE_TESTS = "delete_tests"; diff --git a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequest.ts b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequest.ts index 1bdef8e5b4b6..614d5b175499 100644 --- a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequest.ts +++ b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequest.ts @@ -6,6 +6,9 @@ import { GlobalVariableJsonPatchRequestData } from "./GlobalVariableJsonPatchReq * JSON Patch request for global variable. */ export class GlobalVariableJsonPatchRequest { + /** + * Data object for a JSON Patch request on a Synthetic global variable. + */ "data": GlobalVariableJsonPatchRequestData; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestData.ts b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestData.ts index 6db9850c6f91..c1e5de1ecd7c 100644 --- a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestData.ts +++ b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestData.ts @@ -3,7 +3,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { GlobalVariableJsonPatchRequestDataAttributes } from "./GlobalVariableJsonPatchRequestDataAttributes"; import { GlobalVariableJsonPatchType } from "./GlobalVariableJsonPatchType"; +/** + * Data object for a JSON Patch request on a Synthetic global variable. + */ export class GlobalVariableJsonPatchRequestData { + /** + * Attributes for a JSON Patch request on a Synthetic global variable. + */ "attributes"?: GlobalVariableJsonPatchRequestDataAttributes; /** * Global variable JSON Patch type. diff --git a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestDataAttributes.ts b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestDataAttributes.ts index e7bd8478bd4e..47666c9831fe 100644 --- a/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestDataAttributes.ts +++ b/services/synthetics/src/v2/models/GlobalVariableJsonPatchRequestDataAttributes.ts @@ -2,6 +2,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { JsonPatchOperation } from "./JsonPatchOperation"; +/** + * Attributes for a JSON Patch request on a Synthetic global variable. + */ export class GlobalVariableJsonPatchRequestDataAttributes { /** * JSON Patch operations following RFC 6902. diff --git a/services/synthetics/src/v2/models/SuiteCreateEdit.ts b/services/synthetics/src/v2/models/SuiteCreateEdit.ts index 682cbafcb527..e107823a5cb0 100644 --- a/services/synthetics/src/v2/models/SuiteCreateEdit.ts +++ b/services/synthetics/src/v2/models/SuiteCreateEdit.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SyntheticsSuite } from "./SyntheticsSuite"; import { SyntheticsSuiteTypes } from "./SyntheticsSuiteTypes"; +/** + * Data object for creating or editing a Synthetic test suite. + */ export class SuiteCreateEdit { /** * Object containing details about a Synthetic suite. diff --git a/services/synthetics/src/v2/models/SuiteCreateEditRequest.ts b/services/synthetics/src/v2/models/SuiteCreateEditRequest.ts index fc08c7e0734f..755cab12b291 100644 --- a/services/synthetics/src/v2/models/SuiteCreateEditRequest.ts +++ b/services/synthetics/src/v2/models/SuiteCreateEditRequest.ts @@ -2,7 +2,13 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SuiteCreateEdit } from "./SuiteCreateEdit"; +/** + * Request body for creating or editing a Synthetic test suite. + */ export class SuiteCreateEditRequest { + /** + * Data object for creating or editing a Synthetic test suite. + */ "data": SuiteCreateEdit; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/SuiteSearchResponseType.ts b/services/synthetics/src/v2/models/SuiteSearchResponseType.ts index 629a0c7250c9..a5659b3422f0 100644 --- a/services/synthetics/src/v2/models/SuiteSearchResponseType.ts +++ b/services/synthetics/src/v2/models/SuiteSearchResponseType.ts @@ -1,3 +1,7 @@ import { UnparsedObject } from "@datadog/datadog-api-client"; + +/** + * Type for the Synthetics suites search response, `suites_search`. + */ export type SuiteSearchResponseType = typeof SUITES_SEARCH | UnparsedObject; export const SUITES_SEARCH = "suites_search"; diff --git a/services/synthetics/src/v2/models/SyntheticsNetworkTestEdit.ts b/services/synthetics/src/v2/models/SyntheticsNetworkTestEdit.ts index 8b80183baac4..b388ece77f66 100644 --- a/services/synthetics/src/v2/models/SyntheticsNetworkTestEdit.ts +++ b/services/synthetics/src/v2/models/SyntheticsNetworkTestEdit.ts @@ -3,6 +3,9 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client"; import { SyntheticsNetworkTest } from "./SyntheticsNetworkTest"; import { SyntheticsNetworkTestType } from "./SyntheticsNetworkTestType"; +/** + * Data object for creating or editing a Network Path test. + */ export class SyntheticsNetworkTestEdit { /** * Object containing details about a Network Path test. diff --git a/services/synthetics/src/v2/models/SyntheticsNetworkTestEditRequest.ts b/services/synthetics/src/v2/models/SyntheticsNetworkTestEditRequest.ts index 5acd81b0adc3..b4b7a3b38d69 100644 --- a/services/synthetics/src/v2/models/SyntheticsNetworkTestEditRequest.ts +++ b/services/synthetics/src/v2/models/SyntheticsNetworkTestEditRequest.ts @@ -6,6 +6,9 @@ import { SyntheticsNetworkTestEdit } from "./SyntheticsNetworkTestEdit"; * Network Path test request. */ export class SyntheticsNetworkTestEditRequest { + /** + * Data object for creating or editing a Network Path test. + */ "data": SyntheticsNetworkTestEdit; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/SyntheticsSuite.ts b/services/synthetics/src/v2/models/SyntheticsSuite.ts index 588add028153..f21941ea6b37 100644 --- a/services/synthetics/src/v2/models/SyntheticsSuite.ts +++ b/services/synthetics/src/v2/models/SyntheticsSuite.ts @@ -32,6 +32,9 @@ export class SyntheticsSuite { * Array of tags attached to the suite. */ "tags"?: Array; + /** + * Array of Synthetic tests included in the suite. + */ "tests": Array; /** * Type of the Synthetic suite, `suite`. diff --git a/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseData.ts b/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseData.ts index 48ca17d9fe4c..6ffbe58a77ef 100644 --- a/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseData.ts +++ b/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseData.ts @@ -11,7 +11,13 @@ export class SyntheticsSuiteSearchResponseData { * Synthetics suite search response data attributes */ "attributes"?: SyntheticsSuiteSearchResponseDataAttributes; + /** + * The unique identifier of the suite search response data. + */ "id"?: string; + /** + * Type for the Synthetics suites search response, `suites_search`. + */ "type"?: SuiteSearchResponseType; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseDataAttributes.ts b/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseDataAttributes.ts index 816fd588d8fb..7515c178bca2 100644 --- a/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseDataAttributes.ts +++ b/services/synthetics/src/v2/models/SyntheticsSuiteSearchResponseDataAttributes.ts @@ -6,7 +6,13 @@ import { SyntheticsSuite } from "./SyntheticsSuite"; * Synthetics suite search response data attributes */ export class SyntheticsSuiteSearchResponseDataAttributes { + /** + * List of Synthetic suites matching the search query. + */ "suites"?: Array; + /** + * Total number of Synthetic suites matching the search query. + */ "total"?: number; /** * A container for additional, undeclared properties. diff --git a/services/synthetics/src/v2/models/SyntheticsSuiteTest.ts b/services/synthetics/src/v2/models/SyntheticsSuiteTest.ts index 426037414a2e..213c06628904 100644 --- a/services/synthetics/src/v2/models/SyntheticsSuiteTest.ts +++ b/services/synthetics/src/v2/models/SyntheticsSuiteTest.ts @@ -10,6 +10,9 @@ export class SyntheticsSuiteTest { * Alerting criticality for each the test. */ "alertingCriticality"?: SyntheticsSuiteTestAlertingCriticality; + /** + * The public ID of the Synthetic test included in the suite. + */ "publicId": string; /** * A container for additional, undeclared properties.