search

scylladb / scylladb

NoSQL data store using the seastar framework, compatible with Apache Cassandra
http://scylladb.com
GNU Affero General Public License v3.0
12.93k stars 1.24k forks source link

ScyllaDB rest API: rest api for development should not appear in rest API documentation and swagger ui #16572

Open eliransin opened 6 months ago

eliransin commented 6 months ago

Currently we have some api's used for development (or maybe in the future, debugging in the field). One example of this is error_injection. Those and future development APIs should probably not register with the normal api-doc,ui and v2 and be separated into their own separate API access points and documentations. I would suggest the not original names: api-dev-doc,ui-dev and v2-dev Also probably those access points should probably need the ability to not register at all (configuration option) or unregister and register at will.

tzach commented 6 months ago

There is no API doc (yet) https://github.com/scylladb/scylladb/issues/8180