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

[HTTP/OAS] Add tags and summaries for saved object APIs #184184

Merged
merged 23 commits into from
Jul 8, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 23, 2024

Summary

Relates to #180056, #183935

This PR adds summaries and tags for saved object operations in the generated OpenAPI document.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -uelastic http://localhost:5601/api/oas\?pathStartsWith\=/api/saved_objects | jq > test1.json
  5. curl -s -uelastic http://localhost:5601/api/oas\?pathStartsWith\=/api/encrypted_saved_objects | jq > test2.json

The output will contain info like this:

  "paths": {
    "/api/saved_objects/{type}/{id}": {
      "get": {
        "summary": "Get a saved object",
        "tags": [
          "saved objects"
        ],

@lcawl lcawl added Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes docs v8.15.0 labels May 23, 2024
@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.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review May 24, 2024 01:51
@lcawl lcawl requested review from a team as code owners May 24, 2024 01:51
Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Great job @lcawl! Left a nit.

@kc13greiner kc13greiner self-requested a review May 24, 2024 11:50
Copy link
Contributor

@kc13greiner kc13greiner left a comment

Choose a reason for hiding this comment

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

Descriptions look good!

Just one question echoing JL's comment about routes switching to public

…/src/routes/find.ts

Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
@lcawl lcawl marked this pull request as ready for review June 4, 2024 01:40
@lcawl lcawl requested a review from a team as a code owner June 4, 2024 01:40
@lcawl lcawl changed the title [HTTP/OAS] Add descriptions for saved object APIs [HTTP/OAS] Add tags and descriptions for saved object APIs Jun 4, 2024
@lcawl lcawl marked this pull request as draft June 12, 2024 21:00
@lcawl lcawl changed the title [HTTP/OAS] Add tags and descriptions for saved object APIs [HTTP/OAS] Add tags and summaries for saved object APIs Jun 12, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Jun 12, 2024

I've split off the changes to the manually-maintained OpenAPI document in #186134 since this PR was getting overly large.

@lcawl lcawl marked this pull request as ready for review June 12, 2024 21:55
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #16 / Cloud Security Posture Test adding Cloud Security Posture Integrations CNVM CNVM AWS Clicking on Launch CloudFormation on post intall modal should lead user to Cloud Formation page

Metrics [docs]

✅ unchanged

History

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

Copy link
Contributor

@jloleysens jloleysens left a comment

Choose a reason for hiding this comment

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

Thanks updating these endpoints with summaries and main changes.


I opened this issue to do the last step of including SO APIs in our generated bundle.

@lcawl lcawl enabled auto-merge (squash) July 5, 2024 16:16
@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

Copy link
Contributor

@kc13greiner kc13greiner left a comment

Choose a reason for hiding this comment

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

LGTM!

@lcawl lcawl merged commit dddcf2e into elastic:main Jul 8, 2024
19 of 20 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Jul 8, 2024
Co-authored-by: Jean-Louis Leysens <jloleysens@gmail.com>
(cherry picked from commit dddcf2e)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.15

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

@kibanamachine
Copy link
Contributor

Looks like this PR has a backport PR but it still hasn't been merged. Please merge it ASAP to keep the branches relatively in sync.

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Aug 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport missing Added to PRs automatically when the are determined to be missing a backport. docs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants