next-openapi-gen 0.5.5 → 0.5.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -97,7 +97,7 @@ type UserResponse = {
97
97
 
98
98
  /**
99
99
  * Get user information
100
- * @desc Fetches detailed user information by ID
100
+ * @description Fetches detailed user information by ID
101
101
  * @pathParams UserParams
102
102
  * @response UserResponse
103
103
  * @openapi
@@ -130,7 +130,7 @@ export const ProductResponse = z.object({
130
130
 
131
131
  /**
132
132
  * Get product information
133
- * @desc Fetches detailed product information by ID
133
+ * @description Fetches detailed product information by ID
134
134
  * @pathParams ProductParams
135
135
  * @response ProductResponse
136
136
  * @openapi
@@ -147,7 +147,7 @@ export async function GET(
147
147
 
148
148
  | Tag | Description |
149
149
  | ---------------------- | ----------------------------------------------------------------------------------- |
150
- | `@desc` | Endpoint description |
150
+ | `@description` | Endpoint description |
151
151
  | `@pathParams` | Path parameters type/schema |
152
152
  | `@params` | Query parameters type/schema |
153
153
  | `@body` | Request body type/schema |
@@ -336,6 +336,7 @@ const UserSchema = z.object({
336
336
  });
337
337
 
338
338
  /**
339
+ * @body UserSchema
339
340
  * @response UserResponse
340
341
  */
341
342
  export async function GET() {
package/dist/lib/utils.js CHANGED
@@ -67,8 +67,8 @@ export function extractJSDocComments(path) {
67
67
  break;
68
68
  }
69
69
  }
70
- if (commentValue.includes("@desc")) {
71
- const regex = /@desc\s*(.*)/;
70
+ if (commentValue.includes("@description")) {
71
+ const regex = /@description\s*(.*)/;
72
72
  description = commentValue.match(regex)[1].trim();
73
73
  }
74
74
  if (commentValue.includes("@tag")) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "next-openapi-gen",
3
- "version": "0.5.5",
3
+ "version": "0.5.6",
4
4
  "description": "Automatically generate OpenAPI 3.0 documentation from Next.js projects, with support for TypeScript types and Zod schemas.",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",