docs(openapi-metadata): fix typos and cleanup nav config

openapi-ts · Nov 6, 2024 · 292b12d · 292b12d
1 parent f1075ec
commit 292b12d
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 17 deletions.
diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts
@@ -71,17 +71,18 @@ export default defineConfig({
         },
         {
           text: "openapi-react-query",
+          base: "/openapi-react-query",
           items: [
-            { text: "Getting Started", link: "/openapi-react-query/" },
-            { text: "useQuery", link: "/openapi-react-query/use-query" },
-            { text: "useMutation", link: "/openapi-react-query/use-mutation" },
+            { text: "Getting Started", link: "/" },
+            { text: "useQuery", link: "/use-query" },
+            { text: "useMutation", link: "/use-mutation" },
             {
               text: "useSuspenseQuery",
-              link: "/openapi-react-query/use-suspense-query",
+              link: "/use-suspense-query",
             },
             {
               text: "queryOptions",
-              link: "/openapi-react-query/query-options",
+              link: "/query-options",
             },
             { text: "About", link: "/openapi-react-query/about" },
           ],
@@ -101,14 +102,15 @@ export default defineConfig({
         },
         {
           text: "openapi-metadata",
+          base: "/openapi-metadata",
           items: [
-            { text: "Getting Started", link: "/openapi-metadata/" },
-            { text: "Decorators", link: "/openapi-metadata/decorators" },
-            { text: "Metadata", link: "/openapi-metadata/metadata" },
-            { text: "Type loader", link: "/openapi-metadata/type-loader" },
-            { text: "UI Integrations", link: "/openapi-metadata/ui" },
-            { text: "Examples", link: "/openapi-metadata/examples" },
-            { text: "About", link: "/openapi-metadata/about" },
+            { text: "Getting Started", link: "/" },
+            { text: "Decorators", link: "/decorators" },
+            { text: "Metadata", link: "/metadata" },
+            { text: "Type loader", link: "/type-loader" },
+            { text: "UI Integrations", link: "/ui" },
+            { text: "Examples", link: "/examples" },
+            { text: "About", link: "/about" },
           ],
         },
       ],

diff --git a/docs/openapi-metadata/index.md b/docs/openapi-metadata/index.md
@@ -13,12 +13,12 @@ import { ApiOperation, ApiResponse } from "openapi-metadata/decorators";
 import User from "./user";
 
 class UsersController {
-  @apiOperation({
+  @ApiOperation({
     method: "get",
     pattern: "/users",
     summary: "List users"
   })
-  @apiResponse({ type: [User] })
+  @ApiResponse({ type: [User] })
   async list() {
     ...
   }
@@ -29,13 +29,13 @@ class UsersController {
 import { ApiProperty } from "openapi-metadata/decorators";
 
 class User {
-  @apiProperty()
+  @ApiProperty()
   declare id: number;
 
-  @apiProperty()
+  @ApiProperty()
   declare name: string;
 
-  @apiProperty({ required: false })
+  @ApiProperty({ required: false })
   declare mobile?: string;
 }
 ```