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

Update generating_oas_for_http_apis.mdx #191037

Merged
merged 3 commits into from
Aug 23, 2024
Merged

Update generating_oas_for_http_apis.mdx #191037

merged 3 commits into from
Aug 23, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 22, 2024 •
edited
Loading

Summary

Relates to #180056

This PR adds some more examples of how to add a tag, property descriptions, and deprecation flags that will appear in the generated openAPI documents

@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl added docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Aug 22, 2024
@lcawl lcawl requested a review from jloleysens August 22, 2024 00:06
@lcawl lcawl marked this pull request as ready for review August 22, 2024 01:02
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

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

afharo
afharo approved these changes Aug 23, 2024
View reviewed changes
Copy link
Member

@afharo afharo left a comment

Choose a reason for hiding this comment

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

LGTM! Just a minor comment to fix missing curly-brackets in the code example.

dev_docs/tutorials/generating_oas_for_http_apis.mdx Outdated Show resolved Hide resolved
@lcawl lcawl enabled auto-merge (squash) August 23, 2024 17:01
@lcawl lcawl merged commit 753f3d9 into main Aug 23, 2024
7 checks passed
@lcawl lcawl deleted the lcawl-patch-1 branch August 23, 2024 17:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afharo afharo afharo approved these changes

@jloleysens jloleysens Awaiting requested review from jloleysens

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting docs 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.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@lcawl @obltmachine @elasticmachine @kibana-ci @afharo @kibanamachine