feat(openapi): v11 #4272
Annotations
9 errors and 1 warning
|
test
Process completed with exit code 1.
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Generate Files - with meta + groupBy:
packages/openapi/test/index.test.ts#L150
Error: Snapshot `Generate documents > Generate Files - with meta + groupBy 1` mismatched
- Expected
+ Received
@@ -2,10 +2,12 @@
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -13,11 +15,11 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```json title="inventory/meta.json"
{
"title": "Inventory",
@@ -41,10 +43,12 @@
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -52,19 +56,21 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```mdx title="products/getProductDetails.mdx"
---
title: Get product details
description: Retrieve details of a product by its ID.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -72,11 +78,11 @@
- content: Retrieve details of a product by its ID.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
```
```json title="products/meta.json"
{
"title": "Products",
❯ test/index.test.ts:150:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Generate Files - with meta:
packages/openapi/test/index.test.ts#L135
Error: Snapshot `Generate documents > Generate Files - with meta 1` mismatched
- Expected
+ Received
@@ -2,10 +2,12 @@
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -13,19 +15,21 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```mdx title="getProductDetails.mdx"
---
title: Get product details
description: Retrieve details of a product by its ID.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -33,11 +37,11 @@
- content: Retrieve details of a product by its ID.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
```
```json title="meta.json"
{
"pages": [
❯ test/index.test.ts:135:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Generate Files - with index:
packages/openapi/test/index.test.ts#L121
Error: Snapshot `Generate documents > Generate Files - with index 1` mismatched
- Expected
+ Received
@@ -16,10 +16,12 @@
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -27,19 +29,21 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```mdx title="products/productid/get.mdx"
---
title: Get product details
description: Retrieve details of a product by its ID.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -47,7 +51,7 @@
- content: Retrieve details of a product by its ID.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
```
❯ test/index.test.ts:121:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Generate Files - groupBy tag per operation:
packages/openapi/test/index.test.ts#L92
Error: Snapshot `Generate documents > Generate Files - groupBy tag per operation 1` mismatched
- Expected
+ Received
@@ -2,10 +2,12 @@
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -13,19 +15,21 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```mdx title="products/inventory/productid/get.mdx"
---
title: Get product inventory
description: Retrieve inventory details for a specific product.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -33,19 +37,21 @@
- content: Retrieve inventory details for a specific product.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/inventory/{productId}","method":"get"}]} />
```
```mdx title="products/products/productid/get.mdx"
---
title: Get product details
description: Retrieve details of a product by its ID.
full: true
_openapi:
+ preload:
+ - products
method: GET
webhook: false
toc: []
structuredData:
headings: []
@@ -53,7 +59,7 @@
- content: Retrieve details of a product by its ID.
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
+ <OpenAPIPage document={"products"} operations={[{"path":"/products/{productId}","method":"get"}]} />
```
❯ test/index.test.ts:92:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Generate Files:
packages/openapi/test/index.test.ts#L64
Error: Snapshot `Generate documents > Generate Files 1` mismatched
- Expected
+ Received
@@ -4,10 +4,12 @@
description: >-
An imaginary, but delightful Museum API for interacting with museum services
and information. Built with love by Redocly.
full: true
_openapi:
+ preload:
+ - museum
toc:
- depth: 2
title: Get museum hours
url: '#get-museum-hours'
- depth: 2
@@ -72,18 +74,20 @@
heading: get-ticket-qr-code
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"museum"} webhooks={[]} operations={[{"path":"/museum-hours","method":"get"},{"path":"/special-events","method":"get"},{"path":"/special-events","method":"post"},{"path":"/special-events/{eventId}","method":"get"},{"path":"/special-events/{eventId}","method":"patch"},{"path":"/special-events/{eventId}","method":"delete"},{"path":"/tickets","method":"post"},{"path":"/tickets/{ticketId}/qr","method":"get"}]} showTitle />
+ <OpenAPIPage document={"museum"} webhooks={[]} operations={[{"path":"/museum-hours","method":"get"},{"path":"/special-events","method":"get"},{"path":"/special-events","method":"post"},{"path":"/special-events/{eventId}","method":"get"},{"path":"/special-events/{eventId}","method":"patch"},{"path":"/special-events/{eventId}","method":"delete"},{"path":"/tickets","method":"post"},{"path":"/tickets/{ticketId}/qr","method":"get"}]} showTitle />
```
```mdx title="petstore.mdx"
---
title: Swagger Petstore
full: true
_openapi:
+ preload:
+ - petstore
toc:
- depth: 2
title: List all pets
url: '#list-all-pets'
- depth: 2
@@ -103,7 +107,7 @@
contents: []
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"petstore"} webhooks={[]} operations={[{"path":"/pets","method":"get"},{"path":"/pets","method":"post"},{"path":"/pets/{petId}","method":"get"}]} showTitle />
+ <OpenAPIPage document={"petstore"} webhooks={[]} operations={[{"path":"/pets","method":"get"},{"path":"/pets","method":"post"},{"path":"/pets/{petId}","method":"get"}]} showTitle />
```
❯ test/index.test.ts:64:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Unkey (Per File):
packages/openapi/test/index.test.ts#L50
Error: Snapshot `Generate documents > Unkey (Per File) 1` mismatched
- Expected
+ Received
@@ -1,10 +1,12 @@
```mdx title="unkey.mdx"
---
title: Unkey Api
full: true
_openapi:
+ preload:
+ - unkey
toc:
- depth: 2
title: Check Liveness
url: '#check-liveness'
- depth: 2
@@ -69,7 +71,7 @@
contents: []
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"unkey"} webhooks={[]} operations={[{"path":"/v1/liveness","method":"get"},{"path":"/v1/keys.getKey","method":"get"},{"path":"/v1/keys.deleteKey","method":"post"},{"path":"/v1/keys.createKey","method":"post"},{"path":"/v1/keys.verifyKey","method":"post"},{"path":"/v1/keys.updateKey","method":"post"},{"path":"/v1/keys.updateRemaining","method":"post"},{"path":"/v1/keys.getVerifications","method":"get"},{"path":"/v1/apis.getApi","method":"get"},{"path":"/v1/apis.createApi","method":"post"},{"path":"/v1/apis.listKeys","method":"get"},{"path":"/v1/apis.deleteApi","method":"post"}]} showTitle />
+ <OpenAPIPage document={"unkey"} webhooks={[]} operations={[{"path":"/v1/liveness","method":"get"},{"path":"/v1/keys.getKey","method":"get"},{"path":"/v1/keys.deleteKey","method":"post"},{"path":"/v1/keys.createKey","method":"post"},{"path":"/v1/keys.verifyKey","method":"post"},{"path":"/v1/keys.updateKey","method":"post"},{"path":"/v1/keys.updateRemaining","method":"post"},{"path":"/v1/keys.getVerifications","method":"get"},{"path":"/v1/apis.getApi","method":"get"},{"path":"/v1/apis.createApi","method":"post"},{"path":"/v1/apis.listKeys","method":"get"},{"path":"/v1/apis.deleteApi","method":"post"}]} showTitle />
```
❯ test/index.test.ts:50:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Museum (Per Tag):
packages/openapi/test/index.test.ts#L37
Error: Snapshot `Generate documents > Museum (Per Tag) 1` mismatched
- Expected
+ Received
@@ -2,10 +2,12 @@
---
title: Events
description: Special events hosted by the Museum
full: true
_openapi:
+ preload:
+ - museum
toc:
- depth: 2
title: List special events
url: '#list-special-events'
- depth: 2
@@ -47,19 +49,21 @@
heading: delete-special-event
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"museum"} webhooks={[]} operations={[{"path":"/special-events","method":"get"},{"path":"/special-events","method":"post"},{"path":"/special-events/{eventId}","method":"get"},{"path":"/special-events/{eventId}","method":"patch"},{"path":"/special-events/{eventId}","method":"delete"}]} showTitle />
+ <OpenAPIPage document={"museum"} webhooks={[]} operations={[{"path":"/special-events","method":"get"},{"path":"/special-events","method":"post"},{"path":"/special-events/{eventId}","method":"get"},{"path":"/special-events/{eventId}","method":"patch"},{"path":"/special-events/{eventId}","method":"delete"}]} showTitle />
```
```mdx title="operations.mdx"
---
title: Operations
description: Operational information about the museum.
full: true
_openapi:
+ preload:
+ - museum
toc:
- depth: 2
title: Get museum hours
url: '#get-museum-hours'
structuredData:
@@ -71,19 +75,21 @@
heading: get-museum-hours
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"museum"} webhooks={[]} operations={[{"path":"/museum-hours","method":"get"}]} showTitle />
+ <OpenAPIPage document={"museum"} webhooks={[]} operations={[{"path":"/museum-hours","method":"get"}]} showTitle />
```
```mdx title="tickets.mdx"
---
title: Tickets
description: Museum tickets for general entrance or special events.
full: true
_openapi:
+ preload:
+ - museum
toc:
- depth: 2
title: Buy museum tickets
url: '#buy-museum-tickets'
- depth: 2
@@ -104,7 +110,7 @@
heading: get-ticket-qr-code
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"museum"} webhooks={[]} operations={[{"path":"/tickets","method":"post"},{"path":"/tickets/{ticketId}/qr","method":"get"}]} showTitle />
+ <OpenAPIPage document={"museum"} webhooks={[]} operations={[{"path":"/tickets","method":"post"},{"path":"/tickets/{ticketId}/qr","method":"get"}]} showTitle />
```
❯ test/index.test.ts:37:5
|
|
[fumadocs-openapi] test/index.test.ts > Generate documents > Pet Store (Per Operation):
packages/openapi/test/index.test.ts#L24
Error: Snapshot `Generate documents > Pet Store (Per Operation) 1` mismatched
- Expected
+ Received
```mdx title="createPets.mdx"
---
title: Create a pet
full: true
_openapi:
+ preload:
+ - petstore
method: POST
webhook: false
toc: []
structuredData:
headings: []
contents: []
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"petstore"} operations={[{"path":"/pets","method":"post"}]} />
+ <OpenAPIPage document={"petstore"} operations={[{"path":"/pets","method":"post"}]} />
```
```mdx title="listPets.mdx"
---
title: List all pets
full: true
_openapi:
+ preload:
+ - petstore
method: GET
webhook: false
toc: []
structuredData:
headings: []
contents: []
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"petstore"} operations={[{"path":"/pets","method":"get"}]} />
+ <OpenAPIPage document={"petstore"} operations={[{"path":"/pets","method":"get"}]} />
```
```mdx title="showPetById.mdx"
---
title: Info for a specific pet
full: true
_openapi:
+ preload:
+ - petstore
method: GET
webhook: false
toc: []
structuredData:
headings: []
contents: []
---
{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
- <APIPage document={"petstore"} operations={[{"path":"/pets/{petId}","method":"get"}]} />
+ <OpenAPIPage document={"petstore"} operations={[{"path":"/pets/{petId}","method":"get"}]} />
```
❯ test/index.test.ts:24:5
|
|
test
Node.js 20 actions are deprecated. The following actions are running on Node.js 20 and may not work as expected: pnpm/action-setup@v4. Actions will be forced to run with Node.js 24 by default starting June 16th, 2026. Node.js 20 will be removed from the runner on September 16th, 2026. Please check if updated versions of these actions are available that support Node.js 24. To opt into Node.js 24 now, set the FORCE_JAVASCRIPT_ACTIONS_TO_NODE24=true environment variable on the runner or in your workflow file. Once Node.js 24 becomes the default, you can temporarily opt out by setting ACTIONS_ALLOW_USE_UNSECURE_NODE_VERSION=true. For more information see: https://github.blog/changelog/2025-09-19-deprecation-of-node-20-on-github-actions-runners/
|