|
| 1 | +import assert from "node:assert"; |
| 2 | +import { describe, expect, it } from "vitest"; |
| 3 | +import { generateValidRootSchema } from "../generateValidRootSchema"; |
| 4 | +import type * as Types from "../types"; |
| 5 | + |
| 6 | +describe("generateValidRootSchema", () => { |
| 7 | + describe("パスパラメータの required 正規化", () => { |
| 8 | + it("paths 直下のオペレーションに定義されたパスパラメータで required を省略した場合、required: true が設定されること", () => { |
| 9 | + const input: Types.OpenApi.Document = { |
| 10 | + openapi: "3.1.0", |
| 11 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 12 | + paths: { |
| 13 | + "/items/{id}": { |
| 14 | + get: { |
| 15 | + operationId: "getItemById", |
| 16 | + parameters: [ |
| 17 | + { |
| 18 | + in: "path", |
| 19 | + name: "id", |
| 20 | + required: false, |
| 21 | + schema: { type: "string" }, |
| 22 | + }, |
| 23 | + ], |
| 24 | + responses: { default: { description: "default" } }, |
| 25 | + }, |
| 26 | + }, |
| 27 | + }, |
| 28 | + }; |
| 29 | + |
| 30 | + const result = generateValidRootSchema(input); |
| 31 | + |
| 32 | + const paths = result.paths; |
| 33 | + assert(paths); |
| 34 | + const pathItem = paths["/items/{id}"]; |
| 35 | + assert(pathItem); |
| 36 | + const parameters = pathItem.get?.parameters; |
| 37 | + assert(parameters); |
| 38 | + const parameter = parameters[0] as Types.OpenApi.Parameter; |
| 39 | + expect(parameter.required).toBe(true); |
| 40 | + }); |
| 41 | + |
| 42 | + it("paths 直下のオペレーションに定義されたパスパラメータで required を省略した場合でも required: true が設定されること", () => { |
| 43 | + const input: Types.OpenApi.Document = { |
| 44 | + openapi: "3.1.0", |
| 45 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 46 | + paths: { |
| 47 | + "/items/{id}": { |
| 48 | + get: { |
| 49 | + operationId: "getItemById", |
| 50 | + // required フィールド自体を省略 |
| 51 | + parameters: [{ in: "path", name: "id", required: undefined as unknown as boolean, schema: { type: "string" } }], |
| 52 | + responses: { default: { description: "default" } }, |
| 53 | + }, |
| 54 | + }, |
| 55 | + }, |
| 56 | + }; |
| 57 | + |
| 58 | + const result = generateValidRootSchema(input); |
| 59 | + |
| 60 | + const paths = result.paths; |
| 61 | + assert(paths); |
| 62 | + const pathItem = paths["/items/{id}"]; |
| 63 | + assert(pathItem); |
| 64 | + const parameters = pathItem.get?.parameters; |
| 65 | + assert(parameters); |
| 66 | + const parameter = parameters[0] as Types.OpenApi.Parameter; |
| 67 | + expect(parameter.required).toBe(true); |
| 68 | + }); |
| 69 | + |
| 70 | + it("PathItem レベルのパスパラメータで required を省略した場合、required: true が設定されること", () => { |
| 71 | + const input: Types.OpenApi.Document = { |
| 72 | + openapi: "3.1.0", |
| 73 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 74 | + paths: { |
| 75 | + "/items/{id}": { |
| 76 | + parameters: [{ in: "path", name: "id", required: false, schema: { type: "string" } }], |
| 77 | + get: { |
| 78 | + operationId: "getItemById", |
| 79 | + responses: { default: { description: "default" } }, |
| 80 | + }, |
| 81 | + }, |
| 82 | + }, |
| 83 | + }; |
| 84 | + |
| 85 | + const result = generateValidRootSchema(input); |
| 86 | + |
| 87 | + const paths = result.paths; |
| 88 | + assert(paths); |
| 89 | + const pathItem = paths["/items/{id}"]; |
| 90 | + assert(pathItem); |
| 91 | + const parameters = pathItem.parameters; |
| 92 | + assert(parameters); |
| 93 | + const parameter = parameters[0] as Types.OpenApi.Parameter; |
| 94 | + expect(parameter.required).toBe(true); |
| 95 | + }); |
| 96 | + |
| 97 | + it("components.parameters に定義されたパスパラメータで required を省略した場合、required: true が設定されること", () => { |
| 98 | + const input: Types.OpenApi.Document = { |
| 99 | + openapi: "3.1.0", |
| 100 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 101 | + components: { |
| 102 | + parameters: { |
| 103 | + ItemId: { in: "path", name: "id", required: false, schema: { type: "string" } }, |
| 104 | + }, |
| 105 | + }, |
| 106 | + }; |
| 107 | + |
| 108 | + const result = generateValidRootSchema(input); |
| 109 | + |
| 110 | + const componentsParameters = result.components?.parameters; |
| 111 | + assert(componentsParameters); |
| 112 | + const parameter = componentsParameters.ItemId as Types.OpenApi.Parameter; |
| 113 | + expect(parameter.required).toBe(true); |
| 114 | + }); |
| 115 | + |
| 116 | + it("クエリパラメータで required を省略した場合、required フィールドは変更されないこと", () => { |
| 117 | + const input: Types.OpenApi.Document = { |
| 118 | + openapi: "3.1.0", |
| 119 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 120 | + paths: { |
| 121 | + "/items": { |
| 122 | + get: { |
| 123 | + operationId: "getItems", |
| 124 | + parameters: [{ in: "query", name: "filter", required: false, schema: { type: "string" } }], |
| 125 | + responses: { default: { description: "default" } }, |
| 126 | + }, |
| 127 | + }, |
| 128 | + }, |
| 129 | + }; |
| 130 | + |
| 131 | + const result = generateValidRootSchema(input); |
| 132 | + |
| 133 | + const paths = result.paths; |
| 134 | + assert(paths); |
| 135 | + const pathItem = paths["/items"]; |
| 136 | + assert(pathItem); |
| 137 | + const parameters = pathItem.get?.parameters; |
| 138 | + assert(parameters); |
| 139 | + const parameter = parameters[0] as Types.OpenApi.Parameter; |
| 140 | + expect(parameter.required).toBe(false); |
| 141 | + }); |
| 142 | + |
| 143 | + it("パスパラメータと明示的に required: true が設定されている場合、その値が維持されること", () => { |
| 144 | + const input: Types.OpenApi.Document = { |
| 145 | + openapi: "3.1.0", |
| 146 | + info: { title: "test", version: "1.0.0", summary: "", description: "", termsOfService: "" }, |
| 147 | + paths: { |
| 148 | + "/items/{id}": { |
| 149 | + get: { |
| 150 | + operationId: "getItemById", |
| 151 | + parameters: [{ in: "path", name: "id", required: true, schema: { type: "string" } }], |
| 152 | + responses: { default: { description: "default" } }, |
| 153 | + }, |
| 154 | + }, |
| 155 | + }, |
| 156 | + }; |
| 157 | + |
| 158 | + const result = generateValidRootSchema(input); |
| 159 | + |
| 160 | + const paths = result.paths; |
| 161 | + assert(paths); |
| 162 | + const pathItem = paths["/items/{id}"]; |
| 163 | + assert(pathItem); |
| 164 | + const parameters = pathItem.get?.parameters; |
| 165 | + assert(parameters); |
| 166 | + const parameter = parameters[0] as Types.OpenApi.Parameter; |
| 167 | + expect(parameter.required).toBe(true); |
| 168 | + }); |
| 169 | + }); |
| 170 | +}); |
0 commit comments