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

[META][AppEx - AnalyticsXP] Version all HTTP routes #157046

Closed
47 of 51 tasks
thomasneirynck opened this issue May 8, 2023 · 5 comments
Closed
47 of 51 tasks

[META][AppEx - AnalyticsXP] Version all HTTP routes #157046

thomasneirynck opened this issue May 8, 2023 · 5 comments
Assignees
Labels
impact:critical This issue should be addressed immediately due to a critical level of impact on the product. loe:x-large Extra Large Level of Effort Meta Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:Visualizations Visualization editors, elastic-charts and infrastructure

Comments

@thomasneirynck
Copy link
Contributor

thomasneirynck commented May 8, 2023

Summary

All HTTP routes need versioning.

Concretely, following changes need to be made:

  • on-board on new kibana router
  • if the route exposes saved-objects, decouple storage-model from http-model (this is a pro-forma change. A soft 1:1 relationship is expected for initial releases)
  • adopt versioning scheme
    • public routes need to follow date-based versioning scheme
    • internal routes can use ad-hoc versioning

Route list

Below is an exhausitve list of all internal and external routes.

Search

  • /internal/bsearch
  • /internal/search/{strategy}/**

File upload

  • /internal/file_upload/import
  • /internal/file_upload/index_exists
  • /internal/file_upload/time_field_range

Dashboards

  • /internal/dashboards
  • /api/kibana/dashboards/export (owned by Core)
  • /api/kibana/dashboards/import (owned by Core)

Data views

  • /internal/data_views/has_data_views
  • /api/data_views
  • /api/data_views/data_view
  • /api/data_views/data_view/**
  • /api/data_views/default
  • /api/data_views/has_user_data_view

Canvas

  • /public/canvas/zip
  • /api/canvas/custom-element/**
  • /api/canvas/es_fields Removed
  • /api/canvas/fns/
  • /api/canvas/templates
  • /api/canvas/workpad
  • /api/canvas/workpad-assets
  • /api/canvas/workpad-structures
  • /api/canvas/workpad
  • /api/canvas/workpad/{id}
  • /api/canvas/workpad/find
  • /api/canvas/workpad/import
  • /api/canvas/workpad/resolve/{id}

Graph

  • /api/graph/graphExplore
  • /api/graph/searchProxy

Controls

  • /api/kibana/controls/optionsList/{index}
  • /api/kibana/controls/optionsList/getClusterSettings

Maps

  • /api/maps/checkIsDrawingIndex
  • /api/maps/docSource
  • /api/maps
  • /api/maps/feature/{featureId}
  • /api/maps/fonts/{fontstack}/{range}
  • /api/maps/getMatchingIndexes
  • /api/maps/indexSettings
  • /api/maps/mvt/getGridTile/{z}/{x}/{y}.pbf
  • /api/maps/mvt/getTile/{z}/{x}/{y}.pbf

Saved query

  • /api/saved_query/**

Timelion

  • /api/timelion/functions
  • /api/timelion/run

Index pattern

  • /internal/index-pattern-management/preview_scripted_field
  • /internal/index-pattern-management/resolve_index/{query}
  • /api/index_pattern_field_editor/**
  • /api/index_patterns/_fields_for_wildcard
  • /api/index_patterns/default
  • /api/index_patterns/has_user_index_pattern
  • /api/index_patterns/index_pattern/**

Unified Field List

  • /api/unified_field_list/existing_fields/{dataViewId}
  • /api/unified_field_list/field_stats
@botelastic botelastic bot added the needs-team Issues missing a team label label May 8, 2023
@thomasneirynck thomasneirynck added Meta Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:Visualizations Visualization editors, elastic-charts and infrastructure Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. and removed needs-team Issues missing a team label labels May 8, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-presentation (Team:Presentation)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-visualizations @elastic/kibana-visualizations-external (Team:Visualizations)

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-data-discovery (Team:DataDiscovery)

@logeekal
Copy link
Contributor

logeekal commented Jun 5, 2023

@thomasneirynck , I am trying to learn more about how we are versioning our app, so is it possible to include the original versioning design linked in the PR? It will help to get background on that. Thanks.

@thomasneirynck thomasneirynck self-assigned this Jun 28, 2023
@thomasneirynck
Copy link
Contributor Author

Completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:critical This issue should be addressed immediately due to a critical level of impact on the product. loe:x-large Extra Large Level of Effort Meta Team:DataDiscovery Discover, search (e.g. data plugin and KQL), data views, saved searches. For ES|QL, use Team:ES|QL. Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:Visualizations Visualization editors, elastic-charts and infrastructure
Projects
None yet
Development

No branches or pull requests

4 participants