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] Refactor description -> summary #184651

Merged
merged 27 commits into from
Jun 6, 2024
Merged

[OAS] Refactor description -> summary #184651

merged 27 commits into from
Jun 6, 2024

Conversation

jloleysens
Copy link
Contributor

@jloleysens jloleysens commented Jun 3, 2024 •
edited
Loading

Summary

Per the OAS docs, they have an info object with a summary and description field. This PR refactors the existing router description field to to OAS summary (that is how it has been used) and introduces a "new" description field that will be used for the longer form descriptions.

Resources

@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes v8.15.0 Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jun 3, 2024
@jloleysens
Copy link
Contributor Author

/ci

2 similar comments
@jloleysens
Copy link
Contributor Author

/ci

@jloleysens
Copy link
Contributor Author

/ci

@jloleysens
Copy link
Contributor Author

/ci

@maryam-saeidi maryam-saeidi mentioned this pull request Jun 4, 2024
Closed
@jloleysens
Copy link
Contributor Author

/ci

@jloleysens
Copy link
Contributor Author

/ci

mashhurs
mashhurs approved these changes Jun 5, 2024
View reviewed changes
Copy link
Contributor

@mashhurs mashhurs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM from Logstash.

sabarasaba
sabarasaba approved these changes Jun 5, 2024
View reviewed changes
Copy link
Member

@sabarasaba sabarasaba left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@elastic/kibana-management changes lgtm

qn895
qn895 approved these changes Jun 5, 2024
View reviewed changes
Copy link
Member

@qn895 qn895 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ML changes LGTM

ymao1
ymao1 approved these changes Jun 5, 2024
View reviewed changes
Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

response ops changes LGTM

@lcawl
Copy link
Contributor

lcawl commented Jun 5, 2024

I added a description with some markup in x-pack/plugins/actions/server/routes/execute.ts. When I generate the output and preview it in Bump.sh, it looks great:

image

elena-shostak
elena-shostak approved these changes Jun 6, 2024
View reviewed changes
Copy link
Contributor

@elena-shostak elena-shostak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@jloleysens jloleysens enabled auto-merge (squash) June 6, 2024 09:34
eokoneyo
eokoneyo approved these changes Jun 6, 2024
View reviewed changes
Copy link
Contributor

@eokoneyo eokoneyo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!!

@jloleysens
Copy link
Contributor Author

@elasticmachine merge upstream

@jloleysens jloleysens merged commit dd1864b into elastic:main Jun 6, 2024
38 checks passed
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Unknown metric groups

API count

id before after diff
@kbn/core-http-server 486 487 +1

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 6, 2024
@lcawl lcawl mentioned this pull request Jun 6, 2024
Closed
@jloleysens jloleysens deleted the oas/summary-and-descriptions branch June 26, 2024 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sabarasaba sabarasaba sabarasaba approved these changes

@eokoneyo eokoneyo eokoneyo approved these changes

@TinaHeiligers TinaHeiligers TinaHeiligers approved these changes

@ymao1 ymao1 ymao1 approved these changes

@lcawl lcawl lcawl approved these changes

@qn895 qn895 qn895 approved these changes

@mashhurs mashhurs mashhurs approved these changes

@elena-shostak elena-shostak elena-shostak approved these changes

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.15.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.