Skip to content

[OAS][DOCS] Temporarily omit security APIs from docs#190467

Merged
lcawl merged 8 commits intoelastic:mainfrom
lcawl:security-oas
Aug 14, 2024
Merged

[OAS][DOCS] Temporarily omit security APIs from docs#190467
lcawl merged 8 commits intoelastic:mainfrom
lcawl:security-oas

Conversation

@lcawl
Copy link
Copy Markdown
Member

@lcawl lcawl commented Aug 13, 2024

Summary

This PR:

  • comments the security APIs out of the OpenAPI document bundler, since they're not ready for publishing yet.
  • updates the readme
  • pulls the appropriate introductory info file into the serverless bundle.

@obltmachine
Copy link
Copy Markdown

🤖 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 changed the title [OAS] Edit linting rule severity [OAS] linting rules Aug 13, 2024
@lcawl lcawl changed the title [OAS] linting rules [OAS] Turn off some built-in linting rules Aug 13, 2024
@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs backport:prev-minor Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS Team:Docs labels Aug 13, 2024
@lcawl lcawl marked this pull request as ready for review August 13, 2024 22:25
@lcawl lcawl requested a review from a team as a code owner August 13, 2024 22:25
@elasticmachine
Copy link
Copy Markdown
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl marked this pull request as draft August 13, 2024 23:13
@lcawl lcawl changed the title [OAS] Turn off some built-in linting rules [OAS][DOCS] Temporarily omit security APIs from docs Aug 13, 2024
@lcawl lcawl marked this pull request as ready for review August 13, 2024 23:33
@maximpn
Copy link
Copy Markdown
Contributor

maximpn commented Aug 14, 2024

@lcawl

Commenting out Security Solution source OpenAPI specs will exclude them from automcatic linting in Builkite via Spectral. It's a ok as a short term temporal solution but it could lead to accumulation of issues in a longer distance. We won't notice issues until the last moment. For example catching Kibana wide operationId conflicts isn't possible without merging everything together.

May we could change the approach a bit to have staging and final versions of the result Kibana OpenAPI specs by adding additional merging scripts varying only in sources. For example we could have extra merge_ess_oas_staging.js and merge_serverless_oas_staging.js script which produce oas_docs/output/kibana.staging.yaml and oas_docs/output/kibana.serverless.staging.yaml.

Copy link
Copy Markdown
Contributor

@banderror banderror left a comment

Choose a reason for hiding this comment

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

LGTM, thank you @lcawl 🙏

@lcawl
Copy link
Copy Markdown
Member Author

lcawl commented Aug 14, 2024

May we could change the approach a bit to have staging and final versions of the result Kibana OpenAPI specs by adding additional merging scripts varying only in sources. For example we could have extra merge_ess_oas_staging.js and merge_serverless_oas_staging.js script which produce oas_docs/output/kibana.staging.yaml and oas_docs/output/kibana.serverless.staging.yaml.

Sounds good to me! I've added the *_staging.js scripts. If it's necessary to check in the output, that's also fine by me.

Copy link
Copy Markdown
Member

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🐅

@lcawl lcawl enabled auto-merge (squash) August 14, 2024 15:36
@kibana-ci
Copy link
Copy Markdown

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

22 similar comments
@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@lcawl lcawl removed backport missing Added to PRs automatically when the are determined to be missing a backport. v8.16.0 labels Nov 27, 2024
@kibanamachine
Copy link
Copy Markdown
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 190467 locally

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 28, 2024
@lcawl lcawl added backport:skip This PR does not require backporting and removed backport:prev-minor labels Nov 28, 2024
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport:skip This PR 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:Docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants