fix(rust): revamp the OpenAPI specification #1564
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
agama-web-server docs
command generates the OpenAPI specification of Agama's HTTP API. However, the resulting specification is badly broken 😢. This pull request aims to make the specification usable.Refactoring
Apart from being incomplete, the previous implementation had a few problems.
IpAddr
,IpInet
, etc.).For those reasons, we decided to use the builder API, which is really flexible. We also took the chance to split the generation into smaller pieces, making it easier to maintain.
Generating the
schema.d.ts
You can generate the API in two simple steps:
To do
Future work