Skip to content

[OAS] Migrate remaining ASCII docs to OAS #206243

Open
@jloleysens

Description

The following APIs should migrate to documenting their APIs in code so that OAS can be generated or them and hosted on our new API reference site.

See this script for paths that are currently extracted from code and included in the OAS bundle for hosting.

APIs to migrate are:

Please update this issue once they are included in the generated OAS bundle by:

  1. Adding metadata to your router registered route
  2. Updating the script to include your API when capturing a snapshot

See the following comprehensive examples 1, 2 or search for meta: inside any **/routes/* files in the code base.

See the docs

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    Feature:OASWork or issues related to Core-provided mechanisms for generating OASMetaTeam:CoreCore services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions