Skip to content

docs(registry): revamp #623

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2023
Merged

docs(registry): revamp #623

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions packages/clients/src/api/registry/v1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ export type TagStatus = 'unknown' | 'ready' | 'deleting' | 'error' | 'locked'

/** Image. */
export interface Image {
/** The UUID of the image. */
/** UUID of the image. */
id: string
/** The name of the image, it must be unique within the namespace. */
/** Name of the image, it must be unique within the namespace. */
name: string
/** The UUID of the namespace the image belongs to. */
/** UUID of the namespace the image belongs to. */
namespaceId: string
/** The status of the image. */
/** Status of the image. */
status: ImageStatus
/** Details of the image status. */
statusMessage?: string
Expand Down Expand Up @@ -98,9 +98,9 @@ export interface ListTagsResponse {

/** Namespace. */
export interface Namespace {
/** The UUID of the namespace. */
/** UUID of the namespace. */
id: string
/** The name of the namespace, unique in a region accross all organizations. */
/** Name of the namespace, unique in a region accross all organizations. */
name: string
/** Description of the namespace. */
description: string
Expand All @@ -114,7 +114,7 @@ export interface Namespace {
statusMessage: string
/** Endpoint reachable by docker. */
endpoint: string
/** Whether or not namespace is public. */
/** Defines whether or not namespace is public. */
isPublic: boolean
/**
* Total size of the namespace, calculated as the sum of the size of all
Expand All @@ -133,7 +133,7 @@ export interface Namespace {

/** Tag. */
export interface Tag {
/** The UUID of the tag. */
/** UUID of the tag. */
id: string
/** Tag name, unique to an image. */
name: string
Expand Down Expand Up @@ -185,7 +185,7 @@ export type GetNamespaceRequest = {
* config.
*/
region?: Region
/** The UUID of the namespace. */
/** UUID of the namespace. */
namespaceId: string
}

Expand Down Expand Up @@ -213,7 +213,7 @@ export type CreateNamespaceRequest = {
* could be set.
*/
projectId?: string
/** Whether or not namespace is public. */
/** Defines whether or not namespace is public. */
isPublic: boolean
}

Expand All @@ -227,7 +227,7 @@ export type UpdateNamespaceRequest = {
namespaceId: string
/** Namespace description. */
description?: string
/** Whether or not the namespace is public. */
/** Defines whether or not the namespace is public. */
isPublic?: boolean
}

Expand All @@ -237,7 +237,7 @@ export type DeleteNamespaceRequest = {
* config.
*/
region?: Region
/** The UUID of the namespace. */
/** UUID of the namespace. */
namespaceId: string
}

Expand Down Expand Up @@ -276,7 +276,7 @@ export type GetImageRequest = {
* config.
*/
region?: Region
/** The UUID of the image. */
/** UUID of the image. */
imageId: string
}

Expand All @@ -302,7 +302,7 @@ export type DeleteImageRequest = {
* config.
*/
region?: Region
/** The UUID of the image. */
/** UUID of the image. */
imageId: string
}

Expand All @@ -312,7 +312,7 @@ export type ListTagsRequest = {
* config.
*/
region?: Region
/** The UUID of the image. */
/** UUID of the image. */
imageId: string
/** A positive integer to choose the page to display. */
page?: number
Expand All @@ -337,7 +337,7 @@ export type GetTagRequest = {
* config.
*/
region?: Region
/** The UUID of the tag. */
/** UUID of the tag. */
tagId: string
}

Expand All @@ -347,7 +347,7 @@ export type DeleteTagRequest = {
* config.
*/
region?: Region
/** The UUID of the tag. */
/** UUID of the tag. */
tagId: string
/**
* If two tags share the same digest the deletion will fail unless this
Expand Down