Skip to content

[OAS] Remove Elastic-Api-Version#207071

Merged
jloleysens merged 10 commits intoelastic:mainfrom
jloleysens:oas/remove-version-param
Jan 30, 2025
Merged

[OAS] Remove Elastic-Api-Version#207071
jloleysens merged 10 commits intoelastic:mainfrom
jloleysens:oas/remove-version-param

Conversation

@jloleysens
Copy link
Copy Markdown
Contributor

@jloleysens jloleysens commented Jan 17, 2025 •
edited by kibanamachine
Loading

Summary

We anticipate generating a single document per API version for the foreseeable future. This PR updates our OAS document merging logic to avoid adding the Elastic-Api-Version header to our spec.

This will also remove this header from current documentation.

@jloleysens
remove the addition for Elastic-Api-Version since we are likely not g…
3d04ae2 
…oing to merging different versions of the same spec
@jloleysens jloleysens added Team:Core Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// release_note:skip Skip the PR/issue when compiling release notes Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS backport:version Backport to applied version labels v8.18.0 labels Jan 17, 2025
@jloleysens jloleysens requested a review from maximpn January 17, 2025 13:11
@jloleysens
Copy link
Copy Markdown
Contributor Author

jloleysens commented Jan 20, 2025

/ci

@jloleysens
Copy link
Copy Markdown
Contributor Author

jloleysens commented Jan 20, 2025

/ci

@jloleysens jloleysens changed the title [OAS] Remove the addition for Elastic-Api-Version [OAS] Remove Elastic-Api-Version Jan 20, 2025
@jloleysens
Copy link
Copy Markdown
Contributor Author

jloleysens commented Jan 20, 2025

/ci

@jloleysens jloleysens marked this pull request as ready for review January 21, 2025 08:55
@jloleysens jloleysens requested a review from a team as a code owner January 21, 2025 08:55
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 21, 2025

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

@jloleysens jloleysens force-pushed the oas/remove-version-param branch from 0c1cb38 to 2047973 Compare January 24, 2025 09:26
maximpn
maximpn reviewed Jan 29, 2025
View reviewed changes
maximpn
maximpn approved these changes Jan 29, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@maximpn maximpn left a comment

Choose a reason for hiding this comment

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

The diff LGTM. Some Elastic-Api-Version=2023-10-31 persisted in the diff. I left a comment regarding that.

I'm ok with keeping unused enrichWithVersionMimeParam for now just in case we need it later on. Alternatively Elastic-Api-Version enriching functionality could be moved under a dedicated configuration option for inversion of control and transparency. I'd reiterate on that topic when it's clear we don't need Elastic-Api-Version in MIME type anymore to clean up unused code.

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Jan 30, 2025

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

@jloleysens jloleysens merged commit 53cba30 into elastic:main Jan 30, 2025
@jloleysens jloleysens deleted the oas/remove-version-param branch January 30, 2025 15:59
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 4, 2025

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 207071 locally

5 similar comments
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 5, 2025

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 207071 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 6, 2025

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 207071 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 7, 2025

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 207071 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 10, 2025

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 207071 locally

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 11, 2025

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 207071 locally

@jloleysens jloleysens mentioned this pull request Feb 12, 2025
Merged
jloleysens added a commit to jloleysens/kibana that referenced this pull request Feb 12, 2025
@jloleysens
[OAS] Remove Elastic-Api-Version (elastic#207071)
f3e2be1 
## Summary

We anticipate generating a single document per API version for the
foreseeable future. This PR updates our OAS document merging logic to
avoid adding the `Elastic-Api-Version` header to our spec.

This will also remove this header from current documentation.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 53cba30)

# Conflicts:
#	oas_docs/output/kibana.serverless.yaml
#	oas_docs/output/kibana.yaml
@jloleysens jloleysens mentioned this pull request Feb 12, 2025
Merged
@jloleysens
Copy link
Copy Markdown
Contributor Author

jloleysens commented Feb 12, 2025

💚 All backports created successfully

Status Branch Result
✅ 8.x
✅ 8.18

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

