Skip to content

feat: Support schema property examples #1165

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.

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

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

dsuket
Copy link
Contributor

@dsuket dsuket commented Jun 12, 2025

Description

Support examples of schema property

Motivation and Context

To address Issue #1158, I need to organize the example-related parts.
This is the 4th(final) step toward that goal.

Please see below first.

How Has This Been Tested?

  • Pass npm run build
  • Pass npm run test
  • I went through the demo API and tests and confirmed that the examples are being displayed properly.

Screenshots (if appropriate)

example in request parameters schema

example in request parameters schema

examples in request parameters schema

examples in request parameters schema

example of properties in requestBody schema

example of properties in requestBody schema

examples of properties in requestBody schema

examples of properties in requestBody schema

example of schema properties in response

example of schema properties in response

examples of schema properties in response

examples of schema properties in response

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

@dsuket dsuket deployed to default June 12, 2025 10:25 — with GitHub Actions Active
@dsuket dsuket marked this pull request as ready for review June 13, 2025 00:50
@dsuket dsuket changed the title Support schema property examples feat: Support schema property examples Jun 13, 2025
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.

1 participant