scylladb / scylla-manager

The Scylla Manager
https://manager.docs.scylladb.com/stable/
Other
48 stars 33 forks source link

Move to OpenAPI 3.1 #3772

Open karol-kokoszka opened 3 months ago

karol-kokoszka commented 3 months ago

Scylla manager uses code generators to create scylla , scylla-manager-agent, scylla-manager Go clients. The code is generated out of https://github.com/scylladb/scylla-manager/tree/master/swagger

Specification that is defined here is in Swagger 2.0 https://github.com/scylladb/scylla-manager/blob/6b38cea84cfcefb28157d6f2fc958e6942fe3a4a/swagger/scylla_v1.json#L2

Clients are generated here https://github.com/scylladb/scylla-manager/blob/master/swagger/Makefile

The reason for that change is the default encoding that happens on parameters. Alternator allows to use special characters in column names - current client is escaping these characters.

https://github.com/scylladb/scylla-manager/issues/3754

Goal Update specifications to use OpenAPI 3.1. Validate the tools that can be used to generate clients out of OpenAPI 3.1. Generate new clients. Update references in Scylla-Manager to use new clients.

karol-kokoszka commented 3 months ago

This issue is triggered by the following problem https://github.com/scylladb/scylla-manager/issues/3754

tzach commented 3 months ago

Similar issue on Scylla Core https://github.com/scylladb/scylladb/issues/18028