feat: Add schema tab in Request and Response#1164
feat: Add schema tab in Request and Response#1164dsuket wants to merge 10 commits intoPaloAltoNetworks:mainfrom
Conversation
|
Visit the preview URL for this PR (updated for commit 8ec03dc): https://docusaurus-openapi-36b86--pr1164-kv9npimt.web.app (expires Sat, 26 Jul 2025 17:23:49 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
|
Hi @dsuket, I'm not opposed to exposing request samples/example schemas, but I do wonder if it duplicates the samples we already include in the "API Explorer" panel. I also wonder about the UX noise it may introduce, especially without a direct way to enable/disable the samples. Interested in your thoughts here. |
|
@sserrata Sorry for the late reply. If so, then it is indeed displayed correctly for Media type examples. However, for schema examples, it is not displayed correctly as shown below. Therefore, I made it display in tabs for the Request, similar to the Response, as shown below. Additionally, I believe that having the Request and Response displayed consistently makes it easier to recognize. In fact, I didn't notice the REQUEST panel in the bottom right until you pointed it out. 😅 |
Adds support for the OpenAPI 3.1 schema.examples array in the API Explorer Body component. This is different from Media Type examples (which is an object with named examples) - schema.examples is an array of example values as per JSON Schema alignment in OAS 3.1. - Handle schema.examples for JSON content types - Handle schema.examples for XML content types - Add test cases for schema.examples Closes #1164 (alternative implementation)
…Networks#1269) Adds support for the OpenAPI 3.1 schema.examples array in the API Explorer Body component. This is different from Media Type examples (which is an object with named examples) - schema.examples is an array of example values as per JSON Schema alignment in OAS 3.1. - Handle schema.examples for JSON content types - Handle schema.examples for XML content types - Add test cases for schema.examples Closes PaloAltoNetworks#1164 (alternative implementation)
Description
Ensure that examples are displayed correctly when there are examples in the Media Type and Schema in the Request body and Response.
Motivation and Context
To address Issue #1158, I need to organize the example-related parts.
This is the 3rd step toward that goal.
Please see below first.
How Has This Been Tested?
npm run buildnpm run testScreenshots (if appropriate)
example of schema in requestBody
examples of schema in requestBody
example of schema in response
examples of schema in response
Types of changes
Checklist