Versions Compared

Old Version 4

changes.mady.by.user Aleksandr Pakhomov

Saved on

compared with

New Version 5

changes.mady.by.user Aleksandr Pakhomov

Saved on

Key

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


IDIEP-87
Author

Aleksandr Pakhomov 

Sponsor

Andrey Gura Kirill Gusakov 

Created

 

Status

Status
titledraft

Table of Contents

Motivation

...

Typical development lifecycle for new endpoint:

  1. Implement backend and , test endpoint, and annotate the method with swagger annotations
  2. Build backend module and check that Open API spec is generated
  3. Build client module 
  4. Use generated client

...

This REST group provides methods to read and update node/cluster configuration.

MethodPathParametersDescription
GET/management/v1/configuration/node/
Return node configuration in HOCON format
GET/management/v1/configuration/node/{configPath}
  • configPath: subtree selector in format root.subtree.subsubtree

Return node configuration subtree in HOCON format specified with configPath parameter.

PATCH/management/v1/configuration/node/
  • request body: configuration to update in HOCON format
Update node configuration with a given body.
GET/management/v1/configuration/cluster/
Return cluster configuration in HOCON format.
GET/management/v1/configuration/cluster/{configPath}
  • configPath: subtree selector in format root.subtree.subsubtree

Return cluster configuration subtree in HOCON format specified with configPath parameter.

PATCH/management/v1/configuration/cluster/
  • request body: configuration to update in HOCON format

Update cluster configuration with a given body.

Management REST API

Manage cluster state.

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

Topology REST API

Provide information about cluster topology.

MethodPathParametersDescription
GET/management/v1/topology/


Return cluster topology information(consistent ID, ID, address, status).

Version REST API

Provide the build version for the node. 

MethodPathParametersDescription
GET/management/v1/version/


Return node build version in semver format.


Open tickets

TBD

Closed tickets

...