Support schema property examples (extract)

[dsuket]

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 of properties in requestBody schema

[before] examples of schema properties in response

After

[after] examples in request parameters schema

[after] examples of properties in requestBody schema

[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.

[arloktev]

What do you think about adding an auto example to Response Example if examples is 1?

https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/blob/main/packages/docusaurus-plugin-openapi-docs/src/openapi/createSchemaExample.ts#L116

let { type, example, allOf, properties, items, oneOf, anyOf, examples } = schemaCopy;
if ((examples !== undefined && examples.length === 1) || example !== undefined) {
    return examples[0] || example;
}

[sserrata]

What do you think about adding an auto example to Response Example if examples is 1?

Hi @arloktev, would that be to avoid including the "auto" example if the spec already contains static examples?

[github-actions]

Visit the preview URL for this PR (updated for commit 1591b79):

https://docusaurus-openapi-36b86--pr1198-wwaf79ov.web.app

_{(expires Wed, 24 Sep 2025 14:50:12 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: bf293780ee827f578864d92193b8c2866acd459f}

[sserrata]

I extracted only the handling of property examples.

Hi @dsuket, thanks for that...although I'm not sure we're ready to include the "request schema samples" I think property examples is a good options to have.

[github-actions]

Visual Diff Summary

View Logs

Total: 77, Matches: 75, Diffs: 2, Skipped: 0

Page	Status
/tests/get-entities-by-multiple-status	diff
/tests/oneof-variations-api	diff

[sserrata]

Hi @dsuket, the functionality looks good to me but what are your thoughts on the amount of padding between the example tab and the example itself? I was thinking we should maybe reduce it but I recognize it may be coming from a tab component style.

[dsuket]

@sserrata Sorry for the late response. I've made some adjustments to the design.

• Removed the extra space at the top of the tab content.
• Spaced out the request parameters a bit to align them with the Schema.

Request Parameter:

Request Body:

How does it look now?

[sserrata]

How does it look now?

Hi @dsuket, it looks better in my opinion but I think this also changes the global styles for tabs component:

Before:

As you can see, there is no longer any padding

After: