docs(asm): add response body examples to all 11 operations#7
Open
dmchaledev wants to merge 1 commit into
Open
Conversation
11 of 12 operations had no example responses, leaving Swagger UI, Redoc, and code generators with blank output sections. Added realistic example payloads (using a consistent acmecorp.com tenant) to every success response — listAssets, getAsset, updateAsset, listScans, triggerScan, getScan, listVulnerabilities, getVulnerability, updateVulnerability, listTags, and createTag. https://claude.ai/code/session_013w8uLNCyB2jsGXP7NVGVJT
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
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.
Problem
11 of the 12 operations in
asm/openapi.yamlhad no example responses. This means:$refFix
Added a realistic
example:block at thecontent.application/jsonlevel for every success response across all operations, using a consistent fictional tenant (acmecorp.com) so examples tell a coherent story:listAssetsgetAssetupdateAssetlistScanstriggerScangetScanlistVulnerabilitiesgetVulnerabilityupdateVulnerabilityaccepted_risklistTagscreateTagVerification
The Spectral CI lint job will also validate the spec on this PR.
https://claude.ai/code/session_013w8uLNCyB2jsGXP7NVGVJT
Generated by Claude Code