diff --git a/packages/clients/src/api/registry/v1/api.gen.ts b/packages/clients/src/api/registry/v1/api.gen.ts index cb9c9f0c2..941936282 100644 --- a/packages/clients/src/api/registry/v1/api.gen.ts +++ b/packages/clients/src/api/registry/v1/api.gen.ts @@ -49,11 +49,7 @@ const jsonContentHeaders = { 'Content-Type': 'application/json; charset=utf-8', } -/** - * Registry API. - * - * Container registry API. Registry API. - */ +/** Container Registry API. */ export class API extends ParentAPI { /** Lists the available regions of the API. */ public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw'] @@ -84,7 +80,11 @@ export class API extends ParentAPI { ) /** - * List all your namespaces. + * List namespaces. List all namespaces in a specified region. By default, the + * namespaces listed are ordered by creation date in ascending order. This can + * be modified via the order_by field. You can also define additional + * parameters for your query, such as the `instance_id` and `project_id` + * parameters. * * @param request - The request {@link ListNamespacesRequest} * @returns A Promise of ListNamespacesResponse @@ -93,7 +93,10 @@ export class API extends ParentAPI { enrichForPagination('namespaces', this.pageOfListNamespaces, request) /** - * Get a namespace. Get the namespace associated with the given id. + * Get a namespace. Retrieve information about a given namespace, specified by + * its `namespace_id` and region. Full details about the namespace, such as + * `description`, `project_id`, `status`, `endpoint`, `is_public`, `size`, and + * `image_count` are returned in the response. * * @param request - The request {@link GetNamespaceRequest} * @returns A Promise of Namespace @@ -131,7 +134,10 @@ export class API extends ParentAPI { ) /** - * Create a new namespace. + * Create a namespace. Create a new Container Registry namespace. You must + * specify the namespace name and region in which you want it to be created. + * Optionally, you can specify the `project_id` and `is_public` in the request + * payload. * * @param request - The request {@link CreateNamespaceRequest} * @returns A Promise of Namespace @@ -153,8 +159,9 @@ export class API extends ParentAPI { ) /** - * Update an existing namespace. Update the namespace associated with the - * given id. + * Update a namespace. Update the parameters of a given namespace, specified + * by its `namespace_id` and `region`. You can update the `description` and + * `is_public` parameters. * * @param request - The request {@link UpdateNamespaceRequest} * @returns A Promise of Namespace @@ -176,8 +183,9 @@ export class API extends ParentAPI { ) /** - * Delete an existing namespace. Delete the namespace associated with the - * given id. + * Delete a namespace. Delete a given namespace. You must specify, in the + * endpoint, the `region` and `namespace_id` parameters of the namespace you + * want to delete. * * @param request - The request {@link DeleteNamespaceRequest} * @returns A Promise of Namespace @@ -219,7 +227,10 @@ export class API extends ParentAPI { ) /** - * List all your images. + * List images. List all images in a specified region. By default, the images + * listed are ordered by creation date in ascending order. This can be + * modified via the order_by field. You can also define additional parameters + * for your query, such as the `namespace_id` and `project_id` parameters. * * @param request - The request {@link ListImagesRequest} * @returns A Promise of ListImagesResponse @@ -228,7 +239,10 @@ export class API extends ParentAPI { enrichForPagination('images', this.pageOfListImages, request) /** - * Get a image. Get the image associated with the given id. + * Get an image. Retrieve information about a given container image, specified + * by its `image_id` and region. Full details about the image, such as `name`, + * `namespace_id`, `status`, `visibility`, and `size` are returned in the + * response. * * @param request - The request {@link GetImageRequest} * @returns A Promise of Image @@ -266,7 +280,8 @@ export class API extends ParentAPI { ) /** - * Update an existing image. Update the image associated with the given id. + * Update an image. Update the parameters of a given image, specified by its + * `image_id` and `region`. You can update the `visibility` parameter. * * @param request - The request {@link UpdateImageRequest} * @returns A Promise of Image @@ -288,7 +303,8 @@ export class API extends ParentAPI { ) /** - * Delete an image. Delete the image associated with the given id. + * Delete an image. Delete a given image. You must specify, in the endpoint, + * the `region` and `image_id` parameters of the image you want to delete. * * @param request - The request {@link DeleteImageRequest} * @returns A Promise of Image @@ -327,7 +343,10 @@ export class API extends ParentAPI { ) /** - * List all your tags. + * List tags. List all tags for a given image, specified by region. By + * default, the tags listed are ordered by creation date in ascending order. + * This can be modified via the order_by field. You can also define additional + * parameters for your query, such as the `name`. * * @param request - The request {@link ListTagsRequest} * @returns A Promise of ListTagsResponse @@ -336,7 +355,9 @@ export class API extends ParentAPI { enrichForPagination('tags', this.pageOfListTags, request) /** - * Get a tag. Get the tag associated with the given id. + * Get a tag. Retrieve information about a given image tag, specified by its + * `tag_id` and region. Full details about the tag, such as `name`, + * `image_id`, `status`, and `digest` are returned in the response. * * @param request - The request {@link GetTagRequest} * @returns A Promise of Tag @@ -373,7 +394,8 @@ export class API extends ParentAPI { ) /** - * Delete a tag. Delete the tag associated with the given id. + * Delete a tag. Delete a given image tag. You must specify, in the endpoint, + * the `region` and `tag_id` parameters of the tag you want to delete. * * @param request - The request {@link DeleteTagRequest} * @returns A Promise of Tag diff --git a/packages/clients/src/api/registry/v1/types.gen.ts b/packages/clients/src/api/registry/v1/types.gen.ts index ffbdd1eb0..a5431f21d 100644 --- a/packages/clients/src/api/registry/v1/types.gen.ts +++ b/packages/clients/src/api/registry/v1/types.gen.ts @@ -41,20 +41,20 @@ export type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked' /** Image. */ export interface Image { - /** The unique ID of the Image. */ + /** The UUID of the image. */ id: string - /** The Image name, unique in a namespace. */ + /** The name of the image, it must be unique within the namespace. */ name: string - /** The unique ID of the Namespace the image belongs to. */ + /** The UUID of the namespace the image belongs to. */ namespaceId: string /** The status of the image. */ status: ImageStatus /** Details of the image status. */ statusMessage?: string /** - * A `public` image is pullable from internet without authentication, opposed - * to a `private` image. `inherit` will use the namespace `is_public` - * parameter. + * Set to `public` to allow the image to be pulled without authentication. + * Else, set to `private`. Set to `inherit` to keep the same visibility + * configuration as the namespace. */ visibility: ImageVisibility /** @@ -64,9 +64,9 @@ export interface Image { * counted twice. */ size: number - /** Creation date. */ + /** Date and time of image creation. */ createdAt?: Date - /** Last modification date, from the user or the service. */ + /** Date and time of last update. */ updatedAt?: Date /** List of docker tags of the image. */ tags: string[] @@ -74,31 +74,31 @@ export interface Image { /** List images response. */ export interface ListImagesResponse { - /** Paginated list of images matching filters. */ + /** Paginated list of images that match the selected filters. */ images: Image[] - /** Total number of images matching filters. */ + /** Total number of images that match the selected filters. */ totalCount: number } /** List namespaces response. */ export interface ListNamespacesResponse { - /** Paginated list of namespaces matching filters. */ + /** Paginated list of namespaces that match the selected filters. */ namespaces: Namespace[] - /** Total number of namespaces matching filters. */ + /** Total number of namespaces that match the selected filters. */ totalCount: number } /** List tags response. */ export interface ListTagsResponse { - /** Paginated list of tags matching filters. */ + /** Paginated list of tags that match the selected filters. */ tags: Tag[] - /** Total number of tags matching filters. */ + /** Total number of tags that match the selected filters. */ totalCount: number } /** Namespace. */ export interface Namespace { - /** The unique ID of the namespace. */ + /** The UUID of the namespace. */ id: string /** The name of the namespace, unique in a region accross all organizations. */ name: string @@ -114,16 +114,16 @@ export interface Namespace { statusMessage: string /** Endpoint reachable by docker. */ endpoint: string - /** Namespace visibility policy. */ + /** Whether or not namespace is public. */ isPublic: boolean /** * Total size of the namespace, calculated as the sum of the size of all * images in the namespace. */ size: number - /** Creation date. */ + /** Date and time of creation. */ createdAt?: Date - /** Last modification date, from the user or the service. */ + /** Date and time of last update. */ updatedAt?: Date /** Number of images in the namespace. */ imageCount: number @@ -133,22 +133,22 @@ export interface Namespace { /** Tag. */ export interface Tag { - /** The unique ID of the tag. */ + /** The UUID of the tag. */ id: string - /** Tag name, unique for an image. */ + /** Tag name, unique to an image. */ name: string - /** Image ID this tag belongs to. */ + /** Image ID the of the image the tag belongs to. */ imageId: string /** Tag status. */ status: TagStatus /** - * Hash of the tag actual content. Several tags of a same image may have the - * same digest. + * Hash of the tag content. Several tags of a same image may have the same + * digest. */ digest: string - /** Creation date. */ + /** Date and time of creation. */ createdAt?: Date - /** Last modification date, from the user or the service. */ + /** Date and time of last update. */ updatedAt?: Date } @@ -165,7 +165,11 @@ export type ListNamespacesRequest = { * display. */ pageSize?: number - /** Field by which to order the display of Images. */ + /** + * Criteria to use when ordering namespace listings. Possible values are + * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, + * `status_asc` and `status_desc`. The default value is `created_at_asc`. + */ orderBy?: ListNamespacesRequestOrderBy /** Filter by Organization ID. */ organizationId?: string @@ -181,7 +185,7 @@ export type GetNamespaceRequest = { * config. */ region?: Region - /** The unique ID of the Namespace. */ + /** The UUID of the namespace. */ namespaceId: string } @@ -191,25 +195,25 @@ export type CreateNamespaceRequest = { * config. */ region?: Region - /** Define a namespace name. */ + /** Name of the namespace. */ name?: string - /** Define a description. */ + /** Description of the namespace. */ description: string /** - * @deprecated Assign the namespace owner (deprecated). + * @deprecated Namespace owner (deprecated). * * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' * could be set. */ organizationId?: string /** - * Assign the namespace to a project ID. + * Project ID on which the namespace will be created. * * One-of ('projectIdentifier'): at most one of 'organizationId', 'projectId' * could be set. */ projectId?: string - /** Define the default visibility policy. */ + /** Whether or not namespace is public. */ isPublic: boolean } @@ -219,11 +223,11 @@ export type UpdateNamespaceRequest = { * config. */ region?: Region - /** Namespace ID to update. */ + /** ID of the namespace to update. */ namespaceId: string - /** Define a description. */ + /** Namespace description. */ description?: string - /** Define the default visibility policy. */ + /** Whether or not the namespace is public. */ isPublic?: boolean } @@ -233,7 +237,7 @@ export type DeleteNamespaceRequest = { * config. */ region?: Region - /** The unique ID of the Namespace. */ + /** The UUID of the namespace. */ namespaceId: string } @@ -250,11 +254,15 @@ export type ListImagesRequest = { * display. */ pageSize?: number - /** Field by which to order the display of Images. */ + /** + * Criteria to use when ordering image listings. Possible values are + * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, + * `status_asc` and `status_desc`. The default value is `created_at_asc`. + */ orderBy?: ListImagesRequestOrderBy - /** Filter by the Namespace ID. */ + /** Filter by the namespace ID. */ namespaceId?: string - /** Filter by the Image name (exact match). */ + /** Filter by the image name (exact match). */ name?: string /** Filter by Organization ID. */ organizationId?: string @@ -268,7 +276,7 @@ export type GetImageRequest = { * config. */ region?: Region - /** The unique ID of the Image. */ + /** The UUID of the image. */ imageId: string } @@ -278,12 +286,12 @@ export type UpdateImageRequest = { * config. */ region?: Region - /** Image ID to update. */ + /** ID of the image to update. */ imageId: string /** - * A `public` image is pullable from internet without authentication, opposed - * to a `private` image. `inherit` will use the namespace `is_public` - * parameter. + * Set to `public` to allow the image to be pulled without authentication. + * Else, set to `private`. Set to `inherit` to keep the same visibility + * configuration as the namespace. */ visibility?: ImageVisibility } @@ -294,7 +302,7 @@ export type DeleteImageRequest = { * config. */ region?: Region - /** The unique ID of the Image. */ + /** The UUID of the image. */ imageId: string } @@ -304,7 +312,7 @@ export type ListTagsRequest = { * config. */ region?: Region - /** The unique ID of the image. */ + /** The UUID of the image. */ imageId: string /** A positive integer to choose the page to display. */ page?: number @@ -313,7 +321,11 @@ export type ListTagsRequest = { * display. */ pageSize?: number - /** Field by which to order the display of Images. */ + /** + * Criteria to use when ordering tag listings. Possible values are + * `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`, `region`, + * `status_asc` and `status_desc`. The default value is `created_at_asc`. + */ orderBy?: ListTagsRequestOrderBy /** Filter by the tag name (exact match). */ name?: string @@ -325,7 +337,7 @@ export type GetTagRequest = { * config. */ region?: Region - /** The unique ID of the Tag. */ + /** The UUID of the tag. */ tagId: string } @@ -335,7 +347,7 @@ export type DeleteTagRequest = { * config. */ region?: Region - /** The unique ID of the tag. */ + /** The UUID of the tag. */ tagId: string /** * If two tags share the same digest the deletion will fail unless this