@scalar/openapi-parser 0.10.15 → 0.10.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (332) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +0 -22
  3. package/dist/configuration/index.js +19 -22
  4. package/dist/configuration/index.js.map +7 -0
  5. package/dist/declarations.d.js +1 -0
  6. package/dist/declarations.d.js.map +7 -0
  7. package/dist/index.d.ts +4 -4
  8. package/dist/index.d.ts.map +1 -1
  9. package/dist/index.js +5 -29
  10. package/dist/index.js.map +7 -0
  11. package/dist/lib/Validator/Validator.d.ts +2 -2
  12. package/dist/lib/Validator/Validator.d.ts.map +1 -1
  13. package/dist/lib/Validator/Validator.js +99 -119
  14. package/dist/lib/Validator/Validator.js.map +7 -0
  15. package/dist/lib/Validator/Validator.test.js +8 -0
  16. package/dist/lib/Validator/Validator.test.js.map +7 -0
  17. package/dist/lib/Validator/index.d.ts +2 -2
  18. package/dist/lib/Validator/index.d.ts.map +1 -1
  19. package/dist/lib/Validator/index.js +3 -0
  20. package/dist/lib/Validator/index.js.map +7 -0
  21. package/dist/plugins/fetch-urls/fetchUrls.d.ts +1 -2
  22. package/dist/plugins/fetch-urls/fetchUrls.d.ts.map +1 -1
  23. package/dist/plugins/fetch-urls/fetchUrls.js +36 -111
  24. package/dist/plugins/fetch-urls/fetchUrls.js.map +7 -0
  25. package/dist/plugins/fetch-urls/fetchUrls.test.js +50 -0
  26. package/dist/plugins/fetch-urls/fetchUrls.test.js.map +7 -0
  27. package/dist/plugins/fetch-urls/index.d.ts +1 -1
  28. package/dist/plugins/fetch-urls/index.d.ts.map +1 -1
  29. package/dist/plugins/fetch-urls/index.js +2 -1
  30. package/dist/plugins/fetch-urls/index.js.map +7 -0
  31. package/dist/plugins/read-files/index.d.ts +1 -1
  32. package/dist/plugins/read-files/index.d.ts.map +1 -1
  33. package/dist/plugins/read-files/index.js +2 -1
  34. package/dist/plugins/read-files/index.js.map +7 -0
  35. package/dist/plugins/read-files/readFiles.d.ts +1 -1
  36. package/dist/plugins/read-files/readFiles.d.ts.map +1 -1
  37. package/dist/plugins/read-files/readFiles.js +50 -70
  38. package/dist/plugins/read-files/readFiles.js.map +7 -0
  39. package/dist/plugins/read-files/readFiles.test.js +20 -0
  40. package/dist/plugins/read-files/readFiles.test.js.map +7 -0
  41. package/dist/polyfills/index.d.ts +1 -1
  42. package/dist/polyfills/index.d.ts.map +1 -1
  43. package/dist/polyfills/index.js +5 -0
  44. package/dist/polyfills/index.js.map +7 -0
  45. package/dist/polyfills/path.js +155 -98
  46. package/dist/polyfills/path.js.map +7 -0
  47. package/dist/schemas/v2.0/schema.d.ts +1405 -0
  48. package/dist/schemas/v2.0/schema.d.ts.map +1 -0
  49. package/dist/schemas/v2.0/schema.js +1463 -0
  50. package/dist/schemas/v2.0/schema.js.map +7 -0
  51. package/dist/schemas/v3.0/schema.d.ts +1264 -0
  52. package/dist/schemas/v3.0/schema.d.ts.map +1 -0
  53. package/dist/schemas/v3.0/schema.js +1493 -0
  54. package/dist/schemas/v3.0/schema.js.map +7 -0
  55. package/dist/schemas/v3.1/schema.d.ts +1225 -0
  56. package/dist/schemas/v3.1/schema.d.ts.map +1 -0
  57. package/dist/schemas/v3.1/schema.js +1296 -0
  58. package/dist/schemas/v3.1/schema.js.map +7 -0
  59. package/dist/types/index.d.ts +5 -24
  60. package/dist/types/index.d.ts.map +1 -1
  61. package/dist/types/index.js +1 -0
  62. package/dist/types/index.js.map +7 -0
  63. package/dist/utils/betterAjvErrors/helpers.js +88 -93
  64. package/dist/utils/betterAjvErrors/helpers.js.map +7 -0
  65. package/dist/utils/betterAjvErrors/index.js +14 -13
  66. package/dist/utils/betterAjvErrors/index.js.map +7 -0
  67. package/dist/utils/betterAjvErrors/json/get-meta-from-path.d.ts +2 -0
  68. package/dist/utils/betterAjvErrors/json/get-meta-from-path.d.ts.map +1 -0
  69. package/dist/utils/betterAjvErrors/json/get-meta-from-path.js +27 -0
  70. package/dist/utils/betterAjvErrors/json/get-meta-from-path.js.map +7 -0
  71. package/dist/utils/betterAjvErrors/json/index.d.ts +2 -0
  72. package/dist/utils/betterAjvErrors/json/index.d.ts.map +1 -0
  73. package/dist/utils/betterAjvErrors/json/index.js +5 -0
  74. package/dist/utils/betterAjvErrors/json/index.js.map +7 -0
  75. package/dist/utils/betterAjvErrors/json/utils.d.ts +2 -0
  76. package/dist/utils/betterAjvErrors/json/utils.d.ts.map +1 -0
  77. package/dist/utils/betterAjvErrors/json/utils.js +11 -0
  78. package/dist/utils/betterAjvErrors/json/utils.js.map +7 -0
  79. package/dist/utils/betterAjvErrors/utils.js +21 -14
  80. package/dist/utils/betterAjvErrors/utils.js.map +7 -0
  81. package/dist/utils/betterAjvErrors/validation-errors/additional-prop.d.ts +10 -0
  82. package/dist/utils/betterAjvErrors/validation-errors/additional-prop.d.ts.map +1 -0
  83. package/dist/utils/betterAjvErrors/validation-errors/additional-prop.js +8 -9
  84. package/dist/utils/betterAjvErrors/validation-errors/additional-prop.js.map +7 -0
  85. package/dist/utils/betterAjvErrors/validation-errors/base.d.ts +23 -0
  86. package/dist/utils/betterAjvErrors/validation-errors/base.d.ts.map +1 -0
  87. package/dist/utils/betterAjvErrors/validation-errors/base.js +6 -10
  88. package/dist/utils/betterAjvErrors/validation-errors/base.js.map +7 -0
  89. package/dist/utils/betterAjvErrors/validation-errors/default.d.ts +10 -0
  90. package/dist/utils/betterAjvErrors/validation-errors/default.d.ts.map +1 -0
  91. package/dist/utils/betterAjvErrors/validation-errors/default.js +8 -9
  92. package/dist/utils/betterAjvErrors/validation-errors/default.js.map +7 -0
  93. package/dist/utils/betterAjvErrors/validation-errors/enum.d.ts +11 -0
  94. package/dist/utils/betterAjvErrors/validation-errors/enum.d.ts.map +1 -0
  95. package/dist/utils/betterAjvErrors/validation-errors/enum.js +19 -29
  96. package/dist/utils/betterAjvErrors/validation-errors/enum.js.map +7 -0
  97. package/dist/utils/betterAjvErrors/validation-errors/index.d.ts +7 -0
  98. package/dist/utils/betterAjvErrors/validation-errors/index.d.ts.map +1 -0
  99. package/dist/utils/betterAjvErrors/validation-errors/index.js +15 -0
  100. package/dist/utils/betterAjvErrors/validation-errors/index.js.map +7 -0
  101. package/dist/utils/betterAjvErrors/validation-errors/pattern.d.ts +10 -0
  102. package/dist/utils/betterAjvErrors/validation-errors/pattern.d.ts.map +1 -0
  103. package/dist/utils/betterAjvErrors/validation-errors/pattern.js +8 -9
  104. package/dist/utils/betterAjvErrors/validation-errors/pattern.js.map +7 -0
  105. package/dist/utils/betterAjvErrors/validation-errors/required.d.ts +10 -0
  106. package/dist/utils/betterAjvErrors/validation-errors/required.d.ts.map +1 -0
  107. package/dist/utils/betterAjvErrors/validation-errors/required.js +8 -9
  108. package/dist/utils/betterAjvErrors/validation-errors/required.js.map +7 -0
  109. package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.d.ts +10 -0
  110. package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.d.ts.map +1 -0
  111. package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.js +8 -9
  112. package/dist/utils/betterAjvErrors/validation-errors/unevaluated-prop.js.map +7 -0
  113. package/dist/utils/dereference.d.ts +2 -2
  114. package/dist/utils/dereference.d.ts.map +1 -1
  115. package/dist/utils/dereference.js +17 -19
  116. package/dist/utils/dereference.js.map +7 -0
  117. package/dist/utils/dereference.test.js +300 -0
  118. package/dist/utils/dereference.test.js.map +7 -0
  119. package/dist/utils/details.d.ts +1 -1
  120. package/dist/utils/details.d.ts.map +1 -1
  121. package/dist/utils/details.js +26 -28
  122. package/dist/utils/details.js.map +7 -0
  123. package/dist/utils/errors.test.js +48 -0
  124. package/dist/utils/errors.test.js.map +7 -0
  125. package/dist/utils/escapeJsonPointer.js +5 -8
  126. package/dist/utils/escapeJsonPointer.js.map +7 -0
  127. package/dist/utils/escapeJsonPointer.test.js +11 -0
  128. package/dist/utils/escapeJsonPointer.test.js.map +7 -0
  129. package/dist/utils/filter.d.ts +1 -1
  130. package/dist/utils/filter.d.ts.map +1 -1
  131. package/dist/utils/filter.js +13 -15
  132. package/dist/utils/filter.js.map +7 -0
  133. package/dist/utils/getEntrypoint.d.ts +1 -1
  134. package/dist/utils/getEntrypoint.d.ts.map +1 -1
  135. package/dist/utils/getEntrypoint.js +5 -6
  136. package/dist/utils/getEntrypoint.js.map +7 -0
  137. package/dist/utils/getEntrypoint.test.js +18 -0
  138. package/dist/utils/getEntrypoint.test.js.map +7 -0
  139. package/dist/utils/getListOfReferences.d.ts +1 -1
  140. package/dist/utils/getListOfReferences.d.ts.map +1 -1
  141. package/dist/utils/getListOfReferences.js +15 -22
  142. package/dist/utils/getListOfReferences.js.map +7 -0
  143. package/dist/utils/getSegmentsFromPath.js +8 -15
  144. package/dist/utils/getSegmentsFromPath.js.map +7 -0
  145. package/dist/utils/getSegmentsFromPath.test.js +13 -0
  146. package/dist/utils/getSegmentsFromPath.test.js.map +7 -0
  147. package/dist/utils/index.d.ts +26 -26
  148. package/dist/utils/index.d.ts.map +1 -1
  149. package/dist/utils/index.js +27 -0
  150. package/dist/utils/index.js.map +7 -0
  151. package/dist/utils/isFilesystem.d.ts +1 -2
  152. package/dist/utils/isFilesystem.d.ts.map +1 -1
  153. package/dist/utils/isFilesystem.js +5 -9
  154. package/dist/utils/isFilesystem.js.map +7 -0
  155. package/dist/utils/isJson.js +10 -9
  156. package/dist/utils/isJson.js.map +7 -0
  157. package/dist/utils/isObject.js +5 -6
  158. package/dist/utils/isObject.js.map +7 -0
  159. package/dist/utils/isObject.test.js +23 -0
  160. package/dist/utils/isObject.test.js.map +7 -0
  161. package/dist/utils/isYaml.js +16 -17
  162. package/dist/utils/isYaml.js.map +7 -0
  163. package/dist/utils/load/index.d.ts +1 -1
  164. package/dist/utils/load/index.d.ts.map +1 -1
  165. package/dist/utils/load/index.js +2 -0
  166. package/dist/utils/load/index.js.map +7 -0
  167. package/dist/utils/load/load.d.ts +3 -12
  168. package/dist/utils/load/load.d.ts.map +1 -1
  169. package/dist/utils/load/load.js +89 -149
  170. package/dist/utils/load/load.js.map +7 -0
  171. package/dist/utils/load/load.test.js +361 -0
  172. package/dist/utils/load/load.test.js.map +7 -0
  173. package/dist/utils/makeFilesystem.d.ts +2 -19
  174. package/dist/utils/makeFilesystem.d.ts.map +1 -1
  175. package/dist/utils/makeFilesystem.js +20 -68
  176. package/dist/utils/makeFilesystem.js.map +7 -0
  177. package/dist/utils/makeFilesystem.test.js +15 -0
  178. package/dist/utils/makeFilesystem.test.js.map +7 -0
  179. package/dist/utils/normalize.d.ts +1 -1
  180. package/dist/utils/normalize.d.ts.map +1 -1
  181. package/dist/utils/normalize.js +22 -27
  182. package/dist/utils/normalize.js.map +7 -0
  183. package/dist/utils/normalize.test.js +88 -0
  184. package/dist/utils/normalize.test.js.map +7 -0
  185. package/dist/utils/openapi/actions/details.d.ts +2 -2
  186. package/dist/utils/openapi/actions/details.d.ts.map +1 -1
  187. package/dist/utils/openapi/actions/details.js +9 -11
  188. package/dist/utils/openapi/actions/details.js.map +7 -0
  189. package/dist/utils/openapi/actions/files.d.ts +1 -1
  190. package/dist/utils/openapi/actions/files.d.ts.map +1 -1
  191. package/dist/utils/openapi/actions/files.js +7 -9
  192. package/dist/utils/openapi/actions/files.js.map +7 -0
  193. package/dist/utils/openapi/actions/get.d.ts +1 -1
  194. package/dist/utils/openapi/actions/get.d.ts.map +1 -1
  195. package/dist/utils/openapi/actions/get.js +9 -11
  196. package/dist/utils/openapi/actions/get.js.map +7 -0
  197. package/dist/utils/openapi/actions/toJson.d.ts +1 -1
  198. package/dist/utils/openapi/actions/toJson.d.ts.map +1 -1
  199. package/dist/utils/openapi/actions/toJson.js +9 -11
  200. package/dist/utils/openapi/actions/toJson.js.map +7 -0
  201. package/dist/utils/openapi/actions/toYaml.d.ts +1 -1
  202. package/dist/utils/openapi/actions/toYaml.d.ts.map +1 -1
  203. package/dist/utils/openapi/actions/toYaml.js +9 -11
  204. package/dist/utils/openapi/actions/toYaml.js.map +7 -0
  205. package/dist/utils/openapi/commands/dereferenceCommand.d.ts +5 -5
  206. package/dist/utils/openapi/commands/dereferenceCommand.d.ts.map +1 -1
  207. package/dist/utils/openapi/commands/dereferenceCommand.js +25 -27
  208. package/dist/utils/openapi/commands/dereferenceCommand.js.map +7 -0
  209. package/dist/utils/openapi/commands/filterCommand.d.ts +9 -9
  210. package/dist/utils/openapi/commands/filterCommand.d.ts.map +1 -1
  211. package/dist/utils/openapi/commands/filterCommand.js +24 -26
  212. package/dist/utils/openapi/commands/filterCommand.js.map +7 -0
  213. package/dist/utils/openapi/commands/loadCommand.d.ts +1174 -1174
  214. package/dist/utils/openapi/commands/loadCommand.d.ts.map +1 -1
  215. package/dist/utils/openapi/commands/loadCommand.js +40 -42
  216. package/dist/utils/openapi/commands/loadCommand.js.map +7 -0
  217. package/dist/utils/openapi/commands/upgradeCommand.d.ts +311 -311
  218. package/dist/utils/openapi/commands/upgradeCommand.d.ts.map +1 -1
  219. package/dist/utils/openapi/commands/upgradeCommand.js +27 -29
  220. package/dist/utils/openapi/commands/upgradeCommand.js.map +7 -0
  221. package/dist/utils/openapi/commands/validateCommand.d.ts +311 -311
  222. package/dist/utils/openapi/commands/validateCommand.d.ts.map +1 -1
  223. package/dist/utils/openapi/commands/validateCommand.js +31 -33
  224. package/dist/utils/openapi/commands/validateCommand.js.map +7 -0
  225. package/dist/utils/openapi/index.d.ts +1 -1
  226. package/dist/utils/openapi/index.d.ts.map +1 -1
  227. package/dist/utils/openapi/index.js +2 -0
  228. package/dist/utils/openapi/index.js.map +7 -0
  229. package/dist/utils/openapi/openapi.d.ts +700 -700
  230. package/dist/utils/openapi/openapi.d.ts.map +1 -1
  231. package/dist/utils/openapi/openapi.js +13 -16
  232. package/dist/utils/openapi/openapi.js.map +7 -0
  233. package/dist/utils/openapi/openapi.test-d.js +14 -0
  234. package/dist/utils/openapi/openapi.test-d.js.map +7 -0
  235. package/dist/utils/openapi/openapi.test.js +309 -0
  236. package/dist/utils/openapi/openapi.test.js.map +7 -0
  237. package/dist/utils/openapi/utils/queueTask.d.ts +1 -1
  238. package/dist/utils/openapi/utils/queueTask.d.ts.map +1 -1
  239. package/dist/utils/openapi/utils/queueTask.js +8 -9
  240. package/dist/utils/openapi/utils/queueTask.js.map +7 -0
  241. package/dist/utils/openapi/utils/workThroughQueue.d.ts +1 -1
  242. package/dist/utils/openapi/utils/workThroughQueue.d.ts.map +1 -1
  243. package/dist/utils/openapi/utils/workThroughQueue.js +49 -64
  244. package/dist/utils/openapi/utils/workThroughQueue.js.map +7 -0
  245. package/dist/utils/openapi/utils/workThroughQueue.test.js +244 -0
  246. package/dist/utils/openapi/utils/workThroughQueue.test.js.map +7 -0
  247. package/dist/utils/resolveReferences.d.ts +1 -7
  248. package/dist/utils/resolveReferences.d.ts.map +1 -1
  249. package/dist/utils/resolveReferences.js +91 -149
  250. package/dist/utils/resolveReferences.js.map +7 -0
  251. package/dist/utils/resolveReferences.test.js +567 -0
  252. package/dist/utils/resolveReferences.test.js.map +7 -0
  253. package/dist/utils/toJson.d.ts +1 -1
  254. package/dist/utils/toJson.d.ts.map +1 -1
  255. package/dist/utils/toJson.js +4 -2
  256. package/dist/utils/toJson.js.map +7 -0
  257. package/dist/utils/toYaml.d.ts +1 -1
  258. package/dist/utils/toYaml.d.ts.map +1 -1
  259. package/dist/utils/toYaml.js +5 -4
  260. package/dist/utils/toYaml.js.map +7 -0
  261. package/dist/utils/transform/index.d.ts +1 -1
  262. package/dist/utils/transform/index.d.ts.map +1 -1
  263. package/dist/utils/transform/index.js +2 -0
  264. package/dist/utils/transform/index.js.map +7 -0
  265. package/dist/utils/transform/sanitize.d.ts +3 -3
  266. package/dist/utils/transform/sanitize.d.ts.map +1 -1
  267. package/dist/utils/transform/sanitize.js +22 -21
  268. package/dist/utils/transform/sanitize.js.map +7 -0
  269. package/dist/utils/transform/sanitize.test.js +148 -0
  270. package/dist/utils/transform/sanitize.test.js.map +7 -0
  271. package/dist/utils/transform/utils/addInfoObject.d.ts +1 -1
  272. package/dist/utils/transform/utils/addInfoObject.d.ts.map +1 -1
  273. package/dist/utils/transform/utils/addInfoObject.js +14 -10
  274. package/dist/utils/transform/utils/addInfoObject.js.map +7 -0
  275. package/dist/utils/transform/utils/addLatestOpenApiVersion.d.ts +1 -1
  276. package/dist/utils/transform/utils/addLatestOpenApiVersion.d.ts.map +1 -1
  277. package/dist/utils/transform/utils/addLatestOpenApiVersion.js +8 -5
  278. package/dist/utils/transform/utils/addLatestOpenApiVersion.js.map +7 -0
  279. package/dist/utils/transform/utils/addMissingTags.d.ts +1 -1
  280. package/dist/utils/transform/utils/addMissingTags.d.ts.map +1 -1
  281. package/dist/utils/transform/utils/addMissingTags.js +26 -27
  282. package/dist/utils/transform/utils/addMissingTags.js.map +7 -0
  283. package/dist/utils/transform/utils/normalizeSecuritySchemes.d.ts +1 -1
  284. package/dist/utils/transform/utils/normalizeSecuritySchemes.d.ts.map +1 -1
  285. package/dist/utils/transform/utils/normalizeSecuritySchemes.js +36 -40
  286. package/dist/utils/transform/utils/normalizeSecuritySchemes.js.map +7 -0
  287. package/dist/utils/transform/utils/rejectSwaggerDocuments.d.ts +1 -1
  288. package/dist/utils/transform/utils/rejectSwaggerDocuments.d.ts.map +1 -1
  289. package/dist/utils/transform/utils/rejectSwaggerDocuments.js +8 -6
  290. package/dist/utils/transform/utils/rejectSwaggerDocuments.js.map +7 -0
  291. package/dist/utils/transformErrors.d.ts +1 -1
  292. package/dist/utils/transformErrors.d.ts.map +1 -1
  293. package/dist/utils/transformErrors.js +18 -21
  294. package/dist/utils/transformErrors.js.map +7 -0
  295. package/dist/utils/transformErrors.test.js +17 -0
  296. package/dist/utils/transformErrors.test.js.map +7 -0
  297. package/dist/utils/traverse.d.ts +1 -1
  298. package/dist/utils/traverse.d.ts.map +1 -1
  299. package/dist/utils/traverse.js +19 -22
  300. package/dist/utils/traverse.js.map +7 -0
  301. package/dist/utils/traverse.test.js +68 -0
  302. package/dist/utils/traverse.test.js.map +7 -0
  303. package/dist/utils/unescapeJsonPointer.js +5 -9
  304. package/dist/utils/unescapeJsonPointer.js.map +7 -0
  305. package/dist/utils/unescapeJsonPointer.test.js +19 -0
  306. package/dist/utils/unescapeJsonPointer.test.js.map +7 -0
  307. package/dist/utils/upgrade.d.ts +1 -1
  308. package/dist/utils/upgrade.d.ts.map +1 -1
  309. package/dist/utils/upgrade.js +22 -22
  310. package/dist/utils/upgrade.js.map +7 -0
  311. package/dist/utils/upgrade.test-d.js +16 -0
  312. package/dist/utils/upgrade.test-d.js.map +7 -0
  313. package/dist/utils/upgrade.test.js +57 -0
  314. package/dist/utils/upgrade.test.js.map +7 -0
  315. package/dist/utils/upgradeFromThreeToThreeOne.js +114 -140
  316. package/dist/utils/upgradeFromThreeToThreeOne.js.map +7 -0
  317. package/dist/utils/upgradeFromThreeToThreeOne.test.js +462 -0
  318. package/dist/utils/upgradeFromThreeToThreeOne.test.js.map +7 -0
  319. package/dist/utils/upgradeFromTwoToThree.js +212 -219
  320. package/dist/utils/upgradeFromTwoToThree.js.map +7 -0
  321. package/dist/utils/upgradeFromTwoToThree.test.js +589 -0
  322. package/dist/utils/upgradeFromTwoToThree.test.js.map +7 -0
  323. package/dist/utils/validate.d.ts +1 -1
  324. package/dist/utils/validate.d.ts.map +1 -1
  325. package/dist/utils/validate.js +14 -16
  326. package/dist/utils/validate.js.map +7 -0
  327. package/dist/utils/validate.test.js +64 -0
  328. package/dist/utils/validate.test.js.map +7 -0
  329. package/package.json +6 -8
  330. package/dist/schemas/v2.0/schema.json.js +0 -1623
  331. package/dist/schemas/v3.0/schema.json.js +0 -1673
  332. package/dist/schemas/v3.1/schema.json.js +0 -1451
