Skip to content

Conversation

dsuket
Copy link
Contributor

@dsuket dsuket commented Jun 11, 2025

Description

Since there were many shared parts between createRequestExample and createResponseExample, I refactored and cleaned them up.

Motivation and Context

To address Issue #1158, I need to organize the example-related parts.
This is the first step toward that goal.

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)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
    • Refactoring

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.

Copy link

github-actions bot commented Jun 11, 2025

Visit the preview URL for this PR (updated for commit 084cf87):

https://docusaurus-openapi-36b86--pr1161-fmkdnszd.web.app

(expires Sat, 26 Jul 2025 16:36:45 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: bf293780ee827f578864d92193b8c2866acd459f

@dsuket dsuket changed the title feat: refactor request and response example refactor: refactor request and response example Jun 13, 2025
@sserrata
Copy link
Member

Thanks @dsuket, the change looks solid and helps adhere to DRY principles.

@sserrata sserrata merged commit 6981f25 into PaloAltoNetworks:main Jun 26, 2025
9 checks passed
@dsuket dsuket deleted the refactor-createExample branch October 11, 2025 08:43
dsuket added a commit to dsuket/docusaurus-openapi-docs that referenced this pull request Oct 13, 2025
fix: change label

change tab label name of anyOf/oneOf

build

feat: refactor request and response example

fix: primitive

add build

fix: Added handling for when there is no schema.

feat: Add new endpoints for allOf with nested array items and properties in OpenAPI schema

[Enhancement] Add vendor extension support for positioning sidebar items (PaloAltoNetworks#1160)

* Add support for x-position vendor extension and sorting logic

* Add position and x-position types

chore: restrict workflows to main repo (PaloAltoNetworks#1169)

docs: fix typos and tables (PaloAltoNetworks#1170)

Change the tab label of anyOf/oneOf (PaloAltoNetworks#1167)

* feat: support null type

* fix: fix tab label

refactor: refactor request and response example (PaloAltoNetworks#1161)

* feat: refactor request and response example

* fix: primitive

refactor: change ResponseSamples to CodeSamples (PaloAltoNetworks#1162)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants