fix(types): fix plugin options (#851)

fastify · Jan 8, 2025 · d54763d · d54763d
1 parent 79384b1
commit d54763d
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -234,7 +234,6 @@ An example of using `@fastify/swagger` with `static` mode enabled can be found [
  | ---------------- | --------  | ----------------------------------------------------------------------------------------------------------------------------- |
  | hiddenTag        | X-HIDDEN  | Tag to control hiding of routes.                                                                                              |
  | hideUntagged     | false     | If `true` remove routes without tags from resulting Swagger/OpenAPI schema file.                                              |
- | initOAuth        | {}        | Configuration options for [Swagger UI initOAuth](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/).         |
  | openapi          | {}        | [OpenAPI configuration](https://swagger.io/specification/#oasObject).                                                         |
  | stripBasePath    | true      | Strips base path from routes in docs.                                                                                         |
  | swagger          | {}        | [Swagger configuration](https://swagger.io/specification/v2/#swaggerObject).                                                  |

diff --git a/index.d.ts b/index.d.ts
@@ -112,6 +112,10 @@ declare namespace fastifySwagger {
     openapi?: Partial<OpenAPIV3.Document | OpenAPIV3_1.Document>
     hiddenTag?: string;
     hideUntagged?: boolean;
+
+    /** Include HEAD routes in the definitions */
+    exposeHeadRoutes?: boolean;
+
     /**
      * Strips matching base path from routes in documentation
      * @default true
@@ -127,6 +131,9 @@ declare namespace fastifySwagger {
      */
     transformObject?: SwaggerTransformObject;
 
+    /** Overrides the Fastify decorator. */
+    decorator?: 'swagger' | (string & Record<never, never>);
+
     refResolver?: {
       /** Clone the input schema without changing it. Default to `false`. */
       clone?: boolean;

diff --git a/test/types/types.test.ts b/test/types/types.test.ts
@@ -241,3 +241,19 @@ expectType<string>(app.swagger({ yaml: true }))
 expectType<OpenAPI.Document | string>(app.swagger({ yaml: Boolean(process.env.YAML) }))
 
 expectType<(arg: string)=>string>(formatParamUrl)
+
+app.register(fastifySwagger, {
+  decorator: 'swagger'
+})
+
+app.register(fastifySwagger, {
+  decorator: 'customSwagger'
+})
+
+app.register(fastifySwagger, {
+  exposeHeadRoutes: true
+})
+
+app.register(fastifySwagger, {
+  exposeHeadRoutes: false
+})