Skip to content

Introduce OpenAPI generation of REST API documentation #1145

Open
@michael-valdron

Description

@michael-valdron

Which area this feature is related to?

/area documentation

Which area is this documentation change is related to?

/area registry

Issue details

With the introduction of the OpenAPI 3 specification in #972 gives a centralized definition for the REST endpoints and connected schema types. With this, it would add to our ability to reduce the work on both the source and the documentation for the RESTful API to generate the definitions within both.

For the REST API documentation, we need:

  1. A mechanism to generate doc pages which will replace the current documentation for the RESTful APIs
  2. A mechanism to host the doc pages for anyone to view
    • Ideally a way to make it simple for RESTful API consumers to reference when they need it

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/documentationImprovements or additions to documentationarea/registryDevfile registry for stacks and infrastructurehelp wantedExtra attention is needed

    Type

    No type

    Projects

    Status

    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions