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

[OAS] Add data views openAPI folder and first entrypoints #163444

Merged
merged 15 commits into from
Aug 10, 2023
Merged

[OAS] Add data views openAPI folder and first entrypoints #163444

merged 15 commits into from
Aug 10, 2023

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 8, 2023 •
edited
Loading

Relates to #137240, #161279

This PR drafts openAPI specifications for:

The assumption is that as we determine how/if the specifications differ for Serverless, we can create a entrypoint-serverless.yaml file and re-use as much content as possible.

@github-actions
Copy link
Contributor

github-actions bot commented Aug 8, 2023

Documentation preview:

@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • /oblt-deploy-serverless : Deploy a serverless Kibana instance using the Observability test environments.
  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl mentioned this pull request Aug 8, 2023
Open
@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs Feature:Data Views Data Views code and UI - index patterns before 8.0 backport:skip This commit does not require backporting Team:Docs labels Aug 8, 2023
@lcawl lcawl marked this pull request as ready for review August 9, 2023 15:08
@lcawl lcawl requested a review from a team as a code owner August 9, 2023 15:08
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@lcawl lcawl changed the title [OAS] Add data views openAPI folder and first entrypoint [OAS] Add data views openAPI folder and first entrypoints Aug 9, 2023
@lcawl lcawl requested a review from mattkime August 9, 2023 16:23
@lcawl lcawl mentioned this pull request Aug 9, 2023
Closed
@lcawl lcawl marked this pull request as draft August 9, 2023 19:44
@lcawl lcawl marked this pull request as ready for review August 9, 2023 19:48
@lcawl lcawl added release_note:enhancement and removed release_note:skip Skip the PR/issue when compiling release notes labels Aug 9, 2023
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

mattkime
mattkime requested changes Aug 10, 2023
View reviewed changes
Copy link
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think some portions need more detail. Send me a message if you need help finding the info

src/plugins/data_views/docs/openapi/components/schemas/create_data_view_request_object.yaml
fieldFormats:
$ref: 'fieldformats.yaml'
fields:
type: object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like this should be defined

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, those objects definitely will require more details in the long-run, but the intent of this initial PR is to just get the shape of the APIs covered and be at least as detailed as the docs, with further additions to follow as necessary.

src/plugins/data_views/docs/openapi/components/schemas/fieldattrs.yaml
@@ -0,0 +1,2 @@
type: object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could use more detail

src/plugins/data_views/docs/openapi/components/schemas/fieldformats.yaml
@@ -0,0 +1,2 @@
type: object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could use more detail

src/plugins/data_views/docs/openapi/components/schemas/runtimefieldmap.yaml
@@ -0,0 +1,2 @@
type: object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could use more detail

src/plugins/data_views/docs/openapi/components/schemas/sourcefilters.yaml
@@ -0,0 +1,2 @@
type: array
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this could use more detail

@lcawl lcawl enabled auto-merge (squash) August 10, 2023 14:51
mattkime
mattkime approved these changes Aug 10, 2023
View reviewed changes
Copy link
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs look good to me, thanks!

@lcawl lcawl merged commit 531127c into elastic:main Aug 10, 2023
@lcawl lcawl deleted the data-view-oas branch August 10, 2023 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mattkime mattkime mattkime approved these changes

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting docs Feature:Data Views Data Views code and UI - index patterns before 8.0 release_note:enhancement Team:Docs v8.10.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@lcawl @apmmachine @elasticmachine @kibana-ci @mattkime @kibanamachine