Generate OpenAPI schema for Elasticsearch Serverless #2047
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sethmlarson
reviewed
Mar 29, 2023
There was a problem hiding this comment.
This is excellent, nice work @swallez! Left a few comments inline, some may not make sense due to unfamiliarity with Rust and this code:
|
Following you can find the validation results for the APIs you have changed.
You can validate these APIs yourself by using the |
swallez
force-pushed
the
openapi-converter
branch
from
c312f00 to
ad93d9a
Compare
swallez
force-pushed
the
openapi-converter
branch
from
ad93d9a to
22c046e
Compare
|
Great stuff @swallez 👏 I notice that there are a few errors (denoting actual issues with the produced formatting, rather than "nice to have"s) when linting the generated OpenAPI with https://github.com/stoplightio/spectral - just wondering if you're aware of or are validating the schema with any other tools? Looks like it's largely the following buckets:
There are also some circular references that may break some OpenAPI libraries (it appears to break https://github.com/getkin/kin-openapi) |
swallez
force-pushed
the
openapi-converter
branch
from
a48c7d6 to
915dd15
Compare
|
@jamietanna thanks for the pointer, Spectral is a great linter, picky as it should. The conversion code has been updated and the linter is happy. The OpenAPI output now comes in two flavors, stack (full API) and serverless. I still have to implement a few |
|
Awesome stuff @swallez 👏 Appreciate the tweaks. A couple of plumbing points to note: I believe the circular references may still be an issue (in
Some other validators (like There appears to be a clash in one of the related Key errors I can see in Spectral are: It loosk like I also note that we've got generated code like: "/_async_search/{id}": {
"get": {
"description": "Retrieves the results of a previously submitted async search request given its ID.",
"externalDocs": {
"url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html"
},
"operationId": "async_search.get#0",and "schemas": {
"_types:Id": {
"type": "string"
},Is there anything we can do to maybe massage these into more human-readable names? This may make the generated code that's used with these a little better. |
|
@jamietanna thanks for the feedback. Regarding the failure of linters and code generators, this has to be put of into perspective with the context and and purpose of this conversion:
Regarding the other points you mention:
|
swallez
force-pushed
the
openapi-converter
branch
from
915dd15 to
3f9daef
Compare
swallez
force-pushed
the
openapi-converter
branch
from
1a1b5b4 to
11d15f3
Compare
swallez
changed the title
Anaethelion
approved these changes
Oct 23, 2023
| } | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, ValueEnum)] | ||
| pub enum SchemaFlavor { |
There was a problem hiding this comment.
Why not reuse the values from client_schema::Flavor ?
There was a problem hiding this comment.
Because we're likely to have a Common code generation target in the future (currently commented-out) that will be used to retain what's in both Stack and Serverless. So client_schema::Flavor represents the @availability annotation whereas here this represents the generation flavor that can be different from a simple XOR between Stack and Serverless.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a converter from
schema.jsonto OpenAPI for Elasticsearch serverless.make contribnow produces theoutput/openapi/elasticsearch-serverless-openapi.jsonfile.This converter is written in Rust. To ensure a smooth integration with our existing tooling, the Rust code is compiled to WebAssembly with a JavaScript binding using wasm-pack that exploses the OpenAPI generation function.
As part of this, the
clients-schemacrate provides a complete implementation of theschema.jsonmetamodel along with utilities and common transformation functions such as generics expansion and flavor (stack/serverless) filtering.