Compare Versions - fumadocs-openapi

npm / fumadocs-openapi / Compare Versions

View on npm

From: → To:

10.8.6

Patch Changes

975b530: Add Source API methods & Dynamic Source support to OpenAPI server
Updated dependencies [768b676]
- fumadocs-core@16.8.12
- fumadocs-ui@16.8.12

10.8.5

Patch Changes

da4a81a: Bundle ajv

10.8.4

Patch Changes

e84da60: Bundle xml-js

10.8.3

Patch Changes

d4c78e4: OpenAPI: display a "Deprecated" badge for operations marked as deprecated: true in the spec, next to the operation heading and the method/path bar.
Updated dependencies [1dc86c7]
- fumadocs-core@16.8.11
- fumadocs-ui@16.8.11

10.8.1

Patch Changes

970b1bf: fix inconsistency in option names
Updated dependencies [79d3209]
- fumadocs-core@16.8.5
- fumadocs-ui@16.8.5

10.8.0

Minor Changes

cfeb2c5: Fix @scalar/api-client-react version as 2.0.2 has a breaking change

Patch Changes

Updated dependencies [3ae8809]
- fumadocs-ui@16.8.1
- fumadocs-core@16.8.1

10.7.1

Patch Changes

1ecb7ae: expose more types
- fumadocs-ui@16.7.16

10.7.0

Minor Changes

ccad791: Update min Fumadocs versions requirements

Patch Changes

Updated dependencies [e1567e2]
Updated dependencies [9a200c8]
Updated dependencies [c731a92]
Updated dependencies [ccad791]
Updated dependencies [a4189ce]
- fumadocs-core@16.7.15
- fumadocs-ui@16.7.15

10.6.8

Patch Changes

9518cc8: Reduce deps
690ddb9: bundle more deps
Updated dependencies [690ddb9]
- fumadocs-ui@16.7.13
- fumadocs-core@16.7.13
- @fumari/stf@1.0.5

10.6.7

Patch Changes

8462aa6: Support displaying response results of different mime types
Updated dependencies [5524927]
Updated dependencies [d47c4f1]
- fumadocs-core@16.7.11
- fumadocs-ui@16.7.11

10.6.6

Patch Changes

f15e322: Improve auth UI for playground
Updated dependencies [f15e322]
- @fumari/stf@1.0.4

10.6.5

Patch Changes

94a45da: workaround ajv limitations

10.6.4

Patch Changes

9b88a56: Avoid re-serialization on non-RSC mode
- fumadocs-core@16.7.10
- fumadocs-ui@16.7.10

10.6.3

Patch Changes

b9dd611: Improve pre-render layout shift
Updated dependencies [f580ef6]
- fumadocs-ui@16.7.9
- fumadocs-core@16.7.9

10.6.2

Patch Changes

9b350d7: Support sync loading components on client mode
f1962ec: [Schema UI] prefer alias name for display names
Updated dependencies [f7e69a6]
- fumadocs-ui@16.7.8
- fumadocs-core@16.7.8

10.6.1

Patch Changes

d38e641: Support forwarding pure playground cookies with proxy

10.6.0

Minor Changes

9b7b5b5: Support non-RSC environment via createClientAPIPage()

Patch Changes

b8a95e8: Improve performance
a5186a7: Support watch option
Updated dependencies [9eb3c84]
Updated dependencies [0f39a9f]
Updated dependencies [0a6507b]
- fumadocs-ui@16.7.7
- fumadocs-core@16.7.7

10.5.0

Minor Changes

0edf9ce: Support meta.json file generation

Patch Changes

Updated dependencies [6849807]
- fumadocs-ui@16.7.6
- fumadocs-core@16.7.6

10.4.1

Patch Changes

440b954: support unsetting auth fields in playground
Updated dependencies [11b8691]
Updated dependencies [75b0b94]
- fumadocs-ui@16.7.1
- fumadocs-core@16.7.1

10.4.0

Minor Changes

bdffeba: Implement i18n
1fc5549: Bump deps

Patch Changes

42bf43e: Implement newer JSON Schema spec $ref resolution behaviour
Updated dependencies [8bdee70]
Updated dependencies [bdffeba]
Updated dependencies [3d17757]
Updated dependencies [f45d703]
Updated dependencies [45aa454]
- fumadocs-ui@16.7.0
- fumadocs-core@16.7.0

10.3.18

Patch Changes

c1c954d: fix schema intersection
Updated dependencies [86d3abb]
- fumadocs-ui@16.6.15
- fumadocs-core@16.6.15

10.3.17

Patch Changes

e2e0782: Fix broken dereference-json-schema import in built output caused by unbundle + inlineOnly producing hardcoded .pnpm/ paths
Updated dependencies [d35f30c]
Updated dependencies [ae3e742]
Updated dependencies [269dfb3]
- fumadocs-core@16.6.11
- fumadocs-ui@16.6.11

10.3.15

Patch Changes

440a7ef: Fix intersection resolution
e68700e: fix parameter encoding

10.3.14

Patch Changes

53856d2: Improve dereference & TypeScript generation
5453502: use Shiki.js v4
Updated dependencies [5453502]
- fumadocs-ui@16.6.8
- fumadocs-core@16.6.8
- @fumari/stf@1.0.3

10.3.13

Patch Changes

825f401: enable Typescript definition generation for request body
146bb4b: Support code usage generator registry
Updated dependencies [8faa2e4]
- fumadocs-ui@16.6.7
- fumadocs-core@16.6.7

10.3.12

Patch Changes

fcdaa9f: better schema popover UI
a6e3b58: improve default value generation
41ac2c6: fix $ref handling in stringifier
b01665e: support lazy field reveal on playground
9013195: fix typescript schema generation
Updated dependencies [38bd784]
Updated dependencies [bd8c33a]
- fumadocs-ui@16.6.6
- @fumari/stf@1.0.2
- fumadocs-core@16.6.6

10.3.11

Patch Changes

5a9b381: Pass isRequired to FieldSet for parameter enum fields in playground, fixing required enum parameters incorrectly showing an "Unset" option.
21e60c3: support cleaning namespace information
Updated dependencies [21e60c3]
- @fumari/stf@1.0.1

10.3.10

Patch Changes

ff9e919: add unset button to non-primitive fields
Updated dependencies [fe37b9f]
Updated dependencies [fe37b9f]
- @fumari/stf@1.0.0

10.3.9

Patch Changes

5537900: allow optional parameter schema

10.3.8

Patch Changes

f5e7993: improve edge case handling
Updated dependencies [1a614de]
Updated dependencies [6ab6692]
- fumadocs-core@16.6.5
- fumadocs-ui@16.6.5

10.3.7

Patch Changes

3f8c9b0: Support OpenAPI 3.2 security scheme deprecation
Updated dependencies [8f8e7f0]
- fumadocs-ui@16.6.4
- fumadocs-core@16.6.4

10.3.6

Patch Changes

6ded66b: Improve server selector UI
Updated dependencies [1c26656]
- fumadocs-ui@16.6.3
- fumadocs-core@16.6.3

10.3.5

Patch Changes

013bba7: support servers override
Updated dependencies [9241992]
Updated dependencies [64a0057]
- fumadocs-ui@16.6.0
- fumadocs-core@16.6.0

10.3.4

Patch Changes

7872e27: fix change detector
Updated dependencies [7872e27]
Updated dependencies [1ad8a38]
Updated dependencies [3e8efb0]
- @fumari/stf@0.0.3
- fumadocs-core@16.5.4
- fumadocs-ui@16.5.4

10.3.1

Minor Changes

c03f8c3: Support /ui/base for reduced bundle size

Patch Changes

Updated dependencies [9ba1250]
- fumadocs-ui@16.5.0
- fumadocs-core@16.5.0

10.2.7

Patch Changes

eb3d763: Break long words in openapi examples
2abaff9: Improve object inputs
Updated dependencies [430a5f1]
Updated dependencies [099fde7]
Updated dependencies [6fd7e63]
- fumadocs-ui@16.4.10
- fumadocs-core@16.4.10

10.2.4

Patch Changes

e55510b: fix unknown parameter encoding
Updated dependencies [9f06196]
- fumadocs-ui@16.4.5
- fumadocs-core@16.4.5

10.2.3

Patch Changes

7e58c8e: Fix Parameter Serialization
b16a32f: Switch to tsdown for bundling
Updated dependencies [590d36a]
Updated dependencies [98d38ff]
Updated dependencies [446631d]
Updated dependencies [b16a32f]
- fumadocs-core@16.4.2
- fumadocs-ui@16.4.2

