Changes to swr_umn from docs/doc-exports#702 (SWR UMN: Permission description is

Reviewed-by: Eotvos, Oliver <oliver.eotvos@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_organization.rst

@@ -15,51 +15,49 @@ URI
 
 POST /v2/manage/namespaces
 
-Request Parameters
+Request
-------------------
+-------
 
-.. table:: **Table 1** Request header parameters
+-  Request parameters
 
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+   .. table:: **Table 1** Request body parameter description
-   | Parameter       | Mandatory       | Type            | Description                                                                                                                                              |
-   +=================+=================+=================+==========================================================================================================================================================+
-   | Content-Type    | Yes             | String          | Message body type (format). The value can be **application/json;charset=utf-8 application/json**                                                         |
-   |                 |                 |                 |                                                                                                                                                          |
-   |                 |                 |                 | The default value is **application/json**.                                                                                                               |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
-   | X-Auth-Token    | Yes             | String          | User token.                                                                                                                                              |
-   |                 |                 |                 |                                                                                                                                                          |
-   |                 |                 |                 | The token can be obtained by calling the IAM API used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
 
-.. table:: **Table 2** Request body parameter
+      +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+      | 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
-   | 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. |
-   +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
-Response Parameters
+   Create an organization named **group**:
--------------------
 
-N/A
+   .. code-block:: text
 
-Example Request
+      POST https://{Endpoint}/v2/manage/namespaces
----------------
 
-.. code-block:: text
+   Body:
 
-   POST https://{endpoint}/v2/manage/namespaces
+   .. code-block::
 
-   {
+      {
-     "namespace" : "group"
+          "namespace": "group"
-   }
+      }
 
-Example Response
+Response
-----------------
+--------
 
-N/A
+-  Response parameters
+
+   N/A
+
+-  Example response
+
+   .. code-block::
+
+      {}
 
 Status Code
 -----------

api-ref/source/api/deleting_an_organization.rst

