Skip to content

Support schema property examples (extract) #1198

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 3 commits into
base: main
Choose a base branch
from

Conversation

dsuket
Copy link
Contributor

@dsuket dsuket commented Jul 7, 2025

Description

Original request : #1165 (comment)
I extracted only the handling of property examples.

Additionally, I fixed an issue where a runtime error would occur if there was no schema definition for a mediaObject.

Motivation and Context

There was an issue with property examples not being displayed. I've made it so they are now visible.

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)

Before

[before] examples in request parameters schema
before  examples in request parameters schema

[before] examples of properties in requestBody schema
before  examples of properties in requestBody schema

[before] examples of schema properties in response
before  examples of schema properties in response

After

[after] examples in request parameters schema
after  examples in request parameters schema

[after] examples of properties in requestBody schema
after  examples of properties in requestBody schema

[after] examples of schema properties in response
after  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.

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