10.2.2

Patch Changes

b752aff: Add getSchema() to virtual pages
Updated dependencies [da98fe2]
Updated dependencies [a3b7919]
- fumadocs-ui@16.4.0
- fumadocs-core@16.4.0

10.2.1

Patch Changes

058a46b: Support structuredData in virtual file source
52e84ad: improve schema UI for large unions

10.1.4

Patch Changes

90ada4b: Fix example value generation for parameters

10.1.3

Patch Changes

ddeeb74: Improve error message on invalid document props
fb3440c: fix possible hydration errors
Updated dependencies [8469c6d]
Updated dependencies [7292424]
- fumadocs-ui@16.2.5
- fumadocs-core@16.2.5

10.1.2

Patch Changes

88150ae: Handle empty summary when generating display name

10.1.1

Patch Changes

25393cd: Fix duplicated security scheme name in requirements
928cc25: Fix wrong option types

10.1.0

Minor Changes

4b2a7e4: Require peer dep of Fumadocs 16.2.0
e5c9f7f: Display webhook request examples

Patch Changes

ed67af0: enhance schema generation by merging properties from extended schema properties
196d71c: support webhook badge
0e327bd: use container query
c44d999: Fix schema scope in API playgrounds
6635eb5: Improve UX
0e327bd: Improve allOf merging util
60e3324: improve description rendering
Updated dependencies [80579fd]
Updated dependencies [a9f4eda]
Updated dependencies [36eb90a]
Updated dependencies [5d65002]
Updated dependencies [9a39883]
Updated dependencies [12d3f78]
- fumadocs-ui@16.2.0
- fumadocs-core@16.2.0

10.0.11

Patch Changes

5ac448a: Improve response rendering
Updated dependencies [2e01720]
Updated dependencies [15bd183]
Updated dependencies [42ad84c]
- fumadocs-core@16.1.0
- fumadocs-ui@16.1.0

10.0.10

Patch Changes

fb3401a: Fix errors on empty callbacks
Updated dependencies [fe380da]
Updated dependencies [40d9b75]
Updated dependencies [ade44d0]
- fumadocs-core@16.0.15
- fumadocs-ui@16.0.15

10.0.9

Patch Changes

Updated dependencies [c3b8474]
- fumadocs-core@16.0.14
- fumadocs-ui@16.0.14

10.0.8

Patch Changes

Updated dependencies [88dae4d]
- fumadocs-ui@16.0.13
- fumadocs-core@16.0.13

10.0.7

Patch Changes

Updated dependencies [c5c00e9]
- fumadocs-core@16.0.12
- fumadocs-ui@16.0.12

10.0.6

Patch Changes

e792e43: hotfix recursive oneOf schema UI

10.0.5

Patch Changes

Updated dependencies [ff68f69]
Updated dependencies [00058c8]
- fumadocs-core@16.0.11
- fumadocs-ui@16.0.11

10.0.4

Patch Changes

0ada792: Enhance Schema UI to display inherited properties for oneOf.
Updated dependencies [112e8d9]
Updated dependencies [733b01e]
- fumadocs-ui@16.0.10
- fumadocs-core@16.0.10

10.0.3

Patch Changes

9a7fd08: Improve integer fields handling
Updated dependencies [2eef888]
- fumadocs-ui@16.0.9
- fumadocs-core@16.0.9

10.0.2

Patch Changes

6d0ddb9: fix unset values on number & boolean fields

10.0.1

Patch Changes

2347d33: Fix Scalar integration

10.0.0

Major Changes

ccae0ac: Rename option content.showExampleInFields to schemaUI.showExample.

87cdffa: Drop renderer & fields API

Fumadocs OpenAPI now expects per-feature customizations, dropping the old centralized renderer API.

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';

export const APIPage = createAPIPage(openapi, {
  // e.g. customise render functions
  content: {
    renderResponseTabs,
    renderAPIExampleLayout,
    renderAPIExampleUsageTabs,
  },
});

For migrating the fields option of Playground, you can use render* APIs on client configs.

// components/api-page.client.tsx
'use client';
import { defineClientConfig } from 'fumadocs-openapi/ui/client';

export default defineClientConfig({
  playground: {
    renderParameterField: (fieldName, field) => ...
  }
})

You can customise the renderers of different layouts:

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';

export const APIPage = createAPIPage(openapi, {
  content: {
    renderResponseTabs: (tabs) => <div></div>,
    renderAPIExampleLayout: ({ selector, usageTabs, responseTabs }) => (
      <div></div>
    ),
    renderAPIExampleUsageTabs: (generators) => <div></div>,
    renderPageLayout: ({ operations, webhooks }) => <div></div>,
    renderOperationLayout: (slots) => <div></div>,
    renderWebhookLayout: ({
      header,
      authSchemes,
      paremeters,
      body,
      responses,
      callbacks,
    }) => <div></div>,
  },
});

40d0fa3: Expect OpenAPI server to use generateFiles()

File generation is now part of OpenAPI server, the input field requires the server instead of string array.

Before:

import { openapi } from '@/lib/openapi';

void generateFiles({
  input: ['./products.yaml'],
  output: './content/docs',
});

After:

import { generateFiles } from 'fumadocs-openapi';
import { openapi } from '@/lib/openapi';

void generateFiles({
  input: openapi,
  output: './content/docs',
});

aa4e1ad: Redesign createOpenAPI usage

Isolate API page and API server.

Before:

// lib/openapi.ts
import { createOpenAPI } from 'fumadocs-openapi/server';
import path from 'node:path';

export const openapi = createOpenAPI({
  input: [path.resolve('./scalar.yaml')],
  proxyUrl: '/api/proxy',

  mediaAdapters: { ... },
  shikiOptions: {
    themes: {
      dark: 'vesper',
      light: 'vitesse-light',
    },
  },
});

After:

// lib/openapi.ts
import { createOpenAPI } from 'fumadocs-openapi/server';
import path from 'node:path';

export const openapi = createOpenAPI({
  input: [path.resolve('./scalar.yaml')],
  proxyUrl: '/api/proxy',
});

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';

export const APIPage = createAPIPage(openapi, {
  mediaAdapters: { ... },
  shikiOptions: {
    themes: {
      dark: 'vesper',
      light: 'vitesse-light',
    },
  },
});

Remove disablePlayground from createAPIPage(), use playground.enabled instead:

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';

export const APIPage = createAPIPage(openapi, {
  playground: {
    enabled: false,
  },
});

Support client config:

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';
import client from './api-page.client';

export const APIPage = createAPIPage(openapi, {
  client,
});

// components/api-page.client.tsx
'use client';
import { defineClientConfig } from 'fumadocs-openapi/ui/client';

export default defineClientConfig({
  playground: {
    transformAuthInputs: (inputs) => [
      ...inputs,
      {
        fieldName: 'auth.tests',
        children: <div>Tests</div>,
        defaultValue: '',
      },
    ],
  },
});

Prefer client config for adapter.client:

Forwarding client-side media adapters is also done with api-page.client.tsx:

// components/api-page.tsx
import { openapi } from '@/lib/openapi';
import { createAPIPage } from 'fumadocs-openapi/ui';
import { adapters } from './my-media-adapters';
import client from './api-page.client';

export const APIPage = createAPIPage(openapi, {
  client,
  mediaAdapters: adapters,
});

// components/api-page.client.tsx
'use client';
import { defineClientConfig } from 'fumadocs-openapi/ui/client';
import { adapters } from './my-media-adapters';

export default defineClientConfig({
  mediaAdapters: adapters,
});

Minor Changes

189028a: Add storageKeyPrefix option to isolate localStorage for multiple API instances

When using multiple createOpenAPI() instances in the same application, the server selection state would bleed between different APIs because they all shared the same storage key prefix. Set a prefix to avoid this.

Usage:
```
// components/api-page.client.tsx
'use client';
import { defineClientConfig } from 'fumadocs-openapi/ui/client';

export default defineClientConfig({
  storageKeyPrefix: 'fumadocs-openapi-custom-',
});
```

Patch Changes

c1026b8: Fix TypeScript schema wrong output.

