Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Open API is the most popular approach to design, build and document REST APIs. It does not depend on a particular language. The contract provided by the Swagger (Open API implementation) guarantees that the REST server is compatible with the specification. The specification is the single source of truth for consumers (web interface, CLI, third party integrations). 

Description

The current implementation does not support auto-generation for the API specification. The main value of this improvement is to add the possibility to generate the API specification from code.

...

Code-first approach

Code-first approach is suggested. One writes backend code and after that, the specification is generated from this code.

...

MethodPathParametersDescription
POST/management/v1/init/
  • body: list of meta storage node names and list of cmg nodes
Initialize cluster

Meta storage and cmg definitions.

Topology REST API

Provide information about cluster topology.

...