Skip to content

Commit 292b12d

Browse files
committed
docs(openapi-metadata): fix typos and cleanup nav config
1 parent f1075ec commit 292b12d

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

docs/.vitepress/en.ts

+14-12
Original file line numberDiff line numberDiff line change
@@ -71,17 +71,18 @@ export default defineConfig({
7171
},
7272
{
7373
text: "openapi-react-query",
74+
base: "/openapi-react-query",
7475
items: [
75-
{ text: "Getting Started", link: "/openapi-react-query/" },
76-
{ text: "useQuery", link: "/openapi-react-query/use-query" },
77-
{ text: "useMutation", link: "/openapi-react-query/use-mutation" },
76+
{ text: "Getting Started", link: "/" },
77+
{ text: "useQuery", link: "/use-query" },
78+
{ text: "useMutation", link: "/use-mutation" },
7879
{
7980
text: "useSuspenseQuery",
80-
link: "/openapi-react-query/use-suspense-query",
81+
link: "/use-suspense-query",
8182
},
8283
{
8384
text: "queryOptions",
84-
link: "/openapi-react-query/query-options",
85+
link: "/query-options",
8586
},
8687
{ text: "About", link: "/openapi-react-query/about" },
8788
],
@@ -101,14 +102,15 @@ export default defineConfig({
101102
},
102103
{
103104
text: "openapi-metadata",
105+
base: "/openapi-metadata",
104106
items: [
105-
{ text: "Getting Started", link: "/openapi-metadata/" },
106-
{ text: "Decorators", link: "/openapi-metadata/decorators" },
107-
{ text: "Metadata", link: "/openapi-metadata/metadata" },
108-
{ text: "Type loader", link: "/openapi-metadata/type-loader" },
109-
{ text: "UI Integrations", link: "/openapi-metadata/ui" },
110-
{ text: "Examples", link: "/openapi-metadata/examples" },
111-
{ text: "About", link: "/openapi-metadata/about" },
107+
{ text: "Getting Started", link: "/" },
108+
{ text: "Decorators", link: "/decorators" },
109+
{ text: "Metadata", link: "/metadata" },
110+
{ text: "Type loader", link: "/type-loader" },
111+
{ text: "UI Integrations", link: "/ui" },
112+
{ text: "Examples", link: "/examples" },
113+
{ text: "About", link: "/about" },
112114
],
113115
},
114116
],

docs/openapi-metadata/index.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ import { ApiOperation, ApiResponse } from "openapi-metadata/decorators";
1313
import User from "./user";
1414

1515
class UsersController {
16-
@apiOperation({
16+
@ApiOperation({
1717
method: "get",
1818
pattern: "/users",
1919
summary: "List users"
2020
})
21-
@apiResponse({ type: [User] })
21+
@ApiResponse({ type: [User] })
2222
async list() {
2323
...
2424
}
@@ -29,13 +29,13 @@ class UsersController {
2929
import { ApiProperty } from "openapi-metadata/decorators";
3030

3131
class User {
32-
@apiProperty()
32+
@ApiProperty()
3333
declare id: number;
3434

35-
@apiProperty()
35+
@ApiProperty()
3636
declare name: string;
3737

38-
@apiProperty({ required: false })
38+
@ApiProperty({ required: false })
3939
declare mobile?: string;
4040
}
4141
```

0 commit comments

Comments
 (0)