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

OpenAPI SLO specification changes #161922

Merged
merged 11 commits into from
Jul 15, 2023
Merged

OpenAPI SLO specification changes #161922

merged 11 commits into from
Jul 15, 2023

Conversation

wandergeek
Copy link
Contributor

Summary

This PR makes a few changes to the openAPI specification for the SLO API to assist in the generation of Golang clients and models.

This PR accomplishes the following:

  • Append a suffix to all of the indicatorIDs to prevent naming conflicts in the generated client
  • Add a discriminator to the slo response so indicators can be appropriately unmarshaled.
  • Remove any OneOf that does not currently have more than one type. This can be readded once there is indeed multiple return values
  • Adds a Makefile to automate and ease specification linting/verification/bundling
  • Breaks out a summary_status schema which is used in multiple places

Rel: https://elasticco.atlassian.net/jira/software/c/projects/O11Y/issues/O11Y-236?filter=myopenissues

@wandergeek wandergeek added the Team:Observability Team label for Observability Team (for things that are handled across all of observability) label Jul 14, 2023
@wandergeek wandergeek requested a review from a team as a code owner July 14, 2023 01:36
@wandergeek wandergeek self-assigned this Jul 14, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/unified-observability (Team:Observability)

@wandergeek wandergeek mentioned this pull request Jul 14, 2023
Merged
kdelemme
kdelemme reviewed Jul 14, 2023
View reviewed changes
Copy link
Contributor

@kdelemme kdelemme left a comment

Choose a reason for hiding this comment

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

One missing indicator and one type in the the discriminator mapping, otherwise it looks good to me! Thanks for making this

x-pack/plugins/observability/docs/openapi/slo/components/schemas/slo_response.yaml Outdated Show resolved Hide resolved
x-pack/plugins/observability/docs/openapi/slo/components/schemas/slo_response.yaml Outdated Show resolved Hide resolved
x-pack/plugins/observability/docs/openapi/slo/Makefile Outdated Show resolved Hide resolved
@wandergeek wandergeek added the release_note:skip Skip the PR/issue when compiling release notes label Jul 14, 2023
@wandergeek wandergeek enabled auto-merge (squash) July 14, 2023 21:38
kdelemme
kdelemme approved these changes Jul 15, 2023
View reviewed changes
Copy link
Contributor

@kdelemme kdelemme left a comment

Choose a reason for hiding this comment

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

Just need to fix the Makefile issue, either rename or remove

@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

cc @wandergeek

@wandergeek wandergeek merged commit 2c832d6 into main Jul 15, 2023
@wandergeek wandergeek deleted the O11Y-236-slo-openapi-edits branch July 15, 2023 12:58
@kibanamachine kibanamachine added v8.10.0 backport:skip This commit does not require backporting labels Jul 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kdelemme kdelemme kdelemme approved these changes

Assignees

@wandergeek wandergeek

Labels
backport:skip This commit does not require backporting release_note:skip Skip the PR/issue when compiling release notes Team:Observability Team label for Observability Team (for things that are handled across all of observability) v8.10.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@wandergeek @elasticmachine @kibana-ci @kdelemme @kibanamachine