Skip to content

Commit eef9731

Browse files
authored
feat: upgrade fumadocs v16 (#459)
* feat: upgrade fumadocs v16 * format the code * fix: update API page * feat: bump fumadocs pkgs Ref: fuma-nama/fumadocs#2608 (comment) * format the code * fix: api-reference pages reference in meta.json file * update openapi.yaml file * fix: remove un-used imports in `lib/source.ts` * feat: add `lucideIconsPlugin` plugin to API reference source in `lib/source.ts` file * refactor: move `APIPage` definition to a standalone module and clean up MDX components * format the code
1 parent a9d2985 commit eef9731

File tree

34 files changed

+908
-634
lines changed

34 files changed

+908
-634
lines changed

content/api-reference/auth/getSiteSetup.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Site setup
33
full: true
44
_openapi:
55
method: GET
6-
route: /auth/setup
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Get site setup information.
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/setup","method":"get"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/setup","method":"get"}]} />

content/api-reference/auth/sendVerificationEmail.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Send verification email
33
full: true
44
_openapi:
55
method: POST
6-
route: /auth/email/verify
76
toc: []
87
structuredData:
98
headings: []
@@ -22,4 +21,4 @@ Send a verification email to the user email address.
2221
The email is only sent if have configured [SMTP mail server](https://docs.logchimp.codecarrot.net/self-hosting/environment-variables#mail) are configured at the time of deploying LogChimp.
2322

2423

25-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/email/verify","method":"post"}]} webhooks={[]} hasHead={false} />
24+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/email/verify","method":"post"}]} />

content/api-reference/auth/siteSetup.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Site setup
33
full: true
44
_openapi:
55
method: POST
6-
route: /auth/setup
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Setup the site by creating the owner account.
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/setup","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/setup","method":"post"}]} />

content/api-reference/auth/userSignin.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Login
33
full: true
44
_openapi:
55
method: POST
6-
route: /auth/login
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Login to account using email and password.
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/login","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/login","method":"post"}]} />

content/api-reference/auth/userSignup.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Sign up
33
full: true
44
_openapi:
55
method: POST
6-
route: /auth/signup
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Create a new user account.
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/signup","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/auth/signup","method":"post"}]} />

content/api-reference/boards/filterBoards.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: List all boards
33
full: true
44
_openapi:
55
method: GET
6-
route: /boards
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Get all the boards
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/boards","method":"get"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/boards","method":"get"}]} />

content/api-reference/meta.json

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,31 @@
77
"errors",
88

99
"---Auth---",
10-
".../auth/userSignin",
11-
"...auth/userSignup",
12-
".../auth/sendVerificationEmail",
10+
"auth/userSignin",
11+
"auth/userSignup",
12+
"auth/sendVerificationEmail",
1313

1414
"---Site---",
15-
".../auth/getSiteSetup",
16-
".../auth/siteSetup",
15+
"auth/getSiteSetup",
16+
"auth/siteSetup",
1717

1818
"---Posts---",
19-
"...posts/filterPosts",
20-
"...posts/postBySlug",
21-
"...posts/createPost",
22-
"...posts/updatePost",
23-
"...posts/deletePost",
19+
"posts/filterPosts",
20+
"posts/postBySlug",
21+
"posts/createPost",
22+
"posts/updatePost",
23+
"posts/deletePost",
2424

2525
"---Votes---",
26-
"...votes/addVoteToPost",
27-
"...votes/removeVoteFromPost",
26+
"votes/addVoteToPost",
27+
"votes/removeVoteFromPost",
2828

2929
"---Boards---",
30-
"...boards/filterBoards",
30+
"boards/filterBoards",
3131

3232
"---Roadmaps---",
33-
"...roadmaps/filterRoadmaps",
34-
"...roadmaps/roadmapByUrl",
35-
"...roadmaps/searchRoadmaps"
33+
"roadmaps/filterRoadmaps",
34+
"roadmaps/roadmapByUrl",
35+
"roadmaps/searchRoadmaps"
3636
]
3737
}

content/api-reference/openapi.yaml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ paths:
5757
$ref: '#/components/requestBodies/Login'
5858
responses:
5959
200:
60-
description: ''
60+
description: 'OK'
6161
content:
6262
application/json:
6363
schema:
@@ -107,7 +107,7 @@ paths:
107107
$ref: '#/components/requestBodies/Login'
108108
responses:
109109
201:
110-
description: ''
110+
description: 'Created'
111111
content:
112112
application/json:
113113
schema:
@@ -153,7 +153,7 @@ paths:
153153
operationId: getSiteSetup
154154
responses:
155155
200:
156-
description: ''
156+
description: 'OK'
157157
content:
158158
application/json:
159159
schema:
@@ -193,7 +193,7 @@ paths:
193193
required: true
194194
responses:
195195
200:
196-
description: ''
196+
description: 'OK'
197197
content:
198198
application/json:
199199
schema:
@@ -253,7 +253,7 @@ paths:
253253
operationId: sendVerificationEmail
254254
responses:
255255
200:
256-
description: ''
256+
description: 'OK'
257257
content:
258258
application/json:
259259
schema:
@@ -1270,4 +1270,4 @@ components:
12701270
example: "Something went wrong!"
12711271
code:
12721272
type: string
1273-
example: "SERVER_ERROR"
1273+
example: "SERVER_ERROR"

content/api-reference/posts/createPost.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Create post
33
full: true
44
_openapi:
55
method: POST
6-
route: /posts
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Create a new post
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/posts","method":"post"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/posts","method":"post"}]} />

content/api-reference/posts/deletePost.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ title: Delete post
33
full: true
44
_openapi:
55
method: DELETE
6-
route: /posts
76
toc: []
87
structuredData:
98
headings: []
@@ -15,4 +14,4 @@ _openapi:
1514

1615
Delete a posts
1716

18-
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/posts","method":"delete"}]} webhooks={[]} hasHead={false} />
17+
<APIPage document={"./content/api-reference/openapi.yaml"} operations={[{"path":"/posts","method":"delete"}]} />

0 commit comments

Comments
 (0)