Commit Graph
12 Commits
Author SHA1 Message Date
Khiet Tam NguyenandGitHub 91bd0c1c89 Merge pull request #3127 from nktnet1/fix-typo
fix: typos in all packages
2026-03-20 10:50:17 +08:00
Vitor Bari BucciantiandGitHub f64536d37b Merge pull request #3084 from vitorbari/fix/merge-allof-multiple-oneof
fix(openapi): handle allOf with multiple oneOf arrays
2026-03-09 18:57:22 +08:00
Fuma Nama 7991d042a4 Chore: migrate to oxfmt 2025-12-30 16:49:34 +08:00
0830a5bc2a Feat: support multiple examples in openapi operation #1370 (#1373)
* feat(packages/openapi): add feature to show multiple samples per operation

* chore: add changesset

* feat(packages/openapi): allow specifying a selectedSampleKey and exclusiveSampleKey when using <APIPage> in MDX

* fix(packages/openapi): remove shared groupId, which leads to unintended behaviour when showing multiple examples on one page

* fix(packages/openapi): also show examples for operations with not request body, cleanup data structure

---------

Co-authored-by: Michael Ermer <[email protected]>
2025-02-06 23:31:49 +08:00
Fuma NamaandGitHub 8661e15982 Openapi 3.1 (#1122)
* OpenAPI: update types

* improve OpenAPI 3.0 to 3.1 converter

* prepare for Scalar parser for 3.0 to 3.1 converter

* improve schema type utility

* Fix cyclic references without custom id/title

* Add scopes to auth schemes

* Support Webhooks

* Support generating webhooks docs

* fix tests

* Support operation callbacks

* prepare for merge

* fix conflicts

* make compatible with older OpenAPI versions

* fix issues
2024-11-30 17:00:24 +08:00
Fuma Nama 9750411b3c format files 2024-10-24 12:27:55 +08:00
Twinki 53855c40c9 Support multiple tags in OpenAPI file generation
# Motivations
I maintain a OpenAPI 3.x spec that I'd like to document with Fumadocs, however I utilize multiple tags on a given operation for automatic documentation organization purposes

Redoc supports multiple tags in their documentation generation out-of-the-box, and I think Fumadocs could benefit from the same

# Modifications
- Write the file for every tag for a given operation
- Add test and test fixture
2024-10-22 19:59:11 -04:00
bb1841177c Feature | API Playground (#565)
* CHANGED:
- Added InteractiveButton component
- Updated APIInfo design and added ability to copy the endpoint url
- Installed shiki to fumadocs-ui
- Added api-context

Signed-off-by: kyrylolvov <[email protected]>

* CHANGED:
- Updated APIInfo to render differently depending on whether children are passed
- Added SendButton component

Signed-off-by: kyrylolvov <[email protected]>

* CHANGED:
- Added statusMap and getStatusInfo function which returns description and icon for response

Signed-off-by: kyrylolvov <[email protected]>

* CHANGED:
- Added a new CodeBlock component, which is used to render API response

Signed-off-by: kyrylolvov <[email protected]>

* CHANGED:
- Installed required radix-ui dependencies for input, label, form shadcn components
- Added APIPlayground and ArrayInput components to API

Signed-off-by: kyrylolvov <[email protected]>

* CHANGED:
- Updated defaultBaseUrl in RootProvider
- Fixed errors
- Updated docs

Signed-off-by: kyrylolvov <[email protected]>

* Update pnpm-lock

* Rewrite API Playground

* Clean code

* OpenAPI: Support passing base url to Root component

* Update lock file

* Update test snapshots

* Fix lint issues

* Update API usages

* OpenAPI & UI: Generate Playground from MDX files

* Fix problems

* Improve design

* Handle self-referencing types

* Clean code

* Add switcher UI

* Add unkey for testing

* OpenAPI: Combine `allOf` into one object schema

* Update unkey.json

* OpenAPI & UI: Support optional boolean values

* OpenAPI & UI: Support `additionalProperties` field

* Update test snapshots

* OpenAPI & UI: Clean code & support removing additional properties

* OpenAPI: Improve title generation

* UI: Improve implmentation

* OpenAPI & UI: Improve Implementation

* Remove unkey.json from docs

* OpenAPI & UI: Move UI part of OpenAPI to `fumadocs-openapi`

* OpenAPI & UI: Improve UI implementation

* OpenAPI: Fix dynamic references issues

* OpenAPI: Handle unregistering additional properties

* Docs: Rewrite docs

---------

Signed-off-by: kyrylolvov <[email protected]>
Co-authored-by: fuma-nama <[email protected]>
Co-authored-by: Fuma Nama <[email protected]>
2024-07-14 21:02:36 +08:00
fuma-nama d387a43d67 Docs: Introduce OpenAPI code samples 2024-06-29 12:45:34 +08:00
fuma-nama 3a8562bfc4 OpenAPI: Support generating custom code examples 2024-06-29 12:41:07 +08:00
fuma-nama 65f43bf151 OpenAPI: Renew generate and generateTags API 2024-06-18 14:20:12 +08:00
Fuma Nama e82feb3257 Add unit tests for OpenAPI generator 2024-01-14 00:27:48 +08:00