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

Console support for REST API compatiblity #110881

Open
jakelandis opened this issue Sep 1, 2021 · 3 comments
Open

Console support for REST API compatiblity #110881

jakelandis opened this issue Sep 1, 2021 · 3 comments
Labels
enhancement New value added to drive a business result Feature:Console Dev Tools Console Feature Feature:Dev Tools Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more

Comments

@jakelandis
Copy link
Contributor

Describe the feature:

Staring in 8.0.0, Elasticsearch will support a custom header to request supporting compatible requests and responses with the prior major version (i.e. 7.x). Ideally, the dev console would be able to support this custom header. To enable compatibility per request (for JSON), the header is value is application/vnd.elasticsearch+json;compatible-with=7. This value is used instead of application/json for the Accept and the Content-Type header.

Describe a specific use case for the feature:

This likely isn't a common feature in 8.0.0 since it is opt-in (and brand new). However, this will help consumers that do opt to use REST API compatibility better align the shape of the request and response with that of their client that has this enabled. Most clients expose an all or nothing approach to sending the special header, so I would recommend that for dev console as well. For example, an option in the "Settings" to use REST API compatibility that changes which header is sent. It is safe to send this custom header to any endpoint that accepts normal JSON requests.

Unfortunately there is not a good way to differentiate which APIs will change based on enabling this header, nor is there a good way to identify the exact shape of the request/response for the prior major version.

@jakelandis jakelandis added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Sep 1, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-stack-management (Team:Stack Management)

@cjcenizal cjcenizal added Feature:Console Dev Tools Console Feature Feature:Dev Tools required-for-8.0 This work is required to be done before 8.0 lands, bc it relates to a breaking change or similar. labels Sep 1, 2021
@cjcenizal cjcenizal removed the required-for-8.0 This work is required to be done before 8.0 lands, bc it relates to a breaking change or similar. label Oct 20, 2021
@cjcenizal
Copy link
Contributor

Per Jake, the use cases for this feature are largely for troubleshooting, not primary use cases. As such, it's a non-critical feature for 8.0. Ideally we'd implement it sometime early in 8.x.

@cjcenizal cjcenizal added the enhancement New value added to drive a business result label Oct 20, 2021
@alisonelizabeth alisonelizabeth removed the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Sep 17, 2024
@botelastic botelastic bot added the needs-team Issues missing a team label label Sep 17, 2024
@alisonelizabeth alisonelizabeth added the Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more label Sep 17, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-management (Team:Kibana Management)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New value added to drive a business result Feature:Console Dev Tools Console Feature Feature:Dev Tools Team:Kibana Management Dev Tools, Index Management, Upgrade Assistant, ILM, Ingest Node Pipelines, and more
Projects
None yet
Development

No branches or pull requests

4 participants