oeotvos/software-repository-container
1
0
Fork 0
forked from docs/software-repository-container
Code Pull Requests Activity
software-repository-container/api-ref/source/api/querying_all_api_versions.rst
proposalbot 4894df0e64 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>
2022-11-10 10:13:15 +00:00

7.2 KiB
Raw Blame History

original_name

swr_02_0080.html

Querying All API Versions

Function

Query all available API versions of SWR.

URI

GET /

Request

N/A

Response

  • Response parameters

    Table 1 Response body parameter description
    Parameter Type Description
    versions Array of objects <swr_02_0080__table45446245174724> A list of objects related to the version.
    Table 2 versions parameter description
    Parameter Type Description
    id String Version ID (version number), for example, v2.
    links Object <swr_02_0080__table453717423323> API URL.
    version String If the APIs of this version support microversions, set this parameter to the supported maximum microversion. If the microversion is not supported, leave this parameter blank.
    status String

    Version status. The options are as follows:

    • CURRENT: The version is the primary version.
    • SUPPORTED: The version is an old version, but it is still supported.
    • DEPRECATED: The version is a deprecated version, which may be deleted later.
    updated String Version release time, which must be the UTC time. For example, the release time of v2 is 2014-06-28T12:20:21Z.
    min_version String If APIs of this version support microversions, set this parameter to the supported minimum microversion. If the microversion is not supported, leave this parameter blank.
    Table 3 links parameter description
    Parameter Type Description
    href String Link
    rel String Description

  • Example response

    {
   "versions": [
        {
            "id": "v2",
            "links":
                {
                    "href": "https://xxx",
                    "rel": "self"
                }
            "min_version": "2.0",
            "status": "CURRENT",
            "updated": "2020-07-09T00:00:00Z",
            "version": "2.26",
        }
    ]
}

Status Code

Status Code Description
200 Request successful.
500 Failed to complete the request because of an internal service error.