Add missing OpenAPI examples for SLO endpoints#259859
Open
jasonrhodes wants to merge 7 commits intoelastic:mainfrom
Open
Add missing OpenAPI examples for SLO endpoints#259859jasonrhodes wants to merge 7 commits intoelastic:mainfrom
jasonrhodes wants to merge 7 commits intoelastic:mainfrom
Conversation
Adds request body and response examples to all 12 public SLO API operations, covering all 57 previously missing example entries in the OpenAPI spec. Includes realistic examples for success responses, error responses (400/401/403/404/409), and request bodies for create, update, bulk delete, bulk purge, and delete instances. Made-with: Cursor
jasonrhodes
added
the
Team:actionable-obs
Contributor
|
Pinging @elastic/actionable-obs-team (Team:actionable-obs) |
github-actions
bot
added
the
author:actionable-obs
ApprovabilityVerdict: Would Approve This PR adds OpenAPI documentation examples for SLO endpoints with no runtime code changes. All modifications are to API specification files adding example requests/responses and fixing error response descriptions. The open review comments are minor nitpicks about example data consistency. Macroscope would have approved this PR. A repo admin can enable approvability here. |
jasonrhodes
added
backport:version
elastic-vault-github-plugin-prod
bot
requested a review
from a team
as a code owner
baileycash-elastic
approved these changes
Mar 26, 2026
| summary: Forbidden | ||
| value: | ||
| statusCode: 403 | ||
| error: Unauthorized |
Contributor
There was a problem hiding this comment.
nit: should be Forbidden
Member
Author
There was a problem hiding this comment.
Good catch, not a nit!
| value: | ||
| page: 1 | ||
| perPage: 25 | ||
| total: 2 |
Contributor
There was a problem hiding this comment.
ocd: total 2 but only 1 result 😅
Member
Author
There was a problem hiding this comment.
Would total here be the total SLOs or the total number of pages available? I'm not sure
elastic-vault-github-plugin-prod
bot
requested a review
from a team
as a code owner
Made-with: Cursor
The 403_response.yaml component schema had title and error example set to 'Unauthorized' instead of 'Forbidden'. Also fixes the description on all 403 response entries in path files from 'Unauthorized response' to 'Forbidden response'. This was a pre-existing bug in the SLO OAS spec, not introduced by this PR. Made-with: Cursor
Made-with: Cursor
jasonrhodes
force-pushed
the
slo-oas-examples
branch
from
bfb2ee4 to
469684c
Compare
Contributor
💚 Build Succeeded
Metrics [docs]
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #259854
Summary
Adds missing
examplesto all 12 public SLO API operations in the hand-written OpenAPI spec, covering all 57 previously missing example entries.What was missing:
What was added:
Files changed:
x-pack/solutions/observability/plugins/slo/docs/openapi/slo/paths/bundled.jsonandbundled.yamlValidation:
swagger-cli validate entrypoint.yamlpasses@redocly/cli bundlesucceedsChecklist
release_note:*label is applied per the guidelinesRisk Matrix
Made with Cursor