Qin Ying, Fan 62ab8a5fe2 DC API 20231101 version

Reviewed-by: Sarda, Priya <prsarda@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: Qin Ying, Fan <fanqinying@huawei.com>
Co-committed-by: Qin Ying, Fan <fanqinying@huawei.com>

2024-03-11 15:10:40 +00:00

8.4 KiB

Raw Permalink Blame History

Querying a Specified API Version

Function

This API is used to query a specified API version supported by Direct Connect.

URI

GET /{api_version}

Request

None

Response

Table 1 lists the response parameters.

**Table 1** Response parameters
Parameter	Type	Description
id	String	Specifies the version number, for example, v2.0.
links	Array	Specifies the API URL.
href	String	Specifies the reference address of the current API version.
rel	String	Specifies the relationship between the current API version and the referenced address.
version	String	Specifies the version. If APIs of this version support minor versions, set this parameter to the supported maximum minor version. If minor versions are not supported, leave this parameter blank.
status	String	Specifies the version status. Value options are as follows: CURRENT: indicates a primary version. SUPPORTED: indicates an old version that is still supported. DEPRECATED: indicates a deprecated version that may be deleted later.
updated	String	Specifies the version release time in UTC. For example, the release time format of v2.0 APIs is YYYY-MM-DDTHH:MM:SSZ.
min_version	String	Specifies the version. If APIs of this version support minor versions, set this parameter to the supported minimum minor version. If minor versions are not supported, leave this parameter blank.

Examples

Example request
```
GET /v2.0
```

Example response

{
  "version": {
    "id": "v2.0",
    "links": [
      {
        "href": "https://dcaas.eu-de.otc.t-systems.com/v2.0",
        "rel": "self"
      }
    ],
    "updated": "YYYY-MM-DDTHH:MM:SSZ",
    "status": "CURRENT",
    "version": "",
    "min_version": ""
  }
}

Parent topic: API Version

8.4 KiB Raw Permalink Blame History