Changes to swr_api-ref from docs/doc-exports#415 (SWR API initial version reuplo

Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: proposalbot <proposalbot@otc-service.com>
Co-committed-by: proposalbot <proposalbot@otc-service.com>

api-ref/source/api/creating_an_account_used_for_image_sharing.rst

@@ -0,0 +1,91 @@
+:original_name: swr_02_0070.html
+
+.. _swr_02_0070:
+
+Creating an Account Used for Image Sharing
+==========================================
+
+Function
+--------
+
+Create an account used for image sharing. You can share your private images with other users, granting them permissions to pull the images.
+
+URI
+---
+
+POST /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains
+
+For details about parameters, see :ref:`Table 1 <swr_02_0070__table11843162810214>`.
+
+.. _swr_02_0070__table11843162810214:
+
+.. table:: **Table 1** Parameter description
+
+   ========== ========= ====== =====================
+   Parameter  Mandatory Type   Description
+   ========== ========= ====== =====================
+   namespace  Yes       String Organization name
+   repository Yes       String Image repository name
+   ========== ========= ====== =====================
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 2** Request body parameter description
+
+      +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | Parameter     | Mandatory | Type   | Description                                                                                                                               |
+      +===============+===========+========+===========================================================================================================================================+
+      | access_domain | Yes       | String | Name of the account used for image sharing.                                                                                               |
+      +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | permit        | Yes       | String | Currently, only the read permission is supported.                                                                                         |
+      +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | deadline      | Yes       | String | Valid until (UTC). If the sharing is permanent, the value is **forever**. Otherwise, the sharing is valid until 00:00:00 of the next day. |
+      +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | description   | No        | String | Description.                                                                                                                              |
+      +---------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+
+-  Example request
+
+   .. code-block:: text
+
+      POST https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains
+
+   Body:
+
+   .. code-block::
+
+      {
+          "access_domain": "domain_name",
+          "permit": "read",
+          "deadline": "2021-10-01T16:00:00.000Z",
+          "description": "description"
+      }
+
+Response
+--------
+
+-  Response parameters
+
+   N/A
+
+-  Example response
+
+   .. code-block::
+
+      {}
+
+Status Code
+-----------
+
+=========== ===============================
+Status Code Description
+=========== ===============================
+201         Creation successful.
+400         Request error.
+401         Authentication failed.
+409         The repository has been shared.
+500         Internal error.
+=========== ===============================

api-ref/source/api/creating_an_organization.rst

@@ -0,0 +1,77 @@
+:original_name: swr_02_0026.html
+
+.. _swr_02_0026:
+
+Creating an Organization
+========================
+
+Function
+--------
+
+Create an organization.
+
+URI
+---
+
+POST /v2/manage/namespaces
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 1** Request body parameter description
+
+      +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | Parameter       | Mandatory       | Type            | Description                                                                                                                                                                                                                                                                                                                     |
+      +=================+=================+=================+=================================================================================================================================================================================================================================================================================================================================+
+      | namespace       | Yes             | String          | Organization name.                                                                                                                                                                                                                                                                                                              |
+      |                 |                 |                 |                                                                                                                                                                                                                                                                                                                                 |
+      |                 |                 |                 | Enter 1 to 64 characters, starting with a lowercase letter and ending with a lowercase letter or digit. Only lowercase letters, digits, periods (.), underscores (_), and hyphens (-) are allowed. Periods, underscores, and hyphens cannot be placed next to each other. A maximum of two consecutive underscores are allowed. |
+      +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+-  Example request
+
+   Create an organization named **group**:
+
+   .. code-block:: text
+
+      POST https://{Endpoint}/v2/manage/namespaces
+
+   Body:
+
+   .. code-block::
+
+      {
+          "namespace": "group"
+      }
+
+Response
+--------
+
+-  Response parameters
+
+   N/A
+
+-  Example response
+
+   .. code-block::
+
+      {}
+
+Status Code
+-----------
+
++-------------+----------------------------------------------------------------------------------+
+| Status Code | Description                                                                      |
++=============+==================================================================================+
+| 201         | Creation successful.                                                             |
++-------------+----------------------------------------------------------------------------------+
+| 400         | The request is incorrect or the number of organizations exceeds the upper limit. |
++-------------+----------------------------------------------------------------------------------+
+| 401         | Authentication failed.                                                           |
++-------------+----------------------------------------------------------------------------------+
+| 409         | The resource already exists.                                                     |
++-------------+----------------------------------------------------------------------------------+
+| 500         | Internal error.                                                                  |
++-------------+----------------------------------------------------------------------------------+

