Versioning

API Versioning

The GCS Manager API uses semantic versioning for its API versioning. The version of the API described in this document is 1.36.0.

Connectors

Each Connector providing access to a type of storage will have its own semantic version. This version describes the API specific to that connector, including its input and output document formats and any additional URL routes that it provides.

API Document Versions

Each document in the Globus Connect Server Manager API includes a DATA_TYPE property that indicates the type and version of the document. When a document with a given DATA_TYPE is used in a document, the document must validate against the schema defined for that document type. Note that extensions may be allowed based on the definition of that type.

Deprecations

When a part of the API is to be deprecated, the minor version of the API is increased. When a part of the API is removed, the major version of the API is incremented. When a deprecated API is used, the response message will include a deprecation warning.

Versioning Overview

Method	API Path	Description
`GET`	/api/info	Get GCS service information

Details

Get GCS service information

GET /api/info

Returns information about the GCS Manager service for this endpoint, as well as additional features such as connectors that it provides as extensions to the API defined in this document.

This operation can be performed without an Authorization header.

Query Parameters

Parameter	Type	Description
page_size	integer <int>	Maximum page size for a paginated response
marker	string	Pagination marker for a paginated response

Responses

200 - Get info response

Content-Type: application/json

This is the result envelope returned from all operations in this API. Each operation may add properties to this base document type with additional operation-specific data values.

Version 1.1.0 adds optional authorization_parameters to help process authorization or authentication errors

One of the following schemas:

{
  "code": "string",
  "data": [
    {
      "DATA_TYPE": "connector#1.0.0",
      "display_name": "POSIX",
      "id": "string",
      "version": "string"
    }
  ],
  "DATA_TYPE": "result#1.0.0",
  "detail": null,
  "has_next_page": false,
  "http_response_code": 100,
  "marker": "string",
  "message": "string"
}