Edit image information

Available in Classic and VPC

Edit short description (description) and detailed description (full_description) information registered for an image registered in the registry of Container Registry.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
PATCH	/ncr/api/v2/repositories/{registry}/{imageName} (Korea Region)
PATCH	/ncr/sgn-api/v2/repositories/{registry}/{imageName} (Singapore Region)
PATCH	/ncr/jpn-api/v2/repositories/{registry}/{imageName} (Japan Region)

Request headers

For information about the headers common to all Container Registry APIs, see Container Registry request headers.

Request path parameters

You can use the following path parameters with your request:

Field	Type	Required	Description
`registry`	String	Required	Name of the registry where the image for which you want to edit information is registered
`imageName`	String	Required	Name of the image to edit the information Need to use URI encoded values. Example: For `hello/world`, convert to `hello%2Fworld` and use it.

Request syntax

The request syntax is as follows:

{
  "description": "string",
  "full_description": "string"
}

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`description`	String	Optional	Create short description for the image. Under 100 characters
`full_description`	String	Optional	Create detailed description for the image. Markdown supported

Request example

The request example is as follows:

curl -X PATCH 'https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
  "description": "string",
  "full_description": "string"
}'

Response

This section describes the response format.

Response syntax

The response syntax is as follows:

None

Response status codes

For information about the HTTP status codes common to all Container Registry APIs, see Container Registry response status codes.