Skip to content

[PROPOSAL] Bootstrap API specification from OpenSearch code #30

@dblock

Description

@dblock

What kind of business use case are you trying to solve? What are your requirements?

Looking at the early PRs on this repository it looks like we are hand-creating/editing API specifications. Is that something that could be generated out of OpenSearch code? At least as a bootstrap? This is one half of opensearch-project/OpenSearch#3090.

What is the problem? What is preventing you from meeting the requirements?

The amount of work that will be required to write the models/APIs will be significant and potentially error-prone. It doesn't scale. Every time an API changes we will need to remember to update the specification, by hand. We need to turn this around and generate the RESTful implementation from this spec, which is opensearch-project/OpenSearch#3090.

What are you proposing? What do you suggest we do to solve the problem or improve the existing situation?

Until we start doing opensearch-project/OpenSearch#3090, bootstrap the api specification from source

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions