- Print
- PDF
Edit image information
- Print
- PDF
Available in Classic and VPC
Edit short description (description
) and detailed description (full_description
) information registered for a specific image registered in the registry of Container Registry.
Requests
The following describes the request format for the endpoint. The request format is as follows.
Method | URI |
---|---|
PATCH | /repositories/{registry}/{imageName} |
Request headers
For headers common to all Container Registry APIs, see Container Registry common headers.
Request path parameters
The following describes the parameters.
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
|
Request syntax
The request syntax is as follows.
{
"description": "string",
"full_description": "string"
}
Request body
The following describes the request body.
Field | Type | Required | Description |
---|---|---|---|
description | String | Optional | Create short description for the image
|
full_description | String | Optional | Create detailed description for the image
|
Request example
The following is a sample request.
curl -X PATCH "https://ncr.apigw.ntruss.com/ncr/api/v2/repositories/{registry}/{imageName}"
-H "x-ncp-apigw-timestamp: {Timestamp}"
-H "x-ncp-iam-access-key: {Sub Account Access Key}"
-H "x-ncp-apigw-signature-v2: {API Gateway Signature}"
-d "
{
"description": "string",
"full_description": "string"
}
"
Responses
The following describes the response format.
Response syntax
The response syntax is as follows.
None
Response status codes
The following describes response status codes. For response status codes common to all Container Registry APIs, see Container Registry response status codes.
HTTP status code | Code | Message | Description |
---|---|---|---|
204 | - | OK | Request succeeded |
404 | - | Not Found | Requested resource not found |