next-openapi-gen 1.0.7 → 1.1.1
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 +9 -1
- package/dist/cli.js +2809 -819
- package/dist/index.js +2809 -819
- package/dist/next/index.js +2769 -779
- package/dist/react-router/index.js +2772 -782
- package/dist/vite/index.js +2772 -782
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -259,13 +259,21 @@ patterns, see [docs/getting-started.md](./docs/getting-started.md).
|
|
|
259
259
|
| -------------------------- | ---------------------------------------------------------------- |
|
|
260
260
|
| `@pathParams` | Path parameter schema or type |
|
|
261
261
|
| `@params` / `@queryParams` | Query parameter schema or type |
|
|
262
|
+
| `@header` / `@cookie` | Header / cookie parameter schema or type |
|
|
262
263
|
| `@body` | Request body schema or type |
|
|
263
264
|
| `@response` | Response schema, code, and optional description |
|
|
264
265
|
| `@responseDescription` | Response description without redefining the schema |
|
|
265
|
-
| `@
|
|
266
|
+
| `@responseHeader` | Add a response header to a given status code |
|
|
267
|
+
| `@link` | Add an OpenAPI link to a response |
|
|
268
|
+
| `@auth` / `@security` | Security requirement(s); `@security` accepts explicit scopes |
|
|
269
|
+
| `@servers` | Operation-level servers |
|
|
270
|
+
| `@externalDocs` | Operation-level external documentation |
|
|
271
|
+
| `@callback` | OpenAPI operation callback |
|
|
272
|
+
| `@webhook` | Mark the handler as a webhook (`3.1`+ `webhooks` section) |
|
|
266
273
|
| `@contentType` | Request content type such as `multipart/form-data` |
|
|
267
274
|
| `@examples` | Request, response, and querystring examples |
|
|
268
275
|
| `@openapi` | Explicit inclusion marker when `includeOpenApiRoutes` is enabled |
|
|
276
|
+
| `@openapi-override` | Deep-merge extra OpenAPI fields onto the operation |
|
|
269
277
|
| `@ignore` | Exclude a route from generation |
|
|
270
278
|
| `@method` | Required HTTP method tag for Pages Router handlers |
|
|
271
279
|
|