Note: code formatting has been disabled to improve performance.
ca09b6a: Core: Support accessing MDX plugins separately at fumadocs-core/mdx-plugins/*
Updated dependencies [bc97236]
Updated dependencies [ca09b6a]
Updated dependencies [c0df2c4]
Updated dependencies [117ad86]
- fumadocs-core@16.0.8
- fumadocs-ui@16.0.8

9.7.3

Patch Changes

Updated dependencies [f97cd1e]
Updated dependencies [f7e15e2]
- fumadocs-core@16.0.7
- fumadocs-ui@16.0.7

9.7.1

Patch Changes

Updated dependencies [8221785]
- fumadocs-core@16.0.5
- fumadocs-ui@16.0.5

9.7.0

Minor Changes

ef73516: Support per: custom

9.6.5

Patch Changes

d9d73f3: Support groupBy function value
Updated dependencies [99971c7]
- fumadocs-core@16.0.4
- fumadocs-ui@16.0.4

9.6.4

Patch Changes

fumadocs-core@16.0.3
fumadocs-ui@16.0.3

9.6.3

Patch Changes

cc179fb: Generate Python objects for code examples

9.6.2

Patch Changes

Updated dependencies [d511232]
- fumadocs-core@16.0.2
- fumadocs-ui@16.0.2

9.6.1

Patch Changes

Updated dependencies [45f0c1f]
- fumadocs-core@16.0.1
- fumadocs-ui@16.0.1

9.6.0

Minor Changes

8ebd28f: Redesign schema UI to leverage CSR

Fumadocs OpenAPI now uses CSR to render recursive components, hugely reducing the size of page for highly nested JSON schemas & improve performance.
ef9737d: Add reset value button to non-required fields

Patch Changes

21fcc0b: Support content.showExampleInFields option
4a36701: avoid render-time form modifications
5210f18: Support Fumadocs 16 in peerDependencies.
Updated dependencies [1494340]
Updated dependencies [230c6bf]
Updated dependencies [851897c]
Updated dependencies [de0ce6d]
Updated dependencies [4049ccc]
Updated dependencies [0ed0ca6]
Updated dependencies [429c41a]
Updated dependencies [5210f18]
Updated dependencies [cbc93e9]
Updated dependencies [42f09c3]
Updated dependencies [55afd8a]
Updated dependencies [5966e23]
- fumadocs-ui@16.0.0
- fumadocs-core@16.0.0

9.5.0

Minor Changes

5cb199f: Support generating virtual pages for Source API

Patch Changes

Updated dependencies [ce2be59]
Updated dependencies [31b9494]
- fumadocs-core@15.8.4
- fumadocs-ui@15.8.4

9.4.1

Patch Changes

a3a14e7: Bump deps
Updated dependencies [a3a14e7]
Updated dependencies [7b0d839]
- fumadocs-core@15.8.3
- fumadocs-ui@15.8.3

9.4.0

Minor Changes

ac8e67d: OpenAPI: Custom request timeout for API playground

Patch Changes

Updated dependencies [90cf1fe]
Updated dependencies [ad9a004]
Updated dependencies [90cf1fe]
Updated dependencies [6c3bde5]
Updated dependencies [747bdbc]
- fumadocs-ui@15.8.2
- fumadocs-core@15.8.2

9.3.13

Patch Changes

f04547f: Publish plugins API on loader()
Updated dependencies [71bce86]
Updated dependencies [f04547f]
- fumadocs-core@15.8.1
- fumadocs-ui@15.8.1

9.3.12

Patch Changes

0bb67d3: Improve error message
46e76eb: Fix minItems being ignored
Updated dependencies [655bb46]
Updated dependencies [53a0635]
Updated dependencies [d1ae3e8]
Updated dependencies [6548a59]
Updated dependencies [51268ec]
Updated dependencies [51268ec]
- fumadocs-core@15.8.0
- fumadocs-ui@15.8.0

9.3.11

Patch Changes

3e7e178: OpenAPI: handle undefined description in index.md generation

9.3.10

Patch Changes

Updated dependencies [982aed6]
- fumadocs-core@15.7.13
- fumadocs-ui@15.7.13

9.3.9

Patch Changes

Updated dependencies [846b28a]
Updated dependencies [2b30315]
- fumadocs-core@15.7.12
- fumadocs-ui@15.7.12

9.3.8

Patch Changes

e37b291: Migrate to @scalar/openapi-parser@0.20.3
Updated dependencies [9304db9]
Updated dependencies [dd7338b]
- fumadocs-ui@15.7.11
- fumadocs-core@15.7.11

9.3.7

Patch Changes

0146178: include content encoding into proxied response
44a560f: Remove undefined values in generated frontmatter
Updated dependencies [c948f59]
- fumadocs-core@15.7.10
- fumadocs-ui@15.7.10

9.3.6

Patch Changes

Updated dependencies [45c7531]
Updated dependencies [d135efd]
Updated dependencies [4082acc]
Updated dependencies [4082acc]
- fumadocs-ui@15.7.9
- fumadocs-core@15.7.9

9.3.5

Patch Changes

Updated dependencies [f65778d]
Updated dependencies [ba3382f]
Updated dependencies [e4c12a3]
Updated dependencies [efba995]
Updated dependencies [bec3b36]
- fumadocs-core@15.7.8
- fumadocs-ui@15.7.8

9.3.4

Patch Changes

Updated dependencies [0b53056]
Updated dependencies [3490285]
- fumadocs-core@15.7.7
- fumadocs-ui@15.7.7

9.3.3

Patch Changes

Updated dependencies [dc6d8a0]
- fumadocs-ui@15.7.6
- fumadocs-core@15.7.6

9.3.2

Patch Changes

Updated dependencies [cedc494]
- fumadocs-core@15.7.5
- fumadocs-ui@15.7.5

9.3.1

Patch Changes

585e1b2: Enhance resolveRequestData to support query parameters in path (legacy OpenAPI behavior)
e1b61ea: Unify input id and output documents
Updated dependencies [302cdc2]
Updated dependencies [02d3453]
- fumadocs-ui@15.7.4
- fumadocs-core@15.7.4

9.3.0

Minor Changes

22371ce: Support index generation in generateFiles: create index files to link all generated pages.

Patch Changes

3d3790b: Use schema ID for anti-circular reference
Updated dependencies [f6de900]
Updated dependencies [6d97379]
Updated dependencies [e776ee5]
- fumadocs-ui@15.7.3
- fumadocs-core@15.7.3

9.2.3

Patch Changes

Updated dependencies [88b5a4e]
Updated dependencies [039b24b]
Updated dependencies [08eee2b]
- fumadocs-core@15.7.2
- fumadocs-ui@15.7.2

9.2.2

Patch Changes

Updated dependencies [195b090]
Updated dependencies [e1c84a2]
Updated dependencies [b4e6147]
- fumadocs-core@15.7.1
- fumadocs-ui@15.7.1

9.2.1

Patch Changes

2122783: Fix absolute path when input is string/array
Updated dependencies [514052e]
Updated dependencies [e254c65]
Updated dependencies [ec75601]
Updated dependencies [e785f98]
Updated dependencies [0531bf4]
Updated dependencies [50eb07f]
Updated dependencies [67df155]
Updated dependencies [b109d06]
Updated dependencies [b99cf51]
- fumadocs-core@15.7.0
- fumadocs-ui@15.7.0

9.2.0

Minor Changes

2ef7f6b: Introduce input API on createOpenAPI(), unify generateFiles()

Migration: Move the server object from lib/source to lib/openapi

import { createOpenAPI } from 'fumadocs-openapi/server';

export const openapi = createOpenAPI({
  input: ['./my-schema.json'],
});

Use the server object for generateFiles():

import { generateFiles } from 'fumadocs-openapi';
import { openapi } from '@/lib/openapi';

void generateFiles({
  input: openapi,
  output: './content/docs',
  // we recommend to enable it
  // make sure your endpoint description doesn't break MDX syntax.
  includeDescription: true,
});

Patch Changes

Updated dependencies [fe31a72]
- fumadocs-ui@15.6.12
- fumadocs-core@15.6.12

9.1.13

Patch Changes

Updated dependencies [6de6ff3]
Updated dependencies [f0b1fee]
- fumadocs-ui@15.6.11
- fumadocs-core@15.6.11

9.1.12

Patch Changes

8e3c07e: load default examples without lazy loading

9.1.11

Patch Changes

c07af6f: Support serverContext & createCodeSample for custom generateCodeSamples() function
Updated dependencies [569bc26]
Updated dependencies [817c237]
- fumadocs-core@15.6.10
- fumadocs-ui@15.6.10

9.1.10

Patch Changes

86c973d: fix(multipart): improve encode logic for multipart/form-data

9.1.9

Patch Changes

790494a: fix(ui): Allow decimal values in number inputs
04a73ea: Remove explicit form data Content-Type

9.1.8

Patch Changes

Updated dependencies [0ab2cdd]
Updated dependencies [f2b22ca]
- fumadocs-core@15.6.9
- fumadocs-ui@15.6.9

9.1.7

Patch Changes

224f259: Make Next.js dependency optional
6e29dd1: Fix Waku compatibility
- fumadocs-core@15.6.8
- fumadocs-ui@15.6.8

9.1.6

Patch Changes

Updated dependencies [e9fef34]
Updated dependencies [d4a9037]
Updated dependencies [6fa1442]
- fumadocs-ui@15.6.7
- fumadocs-core@15.6.7

9.1.5

Patch Changes

ec7b9ed: Fix request serialization stripped auth parameters
Updated dependencies [2a0b45b]
Updated dependencies [5913cc4]
Updated dependencies [1b0e9d5]
Updated dependencies [79248f6]
- fumadocs-ui@15.6.6
- fumadocs-core@15.6.6

9.1.4

Patch Changes

d449bb1: fix groupBy: route ignoring curly braces
ac33c3c: Add method option and Content-Type header to generated JavaScript code examples
Updated dependencies [658fa96]
- fumadocs-core@15.6.5
- fumadocs-ui@15.6.5

9.1.3

Patch Changes

Updated dependencies [dca17d7]
- fumadocs-ui@15.6.4
- fumadocs-core@15.6.4

9.1.2

Patch Changes

742c0a6: fix spacing issues

9.1.1

Patch Changes

dd94271: Fix handling of primitive types in anyOf/allOf
Updated dependencies [a2d7940]
- fumadocs-ui@15.6.3
- fumadocs-core@15.6.3

9.1.0

Minor Changes

b60c8ed: Support Parameter Serialization

Maybe need to update your code if you've added custom media adapters.

Patch Changes

Updated dependencies [1e50889]
Updated dependencies [353c139]
Updated dependencies [5844c6f]
- fumadocs-ui@15.6.2
- fumadocs-core@15.6.2

9.0.18

Patch Changes

ae38ed0: Fix Scalar upgrade() is somehow ignored
a35597e: Use new codeblock tab style
8f69e33: Always display collapsible for array items

9.0.17

Patch Changes

7328590: OpenAPI: Fix non-undefined values not rendering
b606d36: support custom slugify function for generate files

9.0.16

Patch Changes

Updated dependencies [1a902ff]
- fumadocs-core@15.6.1
- fumadocs-ui@15.6.1

9.0.15

Patch Changes

504ab2e: Fix minor UI bugs
Updated dependencies [d0f8a15]
Updated dependencies [84918b8]
Updated dependencies [bf15617]
Updated dependencies [f8d1709]
- fumadocs-core@15.6.0
- fumadocs-ui@15.6.0

9.0.14

Patch Changes

Updated dependencies [e9b1c9c]
Updated dependencies [d5c9b11]
Updated dependencies [0d3f76b]
- fumadocs-ui@15.5.5
- fumadocs-core@15.5.5

9.0.13

Patch Changes

Updated dependencies [4a1d3cf]
Updated dependencies [35c3c0b]
Updated dependencies [58b7596]
- fumadocs-ui@15.5.4
- fumadocs-core@15.5.4

9.0.12

Patch Changes

b1f805a: Parse body optionally in proxy

9.0.11

Patch Changes

Updated dependencies [7d1ac21]
- fumadocs-core@15.5.3
- fumadocs-ui@15.5.3

9.0.10

Patch Changes

7a45921: Add absolutePath and path properties to pages, mark file as deprecated
1b7bc4b: Add @types/react to optional peer dependency to avoid version conflict in monorepos
bc7af38: Support C# code example
250ab97: Support Java code example
Updated dependencies [b675728]
Updated dependencies [7a45921]
Updated dependencies [1b7bc4b]
Updated dependencies [82fc4c8]
- fumadocs-ui@15.5.2
- fumadocs-core@15.5.2

9.0.9

Patch Changes

201235f: Fix trailing slashes being normalized

9.0.8

Patch Changes

d435088: fix proxy clone request

9.0.7

Patch Changes

77461e5: Fix root schema manipulation with TypeScript definition generation

9.0.6

Patch Changes

99e3c95: Consistent URL resolution
Updated dependencies [b4916d2]
Updated dependencies [8738b9c]
Updated dependencies [68526ea]
Updated dependencies [a66886b]
- fumadocs-core@15.5.1
- fumadocs-ui@15.5.1

9.0.5

Patch Changes

5067efc: Improved support for all OAuth flows
Updated dependencies [50f8f7f]
Updated dependencies [589d101]
Updated dependencies [697d5b4]
- fumadocs-ui@15.5.0
- fumadocs-core@15.5.0

9.0.4

Patch Changes

9721f6f: Introduce allowedOrigins and filterRequest options to createProxy. Deprecate allowedUrls in favour of new APIs.

9.0.3

Patch Changes

5770180: Implement multiple security schemes support
d2a2d47: Skip non-required values when generating code examples
Updated dependencies [0ab6c7f]
- fumadocs-core@15.4.2
- fumadocs-ui@15.4.2

9.0.2

Patch Changes

0a90cb9: Improve auth handling
Updated dependencies [e72b7b4]
- fumadocs-ui@15.4.1
- fumadocs-core@15.4.1

9.0.1

Patch Changes

2f2ae4d: Disable schema inline on generateFiles()
951a1a4: Support overriding request/response from createProxy()
2f2ae4d: Support code samples without label
2f2ae4d: Hide internal APis since their changes are not documented

9.0.0

Major Changes

bdef238: Redesign generateFiles

This redesign will finalize the behaviour of generateFiles to make it simpler, consistent across different versions of Fumadocs OpenAPI.
- Abandoned groupByFolder, it's deprecated long time ago and can be replaced with groupBy.
- Improved type safety, groupBy is now only available with per set to operation.
- name usage changed (see below).
The name option was supposed to designate a output path for generated page. Since groupBy was introduced, name became somehow useless because its design doesn't work well with groupBy.

New name Design:

It now accepts a function:
```
generateFiles({
  input: ['./content/docs/openapi/museum.yaml'],
  output: './content/docs/openapi/(generated)',
  per: 'operation',
  name: (output, document) => {
    // page info
    output.item;
    // parsed OpenAPI schema
    document;
    return 'dir/my-file';
  },
});
```
You can set algorithm to v1 to keep the behaviour of Fumadocs OpenAPI v8:
```
generateFiles({
  input: ['./content/docs/openapi/museum.yaml'],
  output: './content/docs/openapi/(generated)',
  per: 'operation',
  name: {
    algorithm: 'v1',
  },
});
```
per: operation:

File name will be identical with your operationId if defined, otherwise fallback to endpoint path or webhook name.
```
generateFiles({
  input: ['./content/docs/openapi/museum.yaml'],
  output: './content/docs/openapi/(generated)',
  per: 'operation',
});
```
With per: operation, you can use groupBy to group pages:
- tag: {tag}/{file}
- route: {endpoint}/{method} (it will ignore the name option)
- none: {file} (default)
per: tag | file:

They are unchanged.

Minor Changes

c945b5f: Mark mediaAdapters API stable
b0c02a0: Redesign schema display UI

Patch Changes

00a81e1: Improve playground body input
1bcdc84: Fix recursive reference in anyOf/allOf/oneOf
Updated dependencies [092fd04]
Updated dependencies [1b999eb]
Updated dependencies [961b67e]
Updated dependencies [7d78bc5]
- fumadocs-ui@15.4.0
- fumadocs-core@15.4.0

8.1.12

Patch Changes

a6c909b: Removed unused devDependencies and migrated from fast-glob to tinyglobby
Updated dependencies [e0c2a92]
Updated dependencies [71fc1a5]
- fumadocs-ui@15.3.4
- fumadocs-core@15.3.4

8.1.11

Patch Changes

Updated dependencies [05b3bd9]
Updated dependencies [39bf088]
Updated dependencies [4ae7b4a]
Updated dependencies [e955a98]
- fumadocs-ui@15.3.3
- fumadocs-core@15.3.3

8.1.10

Patch Changes

623610a: Improve error message
Updated dependencies [1753cf1]
Updated dependencies [9b38baf]
Updated dependencies [8e862e5]
Updated dependencies [ac0ab12]
Updated dependencies [c25d678]
- fumadocs-ui@15.3.2
- fumadocs-core@15.3.2

8.1.9

Patch Changes

Updated dependencies [3372792]
- fumadocs-core@15.3.1
- fumadocs-ui@15.3.1

8.1.8

Patch Changes

Updated dependencies [52b5ad8]
Updated dependencies [c05dc03]
Updated dependencies [abce713]
- fumadocs-ui@15.3.0
- fumadocs-core@15.3.0

8.1.7

Patch Changes

12297de: Lazy load media adapters on client side
Updated dependencies [50db874]
Updated dependencies [79e75c3]
- fumadocs-core@15.2.15
- fumadocs-ui@15.2.15

8.1.6

Patch Changes

3e69302: Support media adapter API
Updated dependencies [6ea1718]
- fumadocs-core@15.2.14
- fumadocs-ui@15.2.14

8.1.5

Patch Changes

a7ef446: Fix empty directory detection
Updated dependencies [b433d93]
Updated dependencies [1e07ed8]
- fumadocs-ui@15.2.13
- fumadocs-core@15.2.13

8.1.4

Patch Changes

8c67955: Fix duplications with generateFiles
4b1502e: Improve response type UX
47670c8: Support more JSON schema features

8.1.3

Patch Changes

67070db: Add missing file
Updated dependencies [acff667]
Updated dependencies [b68bb51]
Updated dependencies [127e681]
- fumadocs-core@15.2.12
- fumadocs-ui@15.2.12

8.1.2

Patch Changes

2d18405: Support array type in parameters
4e62b41: Bundle lucide-react as part of library
Updated dependencies [d4d1ba7]
Updated dependencies [4e62b41]
Updated dependencies [07cd690]
- fumadocs-ui@15.2.11
- fumadocs-core@15.2.11

8.1.1

Patch Changes

4dbb7fb: tolerate array schema without items type
2625723: Fix infinite rendering on schema
bd280c8: Change generated file paths for documents

8.1.0

Minor Changes

bb515b7: Display Response in a separate section

Patch Changes

540027e: Support fumadocs-openapi/css/preset.css for Tailwind CSS

We highly recommend to use the following instead:

@import 'tailwindcss';
@import 'fumadocs-ui/css/neutral.css';
@import 'fumadocs-ui/css/preset.css';
/* do this */
@import 'fumadocs-openapi/css/preset.css';

