Add OpenApi 3.0 Yaml document #1229
Open
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.
I've mostly converted the LWS API markdown file into a OpenApi 3.0 YAML spec. We can generate more visually appealing HTML spec files this way. Additionally, all of the fields now have hard constraints on integer size, etc., and can be more tightly validated by checker tools. These tools also provide (mostly decent) JSON examples, so it should lower the barrier to getting people understanding how the spec works.
The spec includes the "drafts" for #603 #647 #1228 such that YAML document is basically complete. This also includes an additional field for
/get_subaddrswhich I will PR after #647 gets merged.