Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propagate changes to gaussdb-opengauss-api-ref from PreProd environment #47

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Propagate changes to gaussdb-opengauss-api-ref from PreProd environment #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions api-ref/source/apis_recommended/api_version_query/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:original_name: opengauss_query_api_version.html

.. _opengauss_query_api_version:

API Version Query
=================

- :ref:`Querying API Versions <opengauss_query_version_list>`
- :ref:`Querying Version Information of an API <opengauss_query_version_info>`

.. toctree::
:maxdepth: 1
:hidden:

querying_api_versions
querying_version_information_of_an_api
140 changes: 140 additions & 0 deletions api-ref/source/apis_recommended/api_version_query/querying_api_versions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
:original_name: opengauss_query_version_list.html

.. _opengauss_query_version_list:

Querying API Versions
=====================

Function
--------

This API is used to query the supported API versions. Before calling this API:

- Learn how to :ref:`authenticate <opengauss_api_0010>` this API.
- Understand the API in :ref:`Using APIs <opengauss_api_0012>`.
- Obtain the required `region and endpoint <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.

URI
---

- URI format

GET https://{*Endpoint*}

- Example

https://gaussdb.eu-de.otc.t-systems.com

Request
-------

None

Response
--------

- Normal response

.. table:: **Table 1** Parameter description

+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================+
| versions | Array of objects | API version information. |
| | | |
| | | For details, see :ref:`Table 2 <en-us_topic_0000001917290504__en-us_topic_0128427215_table578797132615>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0000001917290504__en-us_topic_0128427215_table578797132615:

.. table:: **Table 2** versions field data structure description

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=============================================================================================================+
| id | String | Backup time window. The creation of an automated backup will be triggered during the backup time window. |
| | | |
| | | The time is in the UTC format. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| links | Array of objects | API link information. |
| | | |
| | | For details, see :ref:`Table 3 <en-us_topic_0000001917290504__en-us_topic_0128427215_table14771167122611>`. |
| | | |
| | | .. note:: |
| | | |
| | | If the version is v3 adn v 3.1, the value is **[]**. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| status | String | Version status. |
| | | |
| | | The value is **CURRENT**, indicating that the version has been released. |
| | | |
| | | **SUPPORTED**: The version is an earlier version, but it is still supported. |
| | | |
| | | **DEPRECATED**: The version is a deprecated version, which may be deleted later. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| version | String | Subversion information of the API version. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| min_version | String | Minimum API version number. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| updated | String | Version update time. |
| | | |
| | | The format is yyyy-mm-ddThh:mm:ssZ. |
| | | |
| | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the UTC. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0000001917290504__en-us_topic_0128427215_table14771167122611:

.. table:: **Table 3** links field data structure description

==== ====== ===========================================================
Name Type Description
==== ====== ===========================================================
href String API URL. The value is **""**.
rel String The value is **self**, indicating that URL is a local link.
==== ====== ===========================================================

- Example normal response

.. code-block:: text

{
"versions": [
{
"id": "v3",
"links": [],
"status": "CURRENT",
"version": "",
"min_version": "",
"updated": "2017-02-07T17:34:02Z"
},
{
"id": "v3.1",
"links": [],
"status": "CURRENT",
"version": "",
"min_version": "",
"updated": "2017-02-07T17:34:02Z"
}
]
}

- Abnormal response

For details, see :ref:`Abnormal Request Results <opengauss_api_0031>`.

Status Code
-----------

- Normal

200

- Abnormal

For details, see :ref:`Status Codes <opengauss_api_0032>`.

Error Code
----------

For details, see :ref:`Error Codes <opengauss_api_0033>`.
140 changes: 140 additions & 0 deletions ...e/apis_recommended/api_version_query/querying_version_information_of_an_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
:original_name: opengauss_query_version_info.html

.. _opengauss_query_version_info:

Querying Version Information of an API
======================================

Function
--------

This API is used to query version information of a specified API. Before calling this API:

- Learn how to :ref:`authenticate <opengauss_api_0010>` this API.
- Understand the API in :ref:`Using APIs <opengauss_api_0012>`.
- Obtain the required `region and endpoint <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__.

URI
---

- URI format

GET https://{*Endpoint*}/{version}

- Example

https://gaussdb.eu-de.otc.t-systems.com/v3

- Parameter description

.. table:: **Table 1** Parameter description

======= ========= ==================================
Name Mandatory Description
======= ========= ==================================
version Yes API version. It is case-sensitive.
======= ========= ==================================

Request
-------

None

Response
--------

- Normal response

.. table:: **Table 2** Parameter description

+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+===========================================================================================================+
| version | Object | API version information. |
| | | |
| | | For details, see :ref:`Table 3 <en-us_topic_0000001917130784__en-us_topic_0128427215_table578797132615>`. |
+-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0000001917130784__en-us_topic_0128427215_table578797132615:

.. table:: **Table 3** version field data structure description

+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| Name | Type | Description |
+=======================+=======================+=============================================================================================================+
| id | String | Backup time window. The creation of an automated backup will be triggered during the backup time window. |
| | | |
| | | The time is in the UTC format. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| links | Array of objects | API link information. |
| | | |
| | | For details, see :ref:`Table 4 <en-us_topic_0000001917130784__en-us_topic_0128427215_table14771167122611>`. |
| | | |
| | | .. note:: |
| | | |
| | | If the version is v3 adn v 3.1, the value is **[]**. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| status | String | Version status. |
| | | |
| | | The value is **CURRENT**, indicating that the version has been released. |
| | | |
| | | **SUPPORTED**: The version is an earlier version, but it is still supported. |
| | | |
| | | **DEPRECATED**: The version is a deprecated version, which may be deleted later. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| version | String | Subversion information of the API version. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| min_version | String | Minimum API version number. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+
| updated | String | Version update time. |
| | | |
| | | The format is yyyy-mm-ddThh:mm:ssZ. |
| | | |
| | | **T** is the separator between the calendar and the hourly notation of time. **Z** indicates the UTC. |
+-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------+

.. _en-us_topic_0000001917130784__en-us_topic_0128427215_table14771167122611:

.. table:: **Table 4** links field data structure description

==== ====== ===========================================================
Name Type Description
==== ====== ===========================================================
href String API URL. The value is **""**.
rel String The value is **self**, indicating that URL is a local link.
==== ====== ===========================================================

- Example normal response

.. code-block:: text

{
"version": {
"id": "v3",
"links": [],
"status": "CURRENT",
"version": "",
"min_version": "",
"updated": "2020-06-23T14:45:51Z"
}
}

- Abnormal response

For details, see :ref:`Abnormal Request Results <opengauss_api_0031>`.

Status Code
-----------

- Normal

200

- Abnormal

For details, see :ref:`Status Codes <opengauss_api_0032>`.

Error Code
----------

For details, see :ref:`Error Codes <opengauss_api_0033>`.