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

Add support for more detailed descriptions of APIs #182779

Open
Tracked by #180056
jloleysens opened this issue May 7, 2024 · 1 comment
Open
Tracked by #180056

Add support for more detailed descriptions of APIs #182779

jloleysens opened this issue May 7, 2024 · 1 comment
Labels
Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@jloleysens
Copy link
Contributor

jloleysens commented May 7, 2024 •
edited

See original context provided by @lcawl here: #181277 (comment)

Right now the optional description field on the IRouter and CoreVersionedRouter interfaces map to summary in OAS. OAS also has an optional field for more detailed description called... description. We should allow API authors to also provide a more detailed description of their API, but should probably choose a name like details 🤷🏻
@jloleysens jloleysens mentioned this issue May 7, 2024
Open
@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels May 7, 2024
This was referenced May 28, 2024
Merged
Merged
@lcawl lcawl mentioned this issue Jun 6, 2024
Draft
@lcawl
Copy link
Contributor

lcawl commented Jun 6, 2024

IMO this issue is closed by #184651

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 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
2 participants
@jloleysens @lcawl