api-ref/source/api/deleting_an_account_used_for_image_sharing.rst

@@ -0,0 +1,65 @@
+:original_name: swr_02_0071.html
+
+.. _swr_02_0071:
+
+Deleting an Account Used for Image Sharing
+==========================================
+
+Function
+--------
+
+Delete an account used for image sharing.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains/{*access_domain*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0071__table11843162810214>`.
+
+.. _swr_02_0071__table11843162810214:
+
+.. table:: **Table 1** Parameter description
+
+   +---------------+-----------+--------+---------------------------------------------+
+   | Parameter     | Mandatory | Type   | Description                                 |
+   +===============+===========+========+=============================================+
+   | namespace     | Yes       | String | Organization name.                          |
+   +---------------+-----------+--------+---------------------------------------------+
+   | repository    | Yes       | String | Image repository name.                      |
+   +---------------+-----------+--------+---------------------------------------------+
+   | access_domain | Yes       | String | Name of the account used for image sharing. |
+   +---------------+-----------+--------+---------------------------------------------+
+
+Request
+-------
+
+-  Request parameters
+
+   N/A
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
++-------------+----------------------------------------------------------------------+
+| Status Code | Description                                                          |
++=============+======================================================================+
+| 204         | Deleted successfully.                                                |
++-------------+----------------------------------------------------------------------+
+| 400         | Request error.                                                       |
++-------------+----------------------------------------------------------------------+
+| 401         | Authentication failed.                                               |
++-------------+----------------------------------------------------------------------+
+| 500         | Failed to complete the request because of an internal service error. |
++-------------+----------------------------------------------------------------------+

api-ref/source/api/deleting_an_image_repository.rst

@@ -0,0 +1,66 @@
+:original_name: swr_02_0031.html
+
+.. _swr_02_0031:
+
+Deleting an Image Repository
+============================
+
+Function
+--------
+
+Delete an image repository in an organization.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0031__table184146147323>`.
+
+.. _swr_02_0031__table184146147323:
+
+.. table:: **Table 1** Parameter description
+
+   ========== ========= ====== ======================
+   Parameter  Mandatory Type   Description
+   ========== ========= ====== ======================
+   namespace  Yes       String Organization name.
+   repository Yes       String Image repository name.
+   ========== ========= ====== ======================
+
+Request
+-------
+
+-  Request parameters
+
+   N/A
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
++-------------+---------------------------------------------------------------------------+
+| Status Code | Description                                                               |
++=============+===========================================================================+
+| 204         | The brief information about the image repository is successfully deleted. |
++-------------+---------------------------------------------------------------------------+
+| 400         | Request error. Error information is returned.                             |
++-------------+---------------------------------------------------------------------------+
+| 401         | Authentication failed.                                                    |
++-------------+---------------------------------------------------------------------------+
+| 404         | The repository does not exist.                                            |
++-------------+---------------------------------------------------------------------------+
+| 406         | The repository cannot be deleted because it contains images.              |
++-------------+---------------------------------------------------------------------------+
+| 500         | Internal error. Error information is returned.                            |
++-------------+---------------------------------------------------------------------------+

api-ref/source/api/deleting_an_organization.rst

@@ -0,0 +1,59 @@
+:original_name: swr_02_0027.html
+
+.. _swr_02_0027:
+
+Deleting an Organization
+========================
+
+Function
+--------
+
+Delete an organization.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0027__tae82a09e27434bef9a38b734d798ae6c>`.
+
+.. _swr_02_0027__tae82a09e27434bef9a38b734d798ae6c:
+
+.. table:: **Table 1** Parameter description
+
+   ========= ========= ====== =================
+   Parameter Mandatory Type   Description
+   ========= ========= ====== =================
+   namespace Yes       String Organization name
+   ========= ========= ====== =================
+
+Request
+-------
+
+-  Request parameters
+
+   N/A
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
+=========== ================================
+Status Code Description
+=========== ================================
+204         Deleted successfully.
+400         Request error.
+401         Authentication failed.
+404         The organization does not exist.
+500         Internal error.
+=========== ================================

api-ref/source/api/deleting_image_permissions.rst

@@ -0,0 +1,72 @@
+:original_name: swr_02_0047.html
+
+.. _swr_02_0047:
+
+Deleting Image Permissions
+==========================
+
+Function
+--------
+
+Delete the image operation permissions of certain users.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access
+
+For details about parameters, see :ref:`Table 1 <swr_02_0047__table73271639103420>`.
+
+.. _swr_02_0047__table73271639103420:
+
+.. table:: **Table 1** Parameter description
+
+   ========== ========= ====== ==================
+   Parameter  Mandatory Type   Description
+   ========== ========= ====== ==================
+   namespace  Yes       String Organization name.
+   repository Yes       String Image name.
+   ========== ========= ====== ==================
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 2** Request body parameter description
+
+      +-------------------+-----------+------------------+---------------------------------------------------------+
+      | Parameter         | Mandatory | Type             | Description                                             |
+      +===================+===========+==================+=========================================================+
+      | *[Array element]* | Yes       | Array of strings | ID array of users whose permissions need to be deleted. |
+      +-------------------+-----------+------------------+---------------------------------------------------------+
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
+
+   Body:
+
+   .. code-block::
+
+      ["fb3f175c1fd146ab8cdae3272be6107b"]
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
+=========== =========================
+Status Code Description
+=========== =========================
+204         Deleted successfully.
+400         Request error.
+401         Authentication failed.
+404         The image does not exist.
+500         Internal error.
+=========== =========================

api-ref/source/api/deleting_organization_permissions.rst

@@ -0,0 +1,71 @@
+:original_name: swr_02_0043.html
+
+.. _swr_02_0043:
+
+Deleting Organization Permissions
+=================================
+
+Function
+--------
+
+Delete the organization operation permissions of certain users.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}/access
+
+:ref:`Table 1 <swr_02_0043__table15218458175016>` describes the parameters.
+
+.. _swr_02_0043__table15218458175016:
+
+.. table:: **Table 1** Parameter description
+
+   ========= ========= ====== ==================
+   Parameter Mandatory Type   Description
+   ========= ========= ====== ==================
+   namespace Yes       String Organization name.
+   ========= ========= ====== ==================
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 2** Request body parameter description
+
+      +-------------------+-----------+------------------+---------------------------------------------------------+
+      | Parameter         | Mandatory | Type             | Description                                             |
+      +===================+===========+==================+=========================================================+
+      | *[Array element]* | Yes       | Array of strings | ID array of users whose permissions need to be deleted. |
+      +-------------------+-----------+------------------+---------------------------------------------------------+
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group/access
+
+   Body:
+
+   .. code-block::
+
+      ["fb3f175c1fd146ab8cdae3272be6107b"]
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
+=========== ================================
+Status Code Description
+=========== ================================
+204         Deleted successfully.
+400         Request error.
+401         Authentication failed.
+404         The organization does not exist.
+500         Internal error.
+=========== ================================

api-ref/source/api/deleting_the_image_with_a_specified_tag.rst

@@ -0,0 +1,65 @@
+:original_name: swr_02_0036.html
+
+.. _swr_02_0036:
+
+Deleting the Image with a Specified Tag
+=======================================
+
+Function
+--------
+
+Delete the image with a specified tag in an image repository.
+
+URI
+---
+
+DELETE /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/tags/{*tag*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0036__table05962819187>`.
+
+.. _swr_02_0036__table05962819187:
+
+.. table:: **Table 1** Parameter description
+
+   ========== ========= ====== =====================
+   Parameter  Mandatory Type   Description
+   ========== ========= ====== =====================
+   namespace  Yes       String Organization name
+   repository Yes       String Image repository name
+   tag        Yes       String Image tag name
+   ========== ========= ====== =====================
+
+Request
+-------
+
+-  Request parameters
+
+   N/A
+
+-  Example request
+
+   .. code-block:: text
+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/tags/v1
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
++-------------+------------------------------------------------------------------+
+| Status Code | Description                                                      |
++=============+==================================================================+
+| 204         | The image with a specified tag is deleted successfully.          |
++-------------+------------------------------------------------------------------+
+| 400         | Request error. Error information is returned.                    |
++-------------+------------------------------------------------------------------+
+| 401         | Authentication failed.                                           |
++-------------+------------------------------------------------------------------+
+| 404         | The repository or the image with a specified tag does not exist. |
++-------------+------------------------------------------------------------------+
+| 500         | Internal error. Error information is returned.                   |
++-------------+------------------------------------------------------------------+

api-ref/source/api/index.rst

@@ -0,0 +1,66 @@
+:original_name: swr_02_0011.html
+
+.. _swr_02_0011:
+
+API
+===
+
+-  :ref:`Creating an Organization <swr_02_0026>`
+-  :ref:`Deleting an Organization <swr_02_0027>`
+-  :ref:`Querying the List of Organizations <swr_02_0028>`
+-  :ref:`Querying the Details of an Organization <swr_02_0029>`
+-  :ref:`Creating an Image Repository <swr_02_0030>`
+-  :ref:`Deleting an Image Repository <swr_02_0031>`
+-  :ref:`Updating the Brief Information on an Image Repository <swr_02_0032>`
+-  :ref:`Querying the Brief Information on an Image Repository <swr_02_0033>`
+-  :ref:`Querying the Image Repository List <swr_02_0034>`
+-  :ref:`Querying the List of Image Repository Tags <swr_02_0035>`
+-  :ref:`Deleting the Image with a Specified Tag <swr_02_0036>`
+-  :ref:`Creating an Account Used for Image Sharing <swr_02_0070>`
+-  :ref:`Deleting an Account Used for Image Sharing <swr_02_0071>`
+-  :ref:`Updating an Account Used for Image Sharing <swr_02_0072>`
+-  :ref:`Checking the Existence of an Account Used for Image Sharing <swr_02_0073>`
+-  :ref:`Obtaining the List of Accounts Used for Image Sharing <swr_02_0074>`
+-  :ref:`Viewing the List of Shared Images <swr_02_0075>`
+-  :ref:`Querying All API Versions <swr_02_0080>`
+-  :ref:`Querying a Specific API Version <swr_02_0081>`
+-  :ref:`Creating Organization Permissions <swr_02_0042>`
+-  :ref:`Deleting Organization Permissions <swr_02_0043>`
+-  :ref:`Updating Organization Permissions <swr_02_0044>`
+-  :ref:`Querying Organization Permissions <swr_02_0045>`
+-  :ref:`Creating Image Permissions <swr_02_0046>`
+-  :ref:`Deleting Image Permissions <swr_02_0047>`
+-  :ref:`Updating Image Permissions <swr_02_0048>`
+-  :ref:`Querying Image Permissions <swr_02_0049>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   creating_an_organization
+   deleting_an_organization
+   querying_the_list_of_organizations
+   querying_the_details_of_an_organization
+   creating_an_image_repository
+   deleting_an_image_repository
+   updating_the_brief_information_on_an_image_repository
+   querying_the_brief_information_on_an_image_repository
+   querying_the_image_repository_list
+   querying_the_list_of_image_repository_tags
+   deleting_the_image_with_a_specified_tag
+   creating_an_account_used_for_image_sharing
+   deleting_an_account_used_for_image_sharing
+   updating_an_account_used_for_image_sharing
+   checking_the_existence_of_an_account_used_for_image_sharing
+   obtaining_the_list_of_accounts_used_for_image_sharing
+   viewing_the_list_of_shared_images
+   querying_all_api_versions
+   querying_a_specific_api_version
+   creating_organization_permissions
+   deleting_organization_permissions
+   updating_organization_permissions
+   querying_organization_permissions
+   creating_image_permissions
+   deleting_image_permissions
+   updating_image_permissions
+   querying_image_permissions

api-ref/source/api/querying_the_details_of_an_organization.rst

@@ -0,0 +1,88 @@
+:original_name: swr_02_0029.html
+
+.. _swr_02_0029:
+
+Querying the Details of an Organization
+=======================================
+
+Function
+--------
+
+Query the details of an organization by its name.
+
+URI
+---
+
+GET /v2/manage/namespaces/{*namespace*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0029__table05962819187>`.
+
+.. _swr_02_0029__table05962819187:
+
+.. table:: **Table 1** Parameter description
+
+   ========= ========= ====== =================
+   Parameter Mandatory Type   Description
+   ========= ========= ====== =================
+   namespace Yes       String Organization name
+   ========= ========= ====== =================
+
+Request
+-------
+
+-  Request parameters
+
+   N/A
+
+-  Example request
+
+   .. code-block:: text
+
+      GET https://{Endpoint}/v2/manage/namespaces/group
+
+Response
+--------
+
+-  Response parameters
+
+   .. table:: **Table 2** Response body parameter description
+
+      +-----------------------+-----------------------+-----------------------+
+      | Parameter             | Type                  | Description           |
+      +=======================+=======================+=======================+
+      | id                    | Integer               | Organization ID       |
+      +-----------------------+-----------------------+-----------------------+
+      | name                  | String                | Organization name     |
+      +-----------------------+-----------------------+-----------------------+
+      | creator_name          | String                | IAM username          |
+      +-----------------------+-----------------------+-----------------------+
+      | auth                  | Integer               | User permission       |
+      |                       |                       |                       |
+      |                       |                       | -  7: Manage          |
+      |                       |                       | -  3: Write           |
+      |                       |                       | -  1: Read            |
+      +-----------------------+-----------------------+-----------------------+
+
+-  Example response
+
+   .. code-block::
+
+      {
+          "id": 1422,
+          "name": "group",
+          "creator_name": "username",
+          "auth": 7
+      }
+
+Status Code
+-----------
+
+=========== ================================
+Status Code Description
+=========== ================================
+200         Query succeeded.
+400         Request error.
+401         Authentication failed.
+404         The organization does not exist.
+500         Internal error.
+=========== ================================

api-ref/source/api/updating_an_account_used_for_image_sharing.rst

@@ -0,0 +1,82 @@
+:original_name: swr_02_0072.html
+
+.. _swr_02_0072:
+
+Updating an Account Used for Image Sharing
+==========================================
+
+Function
+--------
+
+Update an account used for image sharing.
+
+URI
+---
+
+PATCH /v2/manage/namespaces/{*namespace*}/repositories/{*repository*}/access-domains/{*access_domain*}
+
+For details about parameters, see :ref:`Table 1 <swr_02_0072__table11843162810214>`.
+
+.. _swr_02_0072__table11843162810214:
+
+.. table:: **Table 1** Parameter description
+
+   +---------------+-----------+--------+--------------------------------------------+
+   | Parameter     | Mandatory | Type   | Description                                |
+   +===============+===========+========+============================================+
+   | namespace     | Yes       | String | Organization name                          |
+   +---------------+-----------+--------+--------------------------------------------+
+   | repository    | Yes       | String | Image repository name                      |
+   +---------------+-----------+--------+--------------------------------------------+
+   | access_domain | Yes       | String | Name of the account used for image sharing |
+   +---------------+-----------+--------+--------------------------------------------+
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 2** Request body parameter description
+
+      +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | Parameter   | Mandatory | Type   | Description                                                                                                                               |
+      +=============+===========+========+===========================================================================================================================================+
+      | permit      | Yes       | String | Currently, only the read permission is supported.                                                                                         |
+      +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | deadline    | Yes       | String | Valid until (UTC). If the sharing is permanent, the value is **forever**. Otherwise, the sharing is valid until 00:00:00 of the next day. |
+      +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+      | description | No        | String | Description. This parameter is left blank by default.                                                                                     |
+      +-------------+-----------+--------+-------------------------------------------------------------------------------------------------------------------------------------------+
+
+-  Example request
+
+   .. code-block::
+
+      PATCH https://{Endpoint}/v2/manage/namespaces/group/repositories/busybox/access-domains/domain_name
+
+   Body:
+
+   .. code-block::
+
+      {
+          "permit": "read",
+          "deadline": "forever",
+          "description": "description"
+      }
+
+Response
+--------
+
+N/A
+
+Status Code
+-----------
+
+=========== ======================
+Status Code Description
+=========== ======================
+201         Modified successfully.
+400         Request error.
+401         Authentication failed.
+500         Internal error.
+=========== ======================

api-ref/source/api/updating_image_permissions.rst

@@ -0,0 +1,94 @@
+:original_name: swr_02_0048.html
+
+.. _swr_02_0048:
+
+Updating Image Permissions
+==========================
+
+Function
+--------
+
+Update the image operation permissions for certain users.
+
+URI
+---
+
+PATCH /v2/manage/namespaces/{*namespace*}/repos/{*repository*}/access
+
+For details about parameters, see :ref:`Table 1 <swr_02_0048__table73271639103420>`.
+
+.. _swr_02_0048__table73271639103420:
+
+.. table:: **Table 1** Parameter description
+
+   ========== ========= ====== =================
+   Parameter  Mandatory Type   Description
+   ========== ========= ====== =================
+   namespace  Yes       String Organization name
+   repository Yes       String Image name
+   ========== ========= ====== =================
+
+Request
+-------
+
+-  Request parameters
+
+   .. table:: **Table 2** Request body parameter description
+
+      +-----------------+-----------------+-----------------+-------------------------------------+
+      | Parameter       | Mandatory       | Type            | Description                         |
+      +=================+=================+=================+=====================================+
+      | user_id         | Yes             | String          | User ID.                            |
+      +-----------------+-----------------+-----------------+-------------------------------------+
+      | user_name       | Yes             | String          | Username.                           |
+      +-----------------+-----------------+-----------------+-------------------------------------+
+      | auth            | Yes             | Integer         | User permission that is configured. |
+      |                 |                 |                 |                                     |
+      |                 |                 |                 | -  7: Manage                        |
+      |                 |                 |                 | -  3: Write                         |
+      |                 |                 |                 | -  1: Read                          |
+      +-----------------+-----------------+-----------------+-------------------------------------+
+
+-  Example request
+
+   .. code-block::
+
+      PATCH https://{Endpoint}/v2/manage/namespaces/group/repos/busybox/access
+
+   Body:
+
+   .. code-block::
+
+      [
+          {
+              "user_id": "fb3f175c1fd146ab8cdae3272be6107b",
+              "user_name": "user01",
+              "auth": 7
+          }
+      ]
+
+Response
+--------
+
+-  Response parameters
+
+   N/A
+
+-  Example response
+
+   .. code-block::
+
+      {}
+
+Status Code
+-----------
+
+=========== =================================================
+Status Code Description
+=========== =================================================
+201         Updated successfully.
+400         Request error.
+401         Authentication failed.
+404         The image or the image permission does not exist.
+500         Internal error.
+=========== =================================================

api-ref/source/api_usage_guidelines.rst

@@ -0,0 +1,12 @@
+:original_name: swr_02_0078.html
+
+.. _swr_02_0078:
+
+API Usage Guidelines
+====================
+
+Public cloud APIs comply with the RESTful API design principles. REST-based Web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: *https://Endpoint/uri*. In the URL, **uri** indicates the resource path, that is, the API access path.
+
+Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with media type represented by **Application/json**.
+
+For details about how to use APIs, see `API Usage Guidelines <https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API%20Documents>`__.

api-ref/source/appendixes/index.rst

@@ -0,0 +1,16 @@
+:original_name: swr_02_0008.html
+
+.. _swr_02_0008:
+
+Appendixes
+==========
+
+-  :ref:`Status Codes <swr_02_0023>`
+-  :ref:`Error Code <swr_02_0024>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   status_codes
+   error_code

api-ref/source/appendixes/status_codes.rst

@@ -0,0 +1,54 @@
+:original_name: swr_02_0023.html
+
+.. _swr_02_0023:
+
+Status Codes
+============
+
+-  Normal
+
+   +----------------+-----------------------------------------------------------------+
+   | Returned Value | Description                                                     |
+   +================+=================================================================+
+   | 200 OK         | The results of GET and PUT operations are returned as expected. |
+   +----------------+-----------------------------------------------------------------+
+   | 201 Created    | The results of the POST operation are returned as expected.     |
+   +----------------+-----------------------------------------------------------------+
+   | 202 Accepted   | The request has been accepted for processing.                   |
+   +----------------+-----------------------------------------------------------------+
+   | 204 No Content | The results of the DELETE operation are returned as expected.   |
+   +----------------+-----------------------------------------------------------------+
+
+-  Abnormal
+
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | Returned Value                    | Description                                                                                |
+   +===================================+============================================================================================+
+   | 400 Bad Request                   | The server failed to process the request.                                                  |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 401 Unauthorized                  | You must enter a username and password to access the requested page.                       |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 403 Forbidden                     | You are forbidden to access the requested page.                                            |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 404 Not Found                     | The server cannot find the requested page.                                                 |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 405 Method Not Allowed            | You are not allowed to use the method specified in the request.                            |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 406 Not Acceptable                | The response generated by the server cannot be accepted by the client.                     |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 407 Proxy Authentication Required | You must use the proxy server for authentication so that the request can be processed.     |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 408 Request Timeout               | The request timed out.                                                                     |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 409 Conflict                      | The request could not be processed due to a conflict.                                      |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 500 Internal Server Error         | Failed to complete the request because of a service error.                                 |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 501 Not Implemented               | Failed to complete the request because the server does not support the requested function. |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 502 Bad Gateway                   | Failed to complete the request because the request is invalid.                             |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 503 Service Unavailable           | Failed to complete the request. The service is unavailable.                                |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+
+   | 504 Gateway Timeout               | A gateway timeout error occurred.                                                          |
+   +-----------------------------------+--------------------------------------------------------------------------------------------+

api-ref/source/change_history.rst

@@ -0,0 +1,14 @@
+:original_name: swr_02_0064.html
+
+.. _swr_02_0064:
+
+Change History
+==============
+
++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+
+| Release Date | Description                                                                                                                                  |
++==============+==============================================================================================================================================+
+| 2021-08-30   | Optimized the whole document, including optimizing the function introduction, adding request examples, and improving parameter descriptions. |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+
+| 2020-04-21   | This issue is the first official release.                                                                                                    |
++--------------+----------------------------------------------------------------------------------------------------------------------------------------------+

api-ref/source/conf.py

@@ -26,9 +26,6 @@ otcdocs_auto_version = False
 
 project = 'Software Repository for Containers'
 otcdocs_repo_name = 'docs/software-repository-container'
-# Those variables are required for edit/bug links
-otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
-otcdocs_git_type = 'gitea'
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -75,12 +72,11 @@ show_authors = False
 html_theme = 'otcdocs'
 
 # Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
+# further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "disable_search": True,
-    "site_name": "Internal Documentation Portal",
-    "logo_url": "https://docs-int.otc-service.com",
+    'disable_search': True,
+    'site_name': 'Internal Documentation Portal'
 }
 
 # The name for this set of Sphinx documents.  If None, it defaults to
@@ -96,8 +92,8 @@ html_static_path = ['_static']
 
 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
-    ('index',
+('index',
      'swr-api-ref.tex',
      u'Software Repository for Containers - API Reference',
      u'OpenTelekomCloud', 'manual'),
-]
+]

api-ref/source/index.rst

@@ -2,3 +2,10 @@
 Software Repository for Containers - API Reference
 ==================================================
 
+.. toctree::
+   :maxdepth: 1
+
+   api_usage_guidelines
+   api/index
+   appendixes/index
+   change_history