From a4471868c2e173833bc6ee7a4713ec75127fea6c Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 30 Oct 2026 19:24:49 +0000 Subject: [PATCH] Regenerate client from commit 0b339c2 of spec repo --- .generator/schemas/v2/openapi.yaml | 146 ++++++++++++++---- .../v2/api/container_images_api.py | 55 +++++-- .../v2/model/container_image.py | 3 +- .../v2/model/container_image_attributes.py | 25 +-- .../v2/model/container_image_flavor.py | 2 +- .../model/container_image_group_attributes.py | 4 +- ...r_image_group_images_relationships_link.py | 4 +- ...ntainer_image_group_relationships_links.py | 4 +- .../v2/model/container_image_item.py | 3 +- .../v2/model/container_image_meta_page.py | 8 +- .../model/container_image_vulnerabilities.py | 3 +- .../v2/model/container_images_response.py | 4 +- 12 files changed, 194 insertions(+), 67 deletions(-) diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 8a63ddc4ce..e16263c43b 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -23260,7 +23260,9 @@ components: attributes: $ref: "#/components/schemas/ContainerImageAttributes" id: - description: Container Image ID. + description: |- + Opaque Container Image ID. Often contains a registry, repository, and digest, but the format + varies by collection source. Preserve the returned value rather than constructing an ID. type: string type: $ref: "#/components/schemas/ContainerImageType" @@ -23274,13 +23276,15 @@ components: type: integer image_flavors: description: |- - List of platform-specific images associated with the image record. - The list contains more than 1 entry for multi-architecture images. + Platform-specific image metadata, including size in bytes and available build and operating + system details. Use these objects to associate sizes with platforms when platform information is available. items: $ref: "#/components/schemas/ContainerImageFlavor" type: array image_tags: - description: List of image tags associated with the Container Image. + description: |- + Image version tags, such as `latest` or `v1.2.3`. Tags can change; use the returned `id` to + identify an image record. The corresponding filter and grouping key is `image_tag`. items: description: An image tag associated with the Container Image. type: string @@ -23320,34 +23324,38 @@ components: description: Time the image was pushed to the container registry. type: string registry: - description: Registry the Container Image was pushed to. + description: Registry where the image is stored. Use the `image_registry` tag key for filtering and grouping. type: string repo_digest: - description: Digest of the compressed image manifest. + description: |- + Digest of the compressed image manifest. Use the `repo_digest` tag key to filter by this value. type: string repository: - description: Repository where the Container Image is stored in. + description: |- + Repository where the image is stored. Use the `image_repository` tag key for filtering and grouping. type: string short_image: description: Short version of the Container Image name. type: string sizes: description: |- - List of size for each platform-specific image associated with the image record. - The list contains more than 1 entry for multi-architecture images. + Reported sizes in bytes of platform-specific images, with multiple values possible for multi-architecture images. + Use `image_flavors` for available platform associations; use `size` as the sort key. items: - description: Size of the platform-specific Container Image. + description: Size of the platform-specific Container Image in bytes. format: int64 type: integer type: array sources: - description: List of sources where the Container Image was collected from. + description: Collection sources, such as `live_containers`, `image_check`, `aws_ecr`, or `agentless_scanner`. items: description: Source where the Container Image was collected from. type: string type: array tags: - description: List of tags associated with the Container Image. + description: |- + Image tags in `key:value` form, such as `image_registry:docker.io` or `status:running`. + Use tag keys in `group_by`. Tags used in `filter[tags]` must satisfy its syntax restrictions. items: description: A tag associated with the Container Image. type: string @@ -23371,7 +23379,7 @@ components: description: Operating System version supported by the Container Image. type: string size: - description: Size of the platform-specific Container Image. + description: Size of the platform-specific Container Image in bytes. format: int64 type: integer type: object @@ -23392,7 +23400,10 @@ components: description: Attributes for a Container Image Group. properties: count: - description: Number of Container Images in the group. + description: |- + Number of images in the group. An image with multiple values for a grouping tag can appear + in multiple groups. Images missing a grouping key are excluded. Summing group counts does + not give a reliable inventory total. format: int64 type: integer name: @@ -23417,7 +23428,10 @@ components: $ref: "#/components/schemas/ContainerImageGroupImagesRelationshipsLink" type: object ContainerImageGroupRelationshipsData: - description: Links data. + description: |- + This array is always empty, even when the group includes images. To retrieve the images in + this group, make a new request without `group_by`, using the `filter[tags]` value from + `links.related` and your site's API host. The tags must satisfy `filter[tags]` syntax restrictions. items: description: A link data. type: string @@ -23426,7 +23440,10 @@ components: description: Links attributes. properties: related: - description: Link to related Container Images. + description: |- + Link containing the original filters combined with the group tags, without `group_by`. + Use its `filter[tags]` value in a new request to your site's API host. The tags must satisfy + `filter[tags]` syntax restrictions. type: string type: object ContainerImageGroupType: @@ -23456,20 +23473,24 @@ components: description: The cursor used to get the current results, if any. type: string limit: - description: Number of results returned + description: Maximum number of results requested. format: int32 maximum: 10000 minimum: 0 type: integer next_cursor: - description: The cursor used to get the next results, if any. + description: |- + The cursor used to get the next results, if any. To make the next request, use the same + parameters with the addition of `page[cursor]`. Always empty for grouped results, even + when additional groups exist. type: string prev_cursor: description: The cursor used to get the previous results, if any. nullable: true type: string total: - description: Total number of records that match the query. + description: |- + Total number of images that match the query. Always `0` for grouped results. format: int64 type: integer type: @@ -23494,7 +23515,9 @@ components: x-enum-varnames: - CONTAINER_IMAGE ContainerImageVulnerabilities: - description: Vulnerability counts associated with the Container Image. + description: |- + Vulnerability counts by severity, when available. An absent `vulnerability_count` does not mean + the image has no vulnerabilities. properties: asset_id: description: ID of the Container Image. @@ -23525,10 +23548,11 @@ components: type: integer type: object ContainerImagesResponse: - description: List of Container Images. + description: List of Container Images or Container Image groups. properties: data: - description: Array of Container Image objects. + description: |- + Array of `container_image` objects, or `container_image_group` objects when `group_by` is specified. items: $ref: "#/components/schemas/ContainerImageItem" type: array @@ -159603,32 +159627,53 @@ paths: /api/v2/container_images: get: description: |- - Get all Container Images for your organization. + Get all container images for your organization. This endpoint queries current + inventory and does not support time-range parameters. + + Use `group_by` to return image groups with counts. Grouped results are limited + by `page[size]`, may be incomplete, and do not support pagination. + **Note**: To enrich the data returned by this endpoint with security scans, see the new [api/v2/security/scanned-assets-metadata](https://docs.datadoghq.com/api/latest/security-monitoring/#list-scanned-assets-metadata) endpoint. operationId: ListContainerImages parameters: - - description: Comma-separated list of tags to filter Container Images by. + - description: |- + Comma-separated `key:value` tags. An image must match every tag. Wildcards, negation + (`-key:value`), spaces, and `IN (...)` are not supported. Use keys such as `image_registry` + and `image_tag`. To match any of several values of the same key, make one request per value. example: short_image:redis,status:running in: query name: filter[tags] required: false schema: type: string - - description: Comma-separated list of tags to group Container Images by. - example: registry,image_tags + - description: |- + Comma-separated list of up to three tag keys, such as `image_registry,image_tag`. Returns + `container_image_group` objects with counts and tags. Grouped results ignore `sort` and do + not support pagination. Images missing a grouping key are excluded. An image with multiple + values for a grouping tag can appear in multiple groups. Grouped results may be incomplete. + Compare counts only within the returned groups; they do not establish the most common tags + or proportions across the inventory. For inventory-wide comparisons, omit `group_by`, keep the + same filters, paginate all results, and deduplicate by returned image ID. For an inventory total, + use `meta.pagination.total` from a query without grouping. + example: image_registry,image_tag in: query name: group_by required: false schema: type: string - - description: Attribute to sort Container Images by. - example: container_count + - description: |- + Attribute to sort individual images by, such as `size` or `container_count`. + Defaults to `image_name` in ascending order. Prefix the attribute with `-` for + descending order, such as `-size`. Ignored when `group_by` is specified. + example: "-container_count" in: query name: sort required: false schema: type: string - - description: Maximum number of results returned. + - description: |- + Maximum number of results returned. Grouped queries default to `100`, with a maximum of `1000` groups. + Without grouping, queries default to `1000`, with a maximum of `10000` images. Minimum is `1`. in: query name: page[size] required: false @@ -159639,8 +159684,8 @@ paths: minimum: 1 type: integer - description: |- - String to query the next page of results. - This key is provided with each valid response from the API in `meta.pagination.next_cursor`. + Opaque cursor from `meta.pagination.next_cursor` for individual images. Keep the same filters + and sort order. Stop when absent or empty. Grouped queries do not support pagination. in: query name: page[cursor] required: false @@ -159656,12 +159701,26 @@ paths: data: - attributes: container_count: 1 + image_flavors: + - built_at: "2026-01-01T00:00:00Z" + os_architecture: amd64 + os_name: linux + os_version: "" + size: 100000000 image_tags: - latest name: nginx registry: docker.io repository: library/nginx short_image: nginx + sizes: + - 100000000 + tags: + - image_registry:docker.io + - image_repository:library/nginx + - image_tag:latest + - short_image:nginx + - status:running id: abc-123 type: container_image meta: @@ -159669,6 +159728,31 @@ paths: limit: 1000 total: 1 type: cursor_limit + grouped: + summary: Images grouped by registry. + value: + data: + - attributes: + count: 1 + name: image_registry:docker.io + tags: + image_registry: docker.io + id: image_registry:docker.io + relationships: + container_images: + data: [] + links: + related: >- + https://api.datadoghq.com/api/v2/container_images?filter[tags]=image_registry:docker.io + type: container_image_group + meta: + pagination: + cursor: "" + limit: 100 + next_cursor: "" + prev_cursor: "" + total: 0 + type: cursor_limit schema: $ref: "#/components/schemas/ContainerImagesResponse" description: OK diff --git a/src/datadog_api_client/v2/api/container_images_api.py b/src/datadog_api_client/v2/api/container_images_api.py index 1b04eebc24..7ec6ff3bb3 100644 --- a/src/datadog_api_client/v2/api/container_images_api.py +++ b/src/datadog_api_client/v2/api/container_images_api.py @@ -85,19 +85,36 @@ def list_container_images( ) -> ContainerImagesResponse: """Get all Container Images. - Get all Container Images for your organization. + Get all container images for your organization. This endpoint queries current + inventory and does not support time-range parameters. + + Use ``group_by`` to return image groups with counts. Grouped results are limited + by ``page[size]`` , may be incomplete, and do not support pagination. + **Note** : To enrich the data returned by this endpoint with security scans, see the new `api/v2/security/scanned-assets-metadata `_ endpoint. - :param filter_tags: Comma-separated list of tags to filter Container Images by. + :param filter_tags: Comma-separated ``key:value`` tags. An image must match every tag. Wildcards, negation + ( ``-key:value`` ), spaces, and ``IN (...)`` are not supported. Use keys such as ``image_registry`` + and ``image_tag``. To match any of several values of the same key, make one request per value. :type filter_tags: str, optional - :param group_by: Comma-separated list of tags to group Container Images by. + :param group_by: Comma-separated list of up to three tag keys, such as ``image_registry,image_tag``. Returns + ``container_image_group`` objects with counts and tags. Grouped results ignore ``sort`` and do + not support pagination. Images missing a grouping key are excluded. An image with multiple + values for a grouping tag can appear in multiple groups. Grouped results may be incomplete. + Compare counts only within the returned groups; they do not establish the most common tags + or proportions across the inventory. For inventory-wide comparisons, omit ``group_by`` , keep the + same filters, paginate all results, and deduplicate by returned image ID. For an inventory total, + use ``meta.pagination.total`` from a query without grouping. :type group_by: str, optional - :param sort: Attribute to sort Container Images by. + :param sort: Attribute to sort individual images by, such as ``size`` or ``container_count``. + Defaults to ``image_name`` in ascending order. Prefix the attribute with ``-`` for + descending order, such as ``-size``. Ignored when ``group_by`` is specified. :type sort: str, optional - :param page_size: Maximum number of results returned. + :param page_size: Maximum number of results returned. Grouped queries default to ``100`` , with a maximum of ``1000`` groups. + Without grouping, queries default to ``1000`` , with a maximum of ``10000`` images. Minimum is ``1``. :type page_size: int, optional - :param page_cursor: String to query the next page of results. - This key is provided with each valid response from the API in ``meta.pagination.next_cursor``. + :param page_cursor: Opaque cursor from ``meta.pagination.next_cursor`` for individual images. Keep the same filters + and sort order. Stop when absent or empty. Grouped queries do not support pagination. :type page_cursor: str, optional :rtype: ContainerImagesResponse """ @@ -132,16 +149,28 @@ def list_container_images_with_pagination( Provide a paginated version of :meth:`list_container_images`, returning all items. - :param filter_tags: Comma-separated list of tags to filter Container Images by. + :param filter_tags: Comma-separated ``key:value`` tags. An image must match every tag. Wildcards, negation + ( ``-key:value`` ), spaces, and ``IN (...)`` are not supported. Use keys such as ``image_registry`` + and ``image_tag``. To match any of several values of the same key, make one request per value. :type filter_tags: str, optional - :param group_by: Comma-separated list of tags to group Container Images by. + :param group_by: Comma-separated list of up to three tag keys, such as ``image_registry,image_tag``. Returns + ``container_image_group`` objects with counts and tags. Grouped results ignore ``sort`` and do + not support pagination. Images missing a grouping key are excluded. An image with multiple + values for a grouping tag can appear in multiple groups. Grouped results may be incomplete. + Compare counts only within the returned groups; they do not establish the most common tags + or proportions across the inventory. For inventory-wide comparisons, omit ``group_by`` , keep the + same filters, paginate all results, and deduplicate by returned image ID. For an inventory total, + use ``meta.pagination.total`` from a query without grouping. :type group_by: str, optional - :param sort: Attribute to sort Container Images by. + :param sort: Attribute to sort individual images by, such as ``size`` or ``container_count``. + Defaults to ``image_name`` in ascending order. Prefix the attribute with ``-`` for + descending order, such as ``-size``. Ignored when ``group_by`` is specified. :type sort: str, optional - :param page_size: Maximum number of results returned. + :param page_size: Maximum number of results returned. Grouped queries default to ``100`` , with a maximum of ``1000`` groups. + Without grouping, queries default to ``1000`` , with a maximum of ``10000`` images. Minimum is ``1``. :type page_size: int, optional - :param page_cursor: String to query the next page of results. - This key is provided with each valid response from the API in ``meta.pagination.next_cursor``. + :param page_cursor: Opaque cursor from ``meta.pagination.next_cursor`` for individual images. Keep the same filters + and sort order. Stop when absent or empty. Grouped queries do not support pagination. :type page_cursor: str, optional :return: A generator of paginated results. diff --git a/src/datadog_api_client/v2/model/container_image.py b/src/datadog_api_client/v2/model/container_image.py index 995f0406a4..a8be5a7bc9 100644 --- a/src/datadog_api_client/v2/model/container_image.py +++ b/src/datadog_api_client/v2/model/container_image.py @@ -49,7 +49,8 @@ def __init__( :param attributes: Attributes for a Container Image. :type attributes: ContainerImageAttributes, optional - :param id: Container Image ID. + :param id: Opaque Container Image ID. Often contains a registry, repository, and digest, but the format + varies by collection source. Preserve the returned value rather than constructing an ID. :type id: str, optional :param type: Type of Container Image. diff --git a/src/datadog_api_client/v2/model/container_image_attributes.py b/src/datadog_api_client/v2/model/container_image_attributes.py index 9238df5058..9493866513 100644 --- a/src/datadog_api_client/v2/model/container_image_attributes.py +++ b/src/datadog_api_client/v2/model/container_image_attributes.py @@ -91,11 +91,12 @@ def __init__( :param container_count: Number of containers running the image. :type container_count: int, optional - :param image_flavors: List of platform-specific images associated with the image record. - The list contains more than 1 entry for multi-architecture images. + :param image_flavors: Platform-specific image metadata, including size in bytes and available build and operating + system details. Use these objects to associate sizes with platforms when platform information is available. :type image_flavors: [ContainerImageFlavor], optional - :param image_tags: List of image tags associated with the Container Image. + :param image_tags: Image version tags, such as ``latest`` or ``v1.2.3``. Tags can change; use the returned ``id`` to + identify an image record. The corresponding filter and grouping key is ``image_tag``. :type image_tags: [str], optional :param images_built_at: List of build times associated with the Container Image. @@ -117,29 +118,31 @@ def __init__( :param published_at: Time the image was pushed to the container registry. :type published_at: str, optional - :param registry: Registry the Container Image was pushed to. + :param registry: Registry where the image is stored. Use the ``image_registry`` tag key for filtering and grouping. :type registry: str, optional - :param repo_digest: Digest of the compressed image manifest. + :param repo_digest: Digest of the compressed image manifest. Use the ``repo_digest`` tag key to filter by this value. :type repo_digest: str, optional - :param repository: Repository where the Container Image is stored in. + :param repository: Repository where the image is stored. Use the ``image_repository`` tag key for filtering and grouping. :type repository: str, optional :param short_image: Short version of the Container Image name. :type short_image: str, optional - :param sizes: List of size for each platform-specific image associated with the image record. - The list contains more than 1 entry for multi-architecture images. + :param sizes: Reported sizes in bytes of platform-specific images, with multiple values possible for multi-architecture images. + Use ``image_flavors`` for available platform associations; use ``size`` as the sort key. :type sizes: [int], optional - :param sources: List of sources where the Container Image was collected from. + :param sources: Collection sources, such as ``live_containers`` , ``image_check`` , ``aws_ecr`` , or ``agentless_scanner``. :type sources: [str], optional - :param tags: List of tags associated with the Container Image. + :param tags: Image tags in ``key:value`` form, such as ``image_registry:docker.io`` or ``status:running``. + Use tag keys in ``group_by``. Tags used in ``filter[tags]`` must satisfy its syntax restrictions. :type tags: [str], optional - :param vulnerability_count: Vulnerability counts associated with the Container Image. + :param vulnerability_count: Vulnerability counts by severity, when available. An absent ``vulnerability_count`` does not mean + the image has no vulnerabilities. :type vulnerability_count: ContainerImageVulnerabilities, optional """ if container_count is not unset: diff --git a/src/datadog_api_client/v2/model/container_image_flavor.py b/src/datadog_api_client/v2/model/container_image_flavor.py index bd4c6b6dcd..012bcfd96f 100644 --- a/src/datadog_api_client/v2/model/container_image_flavor.py +++ b/src/datadog_api_client/v2/model/container_image_flavor.py @@ -56,7 +56,7 @@ def __init__( :param os_version: Operating System version supported by the Container Image. :type os_version: str, optional - :param size: Size of the platform-specific Container Image. + :param size: Size of the platform-specific Container Image in bytes. :type size: int, optional """ if built_at is not unset: diff --git a/src/datadog_api_client/v2/model/container_image_group_attributes.py b/src/datadog_api_client/v2/model/container_image_group_attributes.py index e668841500..62b67d5116 100644 --- a/src/datadog_api_client/v2/model/container_image_group_attributes.py +++ b/src/datadog_api_client/v2/model/container_image_group_attributes.py @@ -38,7 +38,9 @@ def __init__( """ Attributes for a Container Image Group. - :param count: Number of Container Images in the group. + :param count: Number of images in the group. An image with multiple values for a grouping tag can appear + in multiple groups. Images missing a grouping key are excluded. Summing group counts does + not give a reliable inventory total. :type count: int, optional :param name: Name of the Container Image group. diff --git a/src/datadog_api_client/v2/model/container_image_group_images_relationships_link.py b/src/datadog_api_client/v2/model/container_image_group_images_relationships_link.py index 9d1bf1a7eb..c7d1125ac5 100644 --- a/src/datadog_api_client/v2/model/container_image_group_images_relationships_link.py +++ b/src/datadog_api_client/v2/model/container_image_group_images_relationships_link.py @@ -45,7 +45,9 @@ def __init__( """ Relationships to Container Images inside a Container Image Group. - :param data: Links data. + :param data: This array is always empty, even when the group includes images. To retrieve the images in + this group, make a new request without ``group_by`` , using the ``filter[tags]`` value from + ``links.related`` and your site's API host. The tags must satisfy ``filter[tags]`` syntax restrictions. :type data: [str], optional :param links: Links attributes. diff --git a/src/datadog_api_client/v2/model/container_image_group_relationships_links.py b/src/datadog_api_client/v2/model/container_image_group_relationships_links.py index c858f4a68a..c7024488d5 100644 --- a/src/datadog_api_client/v2/model/container_image_group_relationships_links.py +++ b/src/datadog_api_client/v2/model/container_image_group_relationships_links.py @@ -28,7 +28,9 @@ def __init__(self_, related: Union[str, UnsetType] = unset, **kwargs): """ Links attributes. - :param related: Link to related Container Images. + :param related: Link containing the original filters combined with the group tags, without ``group_by``. + Use its ``filter[tags]`` value in a new request to your site's API host. The tags must satisfy + ``filter[tags]`` syntax restrictions. :type related: str, optional """ if related is not unset: diff --git a/src/datadog_api_client/v2/model/container_image_item.py b/src/datadog_api_client/v2/model/container_image_item.py index b0435ec728..3ad72facbc 100644 --- a/src/datadog_api_client/v2/model/container_image_item.py +++ b/src/datadog_api_client/v2/model/container_image_item.py @@ -18,7 +18,8 @@ def __init__(self, **kwargs): :param attributes: Attributes for a Container Image. :type attributes: ContainerImageAttributes, optional - :param id: Container Image ID. + :param id: Opaque Container Image ID. Often contains a registry, repository, and digest, but the format + varies by collection source. Preserve the returned value rather than constructing an ID. :type id: str, optional :param type: Type of Container Image. diff --git a/src/datadog_api_client/v2/model/container_image_meta_page.py b/src/datadog_api_client/v2/model/container_image_meta_page.py index f2c5dff6dd..977fa9217e 100644 --- a/src/datadog_api_client/v2/model/container_image_meta_page.py +++ b/src/datadog_api_client/v2/model/container_image_meta_page.py @@ -64,16 +64,18 @@ def __init__( :param cursor: The cursor used to get the current results, if any. :type cursor: str, optional - :param limit: Number of results returned + :param limit: Maximum number of results requested. :type limit: int, optional - :param next_cursor: The cursor used to get the next results, if any. + :param next_cursor: The cursor used to get the next results, if any. To make the next request, use the same + parameters with the addition of ``page[cursor]``. Always empty for grouped results, even + when additional groups exist. :type next_cursor: str, optional :param prev_cursor: The cursor used to get the previous results, if any. :type prev_cursor: str, none_type, optional - :param total: Total number of records that match the query. + :param total: Total number of images that match the query. Always ``0`` for grouped results. :type total: int, optional :param type: Type of Container Image pagination. diff --git a/src/datadog_api_client/v2/model/container_image_vulnerabilities.py b/src/datadog_api_client/v2/model/container_image_vulnerabilities.py index d464f80dd7..fd0c3d0aee 100644 --- a/src/datadog_api_client/v2/model/container_image_vulnerabilities.py +++ b/src/datadog_api_client/v2/model/container_image_vulnerabilities.py @@ -48,7 +48,8 @@ def __init__( **kwargs, ): """ - Vulnerability counts associated with the Container Image. + Vulnerability counts by severity, when available. An absent ``vulnerability_count`` does not mean + the image has no vulnerabilities. :param asset_id: ID of the Container Image. :type asset_id: str, optional diff --git a/src/datadog_api_client/v2/model/container_images_response.py b/src/datadog_api_client/v2/model/container_images_response.py index cc4f02f476..f1cafb61bf 100644 --- a/src/datadog_api_client/v2/model/container_images_response.py +++ b/src/datadog_api_client/v2/model/container_images_response.py @@ -48,9 +48,9 @@ def __init__( **kwargs, ): """ - List of Container Images. + List of Container Images or Container Image groups. - :param data: Array of Container Image objects. + :param data: Array of ``container_image`` objects, or ``container_image_group`` objects when ``group_by`` is specified. :type data: [ContainerImageItem], optional :param links: Pagination links.