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] Remove Elastic-Api-Version #202923

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

[OAS] Remove Elastic-Api-Version #202923

wants to merge 6 commits into from
+1,092 −6,512

Conversation

jloleysens
Copy link
Contributor

@jloleysens jloleysens commented Dec 4, 2024 •
edited
Loading

Summary

Due to the much slower rate of versioning public APIs we have decided to remove the Elastic-Api-Version body and header information from the spec entirely.

This also cleans up the spec when rendered on our hosted OAS docs.

@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v9.0.0 Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS backport:version Backport to applied version labels v8.18.0 labels Dec 4, 2024
@jloleysens jloleysens self-assigned this Dec 4, 2024
@jloleysens
Copy link
Contributor Author

/ci

@elasticmachine
Copy link
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!

@kibanamachine
[CI] Auto-commit changed files from 'node scripts/capture_oas_snapsho…
f4ee725 
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/fleet --update'
@jloleysens
Copy link
Contributor Author

/ci

@jloleysens jloleysens mentioned this pull request Dec 4, 2024
Closed
@jloleysens
Copy link
Contributor Author

/ci

@jloleysens jloleysens changed the title [OAS] Remove Elastic-Api-Version from spec doc [OAS] Remove Elastic-Api-Version Dec 4, 2024
@jloleysens
Copy link
Contributor Author

/ci

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id before after diff
@kbn/router-to-openapispec 10 9 -1

History

cc @jloleysens

@lcawl lcawl mentioned this pull request Dec 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jloleysens jloleysens

Labels
backport:version Backport to applied version 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 v8.18.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jloleysens @elasticmachine @kibanamachine