@@ -1,1451 +0,0 @@
1
- var $id = "https://spec.openapis.org/oas/3.1/schema/2022-10-07";
2
- var $schema = "https://json-schema.org/draft/2020-12/schema";
3
- var description = "The description of OpenAPI v3.1.x documents without schema validation, as defined by https://spec.openapis.org/oas/v3.1.0";
4
- var type = "object";
5
- var properties = {
6
- openapi: {
7
- type: "string",
8
- pattern: "^3\\.1\\.\\d+(-.+)?$"
9
- },
10
- info: {
11
- $ref: "#/$defs/info"
12
- },
13
- jsonSchemaDialect: {
14
- type: "string",
15
- format: "uri-reference",
16
- "default": "https://spec.openapis.org/oas/3.1/dialect/base"
17
- },
18
- servers: {
19
- type: "array",
20
- items: {
21
- $ref: "#/$defs/server"
22
- },
23
- "default": [
24
- {
25
- url: "/"
26
- }
27
- ]
28
- },
29
- paths: {
30
- $ref: "#/$defs/paths"
31
- },
32
- webhooks: {
33
- type: "object",
34
- additionalProperties: {
35
- $ref: "#/$defs/path-item-or-reference"
36
- }
37
- },
38
- components: {
39
- $ref: "#/$defs/components"
40
- },
41
- security: {
42
- type: "array",
43
- items: {
44
- $ref: "#/$defs/security-requirement"
45
- }
46
- },
47
- tags: {
48
- type: "array",
49
- items: {
50
- $ref: "#/$defs/tag"
51
- }
52
- },
53
- externalDocs: {
54
- $ref: "#/$defs/external-documentation"
55
- }
56
- };
57
- var required = [
58
- "openapi",
59
- "info"
60
- ];
61
- var anyOf = [
62
- {
63
- required: [
64
- "paths"
65
- ]
66
- },
67
- {
68
- required: [
69
- "components"
70
- ]
71
- },
72
- {
73
- required: [
74
- "webhooks"
75
- ]
76
- }
77
- ];
78
- var $ref = "#/$defs/specification-extensions";
79
- var unevaluatedProperties = false;
80
- var $defs = {
81
- info: {
82
- $comment: "https://spec.openapis.org/oas/v3.1.0#info-object",
83
- type: "object",
84
- properties: {
85
- title: {
86
- type: "string"
87
- },
88
- summary: {
89
- type: "string"
90
- },
91
- description: {
92
- type: "string"
93
- },
94
- termsOfService: {
95
- type: "string",
96
- format: "uri-reference"
97
- },
98
- contact: {
99
- $ref: "#/$defs/contact"
100
- },
101
- license: {
102
- $ref: "#/$defs/license"
103
- },
104
- version: {
105
- type: "string"
106
- }
107
- },
108
- required: [
109
- "title",
110
- "version"
111
- ],
112
- $ref: "#/$defs/specification-extensions",
113
- unevaluatedProperties: false
114
- },
115
- contact: {
116
- $comment: "https://spec.openapis.org/oas/v3.1.0#contact-object",
117
- type: "object",
118
- properties: {
119
- name: {
120
- type: "string"
121
- },
122
- url: {
123
- type: "string",
124
- format: "uri-reference"
125
- },
126
- email: {
127
- type: "string",
128
- format: "email"
129
- }
130
- },
131
- $ref: "#/$defs/specification-extensions",
132
- unevaluatedProperties: false
133
- },
134
- license: {
135
- $comment: "https://spec.openapis.org/oas/v3.1.0#license-object",
136
- type: "object",
137
- properties: {
138
- name: {
139
- type: "string"
140
- },
141
- identifier: {
142
- type: "string"
143
- },
144
- url: {
145
- type: "string",
146
- format: "uri-reference"
147
- }
148
- },
149
- required: [
150
- "name"
151
- ],
152
- dependentSchemas: {
153
- identifier: {
154
- not: {
155
- required: [
156
- "url"
157
- ]
158
- }
159
- }
160
- },
161
- $ref: "#/$defs/specification-extensions",
162
- unevaluatedProperties: false
163
- },
164
- server: {
165
- $comment: "https://spec.openapis.org/oas/v3.1.0#server-object",
166
- type: "object",
167
- properties: {
168
- url: {
169
- type: "string"
170
- },
171
- description: {
172
- type: "string"
173
- },
174
- variables: {
175
- type: "object",
176
- additionalProperties: {
177
- $ref: "#/$defs/server-variable"
178
- }
179
- }
180
- },
181
- required: [
182
- "url"
183
- ],
184
- $ref: "#/$defs/specification-extensions",
185
- unevaluatedProperties: false
186
- },
187
- "server-variable": {
188
- $comment: "https://spec.openapis.org/oas/v3.1.0#server-variable-object",
189
- type: "object",
190
- properties: {
191
- "enum": {
192
- type: "array",
193
- items: {
194
- type: "string"
195
- },
196
- minItems: 1
197
- },
198
- "default": {
199
- type: "string"
200
- },
201
- description: {
202
- type: "string"
203
- }
204
- },
205
- required: [
206
- "default"
207
- ],
208
- $ref: "#/$defs/specification-extensions",
209
- unevaluatedProperties: false
210
- },
211
- components: {
212
- $comment: "https://spec.openapis.org/oas/v3.1.0#components-object",
213
- type: "object",
214
- properties: {
215
- schemas: {
216
- type: "object",
217
- additionalProperties: {
218
- $ref: "#/$defs/schema"
219
- }
220
- },
221
- responses: {
222
- type: "object",
223
- additionalProperties: {
224
- $ref: "#/$defs/response-or-reference"
225
- }
226
- },
227
- parameters: {
228
- type: "object",
229
- additionalProperties: {
230
- $ref: "#/$defs/parameter-or-reference"
231
- }
232
- },
233
- examples: {
234
- type: "object",
235
- additionalProperties: {
236
- $ref: "#/$defs/example-or-reference"
237
- }
238
- },
239
- requestBodies: {
240
- type: "object",
241
- additionalProperties: {
242
- $ref: "#/$defs/request-body-or-reference"
243
- }
244
- },
245
- headers: {
246
- type: "object",
247
- additionalProperties: {
248
- $ref: "#/$defs/header-or-reference"
249
- }
250
- },
251
- securitySchemes: {
252
- type: "object",
253
- additionalProperties: {
254
- $ref: "#/$defs/security-scheme-or-reference"
255
- }
256
- },
257
- links: {
258
- type: "object",
259
- additionalProperties: {
260
- $ref: "#/$defs/link-or-reference"
261
- }
262
- },
263
- callbacks: {
264
- type: "object",
265
- additionalProperties: {
266
- $ref: "#/$defs/callbacks-or-reference"
267
- }
268
- },
269
- pathItems: {
270
- type: "object",
271
- additionalProperties: {
272
- $ref: "#/$defs/path-item-or-reference"
273
- }
274
- }
275
- },
276
- patternProperties: {
277
- "^(schemas|responses|parameters|examples|requestBodies|headers|securitySchemes|links|callbacks|pathItems)$": {
278
- $comment: "Enumerating all of the property names in the regex above is necessary for unevaluatedProperties to work as expected",
279
- propertyNames: {
280
- pattern: "^[a-zA-Z0-9._-]+$"
281
- }
282
- }
283
- },
284
- $ref: "#/$defs/specification-extensions",
285
- unevaluatedProperties: false
286
- },
287
- paths: {
288
- $comment: "https://spec.openapis.org/oas/v3.1.0#paths-object",
289
- type: "object",
290
- patternProperties: {
291
- "^/": {
292
- $ref: "#/$defs/path-item"
293
- }
294
- },
295
- $ref: "#/$defs/specification-extensions",
296
- unevaluatedProperties: false
297
- },
298
- "path-item": {
299
- $comment: "https://spec.openapis.org/oas/v3.1.0#path-item-object",
300
- type: "object",
301
- properties: {
302
- summary: {
303
- type: "string"
304
- },
305
- description: {
306
- type: "string"
307
- },
308
- servers: {
309
- type: "array",
310
- items: {
311
- $ref: "#/$defs/server"
312
- }
313
- },
314
- parameters: {
315
- type: "array",
316
- items: {
317
- $ref: "#/$defs/parameter-or-reference"
318
- }
319
- },
320
- get: {
321
- $ref: "#/$defs/operation"
322
- },
323
- put: {
324
- $ref: "#/$defs/operation"
325
- },
326
- post: {
327
- $ref: "#/$defs/operation"
328
- },
329
- "delete": {
330
- $ref: "#/$defs/operation"
331
- },
332
- options: {
333
- $ref: "#/$defs/operation"
334
- },
335
- head: {
336
- $ref: "#/$defs/operation"
337
- },
338
- patch: {
339
- $ref: "#/$defs/operation"
340
- },
341
- trace: {
342
- $ref: "#/$defs/operation"
343
- }
344
- },
345
- $ref: "#/$defs/specification-extensions",
346
- unevaluatedProperties: false
347
- },
348
- "path-item-or-reference": {
349
- "if": {
350
- type: "object",
351
- required: [
352
- "$ref"
353
- ]
354
- },
355
- then: {
356
- $ref: "#/$defs/reference"
357
- },
358
- "else": {
359
- $ref: "#/$defs/path-item"
360
- }
361
- },
362
- operation: {
363
- $comment: "https://spec.openapis.org/oas/v3.1.0#operation-object",
364
- type: "object",
365
- properties: {
366
- tags: {
367
- type: "array",
368
- items: {
369
- type: "string"
370
- }
371
- },
372
- summary: {
373
- type: "string"
374
- },
375
- description: {
376
- type: "string"
377
- },
378
- externalDocs: {
379
- $ref: "#/$defs/external-documentation"
380
- },
381
- operationId: {
382
- type: "string"
383
- },
384
- parameters: {
385
- type: "array",
386
- items: {
387
- $ref: "#/$defs/parameter-or-reference"
388
- }
389
- },
390
- requestBody: {
391
- $ref: "#/$defs/request-body-or-reference"
392
- },
393
- responses: {
394
- $ref: "#/$defs/responses"
395
- },
396
- callbacks: {
397
- type: "object",
398
- additionalProperties: {
399
- $ref: "#/$defs/callbacks-or-reference"
400
- }
401
- },
402
- deprecated: {
403
- "default": false,
404
- type: "boolean"
405
- },
406
- security: {
407
- type: "array",
408
- items: {
409
- $ref: "#/$defs/security-requirement"
410
- }
411
- },
412
- servers: {
413
- type: "array",
414
- items: {
415
- $ref: "#/$defs/server"
416
- }
417
- }
418
- },
419
- $ref: "#/$defs/specification-extensions",
420
- unevaluatedProperties: false
421
- },
422
- "external-documentation": {
423
- $comment: "https://spec.openapis.org/oas/v3.1.0#external-documentation-object",
424
- type: "object",
425
- properties: {
426
- description: {
427
- type: "string"
428
- },
429
- url: {
430
- type: "string",
431
- format: "uri-reference"
432
- }
433
- },
434
- required: [
435
- "url"
436
- ],
437
- $ref: "#/$defs/specification-extensions",
438
- unevaluatedProperties: false
439
- },
440
- parameter: {
441
- $comment: "https://spec.openapis.org/oas/v3.1.0#parameter-object",
442
- type: "object",
443
- properties: {
444
- name: {
445
- type: "string"
446
- },
447
- "in": {
448
- "enum": [
449
- "query",
450
- "header",
451
- "path",
452
- "cookie"
453
- ]
454
- },
455
- description: {
456
- type: "string"
457
- },
458
- required: {
459
- "default": false,
460
- type: "boolean"
461
- },
462
- deprecated: {
463
- "default": false,
464
- type: "boolean"
465
- },
466
- schema: {
467
- $ref: "#/$defs/schema"
468
- },
469
- content: {
470
- $ref: "#/$defs/content",
471
- minProperties: 1,
472
- maxProperties: 1
473
- }
474
- },
475
- required: [
476
- "name",
477
- "in"
478
- ],
479
- oneOf: [
480
- {
481
- required: [
482
- "schema"
483
- ]
484
- },
485
- {
486
- required: [
487
- "content"
488
- ]
489
- }
490
- ],
491
- "if": {
492
- properties: {
493
- "in": {
494
- "const": "query"
495
- }
496
- },
497
- required: [
498
- "in"
499
- ]
500
- },
501
- then: {
502
- properties: {
503
- allowEmptyValue: {
504
- "default": false,
505
- type: "boolean"
506
- }
507
- }
508
- },
509
- dependentSchemas: {
510
- schema: {
511
- properties: {
512
- style: {
513
- type: "string"
514
- },
515
- explode: {
516
- type: "boolean"
517
- }
518
- },
519
- allOf: [
520
- {
521
- $ref: "#/$defs/examples"
522
- },
523
- {
524
- $ref: "#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-path"
525
- },
526
- {
527
- $ref: "#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-header"
528
- },
529
- {
530
- $ref: "#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-query"
531
- },
532
- {
533
- $ref: "#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-cookie"
534
- },
535
- {
536
- $ref: "#/$defs/parameter/dependentSchemas/schema/$defs/styles-for-form"
537
- }
538
- ],
539
- $defs: {
540
- "styles-for-path": {
541
- "if": {
542
- properties: {
543
- "in": {
544
- "const": "path"
545
- }
546
- },
547
- required: [
548
- "in"
549
- ]
550
- },
551
- then: {
552
- properties: {
553
- name: {
554
- pattern: "[^/#?]+$"
555
- },
556
- style: {
557
- "default": "simple",
558
- "enum": [
559
- "matrix",
560
- "label",
561
- "simple"
562
- ]
563
- },
564
- required: {
565
- "const": true
566
- }
567
- },
568
- required: [
569
- "required"
570
- ]
571
- }
572
- },
573
- "styles-for-header": {
574
- "if": {
575
- properties: {
576
- "in": {
577
- "const": "header"
578
- }
579
- },
580
- required: [
581
- "in"
582
- ]
583
- },
584
- then: {
585
- properties: {
586
- style: {
587
- "default": "simple",
588
- "const": "simple"
589
- }
590
- }
591
- }
592
- },
593
- "styles-for-query": {
594
- "if": {
595
- properties: {
596
- "in": {
597
- "const": "query"
598
- }
599
- },
600
- required: [
601
- "in"
602
- ]
603
- },
604
- then: {
605
- properties: {
606
- style: {
607
- "default": "form",
608
- "enum": [
609
- "form",
610
- "spaceDelimited",
611
- "pipeDelimited",
612
- "deepObject"
613
- ]
614
- },
615
- allowReserved: {
616
- "default": false,
617
- type: "boolean"
618
- }
619
- }
620
- }
621
- },
622
- "styles-for-cookie": {
623
- "if": {
624
- properties: {
625
- "in": {
626
- "const": "cookie"
627
- }
628
- },
629
- required: [
630
- "in"
631
- ]
632
- },
633
- then: {
634
- properties: {
635
- style: {
636
- "default": "form",
637
- "const": "form"
638
- }
639
- }
640
- }
641
- },
642
- "styles-for-form": {
643
- "if": {
644
- properties: {
645
- style: {
646
- "const": "form"
647
- }
648
- },
649
- required: [
650
- "style"
651
- ]
652
- },
653
- then: {
654
- properties: {
655
- explode: {
656
- "default": true
657
- }
658
- }
659
- },
660
- "else": {
661
- properties: {
662
- explode: {
663
- "default": false
664
- }
665
- }
666
- }
667
- }
668
- }
669
- }
670
- },
671
- $ref: "#/$defs/specification-extensions",
672
- unevaluatedProperties: false
673
- },
674
- "parameter-or-reference": {
675
- "if": {
676
- type: "object",
677
- required: [
678
- "$ref"
679
- ]
680
- },
681
- then: {
682
- $ref: "#/$defs/reference"
683
- },
684
- "else": {
685
- $ref: "#/$defs/parameter"
686
- }
687
- },
688
- "request-body": {
689
- $comment: "https://spec.openapis.org/oas/v3.1.0#request-body-object",
690
- type: "object",
691
- properties: {
692
- description: {
693
- type: "string"
694
- },
695
- content: {
696
- $ref: "#/$defs/content"
697
- },
698
- required: {
699
- "default": false,
700
- type: "boolean"
701
- }
702
- },
703
- required: [
704
- "content"
705
- ],
706
- $ref: "#/$defs/specification-extensions",
707
- unevaluatedProperties: false
708
- },
709
- "request-body-or-reference": {
710
- "if": {
711
- type: "object",
712
- required: [
713
- "$ref"
714
- ]
715
- },
716
- then: {
717
- $ref: "#/$defs/reference"
718
- },
719
- "else": {
720
- $ref: "#/$defs/request-body"
721
- }
722
- },
723
- content: {
724
- $comment: "https://spec.openapis.org/oas/v3.1.0#fixed-fields-10",
725
- type: "object",
726
- additionalProperties: {
727
- $ref: "#/$defs/media-type"
728
- },
729
- propertyNames: {
730
- format: "media-range"
731
- }
732
- },
733
- "media-type": {
734
- $comment: "https://spec.openapis.org/oas/v3.1.0#media-type-object",
735
- type: "object",
736
- properties: {
737
- schema: {
738
- $ref: "#/$defs/schema"
739
- },
740
- encoding: {
741
- type: "object",
742
- additionalProperties: {
743
- $ref: "#/$defs/encoding"
744
- }
745
- }
746
- },
747
- allOf: [
748
- {
749
- $ref: "#/$defs/specification-extensions"
750
- },
751
- {
752
- $ref: "#/$defs/examples"
753
- }
754
- ],
755
- unevaluatedProperties: false
756
- },
757
- encoding: {
758
- $comment: "https://spec.openapis.org/oas/v3.1.0#encoding-object",
759
- type: "object",
760
- properties: {
761
- contentType: {
762
- type: "string",
763
- format: "media-range"
764
- },
765
- headers: {
766
- type: "object",
767
- additionalProperties: {
768
- $ref: "#/$defs/header-or-reference"
769
- }
770
- },
771
- style: {
772
- "default": "form",
773
- "enum": [
774
- "form",
775
- "spaceDelimited",
776
- "pipeDelimited",
777
- "deepObject"
778
- ]
779
- },
780
- explode: {
781
- type: "boolean"
782
- },
783
- allowReserved: {
784
- "default": false,
785
- type: "boolean"
786
- }
787
- },
788
- allOf: [
789
- {
790
- $ref: "#/$defs/specification-extensions"
791
- },
792
- {
793
- $ref: "#/$defs/encoding/$defs/explode-default"
794
- }
795
- ],
796
- unevaluatedProperties: false,
797
- $defs: {
798
- "explode-default": {
799
- "if": {
800
- properties: {
801
- style: {
802
- "const": "form"
803
- }
804
- },
805
- required: [
806
- "style"
807
- ]
808
- },
809
- then: {
810
- properties: {
811
- explode: {
812
- "default": true
813
- }
814
- }
815
- },
816
- "else": {
817
- properties: {
818
- explode: {
819
- "default": false
820
- }
821
- }
822
- }
823
- }
824
- }
825
- },
826
- responses: {
827
- $comment: "https://spec.openapis.org/oas/v3.1.0#responses-object",
828
- type: "object",
829
- properties: {
830
- "default": {
831
- $ref: "#/$defs/response-or-reference"
832
- }
833
- },
834
- patternProperties: {
835
- "^[1-5](?:[0-9]{2}|XX)$": {
836
- $ref: "#/$defs/response-or-reference"
837
- }
838
- },
839
- minProperties: 1,
840
- $ref: "#/$defs/specification-extensions",
841
- unevaluatedProperties: false
842
- },
843
- response: {
844
- $comment: "https://spec.openapis.org/oas/v3.1.0#response-object",
845
- type: "object",
846
- properties: {
847
- description: {
848
- type: "string"
849
- },
850
- headers: {
851
- type: "object",
852
- additionalProperties: {
853
- $ref: "#/$defs/header-or-reference"
854
- }
855
- },
856
- content: {
857
- $ref: "#/$defs/content"
858
- },
859
- links: {
860
- type: "object",
861
- additionalProperties: {
862
- $ref: "#/$defs/link-or-reference"
863
- }
864
- }
865
- },
866
- required: [
867
- "description"
868
- ],
869
- $ref: "#/$defs/specification-extensions",
870
- unevaluatedProperties: false
871
- },
872
- "response-or-reference": {
873
- "if": {
874
- type: "object",
875
- required: [
876
- "$ref"
877
- ]
878
- },
879
- then: {
880
- $ref: "#/$defs/reference"
881
- },
882
- "else": {
883
- $ref: "#/$defs/response"
884
- }
885
- },
886
- callbacks: {
887
- $comment: "https://spec.openapis.org/oas/v3.1.0#callback-object",
888
- type: "object",
889
- $ref: "#/$defs/specification-extensions",
890
- additionalProperties: {
891
- $ref: "#/$defs/path-item-or-reference"
892
- }
893
- },
894
- "callbacks-or-reference": {
895
- "if": {
896
- type: "object",
897
- required: [
898
- "$ref"
899
- ]
900
- },
901
- then: {
902
- $ref: "#/$defs/reference"
903
- },
904
- "else": {
905
- $ref: "#/$defs/callbacks"
906
- }
907
- },
908
- example: {
909
- $comment: "https://spec.openapis.org/oas/v3.1.0#example-object",
910
- type: "object",
911
- properties: {
912
- summary: {
913
- type: "string"
914
- },
915
- description: {
916
- type: "string"
917
- },
918
- value: true,
919
- externalValue: {
920
- type: "string",
921
- format: "uri-reference"
922
- }
923
- },
924
- not: {
925
- required: [
926
- "value",
927
- "externalValue"
928
- ]
929
- },
930
- $ref: "#/$defs/specification-extensions",
931
- unevaluatedProperties: false
932
- },
933
- "example-or-reference": {
934
- "if": {
935
- type: "object",
936
- required: [
937
- "$ref"
938
- ]
939
- },
940
- then: {
941
- $ref: "#/$defs/reference"
942
- },
943
- "else": {
944
- $ref: "#/$defs/example"
945
- }
946
- },
947
- link: {
948
- $comment: "https://spec.openapis.org/oas/v3.1.0#link-object",
949
- type: "object",
950
- properties: {
951
- operationRef: {
952
- type: "string",
953
- format: "uri-reference"
954
- },
955
- operationId: {
956
- type: "string"
957
- },
958
- parameters: {
959
- $ref: "#/$defs/map-of-strings"
960
- },
961
- requestBody: true,
962
- description: {
963
- type: "string"
964
- },
965
- body: {
966
- $ref: "#/$defs/server"
967
- }
968
- },
969
- oneOf: [
970
- {
971
- required: [
972
- "operationRef"
973
- ]
974
- },
975
- {
976
- required: [
977
- "operationId"
978
- ]
979
- }
980
- ],
981
- $ref: "#/$defs/specification-extensions",
982
- unevaluatedProperties: false
983
- },
984
- "link-or-reference": {
985
- "if": {
986
- type: "object",
987
- required: [
988
- "$ref"
989
- ]
990
- },
991
- then: {
992
- $ref: "#/$defs/reference"
993
- },
994
- "else": {
995
- $ref: "#/$defs/link"
996
- }
997
- },
998
- header: {
999
- $comment: "https://spec.openapis.org/oas/v3.1.0#header-object",
1000
- type: "object",
1001
- properties: {
1002
- description: {
1003
- type: "string"
1004
- },
1005
- required: {
1006
- "default": false,
1007
- type: "boolean"
1008
- },
1009
- deprecated: {
1010
- "default": false,
1011
- type: "boolean"
1012
- },
1013
- schema: {
1014
- $ref: "#/$defs/schema"
1015
- },
1016
- content: {
1017
- $ref: "#/$defs/content",
1018
- minProperties: 1,
1019
- maxProperties: 1
1020
- }
1021
- },
1022
- oneOf: [
1023
- {
1024
- required: [
1025
- "schema"
1026
- ]
1027
- },
1028
- {
1029
- required: [
1030
- "content"
1031
- ]
1032
- }
1033
- ],
1034
- dependentSchemas: {
1035
- schema: {
1036
- properties: {
1037
- style: {
1038
- "default": "simple",
1039
- "const": "simple"
1040
- },
1041
- explode: {
1042
- "default": false,
1043
- type: "boolean"
1044
- }
1045
- },
1046
- $ref: "#/$defs/examples"
1047
- }
1048
- },
1049
- $ref: "#/$defs/specification-extensions",
1050
- unevaluatedProperties: false
1051
- },
1052
- "header-or-reference": {
1053
- "if": {
1054
- type: "object",
1055
- required: [
1056
- "$ref"
1057
- ]
1058
- },
1059
- then: {
1060
- $ref: "#/$defs/reference"
1061
- },
1062
- "else": {
1063
- $ref: "#/$defs/header"
1064
- }
1065
- },
1066
- tag: {
1067
- $comment: "https://spec.openapis.org/oas/v3.1.0#tag-object",
1068
- type: "object",
1069
- properties: {
1070
- name: {
1071
- type: "string"
1072
- },
1073
- description: {
1074
- type: "string"
1075
- },
1076
- externalDocs: {
1077
- $ref: "#/$defs/external-documentation"
1078
- }
1079
- },
1080
- required: [
1081
- "name"
1082
- ],
1083
- $ref: "#/$defs/specification-extensions",
1084
- unevaluatedProperties: false
1085
- },
1086
- reference: {
1087
- $comment: "https://spec.openapis.org/oas/v3.1.0#reference-object",
1088
- type: "object",
1089
- properties: {
1090
- $ref: {
1091
- type: "string",
1092
- format: "uri-reference"
1093
- },
1094
- summary: {
1095
- type: "string"
1096
- },
1097
- description: {
1098
- type: "string"
1099
- }
1100
- },
1101
- unevaluatedProperties: false
1102
- },
1103
- schema: {
1104
- $comment: "https://spec.openapis.org/oas/v3.1.0#schema-object",
1105
- $dynamicAnchor: "meta",
1106
- type: [
1107
- "object",
1108
- "boolean"
1109
- ]
1110
- },
1111
- "security-scheme": {
1112
- $comment: "https://spec.openapis.org/oas/v3.1.0#security-scheme-object",
1113
- type: "object",
1114
- properties: {
1115
- type: {
1116
- "enum": [
1117
- "apiKey",
1118
- "http",
1119
- "mutualTLS",
1120
- "oauth2",
1121
- "openIdConnect"
1122
- ]
1123
- },
1124
- description: {
1125
- type: "string"
1126
- }
1127
- },
1128
- required: [
1129
- "type"
1130
- ],
1131
- allOf: [
1132
- {
1133
- $ref: "#/$defs/specification-extensions"
1134
- },
1135
- {
1136
- $ref: "#/$defs/security-scheme/$defs/type-apikey"
1137
- },
1138
- {
1139
- $ref: "#/$defs/security-scheme/$defs/type-http"
1140
- },
1141
- {
1142
- $ref: "#/$defs/security-scheme/$defs/type-http-bearer"
1143
- },
1144
- {
1145
- $ref: "#/$defs/security-scheme/$defs/type-oauth2"
1146
- },
1147
- {
1148
- $ref: "#/$defs/security-scheme/$defs/type-oidc"
1149
- }
1150
- ],
1151
- unevaluatedProperties: false,
1152
- $defs: {
1153
- "type-apikey": {
1154
- "if": {
1155
- properties: {
1156
- type: {
1157
- "const": "apiKey"
1158
- }
1159
- },
1160
- required: [
1161
- "type"
1162
- ]
1163
- },
1164
- then: {
1165
- properties: {
1166
- name: {
1167
- type: "string"
1168
- },
1169
- "in": {
1170
- "enum": [
1171
- "query",
1172
- "header",
1173
- "cookie"
1174
- ]
1175
- }
1176
- },
1177
- required: [
1178
- "name",
1179
- "in"
1180
- ]
1181
- }
1182
- },
1183
- "type-http": {
1184
- "if": {
1185
- properties: {
1186
- type: {
1187
- "const": "http"
1188
- }
1189
- },
1190
- required: [
1191
- "type"
1192
- ]
1193
- },
1194
- then: {
1195
- properties: {
1196
- scheme: {
1197
- type: "string"
1198
- }
1199
- },
1200
- required: [
1201
- "scheme"
1202
- ]
1203
- }
1204
- },
1205
- "type-http-bearer": {
1206
- "if": {
1207
- properties: {
1208
- type: {
1209
- "const": "http"
1210
- },
1211
- scheme: {
1212
- type: "string",
1213
- pattern: "^[Bb][Ee][Aa][Rr][Ee][Rr]$"
1214
- }
1215
- },
1216
- required: [
1217
- "type",
1218
- "scheme"
1219
- ]
1220
- },
1221
- then: {
1222
- properties: {
1223
- bearerFormat: {
1224
- type: "string"
1225
- }
1226
- }
1227
- }
1228
- },
1229
- "type-oauth2": {
1230
- "if": {
1231
- properties: {
1232
- type: {
1233
- "const": "oauth2"
1234
- }
1235
- },
1236
- required: [
1237
- "type"
1238
- ]
1239
- },
1240
- then: {
1241
- properties: {
1242
- flows: {
1243
- $ref: "#/$defs/oauth-flows"
1244
- }
1245
- },
1246
- required: [
1247
- "flows"
1248
- ]
1249
- }
1250
- },
1251
- "type-oidc": {
1252
- "if": {
1253
- properties: {
1254
- type: {
1255
- "const": "openIdConnect"
1256
- }
1257
- },
1258
- required: [
1259
- "type"
1260
- ]
1261
- },
1262
- then: {
1263
- properties: {
1264
- openIdConnectUrl: {
1265
- type: "string",
1266
- format: "uri-reference"
1267
- }
1268
- },
1269
- required: [
1270
- "openIdConnectUrl"
1271
- ]
1272
- }
1273
- }
1274
- }
1275
- },
1276
- "security-scheme-or-reference": {
1277
- "if": {
1278
- type: "object",
1279
- required: [
1280
- "$ref"
1281
- ]
1282
- },
1283
- then: {
1284
- $ref: "#/$defs/reference"
1285
- },
1286
- "else": {
1287
- $ref: "#/$defs/security-scheme"
1288
- }
1289
- },
1290
- "oauth-flows": {
1291
- type: "object",
1292
- properties: {
1293
- implicit: {
1294
- $ref: "#/$defs/oauth-flows/$defs/implicit"
1295
- },
1296
- password: {
1297
- $ref: "#/$defs/oauth-flows/$defs/password"
1298
- },
1299
- clientCredentials: {
1300
- $ref: "#/$defs/oauth-flows/$defs/client-credentials"
1301
- },
1302
- authorizationCode: {
1303
- $ref: "#/$defs/oauth-flows/$defs/authorization-code"
1304
- }
1305
- },
1306
- $ref: "#/$defs/specification-extensions",
1307
- unevaluatedProperties: false,
1308
- $defs: {
1309
- implicit: {
1310
- type: "object",
1311
- properties: {
1312
- authorizationUrl: {
1313
- type: "string",
1314
- format: "uri-reference"
1315
- },
1316
- refreshUrl: {
1317
- type: "string",
1318
- format: "uri-reference"
1319
- },
1320
- scopes: {
1321
- $ref: "#/$defs/map-of-strings"
1322
- }
1323
- },
1324
- required: [
1325
- "authorizationUrl",
1326
- "scopes"
1327
- ],
1328
- $ref: "#/$defs/specification-extensions",
1329
- unevaluatedProperties: false
1330
- },
1331
- password: {
1332
- type: "object",
1333
- properties: {
1334
- tokenUrl: {
1335
- type: "string",
1336
- format: "uri-reference"
1337
- },
1338
- refreshUrl: {
1339
- type: "string",
1340
- format: "uri-reference"
1341
- },
1342
- scopes: {
1343
- $ref: "#/$defs/map-of-strings"
1344
- }
1345
- },
1346
- required: [
1347
- "tokenUrl",
1348
- "scopes"
1349
- ],
1350
- $ref: "#/$defs/specification-extensions",
1351
- unevaluatedProperties: false
1352
- },
1353
- "client-credentials": {
1354
- type: "object",
1355
- properties: {
1356
- tokenUrl: {
1357
- type: "string",
1358
- format: "uri-reference"
1359
- },
1360
- refreshUrl: {
1361
- type: "string",
1362
- format: "uri-reference"
1363
- },
1364
- scopes: {
1365
- $ref: "#/$defs/map-of-strings"
1366
- }
1367
- },
1368
- required: [
1369
- "tokenUrl",
1370
- "scopes"
1371
- ],
1372
- $ref: "#/$defs/specification-extensions",
1373
- unevaluatedProperties: false
1374
- },
1375
- "authorization-code": {
1376
- type: "object",
1377
- properties: {
1378
- authorizationUrl: {
1379
- type: "string",
1380
- format: "uri-reference"
1381
- },
1382
- tokenUrl: {
1383
- type: "string",
1384
- format: "uri-reference"
1385
- },
1386
- refreshUrl: {
1387
- type: "string",
1388
- format: "uri-reference"
1389
- },
1390
- scopes: {
1391
- $ref: "#/$defs/map-of-strings"
1392
- }
1393
- },
1394
- required: [
1395
- "authorizationUrl",
1396
- "tokenUrl",
1397
- "scopes"
1398
- ],
1399
- $ref: "#/$defs/specification-extensions",
1400
- unevaluatedProperties: false
1401
- }
1402
- }
1403
- },
1404
- "security-requirement": {
1405
- $comment: "https://spec.openapis.org/oas/v3.1.0#security-requirement-object",
1406
- type: "object",
1407
- additionalProperties: {
1408
- type: "array",
1409
- items: {
1410
- type: "string"
1411
- }
1412
- }
1413
- },
1414
- "specification-extensions": {
1415
- $comment: "https://spec.openapis.org/oas/v3.1.0#specification-extensions",
1416
- patternProperties: {
1417
- "^x-": true
1418
- }
1419
- },
1420
- examples: {
1421
- properties: {
1422
- example: true,
1423
- examples: {
1424
- type: "object",
1425
- additionalProperties: {
1426
- $ref: "#/$defs/example-or-reference"
1427
- }
1428
- }
1429
- }
1430
- },
1431
- "map-of-strings": {
1432
- type: "object",
1433
- additionalProperties: {
1434
- type: "string"
1435
- }
1436
- }
1437
- };
1438
- var OpenApi31 = {
1439
- $id: $id,
1440
- $schema: $schema,
1441
- description: description,
1442
- type: type,
1443
- properties: properties,
1444
- required: required,
1445
- anyOf: anyOf,
1446
- $ref: $ref,
1447
- unevaluatedProperties: unevaluatedProperties,
1448
- $defs: $defs
1449
- };
1450
-
1451
- export { $defs, $id, $ref, $schema, anyOf, OpenApi31 as default, description, properties, required, type, unevaluatedProperties };