Output latest version of spec and add note about types being broken

openintegrations · Feb 13, 2025 · a37d76c · a37d76c
1 parent 599b86a
commit a37d76c
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 13 deletions.
diff --git a/packages-v1/api-v1/__generated__/openapi.json b/packages-v1/api-v1/__generated__/openapi.json
diff --git a/packages-v1/api-v1/scripts/gen-oas.ts b/packages-v1/api-v1/scripts/gen-oas.ts
@@ -6,3 +6,6 @@ const dest = path.join(__dirname, '../__generated__', 'openapi.json')
 fs.writeFileSync(dest, JSON.stringify(generateOpenAPISpec({}), null, 2))
 
 console.log(`openapi.json written to ${dest}`)
+// NOTE: While the openapi spec is valid
+// the typescript types generated from it are not due to usage of discrminated union in the oas spec
+// @see https://github.com/openapi-ts/openapi-typescript/issues/2149
diff --git a/packages-v1/api-v1/trpc/openapi.ts b/packages-v1/api-v1/trpc/openapi.ts
@@ -9,6 +9,7 @@ export function generateOpenAPISpec({
   const oas = generateOpenApiDocument(appRouter, {
     title: 'OpenInt',
     version: '1.0.0',
+    openApiVersion: '3.1.0',
     baseUrl,
   })