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

[Cases] Deprecate query params from the find cases API #151833

Closed
cnasikas opened this issue Feb 22, 2023 · 9 comments
Closed

[Cases] Deprecate query params from the find cases API #151833

cnasikas opened this issue Feb 22, 2023 · 9 comments
Labels
Feature:Cases Cases feature Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@cnasikas
Copy link
Member

The find cases API allows searching all case fields that are persistent in ES. This means that all fields should remain in the mapping to be indexable. If we want to remove fields from the mapping it will lead to a breaking change. For that reason, we should deprecate the following query parameters of the find cases API:

  • searchFields
  • fields
@cnasikas cnasikas added Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) Feature:Cases Cases feature labels Feb 22, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops-cases (Feature:Cases)

@lcawl
Copy link
Contributor

lcawl commented Feb 22, 2023

Just a quick reminder that if this change is implemented, the API spec ought to have "deprecated: true" added to these parameters in https://github.com/elastic/kibana/blob/main/x-pack/plugins/cases/docs/openapi/paths/s%40%7Bspaceid%7D%40api%40cases%40_find.yaml

@cnasikas
Copy link
Member Author

Thank you @lcawl! Good point.

@rudolf
Copy link
Contributor

rudolf commented Feb 27, 2023

If there's not a strong business need to have these params deprecating/removing them makes sense. But another option is to limit these to a small set of known fields if we expect users might get benefit from it.

@heespi
Copy link

heespi commented Feb 28, 2023

What is telemetry telling us about customer usage here, @cnasikas ? Rudolf´s suggested change would give us a more nuanced approach here than just deprecation

@cnasikas
Copy link
Member Author

cnasikas commented Feb 28, 2023

Hey @heespi! We do not have telemetry for the use of these specific query parameters. We have telemetry for endpoint usage in general. They or may not use the query parameters. Limiting to a small set of known fields makes sense and probably we should do it for the searchParams but still it can lead to a breaking change.

@heespi
Copy link

heespi commented Feb 28, 2023

Agreed that it could lead to a breaking change, so we should follow process. Still, it does sound like a better user experience for ,hopefully, the majority of our users.

@cnasikas
Copy link
Member Author

cnasikas commented Aug 3, 2023

searchFields got limited to title and descriptions in #162245 and the fields got removed as it was not working properly from the beginning.

@cnasikas cnasikas closed this as completed Aug 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Cases Cases feature Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

No branches or pull requests

5 participants