docs(asm): add response examples and fix missing operation descriptions#17
Merged
Conversation
Every success response now includes a concrete JSON example so developers can see real-world payloads directly in the ReDoc interactive docs without needing to make a live API call first. Also adds the missing `description` fields to the `listTags` and `createTag` operations, and a `description` to the `status` filter parameter on `listScans`. https://claude.ai/code/session_019sqEu3Tq6KRU4SzxQTia3f
…mple check Spectral (as pinned, spectral-cli 6.16.0) throws "Cannot read properties of null (reading 'enum')" when an `example: null` sits under a schema using OAS 3.1 array-form `type: [string, 'null']` (introduced by the nullable-fix merge). The fields are optional/nullable, so omitting them from the example is equally valid and avoids the crash.
dmchaledev
force-pushed
the
claude/elegant-edison-td61c5
branch
from
July 19, 2026 14:31
dbf5d61 to
0a3bb4c
Compare
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
2 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.
Summary
asm/openapi.yaml. These appear as copy-pasteable example payloads in the ReDoc interactive docs, dramatically reducing time-to-first-integration for API consumers.descriptionfields onlistTagsandcreateTag(the only two operations without them), and adds adescriptionto thestatusfilter parameter inlistScans, making the spec consistent throughout.Why this matters
Before this change, the ReDoc docs showed schema structure but no concrete example values for any success response — developers had to make live API calls or reverse-engineer the schema to understand what real responses look like. After this change, every endpoint shows a realistic, copy-pasteable example JSON payload.
The examples use consistent fictional identifiers (
acmecorp.com,ast_1a2b3c4d5e6f0001, etc.) and realistic data that demonstrates each field's purpose.Test plan
spectral lint asm/openapi.yaml --ruleset spectral:oas --fail-severity warn)https://claude.ai/code/session_019sqEu3Tq6KRU4SzxQTia3f
Generated by Claude Code