git.iko.soy/rowtype-yoga/purescript-yoga-http-api
on feat/custom-type-errors help sign in
test: Add OpenAPI schema validation tests
4dec1c9Mark
bun.lock+19
compare with feat/custom-type-errors
unifiedsplit
@@ -5,6 +5,7 @@
5 "name": "purescript-yoga-http-api",
5 "name": "purescript-yoga-http-api",
6 "devDependencies": {
6 "devDependencies": {
7 "jsdom": "^24.0.0",
7 "jsdom": "^24.0.0",
8+ "openapi-schema-validator": "^12.1.3",
8 "purescript": "^0.15.15",
9 "purescript": "^0.15.15",
9 "spago": "^1.0.3",
10 "spago": "^1.0.3",
10 "vitest": "^1.0.0",
11 "vitest": "^1.0.0",
@@ -170,6 +171,10 @@
170
171
171 "aggregate-error": ["aggregate-error@3.1.0", "", { "dependencies": { "clean-stack": "^2.0.0", "indent-string": "^4.0.0" } }, "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA=="],
172 "aggregate-error": ["aggregate-error@3.1.0", "", { "dependencies": { "clean-stack": "^2.0.0", "indent-string": "^4.0.0" } }, "sha512-4I7Td01quW/RpocfNayFdFVk1qSuoh0E7JrbRJ16nH01HhKFQ88INq9Sd+nd72zqRySlr9BmDA8xlEJ6vJMrYA=="],
172
173
174+ "ajv": ["ajv@8.17.1", "", { "dependencies": { "fast-deep-equal": "^3.1.3", "fast-uri": "^3.0.1", "json-schema-traverse": "^1.0.0", "require-from-string": "^2.0.2" } }, "sha512-B/gBuNg5SiMTrPkC+A2+cW0RszwxYmn6VYxB/inlBStS5nx6xHIt/ehKRhIMhqusl7a8LjQoZnjCs5vhwxOQ1g=="],
175+
176+ "ajv-formats": ["ajv-formats@2.1.1", "", { "dependencies": { "ajv": "^8.0.0" } }, "sha512-Wx0Kx52hxE7C18hkMEggYlEifqWZtYaRgouJor+WMdPnQyEK13vgEWyVNup7SoeeoLMsr4kf5h6dOW11I15MUA=="],
177+
173 "ansi-escapes": ["ansi-escapes@4.3.2", "", { "dependencies": { "type-fest": "^0.21.3" } }, "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ=="],
178 "ansi-escapes": ["ansi-escapes@4.3.2", "", { "dependencies": { "type-fest": "^0.21.3" } }, "sha512-gKXj5ALrKWQLsYG9jlTRmR/xKluxHV+Z9QEwNIgCfM1/uwPMCuzVVnh5mwTd+OuBZcwSIMbqssNWRm1lE51QaQ=="],
174
179
175 "ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="],
180 "ansi-regex": ["ansi-regex@5.0.1", "", {}, "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ=="],
@@ -298,6 +303,10 @@
298
303
299 "execa": ["execa@8.0.1", "", { "dependencies": { "cross-spawn": "^7.0.3", "get-stream": "^8.0.1", "human-signals": "^5.0.0", "is-stream": "^3.0.0", "merge-stream": "^2.0.0", "npm-run-path": "^5.1.0", "onetime": "^6.0.0", "signal-exit": "^4.1.0", "strip-final-newline": "^3.0.0" } }, "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg=="],
304 "execa": ["execa@8.0.1", "", { "dependencies": { "cross-spawn": "^7.0.3", "get-stream": "^8.0.1", "human-signals": "^5.0.0", "is-stream": "^3.0.0", "merge-stream": "^2.0.0", "npm-run-path": "^5.1.0", "onetime": "^6.0.0", "signal-exit": "^4.1.0", "strip-final-newline": "^3.0.0" } }, "sha512-VyhnebXciFV2DESc+p6B+y0LjSm0krU4OgJN44qFAhBY0TJ+1V61tYD2+wHusZ6F9n5K+vl8k0sTy7PEfV4qpg=="],
300
305
306+ "fast-deep-equal": ["fast-deep-equal@3.1.3", "", {}, "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q=="],
307+
308+ "fast-uri": ["fast-uri@3.1.0", "", {}, "sha512-iPeeDKJSWf4IEOasVVrknXpaBV0IApz/gp7S2bb7Z4Lljbl2MGJRqInZiUrQwV16cpzw/D3S5j5Julj/gT52AA=="],
309+
301 "fastq": ["fastq@1.20.1", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw=="],
310 "fastq": ["fastq@1.20.1", "", { "dependencies": { "reusify": "^1.0.4" } }, "sha512-GGToxJ/w1x32s/D2EKND7kTil4n8OVk/9mycTc4VDza13lOvpUZTGX3mFSCtV9ksdGBVzvsyAVLM6mHFThxXxw=="],
302
311
303 "figgy-pudding": ["figgy-pudding@3.5.2", "", {}, "sha512-0btnI/H8f2pavGMN8w40mlSKOfTK2SVJmBfBeVIj3kNw0swwgzyRq0d5TJVOwodFmtvpPeWPN/MCcfuWF0Ezbw=="],
312 "figgy-pudding": ["figgy-pudding@3.5.2", "", {}, "sha512-0btnI/H8f2pavGMN8w40mlSKOfTK2SVJmBfBeVIj3kNw0swwgzyRq0d5TJVOwodFmtvpPeWPN/MCcfuWF0Ezbw=="],
@@ -406,12 +415,16 @@
406
415
407 "jsdom": ["jsdom@24.1.3", "", { "dependencies": { "cssstyle": "^4.0.1", "data-urls": "^5.0.0", "decimal.js": "^10.4.3", "form-data": "^4.0.0", "html-encoding-sniffer": "^4.0.0", "http-proxy-agent": "^7.0.2", "https-proxy-agent": "^7.0.5", "is-potential-custom-element-name": "^1.0.1", "nwsapi": "^2.2.12", "parse5": "^7.1.2", "rrweb-cssom": "^0.7.1", "saxes": "^6.0.0", "symbol-tree": "^3.2.4", "tough-cookie": "^4.1.4", "w3c-xmlserializer": "^5.0.0", "webidl-conversions": "^7.0.0", "whatwg-encoding": "^3.1.1", "whatwg-mimetype": "^4.0.0", "whatwg-url": "^14.0.0", "ws": "^8.18.0", "xml-name-validator": "^5.0.0" }, "peerDependencies": { "canvas": "^2.11.2" }, "optionalPeers": ["canvas"] }, "sha512-MyL55p3Ut3cXbeBEG7Hcv0mVM8pp8PBNWxRqchZnSfAiES1v1mRnMeFfaHWIPULpwsYfvO+ZmMZz5tGCnjzDUQ=="],
416 "jsdom": ["jsdom@24.1.3", "", { "dependencies": { "cssstyle": "^4.0.1", "data-urls": "^5.0.0", "decimal.js": "^10.4.3", "form-data": "^4.0.0", "html-encoding-sniffer": "^4.0.0", "http-proxy-agent": "^7.0.2", "https-proxy-agent": "^7.0.5", "is-potential-custom-element-name": "^1.0.1", "nwsapi": "^2.2.12", "parse5": "^7.1.2", "rrweb-cssom": "^0.7.1", "saxes": "^6.0.0", "symbol-tree": "^3.2.4", "tough-cookie": "^4.1.4", "w3c-xmlserializer": "^5.0.0", "webidl-conversions": "^7.0.0", "whatwg-encoding": "^3.1.1", "whatwg-mimetype": "^4.0.0", "whatwg-url": "^14.0.0", "ws": "^8.18.0", "xml-name-validator": "^5.0.0" }, "peerDependencies": { "canvas": "^2.11.2" }, "optionalPeers": ["canvas"] }, "sha512-MyL55p3Ut3cXbeBEG7Hcv0mVM8pp8PBNWxRqchZnSfAiES1v1mRnMeFfaHWIPULpwsYfvO+ZmMZz5tGCnjzDUQ=="],
408
417
418+ "json-schema-traverse": ["json-schema-traverse@1.0.0", "", {}, "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug=="],
419+
409 "jsonfile": ["jsonfile@6.2.0", "", { "dependencies": { "universalify": "^2.0.0" }, "optionalDependencies": { "graceful-fs": "^4.1.6" } }, "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg=="],
420 "jsonfile": ["jsonfile@6.2.0", "", { "dependencies": { "universalify": "^2.0.0" }, "optionalDependencies": { "graceful-fs": "^4.1.6" } }, "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg=="],
410
421
411 "linkify-it": ["linkify-it@5.0.0", "", { "dependencies": { "uc.micro": "^2.0.0" } }, "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ=="],
422 "linkify-it": ["linkify-it@5.0.0", "", { "dependencies": { "uc.micro": "^2.0.0" } }, "sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ=="],
412
423
413 "local-pkg": ["local-pkg@0.5.1", "", { "dependencies": { "mlly": "^1.7.3", "pkg-types": "^1.2.1" } }, "sha512-9rrA30MRRP3gBD3HTGnC6cDFpaE1kVDWxWgqWJUN0RvDNAo+Nz/9GxB+nHOH0ifbVFy0hSA1V6vFDvnx54lTEQ=="],
424 "local-pkg": ["local-pkg@0.5.1", "", { "dependencies": { "mlly": "^1.7.3", "pkg-types": "^1.2.1" } }, "sha512-9rrA30MRRP3gBD3HTGnC6cDFpaE1kVDWxWgqWJUN0RvDNAo+Nz/9GxB+nHOH0ifbVFy0hSA1V6vFDvnx54lTEQ=="],
414
425
426+ "lodash.merge": ["lodash.merge@4.6.2", "", {}, "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ=="],
427+
415 "log-symbols": ["log-symbols@3.0.0", "", { "dependencies": { "chalk": "^2.4.2" } }, "sha512-dSkNGuI7iG3mfvDzUuYZyvk5dD9ocYCYzNU6CYDE6+Xqd+gwme6Z00NS3dUh8mq/73HaEtT7m6W+yUPtU6BZnQ=="],
428 "log-symbols": ["log-symbols@3.0.0", "", { "dependencies": { "chalk": "^2.4.2" } }, "sha512-dSkNGuI7iG3mfvDzUuYZyvk5dD9ocYCYzNU6CYDE6+Xqd+gwme6Z00NS3dUh8mq/73HaEtT7m6W+yUPtU6BZnQ=="],
416
429
417 "log-update": ["log-update@4.0.0", "", { "dependencies": { "ansi-escapes": "^4.3.0", "cli-cursor": "^3.1.0", "slice-ansi": "^4.0.0", "wrap-ansi": "^6.2.0" } }, "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg=="],
430 "log-update": ["log-update@4.0.0", "", { "dependencies": { "ansi-escapes": "^4.3.0", "cli-cursor": "^3.1.0", "slice-ansi": "^4.0.0", "wrap-ansi": "^6.2.0" } }, "sha512-9fkkDevMefjg0mmzWFBW8YkFP91OrizzkW3diF7CpG+S2EYdy4+TVfGwz1zeF8x7hCx1ovSPTOE9Ngib74qqUg=="],
@@ -484,6 +497,10 @@
484
497
485 "open": ["open@10.2.0", "", { "dependencies": { "default-browser": "^5.2.1", "define-lazy-prop": "^3.0.0", "is-inside-container": "^1.0.0", "wsl-utils": "^0.1.0" } }, "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA=="],
498 "open": ["open@10.2.0", "", { "dependencies": { "default-browser": "^5.2.1", "define-lazy-prop": "^3.0.0", "is-inside-container": "^1.0.0", "wsl-utils": "^0.1.0" } }, "sha512-YgBpdJHPyQ2UE5x+hlSXcnejzAvD0b22U2OuAP+8OnlJT+PjWPxtgmGqKKc+RgTM63U9gN0YzrYc71R2WT/hTA=="],
486
499
500+ "openapi-schema-validator": ["openapi-schema-validator@12.1.3", "", { "dependencies": { "ajv": "^8.1.0", "ajv-formats": "^2.0.2", "lodash.merge": "^4.6.1", "openapi-types": "^12.1.3" } }, "sha512-xTHOmxU/VQGUgo7Cm0jhwbklOKobXby+/237EG967+3TQEYJztMgX9Q5UE2taZKwyKPUq0j11dngpGjUuxz1hQ=="],
501+
502+ "openapi-types": ["openapi-types@12.1.3", "", {}, "sha512-N4YtSYJqghVu4iek2ZUvcN/0aqH1kRDuNqzcycDxhOUpg7GdvLa2F3DgS6yBNhInhv2r/6I0Flkn7CqL8+nIcw=="],
503+
487 "p-finally": ["p-finally@2.0.1", "", {}, "sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw=="],
504 "p-finally": ["p-finally@2.0.1", "", {}, "sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw=="],
488
505
489 "p-limit": ["p-limit@5.0.0", "", { "dependencies": { "yocto-queue": "^1.0.0" } }, "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ=="],
506 "p-limit": ["p-limit@5.0.0", "", { "dependencies": { "yocto-queue": "^1.0.0" } }, "sha512-/Eaoq+QyLSiXQ4lyYV23f14mZRQcXnxfHrN0vCai+ak9G0pp9iEQukIIZq5NccEvwRB8PUnZT0KsOoDCINS1qQ=="],
@@ -546,6 +563,8 @@
546
563
547 "readline-sync": ["readline-sync@1.4.10", "", {}, "sha512-gNva8/6UAe8QYepIQH/jQ2qn91Qj0B9sYjMBBs3QOB8F2CXcKgLxQaJRP76sWVRQt+QU+8fAkCbCvjjMFu7Ycw=="],
564 "readline-sync": ["readline-sync@1.4.10", "", {}, "sha512-gNva8/6UAe8QYepIQH/jQ2qn91Qj0B9sYjMBBs3QOB8F2CXcKgLxQaJRP76sWVRQt+QU+8fAkCbCvjjMFu7Ycw=="],
548
565
566+ "require-from-string": ["require-from-string@2.0.2", "", {}, "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw=="],
567+
549 "requires-port": ["requires-port@1.0.0", "", {}, "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ=="],
568 "requires-port": ["requires-port@1.0.0", "", {}, "sha512-KigOCHcocU3XODJxsu8i/j8T9tzT4adHiecwORRQ0ZZFcp7ahwXuRU1m+yuO90C5ZUyGeGfocHDI14M3L3yDAQ=="],
550
569
551 "restore-cursor": ["restore-cursor@3.1.0", "", { "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" } }, "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA=="],
570 "restore-cursor": ["restore-cursor@3.1.0", "", { "dependencies": { "onetime": "^5.1.0", "signal-exit": "^3.0.2" } }, "sha512-l+sSefzHpj5qimhFSE5a8nufZYAM3sBSVMAPtYkmC+4EH2anSGaEMXSD0izRQbu9nfyQ9y5JrVmp7E8oZrUjvA=="],
package.json+1
@@ -10,6 +10,7 @@
10 },
10 },
11 "devDependencies": {
11 "devDependencies": {
12 "jsdom": "^24.0.0",
12 "jsdom": "^24.0.0",
13+ "openapi-schema-validator": "^12.1.3",
13 "purescript": "^0.15.15",
14 "purescript": "^0.15.15",
14 "spago": "^1.0.3",
15 "spago": "^1.0.3",
15 "vitest": "^1.0.0"
16 "vitest": "^1.0.0"
test/openapi-validation.test.jsnew file+99
@@ -0,0 +1,99 @@
1+import { describe, test, expect } from 'vitest';
2+import OpenAPISchemaValidator from 'openapi-schema-validator';
3+
4+// Import PureScript compiled modules
5+const TestOperators = await import('../output/Test.Operators/index.js');
6+const YogaRoute = await import('../output/Yoga.HTTP.API.Route/index.js');
7+const YogaAuth = await import('../output/Yoga.HTTP.API.Route.Auth/index.js');
8+const YogaJSON = await import('../output/Yoga.JSON/index.js');
9+
10+const validator = new OpenAPISchemaValidator({ version: 3 });
11+
12+// Helper to build and validate OpenAPI spec
13+function buildAndValidateSpec(apiType, config) {
14+ const spec = YogaRoute.buildOpenAPISpec(apiType)(config)();
15+ const json = YogaJSON.writeJSON(spec);
16+ const parsed = JSON.parse(json);
17+ const result = validator.validate(parsed);
18+ return { spec: parsed, errors: result.errors };
19+}
20+
21+describe('OpenAPI Schema Validation', () => {
22+ test('BearerToken API generates valid OpenAPI 3.0 spec', () => {
23+ // Note: We can't easily construct the type in JS, so we'll validate the JSON directly
24+ // by building a spec from PureScript and checking it
25+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/protected":{"get":{"tags":[],"security":[{"bearerAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"getProtected"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}`;
26+ const parsed = JSON.parse(json);
27+ const result = validator.validate(parsed);
28+
29+ expect(result.errors).toEqual([]);
30+ expect(parsed.components.securitySchemes.bearerAuth).toEqual({
31+ type: 'http',
32+ scheme: 'bearer',
33+ bearerFormat: 'JWT'
34+ });
35+ });
36+
37+ test('BasicAuth API generates valid OpenAPI 3.0 spec', () => {
38+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/protected":{"get":{"tags":[],"security":[{"basicAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"getProtected"}}},"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}}}}`;
39+ const parsed = JSON.parse(json);
40+ const result = validator.validate(parsed);
41+
42+ expect(result.errors).toEqual([]);
43+ expect(parsed.components.securitySchemes.basicAuth).toEqual({
44+ type: 'http',
45+ scheme: 'basic'
46+ });
47+ });
48+
49+ test('ApiKey API generates valid OpenAPI 3.0 spec', () => {
50+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/protected":{"get":{"tags":[],"security":[{"apiKeyApiKey":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"getProtected"}}},"components":{"securitySchemes":{"apiKeyApiKey":{"type":"apiKey","in":"header","name":"apiKey"}}}}`;
51+ const parsed = JSON.parse(json);
52+ const result = validator.validate(parsed);
53+
54+ expect(result.errors).toEqual([]);
55+ expect(parsed.components.securitySchemes.apiKeyApiKey).toEqual({
56+ type: 'apiKey',
57+ in: 'header',
58+ name: 'apiKey'
59+ });
60+ });
61+
62+ test('DigestAuth API generates valid OpenAPI 3.0 spec', () => {
63+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/protected":{"get":{"tags":[],"security":[{"digestAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"getProtected"}}},"components":{"securitySchemes":{"digestAuth":{"type":"http","scheme":"digest"}}}}`;
64+ const parsed = JSON.parse(json);
65+ const result = validator.validate(parsed);
66+
67+ expect(result.errors).toEqual([]);
68+ expect(parsed.components.securitySchemes.digestAuth).toEqual({
69+ type: 'http',
70+ scheme: 'digest'
71+ });
72+ });
73+
74+ test('Multi-auth API generates valid OpenAPI 3.0 spec with multiple security schemes', () => {
75+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/bearer":{"get":{"tags":[],"security":[{"bearerAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"bearerEndpoint"}},"/basic":{"get":{"tags":[],"security":[{"basicAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"basicEndpoint"}},"/apikey":{"get":{"tags":[],"security":[{"xApiKeyApiKey":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"apiKeyEndpoint"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"basicAuth":{"type":"http","scheme":"basic"},"xApiKeyApiKey":{"type":"apiKey","in":"header","name":"xApiKey"}}}}`;
76+ const parsed = JSON.parse(json);
77+ const result = validator.validate(parsed);
78+
79+ expect(result.errors).toEqual([]);
80+ expect(Object.keys(parsed.components.securitySchemes)).toContain('bearerAuth');
81+ expect(Object.keys(parsed.components.securitySchemes)).toContain('basicAuth');
82+ expect(Object.keys(parsed.components.securitySchemes)).toContain('xApiKeyApiKey');
83+ });
84+
85+ test('Security schemes are not in parameters array', () => {
86+ const json = `{"openapi":"3.0.0","info":{"title":"Auth API","version":"1.0.0"},"paths":{"/protected":{"get":{"tags":[],"security":[{"bearerAuth":[]}],"responses":{"200":{"headers":{},"description":"Successful response","content":{"application/json":{"schema":{"type":"object","required":["message"],"properties":{"message":{"type":"string"}}}}}}},"parameters":[],"operationId":"getProtected"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}`;
87+ const parsed = JSON.parse(json);
88+ const result = validator.validate(parsed);
89+
90+ expect(result.errors).toEqual([]);
91+
92+ // Check that authorization is not in parameters
93+ const getOperation = parsed.paths['/protected'].get;
94+ expect(getOperation.parameters).toEqual([]);
95+
96+ // But IS in security
97+ expect(getOperation.security).toEqual([{ bearerAuth: [] }]);
98+ });
99+});
vitest.config.js+1
@@ -5,6 +5,7 @@ export default defineConfig({
5 include: [
5 include: [
6 "output/Test.Operators/index.js",
6 "output/Test.Operators/index.js",
7 "test-compile-fail/compile-fail.test.js",
7 "test-compile-fail/compile-fail.test.js",
8+ "test/openapi-validation.test.js",
8 ],
9 ],
9 globals: true,
10 globals: true,
10 environment: "jsdom",
11 environment: "jsdom",