Updating the Brief Information on an Image Repository

Function

Update the brief information on an image repository in an organization, including the category, is_public, and description.

URI

PATCH /v2/manage/namespaces/{namespace}/repos/{repository}

For details about parameters, see Table 1.

Table 1 Parameter description

Parameter

Mandatory

Type

Description

namespace

Yes

String

Organization name.

repository

Yes

String

Image repository name.

category

No

String

Repository type.

The value can be app_server, linux, framework_app, database, lang, other, windows or arm.

description

No

String

Repository description.

is_public

No

Boolean

Whether the repository is a public repository. The value can be either true or false.

Request

  • Request parameters

    N/A

  • Example request

    PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox
    

    Body:

    -F "category=linux" \
    -F "description=this is a busybox repository" \
    -F "is_public=false"
    

    Or

    {
        "category": "linux",
        "description": "this is a busybox repository",
        "is_public": false
    }
    

    Note

    The form format will no longer be supported soon. You are advised to use the body in the JSON format to call the API.

Response

  • Response parameters

    N/A

  • Example response

    {}
    

Status Code

Status Code

Description

201

The brief information about the image repository is successfully updated.

400

Request error. Error information is returned.

401

Authentication failed.

404

The repository does not exist.

500

Internal error. Error information is returned.