@@ -21,28 +21,24 @@ For details about parameters, see :ref:`Table 1 <swr_02_0027__tae82a09e27434bef9
 
 .. table:: **Table 1** Parameter description
 
-   +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   ========= ========= ====== =================
-   | Parameter | Mandatory | Type   | 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. |
+   namespace Yes       String Organization name
-   +-----------+-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   ========= ========= ====== =================
 
-Request Parameters
+Request
-------------------
+-------
 
-.. table:: **Table 2** Request header parameters
+-  Request parameters
 
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+   N/A
-   | Parameter       | Mandatory       | Type            | Description                                                                                                                                              |
+
-   +=================+=================+=================+==========================================================================================================================================================+
+-  Example request
-   | Content-Type    | Yes             | String          | Message body type (format). The value can be **application/json;charset=utf-8 application/json**                                                         |
+
-   |                 |                 |                 |                                                                                                                                                          |
+   .. code-block:: text
-   |                 |                 |                 | The default value is **application/json**.                                                                                                               |
+
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
+      DELETE https://{Endpoint}/v2/manage/namespaces/group
-   | X-Auth-Token    | Yes             | String          | User token.                                                                                                                                              |
-   |                 |                 |                 |                                                                                                                                                          |
-   |                 |                 |                 | The token can be obtained by calling the IAM API used to obtain a user token. The value of **X-Subject-Token** in the response header is the user token. |
-   +-----------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Response
 --------

api-ref/source/api/deleting_image_permissions.rst

@@ -64,7 +64,7 @@ Status Code
 =========== =========================
 Status Code Description
 =========== =========================
-204         Deletion succeeded.
+204         Deleted successfully.
 400         Request error.
 401         Authentication failed.
 404         The image does not exist.

api-ref/source/api/obtaining_the_list_of_accounts_used_for_image_sharing.rst

@@ -48,16 +48,6 @@ Response
 
    .. table:: **Table 2** Response body parameter description
 
-      +-------------------+------------------------------------------------------------+------------------+
-      | Parameter         | Type                                                       | Description      |
-      +===================+============================================================+==================+
-      | *[Array element]* | Array of :ref:`objects <swr_02_0074__table45446245174724>` | Shared accounts. |
-      +-------------------+------------------------------------------------------------+------------------+
-
-   .. _swr_02_0074__table45446245174724:
-
-   .. table:: **Table 3** *[Array element]* parameter description
-
       +-----------------------+-----------------------+-------------------------------------------------------------+
       | Parameter             | Type                  | Description                                                 |
       +=======================+=======================+=============================================================+

api-ref/source/api/querying_the_list_of_organizations.rst

@@ -13,17 +13,19 @@ Query the list of organizations.
 URI
 ---
 
-GET /v2/manage/namespaces
+GET /v2/manage/namespaces?filter=namespace::{*namespace*}
 
-.. table:: **Table 1** Query parameters
+For details about parameters, see :ref:`Table 1 <swr_02_0028__tae82a09e27434bef9a38b734d798ae6c>`.
 
-   +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+.. _swr_02_0028__tae82a09e27434bef9a38b734d798ae6c:
-   | Parameter | Mandatory | Type   | Description                                                                                                                                                                                                                                                                                                                                             |
+
-   +===========+===========+========+=========================================================================================================================================================================================================================================================================================================================================================+
+.. table:: **Table 1** Parameter description
-   | namespace | No        | 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.      |
+
-   +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   ========= ========= ====== =================
-   | filter    | No        | String | Enter **namespace::{namespace}|mode::{mode}**. **{namespace}** indicates the organization name. If **{mode}** is not set, the list of authorized organizations is displayed. If **{mode}** is set to **visible**, the list of visible organizations is displayed. (Some organizations can be viewed by the repository, but cannot by the organization.) |
+   Parameter Mandatory Type   Description
-   +-----------+-----------+--------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+   ========= ========= ====== =================
+   namespace No        String Organization name
+   ========= ========= ====== =================
 
 Request
 -------

api-ref/source/api/updating_image_permissions.rst

@@ -35,16 +35,6 @@ Request
 
    .. table:: **Table 2** Request body parameter description
 
-      +-------------------+-----------+--------------------------------------------------------+-------------------------------------------------------+
-      | Parameter         | Mandatory | Type                                                   | Description                                           |
-      +===================+===========+========================================================+=======================================================+
-      | *[Array element]* | Yes       | Array of :ref:`objects <swr_02_0048__table6912142367>` | Information about the image permission to be updated. |
-      +-------------------+-----------+--------------------------------------------------------+-------------------------------------------------------+
-
-   .. _swr_02_0048__table6912142367:
-
-   .. table:: **Table 3** *[Array element]* parameter description
-
       +-----------------+-----------------+-----------------+-------------------------------------+
       | Parameter       | Mandatory       | Type            | Description                         |
       +=================+=================+=================+=====================================+

api-ref/source/api/updating_the_brief_information_on_an_image_repository.rst

@@ -21,31 +21,28 @@ For details about parameters, see :ref:`Table 1 <swr_02_0032__table16521054337>`
 
 .. table:: **Table 1** Parameter description
 
-   ========== ========= ====== ======================
+   +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+
-   Parameter  Mandatory Type   Description
+   | Parameter       | Mandatory       | Type            | Description                                                                                                               |
-   ========== ========= ====== ======================
+   +=================+=================+=================+===========================================================================================================================+
-   namespace  Yes       String Organization name.
+   | namespace       | Yes             | String          | Organization name.                                                                                                        |
-   repository Yes       String Image repository 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
 
-   .. table:: **Table 2** Request body parameter description
+   N/A
-
-      +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+
-      | Parameter       | Mandatory       | Type            | Description                                                                                                               |
-      +=================+=================+=================+===========================================================================================================================+
-      | 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       | Yes             | Boolean         | Whether the repository is a public repository. The value can be either **true** or **false**.                             |
-      +-----------------+-----------------+-----------------+---------------------------------------------------------------------------------------------------------------------------+
 
 -  Example request
 

api-ref/source/appendixes/error_code.rst

@@ -30,7 +30,7 @@ Error Code Description
 +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | Status Code | Error Code         | Description                                                                                                                                                          |
 +=============+====================+======================================================================================================================================================================+
-| 401         | SVCSTG.SWR.4010000 | Authentication failed. Obtain a new token and try again.                                                                                                             |
+| 401         | SVCSTG.SWR.4010000 | Authentication failed.                                                                                                                                               |
 +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 500         | SVCSTG.SWR.5000001 | Internal server error: Failed to obtain the application description.                                                                                                 |
 +-------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------+

api-ref/source/conf.py

@@ -18,7 +18,7 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme'
+    'otcdocstheme',
 ]
 
 otcdocs_auto_name = False
@@ -26,6 +26,20 @@ 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'
+
+# Those variables are needed for indexing into OpenSearch
+otcdocs_doc_environment = 'internal'
+otcdocs_doc_link = '/software-repository-container/api-ref/'
+otcdocs_doc_title = 'API Reference'
+otcdocs_doc_type = 'api-ref'
+otcdocs_service_category = 'container'
+otcdocs_service_title = 'Software Repository for Containers'
+otcdocs_service_type = 'swr'
+otcdocs_search_environment = 'hc_de'
+otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
 
 # 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
@@ -72,11 +86,12 @@ 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,
+    "disable_search": True,
-    'site_name': 'Internal Documentation Portal'
+    "site_name": "Internal Documentation Portal",
+    "logo_url": "https://docs-int.otc-service.com",
 }
 
 # The name for this set of Sphinx documents.  If None, it defaults to
@@ -90,10 +105,13 @@ html_title = "Software Repository for Containers - API Reference"
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+# Do not include sources into the rendered results
+html_copy_source = False
+
 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
-('index',
+    ('index',
      'swr-api-ref.tex',
      u'Software Repository for Containers - API Reference',
      u'OpenTelekomCloud', 'manual'),
-]
+]

doc/best-practice/source/best_practices/index.rst

@@ -0,0 +1,14 @@
+:original_name: swr_bp_index.html
+
+.. _swr_bp_index:
+
+Best Practices
+==============
+
+-  :ref:`Migrating Container Images <swr_bestpractice_0016>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   migrating_container_images/index

doc/best-practice/source/best_practices/migrating_container_images/index.rst

@@ -0,0 +1,18 @@
+:original_name: swr_bestpractice_0016.html
+
+.. _swr_bestpractice_0016:
+
+Migrating Container Images
+==========================
+
+-  :ref:`Migrating Images to SWR Using Docker Commands <swr_bestpractice_0012>`
+-  :ref:`Migrating Images to SWR Using image-syncer <swr_bestpractice_0015>`
+-  :ref:`Synchronizing Images Across Clouds from Harbor to SWR <swr_bestpractice_0004>`
+
+.. toctree::
+   :maxdepth: 1
+   :hidden: 
+
+   migrating_images_to_swr_using_docker_commands
+   migrating_images_to_swr_using_image-syncer
+   synchronizing_images_across_clouds_from_harbor_to_swr