Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger: backup and restore Scylla API #4100

Merged
merged 3 commits into from
Nov 12, 2024
Merged

Swagger: backup and restore Scylla API #4100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8afae35
feat(swagger): scylla, add task manager endpoints
Michal-Leszczynski Nov 4, 2024
e511fb2
feat(swagger): scylla, add backup and restore endpoints
Michal-Leszczynski Nov 5, 2024
30b6279
feat(swagger): add README file
Michal-Leszczynski Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions v3/swagger/README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This module contains the following swagger definitions used in *Scylla Manager* repository:

1. **scylla-manager** - describes *Scylla Manager* API. It is mainly used by the *sctool* CLI and *Scylla Cloud* and *Scylla Operator* teams.

2. **scylla-manager-agent** - describes *Scylla Manager Agent* API. It is mainly used by the *Scylla Manager*.
It consists mostly of the *rclone* server swagger definitions, but there are also a few agent specific definitions as well.

3. **scylla_v1** - describes general *Scylla* API. The swagger definitions come from [Scylla repository](https://github.com/scylladb/scylladb/tree/master/api),
and they are divided into per service files (e.g. [storage_service](https://github.com/scylladb/scylladb/blob/b158ca734603d62fa8e173a72e60866a4d8d3bc7/api/api-doc/storage_service.json#L5)).
Note that *Scylla* uses swagger *1.2*, and we use swagger *2.0* in Scylla Manager repository, so the swagger definitions needs to be adjusted accordingly.

4. **scylla_v2** - describes config related *Scylla* API. The swagger definitions [correspond to querying](https://github.com/scylladb/scylladb/blob/b158ca734603d62fa8e173a72e60866a4d8d3bc7/api/api-doc/config.json#L1)
*Scylla* node's *scylla.yaml* config file. Note that in some cases this API does not distinguish [unset and default values](https://github.com/scylladb/scylladb/issues/7206#issuecomment-689598343).
Loading
Loading