Updated dependencies [3a5595a]
Updated dependencies [8c9fc1f]
- fumadocs-ui@15.2.10
- fumadocs-core@15.2.10

8.0.3

Patch Changes

Updated dependencies [e72af4b]
Updated dependencies [ea0f468]
Updated dependencies [7f3c30e]
- fumadocs-ui@15.2.9
- fumadocs-core@15.2.9

8.0.2

Patch Changes

Updated dependencies [4fad539]
Updated dependencies [a673ef4]
- fumadocs-ui@15.2.8
- fumadocs-core@15.2.8

8.0.1

Patch Changes

5a6bf83: fix(#1717): add number type stringify for getPathnameFromInput

8.0.0

Major Changes

ff12b53: Move APIPage to fumadocs-openapi/ui

migrate:

in your mdx-components.tsx (or where you pass MDX components):

import defaultComponents from 'fumadocs-ui/mdx';
import { APIPage } from 'fumadocs-openapi/ui';
import { openapi } from '@/lib/source';
import type { MDXComponents } from 'mdx/types';

export function getMDXComponents(components?: MDXComponents): MDXComponents {
  return {
    ...defaultComponents,
    // use this instead
    APIPage: (props) => <APIPage {...openapi.getAPIPageProps(props)} />,
    ...components,
  };
}

why: Next.js compiles the same module in different layers: route handlers, pages (which include browser bundle), and middleware (Edge Runtime). It avoids compiling React components of fumadocs-openapi twice when you reference the OpenAPI server in a route handler.

Patch Changes

24ea50d: support JSON mode for body input
b664784: support application/x-www-form-urlencoded content type
Updated dependencies [eb18da9]
Updated dependencies [085e39f]
Updated dependencies [4d50bcf]
Updated dependencies [ec85a6c]
Updated dependencies [e1a61bf]
- fumadocs-ui@15.2.7
- fumadocs-core@15.2.7

7.0.14

Patch Changes

Updated dependencies [d49f9ae]
Updated dependencies [b07e98c]
Updated dependencies [b07e98c]
Updated dependencies [3a4bd88]
- fumadocs-core@15.2.6
- fumadocs-ui@15.2.6

7.0.13

Patch Changes

4d89c13: Improve generateFiles warnings
Updated dependencies [c66ed79]
- fumadocs-core@15.2.5
- fumadocs-ui@15.2.5

7.0.12

Patch Changes

Updated dependencies [1057957]
- fumadocs-core@15.2.4
- fumadocs-ui@15.2.4

7.0.11

Patch Changes

Updated dependencies [5e4e9ec]
Updated dependencies [293178f]
- fumadocs-ui@15.2.3
- fumadocs-core@15.2.3

7.0.10

Patch Changes

Updated dependencies [0829544]
Updated dependencies [0829544]
- fumadocs-ui@15.2.2
- fumadocs-core@15.2.2

7.0.9

Patch Changes

70d7ab0: Change playground localStorage key for authorization info
- fumadocs-ui@15.2.1

7.0.8

Patch Changes

Updated dependencies [22aeafb]
- fumadocs-ui@15.2.1
- fumadocs-core@15.2.1

7.0.7

Patch Changes

c37b12a: Fix security display issues
Updated dependencies [c5af09f]
Updated dependencies [2fd325c]
Updated dependencies [a7cf4fa]
- fumadocs-ui@15.2.0
- fumadocs-core@15.2.0

7.0.6

Patch Changes

Updated dependencies [b734f92]
- fumadocs-core@15.1.3
- fumadocs-ui@15.1.3

7.0.5

Patch Changes

Updated dependencies [44d5acf]
Updated dependencies [3f580c4]
- fumadocs-ui@15.1.2
- fumadocs-core@15.1.2

7.0.4

Patch Changes

Updated dependencies [c5add28]
Updated dependencies [f3cde4f]
Updated dependencies [7c8a690]
Updated dependencies [b812457]
- fumadocs-core@15.1.1
- fumadocs-ui@15.1.1

7.0.3

Patch Changes

Updated dependencies [f491f6f]
Updated dependencies [f491f6f]
Updated dependencies [f491f6f]
- fumadocs-core@15.1.0
- fumadocs-ui@15.1.0

7.0.2

Patch Changes

30b7bd4: Fix codeblock highlight options being ignored
Updated dependencies [e7e2a2a]
- fumadocs-ui@15.0.18
- fumadocs-core@15.0.18

7.0.1

Patch Changes

Updated dependencies [b790699]
Updated dependencies [72f79cf]
- fumadocs-ui@15.0.17
- fumadocs-core@15.0.17

7.0.0

Major Changes

190ec35: Auto-update generated API example as user interact with API Playground

Minor Changes

670c179: Support cookie parameters

Patch Changes

fumadocs-core@15.0.16
fumadocs-ui@15.0.16

7.0.0-beta.0

Major Changes

Auto-update generated API example as user interact with API Playground

6.3.0

Minor Changes

70d715d: Added auto-generated comments to top of generated openapi docs files

Patch Changes

Updated dependencies [9f6d39a]
Updated dependencies [0e5e14d]
Updated dependencies [2035cb1]
- fumadocs-core@15.0.15
- fumadocs-ui@15.0.15

6.2.1

Patch Changes

Updated dependencies [37dc0a6]
Updated dependencies [796cc5e]
Updated dependencies [2cc0be5]
Updated dependencies [6bc033a]
- fumadocs-core@15.0.14
- fumadocs-ui@15.0.14

6.2.0

Minor Changes

ecf7288: Support OAuth 2.0 in-browser authorize dialog

Patch Changes

Updated dependencies [7608f4e]
Updated dependencies [89ff3ae]
Updated dependencies [16c8944]
- fumadocs-ui@15.0.13
- fumadocs-core@15.0.13

6.1.1

Patch Changes

3534a10: Move fumadocs-core highlighting utils to fumadocs-core/highlight and fumadocs-core/highlight/client
Updated dependencies [3534a10]
Updated dependencies [ecacb53]
Updated dependencies [93952db]
- fumadocs-core@15.0.12
- fumadocs-ui@15.0.12

6.1.0

Minor Changes

3d211f3: throw error, when input file is not found

Patch Changes

5730116: Improve experience to customise API Playground
Updated dependencies [886da49]
Updated dependencies [04e6c6e]
- fumadocs-ui@15.0.11
- fumadocs-core@15.0.11

6.0.11

Patch Changes

0a13c45: Support response examples
Updated dependencies [e8a3ab7]
Updated dependencies [d95c21f]
- fumadocs-ui@15.0.10
- fumadocs-core@15.0.10

6.0.10

Patch Changes

Updated dependencies [fa5b908]
- fumadocs-ui@15.0.9
- fumadocs-core@15.0.9

6.0.9

Patch Changes

Updated dependencies [8f5993b]
- fumadocs-ui@15.0.8
- fumadocs-core@15.0.8

6.0.8

Patch Changes

f118e24: Fix gaps of property components under parameters section
Updated dependencies [5deaf40]
Updated dependencies [f782c2c]
- fumadocs-core@15.0.7
- fumadocs-ui@15.0.7

6.0.7

Patch Changes

e7b6f0a: Support disablePlayground option
Updated dependencies [08236e1]
Updated dependencies [a06af26]
- fumadocs-core@15.0.6
- fumadocs-ui@15.0.6

6.0.6

Patch Changes

Updated dependencies [14b2f95]
- fumadocs-ui@15.0.5
- fumadocs-core@15.0.5

6.0.5

Patch Changes

c892bd9: fix(packages/openapi): hide AuthSection is security is an empty array
cd894b1: Feat: support multiple examples in openapi operation #1370

Adds two new options to the ApiExample renderer "Samples" and "Sample"
Updated dependencies [c892bd9]
Updated dependencies [c892bd9]
- fumadocs-ui@15.0.4
- fumadocs-core@15.0.4

6.0.4

Patch Changes

f3ccad2: fix: openapi - preserve <> placeholder marker for params with no example value
ff9bf0f: Fix: Hide the server select panel, not just the select, if no or only one server is present
Updated dependencies [47171db]
- fumadocs-ui@15.0.3
- fumadocs-core@15.0.3

6.0.3

Patch Changes

a8e9e1f: Bump deps
ab44e05: Add file extensions to imports
Updated dependencies [a8e9e1f]
- fumadocs-ui@15.0.2
- fumadocs-core@15.0.2

6.0.2

Patch Changes

a127dc4: Move to tsc for building package
Updated dependencies [421166a]
- fumadocs-ui@15.0.1
- fumadocs-core@15.0.1

6.0.1

Patch Changes

127d9df: Fix type errors

6.0.0

Major Changes

1286a04: Change interface for useScalar

From:

import { createOpenAPI } from 'fumadocs-openapi/server';
import { APIPlayground } from 'fumadocs-openapi/scalar';

export const openapi = createOpenAPI({
  useScalar: true,
});

To:

import { createOpenAPI } from 'fumadocs-openapi/server';
import { APIPlayground } from 'fumadocs-openapi/scalar';

export const openapi = createOpenAPI({
  renderer: {
    APIPlayground,
  },
});

Minor Changes

9e02460: Add built-in UI to basic auth input (username:password)

5.12.0

Minor Changes

471478b: Support useScalar option

Patch Changes

983b8a6: Use path of operation when id is not defined
Updated dependencies [5b8cca8]
Updated dependencies [a89d6e0]
Updated dependencies [a84f37a]
Updated dependencies [f2f9c3d]
Updated dependencies [a763058]
Updated dependencies [581f4a5]
- fumadocs-core@15.0.0
- fumadocs-ui@15.0.0

5.11.8

Patch Changes

Updated dependencies [4f2538a]
Updated dependencies [191012a]
Updated dependencies [fb6b168]
- fumadocs-ui@14.7.7
- fumadocs-core@14.7.7

5.11.7

Patch Changes

b9601fb: Update Shiki
Updated dependencies [b9601fb]
- fumadocs-core@14.7.6
- fumadocs-ui@14.7.6

5.11.6

Patch Changes

Updated dependencies [5d41bf1]
Updated dependencies [777188b]
Updated dependencies [900eb6c]
Updated dependencies [a959374]
- fumadocs-ui@14.7.5
- fumadocs-core@14.7.5

5.11.5

Patch Changes

Updated dependencies [26d9ccb]
Updated dependencies [036f8e1]
Updated dependencies [bb73a72]
Updated dependencies [69bd4fe]
- fumadocs-ui@14.7.4
- fumadocs-core@14.7.4

5.11.4

Patch Changes

056ab2c: Add showResponseSchema option to show the full response schema
Updated dependencies [041f230]
Updated dependencies [ca1cf19]
- fumadocs-core@14.7.3
- fumadocs-ui@14.7.3

5.11.3

Patch Changes

35a12cd: Add code sample generation support for variable url

5.11.2

Patch Changes

60fe635: Support variable server url
Updated dependencies [14b280c]
- fumadocs-core@14.7.2
- fumadocs-ui@14.7.2

5.11.1

Patch Changes

Updated dependencies [72dc093]
Updated dependencies [18b00c1]
- fumadocs-core@14.7.1
- fumadocs-ui@14.7.1

5.11.0

Minor Changes

0e8be0e: Support XML request body

Patch Changes

698b385: Fix switcher default value being ignored
Updated dependencies [a557bb4]
Updated dependencies [97ed36c]
- fumadocs-ui@14.7.0
- fumadocs-core@14.7.0

5.10.6

Patch Changes

Updated dependencies [e95be52]
Updated dependencies [f3298ea]
- fumadocs-ui@14.6.8
- fumadocs-core@14.6.8

5.10.5

Patch Changes

Updated dependencies [5474343]
- fumadocs-core@14.6.7
- fumadocs-ui@14.6.7

5.10.4

Patch Changes

Updated dependencies [9c930ea]
- fumadocs-ui@14.6.6
- fumadocs-core@14.6.6

5.10.3

Patch Changes

Updated dependencies [969da26]
- fumadocs-core@14.6.5
- fumadocs-ui@14.6.5

5.10.2

Patch Changes

Updated dependencies [b71064a]
Updated dependencies [67124b1]
Updated dependencies [1810868]
- fumadocs-core@14.6.4
- fumadocs-ui@14.6.4

5.10.1

Patch Changes

Updated dependencies [abc3677]
- fumadocs-ui@14.6.3
- fumadocs-core@14.6.3

5.10.0

Minor Changes

8aff7f4: Support Route Handler Proxy

Patch Changes

1a2597a: Expose --fd-tocnav-height CSS variable
Updated dependencies [9908922]
Updated dependencies [2357d40]
Updated dependencies [ece734f]
Updated dependencies [1a2597a]
- fumadocs-ui@14.6.2
- fumadocs-core@14.6.2

5.9.0

Minor Changes

ec5fb2e: Replace @apidevtools/json-schema-ref-parser with @scalar/openapi-parser

Patch Changes

Updated dependencies [9532855]
- fumadocs-ui@14.6.1
- fumadocs-core@14.6.1

5.8.2

Patch Changes

4766292: Support React 19
Updated dependencies [010da9e]
Updated dependencies [bebb16b]
Updated dependencies [9585561]
Updated dependencies [4dfde6b]
Updated dependencies [bebb16b]
Updated dependencies [4766292]
Updated dependencies [050b326]
- fumadocs-ui@14.6.0
- fumadocs-core@14.6.0

5.8.1

Patch Changes

Updated dependencies [b7745f4]
Updated dependencies [9a18c14]
- fumadocs-ui@14.5.6
- fumadocs-core@14.5.6

5.8.0

Minor Changes

2d0501f: Support webhooks & callbacks
2d0501f: Support OpenAPI 3.1

Patch Changes

Updated dependencies [06f66d8]
Updated dependencies [2d0501f]
- fumadocs-ui@14.5.5
- fumadocs-core@14.5.5

5.7.5

Patch Changes

Updated dependencies [8e2cb31]
- fumadocs-ui@14.5.4
- fumadocs-core@14.5.4

5.7.4

Patch Changes

Updated dependencies [c5a5ba0]
Updated dependencies [f34e895]
Updated dependencies [4c82a3d]
Updated dependencies [f8e5157]
Updated dependencies [ad00dd3]
- fumadocs-ui@14.5.3
- fumadocs-core@14.5.3

5.7.3

Patch Changes

Updated dependencies [072e349]
- fumadocs-ui@14.5.2
- fumadocs-core@14.5.2

5.7.2

Patch Changes

Updated dependencies [6fd480f]
- fumadocs-ui@14.5.1
- fumadocs-core@14.5.1

5.7.1

Patch Changes

Updated dependencies [66c70ec]
Updated dependencies [05d224c]
- fumadocs-ui@14.5.0
- fumadocs-core@14.5.0

5.7.0

Minor Changes

c66df64: OpenAPI: Display the server selector only when more than one server is defined in the OpenAPI schema OpenAPI: Improve APIInfo position for better visibility on smaller screens

5.6.2

Patch Changes

Updated dependencies [0f1603a]
- fumadocs-ui@14.4.2
- fumadocs-core@14.4.2

5.6.1

Patch Changes

Updated dependencies [07474cb]
Updated dependencies [48a2c15]
- fumadocs-ui@14.4.1
- fumadocs-core@14.4.1

5.6.0

Minor Changes

196b78b: OpenAPI: Server selector to allow interacting with different API environments

5.5.11

Patch Changes

47fc20e: Fix custom name in apiKey type authorization being ignored

5.5.10

Patch Changes

Updated dependencies [5fd4e2f]
Updated dependencies [5fd4e2f]
Updated dependencies [5145123]
Updated dependencies [64defe0]
Updated dependencies [8a3f5b0]
- fumadocs-ui@14.4.0
- fumadocs-core@14.4.0

5.5.9

Patch Changes

Updated dependencies [e7443d7]
- fumadocs-ui@14.3.1
- fumadocs-core@14.3.1

5.5.8

Patch Changes

4e76165: Fix rendering of OpenAPI nullable defined with allOf.
Updated dependencies [80655b3]
Updated dependencies [b8a12ed]
- fumadocs-ui@14.3.0
- fumadocs-core@14.3.0

5.5.7

Patch Changes

Updated dependencies [ca94bfd]
Updated dependencies [2949da3]
- fumadocs-core@14.2.1
- fumadocs-ui@14.2.1

5.5.6

Patch Changes

Updated dependencies [e248a0f]
Updated dependencies [7a5393b]
- fumadocs-core@14.2.0
- fumadocs-ui@14.2.0

5.5.5

Patch Changes

Updated dependencies [1573d63]
- fumadocs-core@14.1.1
- fumadocs-ui@14.1.1

5.5.3

Patch Changes

35695be: Support multiple tags in OpenAPI groupBy: tag file generation

5.5.1

Patch Changes

Updated dependencies [1a7d78a]
- fumadocs-ui@14.0.1
- fumadocs-core@14.0.1

5.5.0

Minor Changes

129923e: Support custom shiki options
160e52e: Support disableCache prop on APIPage

Patch Changes

61a3d14: Support x-displayName on tags
e612f2a: Make compatible with Next.js 15
8a32f79: Fix header name in code samples
be820c4: Bump deps
42c9701: Fix TypeScript schema generation
Updated dependencies [e45bc67]
Updated dependencies [34cf456]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [f949520]
Updated dependencies [ad47fd8]
Updated dependencies [9a0b09f]
Updated dependencies [9a0b09f]
Updated dependencies [d9e908e]
Updated dependencies [367f4c3]
Updated dependencies [87063eb]
Updated dependencies [367f4c3]
Updated dependencies [64f0653]
Updated dependencies [e1ee822]
Updated dependencies [d9e908e]
Updated dependencies [d9e908e]
Updated dependencies [e612f2a]
Updated dependencies [3d0369a]
Updated dependencies [9a0b09f]
Updated dependencies [d9e908e]
Updated dependencies [9a10262]
Updated dependencies [d9e908e]
Updated dependencies [3d054a8]
Updated dependencies [8ef00dc]
Updated dependencies [979e301]
Updated dependencies [d9e908e]
Updated dependencies [979e301]
Updated dependencies [15781f0]
Updated dependencies [be820c4]
Updated dependencies [be53a0e]
Updated dependencies [d9e908e]
- fumadocs-core@14.0.0
- fumadocs-ui@14.0.0

5.4.14

Patch Changes

Updated dependencies [6231ad3]
Updated dependencies [4cb74d5]
- fumadocs-core@13.4.10
- fumadocs-ui@13.4.10

5.4.13

Patch Changes

Updated dependencies [083f04a]
Updated dependencies [bcf51a6]
- fumadocs-core@13.4.9
- fumadocs-ui@13.4.9

5.4.12

Patch Changes

Updated dependencies [5581733]
Updated dependencies [78e59e7]
Updated dependencies [1a327cc]
- fumadocs-ui@13.4.8
- fumadocs-core@13.4.8

5.4.11

Patch Changes

Updated dependencies [6e1923e]
Updated dependencies [6e1923e]
Updated dependencies [6e1923e]
- fumadocs-core@13.4.7
- fumadocs-ui@13.4.7

5.4.10

Patch Changes

Updated dependencies [b33aff0]
Updated dependencies [afb697e]
Updated dependencies [6bcd263]
Updated dependencies [daa66d2]
- fumadocs-ui@13.4.6
- fumadocs-core@13.4.6

5.4.9

Patch Changes

5bca46f: Support removing all code samples
Updated dependencies [d46a3f1]
- fumadocs-ui@13.4.5
- fumadocs-core@13.4.5

5.4.8

Patch Changes

Updated dependencies [729928e]
- fumadocs-core@13.4.4
- fumadocs-ui@13.4.4

5.4.7

Patch Changes

fumadocs-core@13.4.3
fumadocs-ui@13.4.3

5.4.6

Patch Changes

0cff470: Enable group id on tabs by default
0c251e5: Bump deps
Updated dependencies [7dabbc1]
Updated dependencies [0c251e5]
Updated dependencies [3b56170]
Updated dependencies [0c251e5]
Updated dependencies [0c251e5]
- fumadocs-core@13.4.2
- fumadocs-ui@13.4.2

5.4.5

Patch Changes

Updated dependencies [95dbba1]
- fumadocs-core@13.4.1
- fumadocs-ui@13.4.1

5.4.4

Patch Changes

Updated dependencies [26f5360]
- fumadocs-ui@13.4.0
- fumadocs-core@13.4.0

5.4.3

Patch Changes

Updated dependencies [f8cc167]
- fumadocs-core@13.3.3
- fumadocs-ui@13.3.3

5.4.2

Patch Changes

3d1ec96: Improve schema fields margins

5.4.1

Patch Changes

029a156: Fix display on property components
eb922e1: Support adding description to generated document body

5.4.0

Minor Changes

6cf5535: Persist authorization field

5.3.2

Patch Changes

0b93a31: Support required in allOf schemas

5.3.1

Patch Changes

5660e1e: Fix allOf schema display problem
28bb673: Fix fields styles

5.3.0

Minor Changes

3fa2436: Support Python code sample

Patch Changes

3e4627a: Show required label on body parameters
10f6f39: Fix common parameters
Updated dependencies [17746a6]
Updated dependencies [0e0ef8c]
- fumadocs-ui@13.3.2
- fumadocs-core@13.3.2

5.2.2

Patch Changes

Updated dependencies [7258c4b]
- fumadocs-ui@13.3.1
- fumadocs-core@13.3.1

5.2.1

Patch Changes

81d0887: Support disabling code sample with undefined source
Updated dependencies [8f5b19e]
Updated dependencies [4916f84]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [fd46eb6]
Updated dependencies [32ca37a]
Updated dependencies [9aae448]
Updated dependencies [c542561]
- fumadocs-ui@13.3.0
- fumadocs-core@13.3.0

5.2.0

Minor Changes

70172f1: Change default value of per to operation

Patch Changes

61b91fa: Improve Fumadocs OpenAPI support
Updated dependencies [36b771b]
Updated dependencies [61b91fa]
- fumadocs-core@13.2.2
- fumadocs-ui@13.2.2

5.1.0

Minor Changes

c7aa090: Generate document field on output MDX files

Patch Changes

Updated dependencies [17fa173]
- fumadocs-core@13.2.1
- fumadocs-ui@13.2.1

5.0.3

Patch Changes

96c9dda: Change Heading scroll margins
c094fef: Fix compatibility issues on other content sources
Updated dependencies [96c9dda]
Updated dependencies [ba588a2]
Updated dependencies [96c9dda]
Updated dependencies [ec983a3]
- fumadocs-core@13.2.0
- fumadocs-ui@13.2.0

5.0.2

Patch Changes

22549cd: Add authorization properties to examples

5.0.1

Patch Changes

444af27: Fix self-referencing schema types
90af678: Reduce initial loaded bundle size

5.0.0

Major Changes

971817c: Migrate to React Server Component

The API reference page is now a server component. The MDX generator will only generate a small MDX file, and the rest will be handled by our APIPage component.
```
---
title: Delete Api
full: true
method: POST
route: /v1/apis.deleteApi
---

<APIPage
  operations={[{ path: '/v1/apis.deleteApi', method: 'post' }]}
  hasHead={false}
/>
```
- Markdown/MDX content is still supported, but will be processed in the server component (during runtime) instead.
- Your Remark/Rehype plugins (e.g. Rehype Code) configured in Fumadocs MDX or other source providers, will not be shared. Fumadocs OpenAPI uses a separate MDX processor instance.
- APIPage component will fetch the OpenAPI Schema when being rendered. On Vercel, if it relies on the file system, ensure the page will not be re-rendered after build.
Please refer to documentation for the new usage.

Minor Changes

480d211: Change output path logic
4bf9851: Support to group pages by tags
3874ab5: Support Go Sample Request
3874ab5: Replace Response Table of Tabs

Patch Changes

4bf9851: Improve Curl example generator
Updated dependencies [f280191]
Updated dependencies [61ef42c]
Updated dependencies [deae4dd]
Updated dependencies [c8910c4]
Updated dependencies [c8910c4]
Updated dependencies [6c42960]
- fumadocs-core@13.1.0
- fumadocs-ui@13.1.0

4.4.2

Patch Changes

Updated dependencies [37bbfff]
Updated dependencies [e7c52f2]
- fumadocs-core@13.0.7
- fumadocs-ui@13.0.7

4.4.1

Patch Changes

Updated dependencies [1622e36]
- fumadocs-ui@13.0.6
- fumadocs-core@13.0.6

4.4.0

Minor Changes

b109e44: Improve generated sample requests

Patch Changes

Updated dependencies [2cf65f6]
- fumadocs-core@13.0.5
- fumadocs-ui@13.0.5

4.3.1

Patch Changes

d987912: Show current request pathname in Playground
0146572: Fix empty params

4.3.0

Minor Changes

5acebdd: Support grouping output by folders (per operation)
744bd24: Support accessing context information on custom frontmatter
6bb9d2d: Support integration with Fumadocs Source API

Patch Changes

744bd24: Fix generate files on operation mode
Updated dependencies [5355391]
- fumadocs-core@13.0.4
- fumadocs-ui@13.0.4

4.2.2

Patch Changes

Updated dependencies [978342f]
- fumadocs-core@13.0.3
- fumadocs-ui@13.0.3

4.2.1

Patch Changes

Updated dependencies [4819820]
- fumadocs-core@13.0.2
- fumadocs-ui@13.0.2

4.2.0

Minor Changes

dfcc61f: Implement multipart form data

Patch Changes

f2b540a: Fix fetch problems on API Playground

4.1.1

Patch Changes

fumadocs-core@13.0.1
fumadocs-ui@13.0.1

4.1.0

Minor Changes

abf84bb: Support to customise/disable TypeScript Response generation
40728a1: Support custom fields (auth, query, header, path and body)

Patch Changes

Updated dependencies [89190ae]
Updated dependencies [b02eebf]
Updated dependencies [09c3103]
Updated dependencies [f868018]
Updated dependencies [8aebeab]
Updated dependencies [c684c00]
Updated dependencies [8aebeab]
Updated dependencies [0377bb4]
Updated dependencies [e8e6a17]
Updated dependencies [c8964d3]
Updated dependencies [c901e6b]
Updated dependencies [daa7d3c]
Updated dependencies [c714eaa]
Updated dependencies [89190ae]
Updated dependencies [b02eebf]
Updated dependencies [b02eebf]
Updated dependencies [4373231]
- fumadocs-ui@13.0.0
- fumadocs-core@13.0.0

4.0.6

Patch Changes

Updated dependencies [a332bee]
- fumadocs-ui@12.5.6
- fumadocs-core@12.5.6

4.0.5

Patch Changes

Updated dependencies [3519e6c]
- fumadocs-ui@12.5.5
- fumadocs-core@12.5.5

4.0.4

Patch Changes

Updated dependencies [fccdfdb]
Updated dependencies [2ffd5ea]
- fumadocs-core@12.5.4
- fumadocs-ui@12.5.4

4.0.3

Patch Changes

Updated dependencies [5d963f4]
- fumadocs-ui@12.5.3

4.0.2

Patch Changes

0c8eddf: Fix overlap of navbar and api info
Updated dependencies [a5c34f0]
- fumadocs-ui@12.5.2

4.0.1

Patch Changes

Updated dependencies [c5d20d0]
Updated dependencies [3d8f6cf]
- fumadocs-ui@12.5.1

4.0.0

Major Changes

ad143e1: Move UI implementation from fumadocs-ui to fumadocs-openapi.

why: Allow a better organization of packages.

migrate:

This package is now Tailwind CSS only, you need to use it in conjunction with the official Tailwind CSS plugin.

Add the package to content under your Tailwind CSS configuration.
```
import { createPreset, presets } from 'fumadocs-ui/tailwind-plugin';

/** @type {import('tailwindcss').Config} */
export default {
  content: [
    './node_modules/fumadocs-ui/dist/**/*.js',
    './node_modules/fumadocs-openapi/dist/**/*.js',
  ],
  presets: [createPreset()],
};
```
Re-generate MDX files if needed.

Minor Changes

ad143e1: Implement OpenAPI playground
ad143e1: Support passing base url to Root component

Patch Changes

ad143e1: Combine allOf into one object schema
Updated dependencies [b9fa99d]
Updated dependencies [a4bcaa7]
Updated dependencies [d1c7405]
- fumadocs-ui@12.5.0

3.3.0

Minor Changes

b1b154e: Display object types mentioned in schema
81fde3f: Support complex types & self-referencing types

3.2.0

Minor Changes

0e420cb: Support generating custom code examples

3.1.3

Patch Changes

464e44c: Improve example request URL generation

3.1.2

Patch Changes

78acd55: Use full mode on docs pages by default on OpenAPI generated pages

3.1.1

Patch Changes

318eaf9: Support generating files per operation

3.1.0

Minor Changes

3bdc786: Support JavaScript request example
3bdc786: Support generating Authorization (security) section

3.0.0

Major Changes

284a571: Renew Generate API.

why: Improve flexibility.

migrate:

Removed the render option from generate, generateFiles and generateTags, use frontmatter to customise frontmatter, imports to customise imports.

284a571: Support Custom MDX Renderer.

why: Allow people to customise how the MDX file is generated.

migrate:

Changed the output of MDX files, the new structure requires components:

Root
API
APIInfo
APIExample
Responses
Response
ExampleResponse
TypeScriptResponse
Property
ObjectCollapsible
ResponseTypes

<API>

<APIInfo method={"GET"} route={"/pets/{petId}"}>

## Info for a specific pet

### Path Parameters

<Property name={"petId"} type={"string"} required={true} deprecated={false}>

The id of the pet to retrieve

</Property>

| Status code | Description                          |
| ----------- | ------------------------------------ |
| `200`       | Expected response to a valid request |
| `default`   | unexpected error                     |

</APIInfo>

<APIExample>

```bash title="curl"
curl -X GET "http://petstore.swagger.io/pets/string"
```

<Responses items={["200","default"]}>

<Response value={"200"}>

<ResponseTypes>

<ExampleResponse>

```json
{
  "id": 0,
  "name": "string",
  "tag": "string"
}
```

</ExampleResponse>

<TypeScriptResponse>

```ts
export interface Response {
  id: number;
  name: string;
  tag?: string;
}
```

</TypeScriptResponse>

</ResponseTypes>

</Responses>

</APIExample>

</API>

2.0.5

Patch Changes

bcc05d6: Fix docs typo

2.0.4

Patch Changes

310e0ab: Fix multi-line frontmatter

2.0.3

Patch Changes

1d3917f: Fix nullable types cannot be detected

2.0.2

Patch Changes

9681cc3: Add put method key

2.0.1

Patch Changes

8ef2b68: Bump deps

2.0.0

Major Changes

eacd7b0b: Remove support for bin usages

why: It is more flexible and faster to write a script directly.

migrate: Create a script named scripts/generate-docs.mjs:
```
import { generateFiles } from 'fumadocs-openapi';

void generateFiles({
  input: ['./petstore.yaml'],
  output: './content/docs',
});
```
Execute it with node ./scripts/generate-docs.mjs.

1.1.0

Minor Changes

8665888: Added patterns support to config Inputs.

1.0.1

Patch Changes

6c5a39a: Rename Git repository to fumadocs

1.0.0

Major Changes

2b11c20: Rename to Fumadocs

next-docs-zeta -> fumadocs-core

next-docs-ui -> fumadocs-ui

next-docs-mdx -> fumadocs-mdx

@fuma-docs/openapi -> fumadocs-openapi

create-next-docs-app -> create-fumadocs-app