feat(ts): support readonly schema (#730)

* feat(ts): suppoert readonly schema * tests(tsd): add readonly route schema tests
fastify · Jun 18, 2023 · 75761d5 · 75761d5
1 parent 3618eb0
commit 75761d5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -34,13 +34,13 @@ declare module 'fastify' {
   interface FastifySchema {
     hide?: boolean;
     deprecated?: boolean;
-    tags?: string[];
+    tags?: readonly string[];
     description?: string;
     summary?: string;
-    consumes?: string[];
-    produces?: string[];
+    consumes?: readonly string[];
+    produces?: readonly string[];
     externalDocs?: OpenAPIV2.ExternalDocumentationObject | OpenAPIV3.ExternalDocumentationObject;
-    security?: Array<{ [securityLabel: string]: string[] }>;
+    security?: ReadonlyArray<{ [securityLabel: string]: readonly string[] }>;
     /**
      * OpenAPI operation unique identifier
      */

diff --git a/test/types/types.test.ts b/test/types/types.test.ts
@@ -111,6 +111,19 @@ app.get('/public/route', {
     }
   }, (req, reply) => {});
 
+app.get('/public/readonly-schema-route', {
+    schema: {
+      description: 'returns 200 OK',
+      tags: ['foo'],
+      summary: 'qwerty',
+      security: [],
+      response: { 200: {} }
+    },
+    links: {
+      200: {'some-route': { operationId: 'opeId'}}
+    }
+  } as const, (req, reply) => {});
+
 app
   .register(fastifySwagger, {
     swagger: {