Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[OAS] Migrate remaining ASCII docs to OAS #206243

Open
9 tasks
jloleysens opened this issue Jan 10, 2025 · 0 comments
Open
9 tasks

[OAS] Migrate remaining ASCII docs to OAS #206243

jloleysens opened this issue Jan 10, 2025 · 0 comments
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@jloleysens
Copy link
Contributor

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
@jloleysens jloleysens added Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Meta labels Jan 10, 2025
@botelastic botelastic bot added the needs-team Issues missing a team label label Jan 10, 2025
@jloleysens jloleysens added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Jan 10, 2025
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Meta Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jloleysens