Skip to content

#1196: Improve OAS examples for non-deprecated APIs#4148

Open
reinkrul wants to merge 1 commit intomasterfrom
feature/1196-oas-examples
Open

#1196: Improve OAS examples for non-deprecated APIs#4148
reinkrul wants to merge 1 commit intomasterfrom
feature/1196-oas-examples

Conversation

@reinkrul
Copy link
Copy Markdown
Member

@reinkrul reinkrul commented Apr 2, 2026

Fixes #1196

Summary

  • Added missing example / examples fields to properties and response bodies across all non-deprecated API specs (auth/v2, auth/iam.partial, vdr/v2, vcr/vcr_v2, discovery/v1, monitoring/v1)
  • Fixed incorrect examples (e.g. UserDetails.id was an array instead of a string; TokenResponse schema example was incomplete; ServiceActivationRequest.registrationParameters used an inline YAML string instead of a proper object)
  • Added named examples (DPoP, Bearer, pending) on TokenResponse response content blocks instead of a single schema-level example
  • Updated descriptions where the example implied a specific format that isn't required (e.g. UserDetails.id)

Test plan

  • Review rendered examples in Swagger UI / ReadTheDocs
  • Verify no YAML syntax errors (yamllint or OAS validator)

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@qltysh
Copy link
Copy Markdown

qltysh bot commented Apr 2, 2026

Qlty

Coverage Impact

⬇️ Merging this pull request will decrease total coverage on master by 0.03%.

🚦 See full report on Qlty Cloud »

🛟 Help
  • Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.

  • Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.

  • File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)

    • Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix "examples" in swagger UI

1 participant