Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
66 commits
Select commit Hold shift + click to select a range
a5b742a
support schema tab in request body
dsuket Jun 10, 2025
b544206
add RequestExamples
dsuket Jun 10, 2025
808e9b1
refactor Examples
dsuket Jun 11, 2025
294609b
feat: refactor request and response example
dsuket Jun 11, 2025
cd478ed
refactor: change ResponseSamples to CodeSamples
dsuket Jun 11, 2025
bf1af5f
refactor: add BaseSchemaComponent
dsuket Jun 11, 2025
c4ea69d
add exmaples for schema property
dsuket Jun 12, 2025
0718462
add lib
dsuket Jun 13, 2025
a64f70a
feat: support null type
dsuket May 29, 2025
ad4b024
refactor(theme): clean up type definitions (#1172)
sserrata Jun 27, 2025
1e3ce9b
refactor: replace Map type with Record (#1173)
sserrata Jun 27, 2025
01703f0
fix types for plugin openapi (#1174)
sserrata Jun 27, 2025
42539c9
chore: add typings and remove placeholders (#1175)
sserrata Jun 27, 2025
dcd77b8
chore(demo): upgrade Docusaurus to v3.8.1 (#1176)
sserrata Jun 27, 2025
10617ba
docs: update compatibility for docusaurus 3.8.1 (#1177)
sserrata Jun 27, 2025
2931a5a
Prepare release v4.5.0 (#1178)
sserrata Jun 27, 2025
e371074
Add AGENTS guidelines (#1179)
sserrata Jun 27, 2025
b36897d
Fix Postman request initialization (#1181)
sserrata Jun 27, 2025
96e357c
Prepare release v4.5.1 (#1182)
sserrata Jun 27, 2025
902faed
docs: expand list of ignored vendor extensions (#1184)
sserrata Jun 30, 2025
21543a2
Add PR comment for visual diff (#1185)
sserrata Jun 30, 2025
74ab43b
Update deploy-preview.yml
sserrata Jun 30, 2025
dcd5600
Update sitemap-visual-diff.ts
sserrata Jun 30, 2025
23794b8
Update sitemap-visual-diff.ts
sserrata Jun 30, 2025
01e2f27
Update deploy-preview.yml
sserrata Jun 30, 2025
b2c4701
Update sitemap-visual-diff.ts
sserrata Jun 30, 2025
3414c56
Update deploy-preview.yml
sserrata Jun 30, 2025
8283f38
Update sitemap-visual-diff.ts
sserrata Jun 30, 2025
487d31e
update .gitignore
sserrata Jun 30, 2025
9559a16
Update deploy-preview.yml
sserrata Jun 30, 2025
e9f50d2
Update deploy-preview.yml
sserrata Jun 30, 2025
f6c1b62
Update deploy-preview.yml
sserrata Jun 30, 2025
be0551e
Increase visual diff concurrency (#1187)
sserrata Jul 1, 2025
0379503
Codex/create visual and html diff report (#1191)
sserrata Jul 1, 2025
f2a8905
Add allOf required spec and fix items branch (#1190)
sserrata Jul 2, 2025
7bcc38b
Update AGENTS.md
sserrata Jul 2, 2025
323f781
fix(webhooks): use event name when summary missing (#1193)
sserrata Jul 2, 2025
a6f6602
Support both curl and bash code tab highlight (#1195)
sserrata Jul 2, 2025
6fcf107
Upgrade to node v20 for build-perf and canary workflows
blindaa121 Jul 2, 2025
9c26039
Fix schema output missing when using allOf within array items (#1197)
raldred Jul 3, 2025
a30b5e0
Update GitHub Actions (#1201)
james-otten-pan Jul 8, 2025
b18b25b
Codex/update packages and run tests (#1196)
blindaa121 Jul 9, 2025
53d8526
fix: properly encode parameters (#1202)
michaelandresen Jul 9, 2025
221d2c6
Update deploy-preview.yml
sserrata Jul 14, 2025
7ad3075
docs: explain swizzling DocCard (#1207)
sserrata Jul 14, 2025
b051316
Improve error handling when spec isn't valid (#1200)
Dianoga Jul 14, 2025
5b617d8
Additional hardening measures for workflows (#1209)
sserrata Jul 16, 2025
106f987
cleanup workflow permissions and node version
sserrata Jul 16, 2025
7e43d40
Update deploy-preview.yml
sserrata Jul 16, 2025
28f9647
Add maskCredentials as a pluginOption (#1212)
Devon-White Jul 28, 2025
9754738
feat(theme): add initial i18n support (#1210)
sserrata Aug 25, 2025
c12a553
feat: translate additional labels (#1221)
sserrata Aug 27, 2025
e8fa020
Update deploy-preview.yml
sserrata Aug 28, 2025
d70ad33
Update deploy-preview.yml
sserrata Aug 28, 2025
c67bfb1
Update deploy-preview.yml
sserrata Aug 28, 2025
58d9c09
Update deploy-preview.yml
sserrata Aug 28, 2025
cfc8f74
Update deploy-preview.yml
sserrata Aug 28, 2025
1608c94
Update deploy-preview.yml
sserrata Aug 28, 2025
0df8ec5
Update deploy-live.yml
sserrata Aug 28, 2025
95cd95d
Update deploy-preview.yml
sserrata Aug 28, 2025
b242618
Update deploy-live.yml
sserrata Aug 28, 2025
6f0c307
cleanup workflows
sserrata Aug 29, 2025
4e7c164
Update deploy-live.yml
sserrata Aug 29, 2025
924fd93
refactor: use docusaurus sidebar types (#1220)
sserrata Sep 16, 2025
f0831b4
remove cache
dsuket Oct 13, 2025
396ab30
Fix bugs for allOf with nexted array items
dsuket Oct 13, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion .github/workflows/build-perf.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ on:

jobs:
build-size:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Build Size Report
timeout-minutes: 30
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
cache: yarn
- uses: preactjs/compressed-size-action@946a292cd35bd1088e0d7eb92b69d1a8d5b5d76a # v2
with:
Expand All @@ -29,9 +33,12 @@ jobs:
compression: none

build-time:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Build Time Perf
timeout-minutes: 30
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/canary-beta-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Set up Node
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
cache: yarn
- name: Prepare git
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/canary-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: Set up Node
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
cache: yarn
- name: Prepare git
run: |
Expand Down
19 changes: 16 additions & 3 deletions .github/workflows/deploy-live.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ on:

jobs:
build:
if: github.repository_owner == 'PaloAltoNetworks'
if: github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs'
name: Build
runs-on: ubuntu-latest

Expand Down Expand Up @@ -35,9 +35,12 @@ jobs:
path: build.zip

deploy:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Deploy
needs: build
runs-on: ubuntu-latest
permissions:
id-token: write

steps:
- name: Checkout repository
Expand All @@ -49,6 +52,16 @@ jobs:
node-version: "20"
cache: "yarn"

- name: Authenticate to Google Cloud
id: auth
uses: google-github-actions/auth@b7593ed2efd1c1617e1b0254da33b86225adb2a5
with:
workload_identity_provider: ${{ secrets.WIF_PROVIDER }}
service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}

- name: Export Google Cloud Credentials
run: echo "GCP_SA_KEY=$(cat ${{ steps.auth.outputs.credentials_file_path }})" >> $GITHUB_ENV

- uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
with:
name: build
Expand All @@ -58,10 +71,10 @@ jobs:

- name: Deploy to Firebase
id: deploy_live
uses: FirebaseExtended/action-hosting-deploy@0cbcac4740c2bfb00d632f0b863b57713124eb5a # v0.9.0
uses: FirebaseExtended/action-hosting-deploy@e2eda2e106cfa35cdbcf4ac9ddaf6c4756df2c8c # v0.10.0
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PANDEV }}"
firebaseServiceAccount: "${{ env.GCP_SA_KEY }}"
projectId: pandev
channelId: live
target: docusaurus-openapi.tryingpan.dev
Expand Down
85 changes: 74 additions & 11 deletions .github/workflows/deploy-preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,33 @@ name: "Deploy Preview"

on:
pull_request_target:
branches: [main, v3.0.0, v2.0.0]
branches: [main]

jobs:
precheck:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Precheck
runs-on: ubuntu-latest
permissions:
contents: read
security-events: write
outputs:
is-org-member-result: ${{ steps.is-org-member.outputs.is-org-member-result }}
steps:
- name: Check if actor is org member
id: is-org-member
run: echo "is-org-member-result=$(gh api -X GET orgs/PaloAltoNetworks/memberships/${{ github.actor }} | jq -r .message)" >> "$GITHUB_OUTPUT"
env:
GH_TOKEN: ${{ secrets.PAT }}
run: |
status=$(curl -s -o /dev/null -w "%{http_code}" -H "Authorization: Bearer $GH_TOKEN" \
https://api.github.com/orgs/PaloAltoNetworks/members/${{ github.actor }})
if [ "$status" = "204" ]; then
echo "is-org-member-result=true" >> "$GITHUB_OUTPUT"
else
echo "is-org-member-result=false" >> "$GITHUB_OUTPUT"
fi
env:
GH_TOKEN: ${{ secrets.PAT }}

analyze:
if: github.repository_owner == 'PaloAltoNetworks' && needs.precheck.outputs.is-org-member-result == 'null'
if: github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && needs.precheck.outputs.is-org-member-result == 'true'
name: Analyze
needs: precheck
runs-on: ubuntu-latest
Expand Down Expand Up @@ -49,7 +56,7 @@ jobs:
uses: github/codeql-action/analyze@1b549b9259bda1cb5ddde3b41741a82a2d15a841 # v3

analyze_unsafe:
if: github.repository_owner == 'PaloAltoNetworks' && needs.precheck.outputs.is-org-member-result != 'null'
if: github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && needs.precheck.outputs.is-org-member-result == 'false'
name: Analyze Unsafe
needs: precheck
runs-on: ubuntu-latest
Expand Down Expand Up @@ -81,7 +88,8 @@ jobs:
name: Build
needs: [analyze, analyze_unsafe]
if: |
!failure() && !cancelled() &&
github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' &&
!failure() && !cancelled() &&
(success('analyze') || success('analyze_unsafe'))
runs-on: ubuntu-latest
permissions:
Expand Down Expand Up @@ -116,8 +124,15 @@ jobs:
deploy:
name: Deploy
needs: build
if: ${{ !failure() && !cancelled() }}
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && !failure() && !cancelled() }}
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
checks: write
id-token: write
outputs:
preview_url: ${{ steps.deploy_preview.outputs.details_url }}

steps:
- name: Checkout repository
Expand All @@ -129,6 +144,16 @@ jobs:
node-version: "20"
cache: "yarn"

- name: Authenticate to Google Cloud
id: auth
uses: google-github-actions/auth@b7593ed2efd1c1617e1b0254da33b86225adb2a5
with:
workload_identity_provider: ${{ secrets.WIF_PROVIDER }}
service_account: ${{ secrets.WIF_SERVICE_ACCOUNT }}

- name: Export Google Cloud Credentials
run: echo "GCP_SA_KEY=$(cat ${{ steps.auth.outputs.credentials_file_path }})" >> $GITHUB_ENV

- uses: actions/download-artifact@95815c38cf2ff2164869cbab79da8d1f422bc89e # v4
with:
name: build
Expand All @@ -138,12 +163,50 @@ jobs:

- name: Deploy to Firebase
id: deploy_preview
uses: FirebaseExtended/action-hosting-deploy@0cbcac4740c2bfb00d632f0b863b57713124eb5a # v0.9.0
uses: FirebaseExtended/action-hosting-deploy@e2eda2e106cfa35cdbcf4ac9ddaf6c4756df2c8c # v0.10.0
with:
repoToken: "${{ secrets.GITHUB_TOKEN }}"
firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_PANDEV }}"
firebaseServiceAccount: "${{ env.GCP_SA_KEY }}"
projectId: pandev
expires: 30d
channelId: "pr${{ github.event.number }}"
env:
FIREBASE_CLI_PREVIEWS: hostingchannels

visual_diff:
name: Visual Diff
needs: deploy
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' && !failure() && !cancelled() }}
runs-on: ubuntu-latest
permissions:
contents: read

steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
with:
ref: ${{ github.event.pull_request.head.sha }}

- name: Setup node
uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "20"
cache: "yarn"

- name: Install dependencies
run: yarn --prefer-offline

- name: Install Playwright
run: npx playwright install --with-deps chromium

- name: Run visual diff
run: yarn ts-node scripts/sitemap-visual-diff.ts --preview-url ${{ needs.deploy.outputs.preview_url }} --summary-file visual_diffs/results.json --concurrency 4 --paths "/tests/"

- name: Generate report and summary
run: yarn ts-node scripts/generate-visual-diff-report.ts visual_diffs/results.json visual_diffs/index.html

- uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
if: always()
with:
name: visual_diffs
path: visual_diffs
1 change: 1 addition & 0 deletions .github/workflows/pr-title-check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ on:

jobs:
check:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Check
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-beta.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
git config user.email "github-actions[bot]@users.noreply.github.com"
- uses: actions/setup-node@7c12f8017d5436eb855f1ed4399f037a36fbd9e8 # v2
with:
node-version: "*"
node-version: "20"
registry-url: "https://registry.npmjs.org"
- name: Release Beta
run: npx ts-node --transpile-only scripts/publish-beta.ts
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
git config user.email "github-actions[bot]@users.noreply.github.com"
- uses: actions/setup-node@7c12f8017d5436eb855f1ed4399f037a36fbd9e8 # v2
with:
node-version: "*"
node-version: "20"
registry-url: "https://registry.npmjs.org"
- name: Release
run: npx ts-node --transpile-only scripts/publish.ts
Expand Down
20 changes: 16 additions & 4 deletions .github/workflows/validate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ env:

jobs:
prepare-yarn-cache:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Prepare Cache
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
- uses: actions/cache@2f8e54208210a422b2efd51efaa6bd6d7ca8920f # v3
with:
path: |
Expand All @@ -29,14 +32,17 @@ jobs:
run: yarn install --frozen-lockfile

lint:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Lint
needs: prepare-yarn-cache
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
- uses: actions/cache@2f8e54208210a422b2efd51efaa6bd6d7ca8920f # v3
with:
path: |
Expand All @@ -51,14 +57,17 @@ jobs:
run: yarn lint --max-warnings 0

test:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Test
needs: prepare-yarn-cache
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
- uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
with:
path: |
Expand All @@ -71,14 +80,17 @@ jobs:
run: yarn test

cypress:
if: ${{ github.repository == 'PaloAltoNetworks/docusaurus-openapi-docs' }}
name: Cypress
needs: prepare-yarn-cache
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4
with:
node-version: "18"
node-version: "20"
- uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4
with:
path: |
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -143,3 +143,6 @@ demo/**/versions.json

.idea
.tool-versions

# Playwright
visual_diffs/
Loading