jloleysens added a commit to jloleysens/kibana that referenced this pull request Feb 12, 2025
@jloleysens
[OAS] Remove Elastic-Api-Version (elastic#207071)
a693f6d 
## Summary

We anticipate generating a single document per API version for the
foreseeable future. This PR updates our OAS document merging logic to
avoid adding the `Elastic-Api-Version` header to our spec.

This will also remove this header from current documentation.

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
(cherry picked from commit 53cba30)

# Conflicts:
#	oas_docs/output/kibana.serverless.yaml
#	oas_docs/output/kibana.yaml
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 12, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

1 similar comment
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 13, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 14, 2025

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 17, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

8 similar comments
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 18, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 19, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 21, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 24, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 25, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 26, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 27, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Feb 28, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

@kibanamachine kibanamachine mentioned this pull request Feb 28, 2025
Merged
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Mar 3, 2025

Looks like this PR has backport PRs but they still haven't been merged. Please merge them ASAP to keep the branches relatively in sync.

jloleysens added a commit that referenced this pull request Mar 3, 2025
@jloleysens @kibanamachine
[8.18] [OAS] Remove Elastic-Api-Version (#207071) (#210835)
a4cd9d3 
# Backport

This will backport the following commits from `main` to `8.18`:
- [[OAS] Remove &#x60;Elastic-Api-Version&#x60;
(#207071)](#207071)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Jean-Louis
Leysens","email":"jeanlouis.leysens@elastic.co"},"sourceCommit":{"committedDate":"2025-01-30T15:59:45Z","message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","backport
missing","v9.0.0","Feature:OAS","backport:version","v8.18.0"],"title":"[OAS]
Remove
`Elastic-Api-Version`","number":207071,"url":"https://github.com/elastic/kibana/pull/207071","mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},"sourceBranch":"main","suggestedTargetBranches":["8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/207071","number":207071,"mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
jloleysens added a commit that referenced this pull request Mar 3, 2025
@jloleysens @kibanamachine
[8.x] [OAS] Remove Elastic-Api-Version (#207071) (#210834)
39cd1ce 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OAS] Remove &#x60;Elastic-Api-Version&#x60;
(#207071)](#207071)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Jean-Louis
Leysens","email":"jeanlouis.leysens@elastic.co"},"sourceCommit":{"committedDate":"2025-01-30T15:59:45Z","message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","backport
missing","v9.0.0","Feature:OAS","backport:version","v8.18.0"],"title":"[OAS]
Remove
`Elastic-Api-Version`","number":207071,"url":"https://github.com/elastic/kibana/pull/207071","mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},"sourceBranch":"main","suggestedTargetBranches":["8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/207071","number":207071,"mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
@kibanamachine kibanamachine added v8.19.0 and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Mar 3, 2025
SoniaSanzV pushed a commit to SoniaSanzV/kibana that referenced this pull request Mar 4, 2025
@jloleysens @kibanamachine @SoniaSanzV
[8.x] [OAS] Remove Elastic-Api-Version (elastic#207071) (elastic#21…
48a48c2 
…0834)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[OAS] Remove &#x60;Elastic-Api-Version&#x60;
(elastic#207071)](elastic#207071)

<!--- Backport version: 9.6.4 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sorenlouv/backport)

<!--BACKPORT [{"author":{"name":"Jean-Louis
Leysens","email":"jeanlouis.leysens@elastic.co"},"sourceCommit":{"committedDate":"2025-01-30T15:59:45Z","message":"[OAS]
Remove `Elastic-Api-Version` (elastic#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","backport
missing","v9.0.0","Feature:OAS","backport:version","v8.18.0"],"title":"[OAS]
Remove
`Elastic-Api-Version`","number":207071,"url":"https://github.com/elastic/kibana/pull/207071","mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (elastic#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},"sourceBranch":"main","suggestedTargetBranches":["8.18"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/207071","number":207071,"mergeCommit":{"message":"[OAS]
Remove `Elastic-Api-Version` (elastic#207071)\n\n## Summary\r\n\r\nWe
anticipate generating a single document per API version for
the\r\nforeseeable future. This PR updates our OAS document merging
logic to\r\navoid adding the `Elastic-Api-Version` header to our
spec.\r\n\r\nThis will also remove this header from current
documentation.\r\n\r\n---------\r\n\r\nCo-authored-by: kibanamachine
<42973632+kibanamachine@users.noreply.github.com>","sha":"53cba303e55c6c7d0060908938c343931513d114"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@maximpn maximpn maximpn approved these changes

Assignees

No one assigned

Labels

backport:version Backport to applied version labels 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 Platform Core services: plugins, logging, config, saved objects, http, ES client, i18n, etc t// v8.18.0 v8.19.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jloleysens @elasticmachine @kibanamachine @maximpn