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.

Sign up for GitHub

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

Jump to bottom

[Docs] Add OpenAPI spec for dataviews #161279

Closed
thomasneirynck opened this issue Jul 5, 2023 · 3 comments
Closed

[Docs] Add OpenAPI spec for dataviews #161279

thomasneirynck opened this issue Jul 5, 2023 · 3 comments
Assignees
@amyjtechwriter
Labels
docs Feature:Data Views Data Views code and UI - index patterns before 8.0 impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:medium Medium Level of Effort Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Data, DataViews)

Comments

@thomasneirynck
Copy link
Contributor

thomasneirynck commented Jul 5, 2023 •
edited
Loading

Indexpattern / dataview routes (https://www.elastic.co/guide/en/kibana/current/data-views-api.html, https://www.elastic.co/guide/en/kibana/current/index-patterns-api.html) need OpenAPI specification
@thomasneirynck thomasneirynck added Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Data, DataViews) docs labels Jul 5, 2023
@thomasneirynck thomasneirynck added the impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. label Jul 5, 2023
@lcawl lcawl mentioned this issue Jul 5, 2023
Open
@mattkime
Copy link
Contributor

mattkime commented Jul 5, 2023

@thomasneirynck We consider the index_patterns endpoints to be deprecated in favor of the data_views versions. Can we skip the OpenAPI docs for index_patterns endpoints?

@thomasneirynck thomasneirynck changed the title [Docs] Add OpenAPI spec to indexpattern/dataviews [Docs] Add OpenAPI spec for dataviews Jul 6, 2023
@thomasneirynck
Copy link
Contributor Author

@mattkime , yes agreed, let's skip OpenAPI doc for index_patterns. updated the title

@davismcphee davismcphee added loe:medium Medium Level of Effort Feature:Data Views Data Views code and UI - index patterns before 8.0 labels Jul 20, 2023
@lcawl lcawl mentioned this issue Aug 9, 2023
Merged
@mattkime mattkime assigned amyjtechwriter and unassigned mattkime Aug 15, 2023
@jrodewig
Copy link
Contributor

OAS files for non-deprecated data views endpoints are now located in https://github.com/elastic/kibana/tree/main/src/plugins/data_views/docs/openapi

@lcawl is working on adding OAS files for deprecated data views endpoints with #164355

Going to close this up. Please re-open if I'm missing anything.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amyjtechwriter amyjtechwriter

Labels
docs Feature:Data Views Data Views code and UI - index patterns before 8.0 impact:high Addressing this issue will have a high level of impact on the quality/strength of our product. loe:medium Medium Level of Effort Team:DataDiscovery Discover App Team (Document Explorer, Saved Search, Surrounding documents, Data, DataViews)
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@mattkime @thomasneirynck @davismcphee @jrodewig @amyjtechwriter