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

[OAS] Support tags #184320

Merged
merged 23 commits into from
Jun 4, 2024
Merged

[OAS] Support tags #184320

merged 23 commits into from
Jun 4, 2024

Conversation

jloleysens
Copy link
Contributor

@jloleysens jloleysens commented May 27, 2024

Summary

Close #183935
Close #182649

Test

  1. Start Kibana + ES
  2. Add a tag like oas-tag:foo to a route under options.tags
  3. Generate and view OAS using command like curl -suelastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/status | jq

Should contain (note addition of "global" tags object):

  "paths": {
    "/api/status": {
      "get": {
        "summary": "Get Kibana's current status.",
        "tags": [
          "foo"
        ],
  ...
  "tags": [{ "name": "foo" }],

@jloleysens jloleysens added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc release_note:skip Skip the PR/issue when compiling release notes v8.15.0 Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels May 27, 2024
@jloleysens jloleysens self-assigned this May 27, 2024
@jloleysens jloleysens requested a review from a team as a code owner May 27, 2024 15:57
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@jloleysens jloleysens requested a review from lcawl May 27, 2024 16:13
Copy link
Contributor

@pgayvallet pgayvallet left a comment

Choose a reason for hiding this comment

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

LGTM

@jloleysens
Copy link
Contributor Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
@kbn/router-to-openapispec 0 1 +1

Total ESLint disabled count

id before after diff
@kbn/router-to-openapispec 0 1 +1

History

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

cc @jloleysens

Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

Tested output and it passes linting rules. LGTM!

@jloleysens jloleysens merged commit 5fd4795 into elastic:main Jun 4, 2024
19 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 4, 2024
@jloleysens jloleysens deleted the oas/tags branch June 4, 2024 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support tags Add operations tagging for more intentional grouping of APIs
6 participants