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.

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

[Fleet] make deprecated paths public #175038

Merged
merged 4 commits into from
Jan 18, 2024

Conversation

juliaElastic
Copy link
Contributor

@juliaElastic juliaElastic commented Jan 17, 2024

Summary

Closes #175031

Made deprecated APIs public instead of internal, to fix the accidental breaking change for customers who called these APIs before (internal APIs don't have a default version resolution yet, so require a version header)

One caveat of this change is if someone already changed their deprecated API call to use 'elastic-api-version: 1' in 8.11, as it would have to be changed again to use the public version or remove the header. Though I don't think we have many usages like that, since the version usage is not very well documented and we only got one support question about it.

@juliaElastic juliaElastic added release_note:skip Skip the PR/issue when compiling release notes v8.12.1 labels Jan 17, 2024
@juliaElastic juliaElastic self-assigned this Jan 17, 2024
@juliaElastic juliaElastic requested a review from a team as a code owner January 17, 2024 15:27
@botelastic botelastic bot added the Team:Fleet Team label for Observability Data Collection Fleet team label Jan 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

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

Copy link
Member

@kpollich kpollich left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 Thanks for tracking this down.

@juliaElastic
Copy link
Contributor Author

/ci

@juliaElastic juliaElastic requested a review from a team as a code owner January 18, 2024 12:21
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Jest Integration Tests #7 / checking migration metadata changes on all registered SO types detecting migration related changes in registered types
  • [job] [logs] Jest Integration Tests #7 / getOutdatedDocumentsQuery creates a query returning the expected documents
  • [job] [logs] Jest Integration Tests #7 / Higher version doc conversion #bulkGet returns the documents with the correct shape
  • [job] [logs] Jest Integration Tests #7 / Higher version doc conversion #bulkResolve returns the documents with the correct shape
  • [job] [logs] Jest Integration Tests #7 / Higher version doc conversion #get returns the documents with the correct shape
  • [job] [logs] Jest Integration Tests #7 / Higher version doc conversion #resolve returns the documents with the correct shape
  • [job] [logs] Jest Integration Tests #7 / ZDT upgrades - introducing a new SO type should support adding the bar type
  • [job] [logs] Jest Integration Tests #7 / ZDT upgrades - switching from v2 algorithm when switching from a compatible version it able to re-use a cluster state from the v2 algorithm
  • [job] [logs] Jest Integration Tests #7 / ZDT upgrades - switching from v2 algorithm when switching from an incompatible version fails and throws an explicit error
  • [job] [logs] Jest Integration Tests #7 / ZDT with v2 compat - recovering from partially migrated state migrates the documents

Metrics [docs]

✅ unchanged

History

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

cc @juliaElastic

@juliaElastic juliaElastic requested a review from Kerry350 January 18, 2024 13:34
Copy link
Contributor

@tonyghiani tonyghiani left a comment

Choose a reason for hiding this comment

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

LGTM!

@juliaElastic juliaElastic merged commit e31118a into elastic:main Jan 18, 2024
20 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jan 18, 2024
## Summary

Closes elastic#175031

Made deprecated APIs public instead of internal, to fix the accidental
breaking change for customers who called these APIs before (internal
APIs don't have a default version resolution yet, so require a version
header)

One caveat of this change is if someone already changed their deprecated
API call to use 'elastic-api-version: 1' in 8.11, as it would have to be
changed again to use the public version or remove the header. Though I
don't think we have many usages like that, since the version usage is
not very well documented and we only got one support question about it.

(cherry picked from commit e31118a)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.12

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

Questions ?

Please refer to the Backport tool documentation

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jan 19, 2024
@kibanamachine
Copy link
Contributor

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 added a commit that referenced this pull request Jan 22, 2024
# Backport

This will backport the following commits from `main` to `8.12`:
- [[Fleet] make deprecated paths public
(#175038)](#175038)

<!--- Backport version: 9.4.3 -->

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

<!--BACKPORT [{"author":{"name":"Julia
Bardi","email":"90178898+juliaElastic@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-01-18T14:35:56Z","message":"[Fleet]
make deprecated paths public (#175038)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/175031\r\n\r\nMade deprecated
APIs public instead of internal, to fix the accidental\r\nbreaking
change for customers who called these APIs before (internal\r\nAPIs
don't have a default version resolution yet, so require a
version\r\nheader)\r\n\r\nOne caveat of this change is if someone
already changed their deprecated\r\nAPI call to use
'elastic-api-version: 1' in 8.11, as it would have to be\r\nchanged
again to use the public version or remove the header. Though I\r\ndon't
think we have many usages like that, since the version usage is\r\nnot
very well documented and we only got one support question about
it.","sha":"e31118abf9d3e312951f9184066242690c6a2ef5","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","v8.12.1","v8.13.0"],"title":"[Fleet]
make deprecated paths
public","number":175038,"url":"https://github.com/elastic/kibana/pull/175038","mergeCommit":{"message":"[Fleet]
make deprecated paths public (#175038)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/175031\r\n\r\nMade deprecated
APIs public instead of internal, to fix the accidental\r\nbreaking
change for customers who called these APIs before (internal\r\nAPIs
don't have a default version resolution yet, so require a
version\r\nheader)\r\n\r\nOne caveat of this change is if someone
already changed their deprecated\r\nAPI call to use
'elastic-api-version: 1' in 8.11, as it would have to be\r\nchanged
again to use the public version or remove the header. Though I\r\ndon't
think we have many usages like that, since the version usage is\r\nnot
very well documented and we only got one support question about
it.","sha":"e31118abf9d3e312951f9184066242690c6a2ef5"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"8.12","label":"v8.12.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/175038","number":175038,"mergeCommit":{"message":"[Fleet]
make deprecated paths public (#175038)\n\n## Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/175031\r\n\r\nMade deprecated
APIs public instead of internal, to fix the accidental\r\nbreaking
change for customers who called these APIs before (internal\r\nAPIs
don't have a default version resolution yet, so require a
version\r\nheader)\r\n\r\nOne caveat of this change is if someone
already changed their deprecated\r\nAPI call to use
'elastic-api-version: 1' in 8.11, as it would have to be\r\nchanged
again to use the public version or remove the header. Though I\r\ndon't
think we have many usages like that, since the version usage is\r\nnot
very well documented and we only got one support question about
it.","sha":"e31118abf9d3e312951f9184066242690c6a2ef5"}}]}] BACKPORT-->

---------

Co-authored-by: Julia Bardi <90178898+juliaElastic@users.noreply.github.com>
Co-authored-by: Julia Bardi <julia.bardi@elastic.co>
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Jan 22, 2024
CoenWarmer pushed a commit to CoenWarmer/kibana that referenced this pull request Feb 15, 2024
## Summary

Closes elastic#175031

Made deprecated APIs public instead of internal, to fix the accidental
breaking change for customers who called these APIs before (internal
APIs don't have a default version resolution yet, so require a version
header)

One caveat of this change is if someone already changed their deprecated
API call to use 'elastic-api-version: 1' in 8.11, as it would have to be
changed again to use the public version or remove the header. Though I
don't think we have many usages like that, since the version usage is
not very well documented and we only got one support question about it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.12.1 v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Fleet] Deprecated internal versioned APIs not working without version header
7 participants