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

[Core] [UA] Setting severity for API deprecations #199675

Open
Bamieh opened this issue Nov 11, 2024 · 2 comments
Open

[Core] [UA] Setting severity for API deprecations #199675

Bamieh opened this issue Nov 11, 2024 · 2 comments
Assignees
Labels
discuss Feature:Upgrade Assistant Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.17.0 v9.0.0

Comments

@Bamieh
Copy link
Member

Bamieh commented Nov 11, 2024

Should we be blocking upgrade critical severity api deprecations? Or should we allow that? Or should we prevent devs from setting critical severity for api deprecations.


copying comments from PR thread #199026 (comment)

JL

This actually raises something of an oversight: I don't think ever setting an internal route as deprecated was intended for this API 🤔 , although being able to set critical on it could be useful if we want to remove it and have known integrations.
My gut feel would be to remove it from the types for internal routes (versioned or non-versioned). FWIW I don't think we should block on it here.

Tina

++ internal APIs aren't supposed to be consumed externally and we can add .jsdocs to warn plugin developers that the route is deprecated.

@botelastic botelastic bot added the needs-team Issues missing a team label label Nov 11, 2024
@dmlemeshko dmlemeshko added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Nov 11, 2024
@elasticmachine
Copy link
Contributor

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

@botelastic botelastic bot removed the needs-team Issues missing a team label label Nov 11, 2024
@Bamieh Bamieh self-assigned this Nov 12, 2024
@jloleysens
Copy link
Contributor

After some discussion I think the likely path forward we settled on was:

  • Allow API deprecations to only register as warning for now
  • In future, we might enhance this by also having something like breaking so that the UI can "lift" these to user attention

Does this sound right @Bamieh ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Feature:Upgrade Assistant Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.17.0 v9.0.0
Projects
None yet
Development

No branches or pull requests

4 participants