hanzoai/docs
2
0
Fork 0
mirror of https://github.com/hanzo-docs/docs.git synced 2026-10-26 10:55:57 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
3,455 Commits 19 Branches 1,995 Tags
3c19ffcb03aa48cf66f5b3bbef352db2a4c4f8dd
Commit Graph
50 Commits
Author SHA1 Message Date
Fuma Nama 8a04215c04 update snapshots 2025-03-12 20:14:42 +08:00
Fuma Nama 670c1797d0 OpenAPI: Support cookie parameters 2025-03-12 20:05:26 +08:00
Fuma Nama ab47221e93 update unit tests 2025-03-07 23:19:27 +08:00
Andrew MikofalvyGitHubFuma Nama
 		70d715d190 Add comments to generated files indicating they were generated (#1512) 
* feat: auto-gen comment

* Add addGeneratedComment option to OpenAPI.generateFiles

* adding back previous GenerateOptions, mistakenly removed

* ran prettier

* use mdx style format below the frontmatter

* minimizing changes to the existing codebase

* minimizing changes to the existing codebase

* run prettier

* fixing format of comment within example docs

* fixing issue with prettier removing formatting from JSX style comment within a MDX codeblock

* fix duplicated types

---------

Co-authored-by: Fuma Nama <[email protected]>
 2025-03-03 19:09:14 +08:00
MoritzandGitHub 3d211f3f34 Merge pull request #1465 from mrzmyr/feat/throw-when-input-not-found 
feat: throw when input not found
 2025-02-22 21:27:46 +08:00
Michael ErmerGitHubMichael Ermer
 		cd894b1d7b 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 Nama 31b0a38660 Chore: update snapshots 2025-02-05 21:07:16 +08:00
Fuma NamaandGitHub c88590b935 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 53c741aa66 format files 2024-10-24 12:27:55 +08:00
Twinki 84563248fd cleanup 2024-10-22 20:03:36 -04:00
Twinki 60d48ae3b7 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
fuma-nama f14e9472a8 degrade Algolia 2024-10-22 07:37:43 +08:00
fuma-nama bb7581f686 lint: migrate to ESLint v9 2024-10-18 20:41:35 +08:00
fuma-nama 0b93a3180a OpenAPI: Support required in allOf schemas 2024-08-23 13:53:56 +08:00
fuma-nama 3fa2436df1 OpenAPI: Support Python code sample 2024-08-19 23:23:44 +08:00
fuma-nama 61b91fa2a0 Core & OpenAPI: Improve Fumadocs OpenAPI support (TOC & Structured Data plugins) 2024-08-13 18:06:51 +08:00
fuma-nama 70172f1f28 OpenAPI: Change default value of per to operation 2024-08-13 18:06:51 +08:00
fuma-nama c7aa0909f0 OpenAPI: Generate document field on output MDX files 2024-08-13 00:10:30 +08:00
fuma-nama c094fefcba OpenAPI: Fix compatibility issues on other content sources 2024-08-12 20:49:44 +08:00
fuma-nama 4e0f9e53c9 OpenAPI: Generate TOC and Structured Data statically 2024-08-08 16:36:42 +08:00
fuma-nama c3518495fc OpenAPI: Support TOC & Search Index Generation 2024-08-08 14:41:03 +08:00
fuma-nama c6d1574f9f OpenAPI: Migrate to Server Component [experimental] 2024-08-08 01:11:31 +08:00
fuma-nama 3874ab550c OpenAPI: Support Go Sample Request 2024-08-06 17:37:34 +08:00
fuma-nama f2801911db Core: Sort folders to bottom on Page Tree Builder 2024-08-06 00:16:10 +08:00
fuma-nama ea15b78d62 OpenAPI: Improve generated sample requests 2024-08-04 00:14:37 +08:00
fuma-nama 5553be2475 Update test snapshots 2024-07-31 16:52:46 +08:00
fuma-nama 40728a125e OpenAPI: Support custom authorization field 2024-07-27 13:02:50 +08:00
Kyrylo LvovGitHubfuma-namaFuma Nama
 		ad143e19f5 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 81fde3f114 OpenAPI: Display complex types & self-referencing types 2024-07-08 16:12:03 +08:00
fuma-nama b1b154e47f OpenAPI: Display object types mentioned in schema 2024-07-08 15:22:11 +08:00
fuma-nama 103fd3044c Docs: Introduce OpenAPI code samples 2024-06-29 12:45:34 +08:00
fuma-nama 0e420cb4d0 OpenAPI: Support generating custom code examples 2024-06-29 12:41:07 +08:00
fuma-nama 464e44c7ed OpenAPI: Improve example request URL generation 2024-06-24 21:49:25 +08:00
fuma-nama 341f843d1a Update test snapshots 2024-06-21 21:48:38 +08:00
fuma-nama 2f2d9cf225 UI: Redesign footer 2024-06-20 19:35:53 +08:00
fuma-nama 3bdc786bef OpenAPI: Support JavaScript request example & Authorization 2024-06-19 17:50:43 +08:00
fuma-nama 4c5b1b49b8 UI: Improve OpenAPI UI 2024-06-18 15:21:57 +08:00
fuma-nama 284a571a85 OpenAPI: Renew generate and generateTags API 2024-06-18 14:20:12 +08:00
Ankur Goyal af4419619b Run prettier and udpate test snapshots 2024-06-11 10:37:29 -07:00
fuma-nama 8ef2b682dd Chore: Update dependencies 2024-05-16 16:43:24 +08:00
Fuma Nama 2245befe7f Update dependencies 2024-03-06 20:32:09 +08:00
Fuma Nama 73d4fc6fd4 OpenAPI: Fix bugs with resolving patterns 2024-02-07 22:01:39 +08:00
Fuma Nama 06f72a1c01 Announce the new name: Fumadocs 2024-01-19 21:33:17 +08:00
Fuma Nama 2b11c20aca Refactor: Rename to @fuma-docs/* 2024-01-18 21:34:55 +08:00
Fuma Nama edf08c098c Clear 2024-01-16 16:15:44 +08:00
Fuma Nama c4ff802e1f Ignore formatting generated files 2024-01-15 23:43:52 +08:00
Fuma Nama ec9d813b72 UI: Improve stylings 2024-01-15 22:29:27 +08:00
Fuma Nama 1276ac1ac6 Docs: Write docs for OpenAPI generator 2024-01-15 16:53:03 +08:00
Fuma Nama 45a52ae5eb OpenAPI: CLI support configuration files 2024-01-14 19:17:53 +08:00
Fuma Nama c0195449dd Add unit tests for OpenAPI generator 2024-01-14 00:27:48 +08:00