Skip to content

Commit af39cc7

Browse files
committed
Update README.md
1 parent 09b5dd8 commit af39cc7

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,18 @@ export default Page;
6060

6161
The `generateOpenApiSpec` function takes an object with the following properties:
6262

63-
| Property | Type | Description |
64-
| ------------------------ | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
65-
| models | Record<string, [ZodType](https://zod.dev)> | An object where keys are model names and values are Zod schemas |
66-
| options | Object | `(Optional)` An object to customize the functionality of the route definer |
67-
| options.include | string[] | `(Optional)` An array of strings which specifies the routes will be included to the JSON output |
68-
| options.exclude | string[] | `(Optional)` An array of strings which specifies the routes will be excluded from the JSON output |
69-
| options.routeDefinerName | string | `(Optional)` Name of the function that was exported from the [`Next OpenAPI Route Handler`](https://www.npmjs.com/package/@omer-x/next-openapi-route-handler) (Default: `defineRoute`) |
63+
| Property | Type | Description |
64+
| -------- | ------------------------------------------ | ---------------------------------------------------------------------------------- |
65+
| models | Record<string, [ZodType](https://zod.dev)> | An object where keys are model names and values are Zod schemas |
66+
| options | Object | `(Optional)` An object to customize the functionality of the generator (see below) |
67+
68+
#### Options
69+
70+
| Property | Type | Description |
71+
| ---------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
72+
| include | string[] | `(Optional)` An array of strings which specifies the routes will be included to the JSON output |
73+
| exclude | string[] | `(Optional)` An array of strings which specifies the routes will be excluded from the JSON output |
74+
| routeDefinerName | string | `(Optional)` Name of the function that was exported from the [`Next OpenAPI Route Handler`](https://www.npmjs.com/package/@omer-x/next-openapi-route-handler) (Default: `defineRoute`) |
7075

7176
### Result
7277

0 commit comments

Comments
 (0)