Open dblock opened 1 month ago
To provide some context for those not familiar with the API Spec repo:
Once this is implemented and all clients are generated using the spec, it'd be nice to add a dropdown to all code blocks that users can use to choose the language for the code block. That way, client documentation can be integrated with the REST documentation.
What do you want to do?
The https://github.com/opensearch-project/opensearch-api-specification repo contains and publishes the machine-readable reference of the APIs in OpenAPI format, along with runnable tests that execute an actual version of OpenSearch. The spec is work in progress, but has some solid coverage of core, and soon to have coverage of plugins before EOY 2024. The spec also supports
description
,x-version-added/removed/deprecated
fields, and much more.We propose to generate the documentation reference from spec instead of authoring it by hand.