chore: oas spec fixes, to satisfy spectral rules (without modifying the actual oas state from Xano)

Author: MihalyToth20

.changeset/tangy-windows-taste.md

@@ -0,0 +1,8 @@
+---
+'@calycode/core': patch
+'@calycode/cli': patch
+---
+
+chore: extract the tags from the paths to the global to comply better with OAS
+chore: set maxLength to strings on the error codes (owasp:api4:2019-string-limit)
+chore: set type to strings (owasp:api4:2019-string-restricted)

packages/core/src/features/oas/generate/methods/extract-tags-to-global-level.ts

@@ -0,0 +1,29 @@
+function extractTagsToGlobal(paths) {
+   // 1. Collect all tags used in operations
+   const tagSet = new Set();
+   for (const [path, methods] of Object.entries(paths || {})) {
+      for (const [method, operation] of Object.entries(methods)) {
+         if (operation.tags && Array.isArray(operation.tags)) {
+            operation.tags.forEach((tag) => tagSet.add(tag));
+         }
+      }
+   }
+
+   // 2. Build the global tags array if not present
+   let tags = Array.from(tagSet).map((tag) => ({
+      name: tag,
+      description: `Auto-generated tag for ${tag}`,
+   }));
+
+   // (Optional) If you want to preserve existing tags and only add missing ones:
+   const existingTags = (tags || []).map((t) => t.name);
+   const allTags = Array.from(new Set([...existingTags, ...tagSet]));
+   tags = allTags.map((tag) => ({
+      name: tag,
+      description: `Auto-generated tag for ${tag}`,
+   }));
+
+   return tags;
+}
+
+export { extractTagsToGlobal };

packages/core/src/features/oas/generate/methods/patch-oas-spec.ts

@@ -1,4 +1,5 @@
 import { cleanupResponseSchemas } from './cleanup-response-schemas';
+import { extractTagsToGlobal } from './extract-tags-to-global-level';
 import { generateTableSchemas } from '..';
 
 async function patchOasSpec({
@@ -15,6 +16,8 @@ async function patchOasSpec({
 
    newOas.openapi = '3.1.1';
 
+   newOas.tags = extractTagsToGlobal(newOas.paths);
+
    newOas.components = {
       ...(oas.components ?? {}),
 
@@ -89,16 +92,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_CODE_ACCESS_DENIED',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'Forbidden access.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },
@@ -112,16 +121,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_CODE_UNAUTHORIZED',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'Authentication required.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },
@@ -135,16 +150,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_FATAL',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'Something went wrong.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },
@@ -158,16 +179,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_CODE_TOO_MANY_REQUESTS',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'Hit quota limits.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },
@@ -181,16 +208,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_CODE_NOT_FOUND',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'The requested resource cannot be found.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },
@@ -204,16 +237,22 @@ async function patchOasSpec({
             properties: {
                code: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 64,
                   example: 'ERROR_CODE_BAD_REQUEST',
                },
                message: {
                   type: 'string',
+                  format: 'const',
+                  maxLength: 256,
                   example: 'The provided inputs are not correct.',
                },
                payload: {
                   anyOf: [
                      {
                         type: 'string',
+                        format: 'const',
+                        maxLength: 1024,
                      },
                      { type: 'null' },
                      { type: 'object', properties: {}, additionalProperties: true },