@lukoweb/apitogo 0.1.24 → 0.1.38

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 (477) hide show
  1. package/README.md +92 -0
  2. package/cli.js +13 -13
  3. package/client.d.ts +8 -8
  4. package/dist/cli/cli.js +1117 -624
  5. package/dist/declarations/config/config.d.ts +4 -0
  6. package/dist/declarations/config/loader.d.ts +2 -0
  7. package/dist/declarations/config/resolve-modules.d.ts +34 -0
  8. package/dist/declarations/config/validators/InputNavigationSchema.d.ts +7 -7
  9. package/dist/declarations/config/validators/ModulesSchema.d.ts +417 -0
  10. package/dist/declarations/config/validators/ZudokuConfig.d.ts +123 -4
  11. package/dist/declarations/index.d.ts +3 -1
  12. package/dist/declarations/lib/authentication/components/ProductionUnlockPage.d.ts +1 -0
  13. package/dist/declarations/lib/authentication/hook.d.ts +3 -19
  14. package/dist/declarations/lib/authentication/providers/dev-portal-constants.d.ts +16 -0
  15. package/dist/declarations/lib/authentication/providers/dev-portal-utils.d.ts +9 -0
  16. package/dist/declarations/lib/authentication/providers/dev-portal.d.ts +39 -0
  17. package/dist/declarations/lib/authentication/state.d.ts +12 -26
  18. package/dist/declarations/lib/components/LandingLayout.d.ts +4 -0
  19. package/dist/declarations/lib/components/index.d.ts +2 -0
  20. package/dist/declarations/lib/plugins/api-keys/index.d.ts +2 -1
  21. package/dist/flat-config.d.ts +209 -24
  22. package/docs/components/alert.mdx +130 -0
  23. package/docs/components/badge.mdx +70 -0
  24. package/docs/components/button.mdx +132 -0
  25. package/docs/components/callout.mdx +112 -0
  26. package/docs/components/card.mdx +104 -0
  27. package/docs/components/checkbox.mdx +72 -0
  28. package/docs/components/client-only.mdx +79 -0
  29. package/docs/components/code-tabs.mdx +179 -0
  30. package/docs/components/dialog.mdx +167 -0
  31. package/docs/components/head.mdx +200 -0
  32. package/docs/components/icons.mdx +27 -0
  33. package/docs/components/input.mdx +96 -0
  34. package/docs/components/label.mdx +86 -0
  35. package/docs/components/link.mdx +242 -0
  36. package/docs/components/markdown.mdx +151 -0
  37. package/docs/components/mermaid.mdx +81 -0
  38. package/docs/components/playground.mdx +87 -0
  39. package/docs/components/secret.mdx +79 -0
  40. package/docs/components/select.mdx +176 -0
  41. package/docs/components/shadcn.mdx +73 -0
  42. package/docs/components/slider.mdx +108 -0
  43. package/docs/components/slot.mdx +119 -0
  44. package/docs/components/stepper.mdx +138 -0
  45. package/docs/components/switch.mdx +96 -0
  46. package/docs/components/syntax-highlight.mdx +602 -0
  47. package/docs/components/textarea.mdx +78 -0
  48. package/docs/components/tooltip.mdx +195 -0
  49. package/docs/components/typography.mdx +61 -0
  50. package/docs/concepts/auth-provider-api-identities.md +109 -0
  51. package/docs/configuration/ai-assistants.md +65 -0
  52. package/docs/configuration/api-catalog.md +109 -0
  53. package/docs/configuration/api-reference.md +397 -0
  54. package/docs/configuration/authentication-auth0.md +174 -0
  55. package/docs/configuration/authentication-azure-ad.md +238 -0
  56. package/docs/configuration/authentication-clerk.md +110 -0
  57. package/docs/configuration/authentication-firebase.md +62 -0
  58. package/docs/configuration/authentication-pingfederate.md +136 -0
  59. package/docs/configuration/authentication-supabase.md +226 -0
  60. package/docs/configuration/authentication.md +231 -0
  61. package/docs/configuration/build-configuration.mdx +147 -0
  62. package/docs/configuration/docs.md +282 -0
  63. package/docs/configuration/footer.mdx +214 -0
  64. package/docs/configuration/llms.md +90 -0
  65. package/docs/configuration/make-config.mdx +90 -0
  66. package/docs/configuration/navigation.mdx +422 -0
  67. package/docs/configuration/overview.md +380 -0
  68. package/docs/configuration/protected-routes.md +150 -0
  69. package/docs/configuration/search.md +163 -0
  70. package/docs/configuration/sentry.mdx +44 -0
  71. package/docs/configuration/site.md +124 -0
  72. package/docs/configuration/slots.mdx +125 -0
  73. package/docs/configuration/vite-config.md +18 -0
  74. package/docs/custom-plugins.md +285 -0
  75. package/docs/customization/colors-theme.mdx +276 -0
  76. package/docs/customization/fonts.md +110 -0
  77. package/docs/deploy/apache-nginx.md +41 -0
  78. package/docs/deploy/apitogo.md +139 -0
  79. package/docs/deploy/cloudflare-pages.md +75 -0
  80. package/docs/deploy/direct-upload.md +18 -0
  81. package/docs/deploy/github-pages.md +50 -0
  82. package/docs/deploy/vercel.md +103 -0
  83. package/docs/deployment.md +21 -0
  84. package/docs/extending/events.md +124 -0
  85. package/docs/guides/custom-pages.md +106 -0
  86. package/docs/guides/environment-variables.md +99 -0
  87. package/docs/guides/managing-api-keys-and-identities.md +172 -0
  88. package/docs/guides/mermaid.mdx +70 -0
  89. package/docs/guides/navigation-migration.md +87 -0
  90. package/docs/guides/navigation-rules.mdx +203 -0
  91. package/docs/guides/processors.mdx +234 -0
  92. package/docs/guides/static-files.md +55 -0
  93. package/docs/guides/transforming-examples.md +156 -0
  94. package/docs/guides/using-multiple-apis.md +87 -0
  95. package/docs/markdown/admonitions.md +128 -0
  96. package/docs/markdown/code-blocks.md +196 -0
  97. package/docs/markdown/frontmatter.md +173 -0
  98. package/docs/markdown/mdx.md +68 -0
  99. package/docs/markdown/overview.md +275 -0
  100. package/docs/plugins.md +5 -0
  101. package/docs/quickstart.md +87 -0
  102. package/docs/writing.mdx +72 -0
  103. package/package.json +170 -116
  104. package/src/app/ZuploBuildConfig.ts +36 -36
  105. package/src/app/defaultTheme.css +77 -77
  106. package/src/app/demo-cdn.html +37 -37
  107. package/src/app/demo.html +21 -21
  108. package/src/app/demo.tsx +77 -77
  109. package/src/app/entry.client.tsx +118 -118
  110. package/src/app/entry.server.tsx +160 -160
  111. package/src/app/env.ts +40 -40
  112. package/src/app/font.geist.css +73 -73
  113. package/src/app/main.css +390 -390
  114. package/src/app/main.tsx +8 -1
  115. package/src/app/polyfills.ts +47 -47
  116. package/src/app/processRoutes.tsx +51 -25
  117. package/src/app/sentry.ts +24 -24
  118. package/src/app/standalone.html +23 -23
  119. package/src/app/standalone.tsx +60 -60
  120. package/src/app/utils/createRedirectRoutes.ts +11 -11
  121. package/src/config/config.ts +32 -0
  122. package/src/config/create-plugin.ts +71 -71
  123. package/src/config/file-exists.ts +6 -6
  124. package/src/config/loader.ts +11 -1
  125. package/src/config/resolve-modules.ts +260 -0
  126. package/src/config/validators/BuildSchema.ts +95 -95
  127. package/src/config/validators/HeaderNavigationSchema.ts +41 -41
  128. package/src/config/validators/InputNavigationSchema.test-d.ts +178 -178
  129. package/src/config/validators/InputNavigationSchema.ts +206 -206
  130. package/src/config/validators/ModulesSchema.ts +312 -0
  131. package/src/config/validators/ProtectedRoutesSchema.ts +35 -35
  132. package/src/config/validators/ZudokuConfig.ts +766 -729
  133. package/src/config/validators/auth.ts +3 -3
  134. package/src/config/validators/reason-codes.ts +7 -7
  135. package/src/env.d.ts +11 -11
  136. package/src/index.ts +31 -0
  137. package/src/lib/MissingIcon.tsx +22 -22
  138. package/src/lib/assets/language-icons/bun.tsx +50 -50
  139. package/src/lib/assets/language-icons/c.tsx +31 -31
  140. package/src/lib/assets/language-icons/commonlisp.tsx +22 -22
  141. package/src/lib/assets/language-icons/cpp.tsx +35 -35
  142. package/src/lib/assets/language-icons/csharp.tsx +35 -35
  143. package/src/lib/assets/language-icons/css.tsx +36 -36
  144. package/src/lib/assets/language-icons/dart.tsx +39 -39
  145. package/src/lib/assets/language-icons/elixir.tsx +19 -19
  146. package/src/lib/assets/language-icons/go.tsx +19 -19
  147. package/src/lib/assets/language-icons/graphql.tsx +19 -19
  148. package/src/lib/assets/language-icons/html.tsx +24 -24
  149. package/src/lib/assets/language-icons/java.tsx +35 -35
  150. package/src/lib/assets/language-icons/javascript.tsx +11 -11
  151. package/src/lib/assets/language-icons/json.tsx +19 -19
  152. package/src/lib/assets/language-icons/kotlin.tsx +30 -30
  153. package/src/lib/assets/language-icons/markdown.tsx +19 -19
  154. package/src/lib/assets/language-icons/mdx.tsx +23 -23
  155. package/src/lib/assets/language-icons/npm.tsx +15 -15
  156. package/src/lib/assets/language-icons/objectivec.tsx +23 -23
  157. package/src/lib/assets/language-icons/ocaml.tsx +34 -34
  158. package/src/lib/assets/language-icons/php.tsx +19 -19
  159. package/src/lib/assets/language-icons/pnpm.tsx +32 -32
  160. package/src/lib/assets/language-icons/powershell.tsx +27 -27
  161. package/src/lib/assets/language-icons/python.tsx +23 -23
  162. package/src/lib/assets/language-icons/react.tsx +21 -21
  163. package/src/lib/assets/language-icons/ruby.tsx +19 -19
  164. package/src/lib/assets/language-icons/rust.tsx +19 -19
  165. package/src/lib/assets/language-icons/scala.tsx +19 -19
  166. package/src/lib/assets/language-icons/shell.tsx +19 -19
  167. package/src/lib/assets/language-icons/swift.tsx +19 -19
  168. package/src/lib/assets/language-icons/toml.tsx +23 -23
  169. package/src/lib/assets/language-icons/typescript.tsx +23 -23
  170. package/src/lib/assets/language-icons/xml.tsx +19 -19
  171. package/src/lib/assets/language-icons/yaml.tsx +23 -23
  172. package/src/lib/assets/language-icons/yarn.tsx +17 -17
  173. package/src/lib/assets/language-icons/zig.tsx +32 -32
  174. package/src/lib/auth/issuer.ts +34 -31
  175. package/src/lib/authentication/AuthenticationPlugin.tsx +33 -33
  176. package/src/lib/authentication/authentication.ts +48 -48
  177. package/src/lib/authentication/components/OAuthErrorPage.tsx +197 -197
  178. package/src/lib/authentication/components/ProductionUnlockPage.tsx +27 -0
  179. package/src/lib/authentication/components/SignOut.tsx +15 -15
  180. package/src/lib/authentication/constants.ts +1 -1
  181. package/src/lib/authentication/errors.ts +34 -34
  182. package/src/lib/authentication/hook.ts +141 -139
  183. package/src/lib/authentication/providers/auth0.tsx +91 -91
  184. package/src/lib/authentication/providers/azureb2c.tsx +223 -223
  185. package/src/lib/authentication/providers/dev-portal-constants.ts +21 -0
  186. package/src/lib/authentication/providers/dev-portal-utils.ts +107 -0
  187. package/src/lib/authentication/providers/dev-portal.tsx +270 -0
  188. package/src/lib/authentication/providers/firebase.tsx +486 -486
  189. package/src/lib/authentication/providers/openid.tsx +516 -516
  190. package/src/lib/authentication/providers/supabase.tsx +412 -412
  191. package/src/lib/authentication/providers/util.ts +26 -26
  192. package/src/lib/authentication/state.ts +179 -91
  193. package/src/lib/authentication/ui/icons/Apple.tsx +10 -10
  194. package/src/lib/authentication/ui/icons/Facebook.tsx +15 -15
  195. package/src/lib/authentication/ui/icons/Github.tsx +16 -16
  196. package/src/lib/authentication/ui/icons/Google.tsx +16 -16
  197. package/src/lib/authentication/ui/icons/Microsoft.tsx +12 -12
  198. package/src/lib/authentication/ui/icons/X.tsx +10 -10
  199. package/src/lib/authentication/utils/relativeRedirectUrl.ts +16 -16
  200. package/src/lib/components/AnchorLink.tsx +24 -24
  201. package/src/lib/components/Banner.tsx +52 -52
  202. package/src/lib/components/Bootstrap.tsx +77 -77
  203. package/src/lib/components/BuildCheck.tsx +87 -87
  204. package/src/lib/components/CategoryHeading.tsx +19 -19
  205. package/src/lib/components/ClientOnly.tsx +19 -19
  206. package/src/lib/components/ErrorPage.tsx +26 -26
  207. package/src/lib/components/Footer.tsx +140 -140
  208. package/src/lib/components/Framed.tsx +51 -51
  209. package/src/lib/components/Header.tsx +11 -3
  210. package/src/lib/components/HeaderNavigation.tsx +148 -148
  211. package/src/lib/components/Heading.tsx +84 -84
  212. package/src/lib/components/InlineCode.tsx +15 -15
  213. package/src/lib/components/LandingLayout.tsx +21 -0
  214. package/src/lib/components/LanguageIcon.tsx +199 -199
  215. package/src/lib/components/Markdown.tsx +55 -55
  216. package/src/lib/components/Meta.tsx +46 -46
  217. package/src/lib/components/MobileTopNavigation.tsx +11 -3
  218. package/src/lib/components/NotFoundPage.tsx +37 -37
  219. package/src/lib/components/PageProgress.tsx +28 -28
  220. package/src/lib/components/PagefindSearchMeta.tsx +14 -14
  221. package/src/lib/components/Pagination.tsx +44 -44
  222. package/src/lib/components/PathRenderer.tsx +61 -61
  223. package/src/lib/components/PluginHeads.tsx +17 -17
  224. package/src/lib/components/Search.tsx +70 -70
  225. package/src/lib/components/Slot.tsx +64 -64
  226. package/src/lib/components/Spinner.tsx +5 -5
  227. package/src/lib/components/StatusPage.tsx +96 -96
  228. package/src/lib/components/ThemeSwitch.tsx +49 -49
  229. package/src/lib/components/Typography.tsx +12 -12
  230. package/src/lib/components/Zudoku.tsx +106 -106
  231. package/src/lib/components/cache.ts +27 -27
  232. package/src/lib/components/context/RenderContext.ts +11 -11
  233. package/src/lib/components/context/RouterEventsEmitter.tsx +19 -19
  234. package/src/lib/components/context/SlotProvider.tsx +149 -149
  235. package/src/lib/components/context/ViewportAnchorContext.tsx +137 -137
  236. package/src/lib/components/context/ZudokuContext.ts +140 -140
  237. package/src/lib/components/context/ZudokuProvider.tsx +22 -22
  238. package/src/lib/components/context/ZudokuReactContext.tsx +17 -17
  239. package/src/lib/components/index.ts +2 -0
  240. package/src/lib/components/navigation/Navigation.tsx +51 -51
  241. package/src/lib/components/navigation/NavigationBadge.tsx +48 -48
  242. package/src/lib/components/navigation/NavigationFilterContext.tsx +28 -28
  243. package/src/lib/components/navigation/NavigationWrapper.tsx +49 -49
  244. package/src/lib/components/navigation/Toc.tsx +137 -137
  245. package/src/lib/components/navigation/ZudokuLogo.tsx +25 -25
  246. package/src/lib/components/navigation/ZuploLogo.tsx +14 -14
  247. package/src/lib/components/navigation/utils.ts +234 -234
  248. package/src/lib/core/RouteGuard.tsx +11 -1
  249. package/src/lib/core/ZudokuContext.ts +271 -271
  250. package/src/lib/core/plugins.ts +138 -138
  251. package/src/lib/core/react-query.ts +1 -1
  252. package/src/lib/core/router.ts +1 -1
  253. package/src/lib/core/transform-config.ts +67 -67
  254. package/src/lib/demo/DemoAnnouncement.tsx +17 -17
  255. package/src/lib/errors/ErrorAlert.tsx +28 -28
  256. package/src/lib/errors/RouterError.tsx +18 -18
  257. package/src/lib/errors/ServerError.tsx +5 -5
  258. package/src/lib/errors/TopLevelError.tsx +6 -6
  259. package/src/lib/hooks/index.ts +13 -13
  260. package/src/lib/hooks/useEvent.ts +41 -41
  261. package/src/lib/hooks/useHighlighter.ts +15 -15
  262. package/src/lib/hooks/useHotkey.ts +70 -70
  263. package/src/lib/icons.ts +2 -2
  264. package/src/lib/navigation/applyRules.ts +127 -127
  265. package/src/lib/navigation/pathMatcher.ts +81 -81
  266. package/src/lib/oas/graphql/circular.ts +69 -69
  267. package/src/lib/oas/graphql/constants.ts +2 -2
  268. package/src/lib/oas/graphql/index.ts +791 -791
  269. package/src/lib/oas/parser/dereference/index.ts +84 -84
  270. package/src/lib/oas/parser/dereference/resolveRef.ts +32 -32
  271. package/src/lib/oas/parser/index.ts +129 -129
  272. package/src/lib/oas/parser/schemas/v3.0.json +1489 -1489
  273. package/src/lib/oas/parser/schemas/v3.1.json +1298 -1298
  274. package/src/lib/oas/parser/upgrade/index.ts +174 -174
  275. package/src/lib/plugins/api-catalog/index.tsx +119 -119
  276. package/src/lib/plugins/api-keys/ProtectedRoute.tsx +33 -33
  277. package/src/lib/plugins/api-keys/index.tsx +274 -272
  278. package/src/lib/plugins/api-keys/settings/ApiKeyList.tsx +67 -67
  279. package/src/lib/plugins/custom-pages/index.tsx +32 -32
  280. package/src/lib/plugins/markdown/assets/ChatGPTLogo.tsx +11 -11
  281. package/src/lib/plugins/markdown/assets/ClaudeLogo.tsx +19 -19
  282. package/src/lib/plugins/markdown/index.tsx +62 -62
  283. package/src/lib/plugins/openapi/ColorizedParam.tsx +115 -115
  284. package/src/lib/plugins/openapi/Endpoint.tsx +85 -85
  285. package/src/lib/plugins/openapi/MCPEndpoint.tsx +273 -273
  286. package/src/lib/plugins/openapi/OasProvider.tsx +74 -74
  287. package/src/lib/plugins/openapi/OperationList.tsx +275 -275
  288. package/src/lib/plugins/openapi/ParamInfos.tsx +96 -96
  289. package/src/lib/plugins/openapi/ParameterList.tsx +53 -53
  290. package/src/lib/plugins/openapi/ParameterListItem.tsx +161 -161
  291. package/src/lib/plugins/openapi/PlaygroundDialogWrapper.tsx +67 -67
  292. package/src/lib/plugins/openapi/SidecarBox.tsx +57 -57
  293. package/src/lib/plugins/openapi/SimpleSelect.tsx +46 -46
  294. package/src/lib/plugins/openapi/client/GraphQLClient.tsx +73 -73
  295. package/src/lib/plugins/openapi/client/GraphQLContext.tsx +16 -16
  296. package/src/lib/plugins/openapi/client/createServer.ts +35 -35
  297. package/src/lib/plugins/openapi/client/useCreateQuery.ts +44 -44
  298. package/src/lib/plugins/openapi/components/ConstValue.tsx +24 -24
  299. package/src/lib/plugins/openapi/components/NonHighlightedCode.tsx +22 -22
  300. package/src/lib/plugins/openapi/components/SelectOnClick.tsx +29 -29
  301. package/src/lib/plugins/openapi/context.tsx +16 -16
  302. package/src/lib/plugins/openapi/graphql/fragment-masking.ts +104 -104
  303. package/src/lib/plugins/openapi/graphql/gql.ts +95 -95
  304. package/src/lib/plugins/openapi/graphql/graphql.ts +835 -835
  305. package/src/lib/plugins/openapi/graphql/index.ts +2 -2
  306. package/src/lib/plugins/openapi/index.tsx +221 -221
  307. package/src/lib/plugins/openapi/interfaces.ts +100 -100
  308. package/src/lib/plugins/openapi/playground/Headers.tsx +6 -6
  309. package/src/lib/plugins/openapi/playground/PathParams.tsx +53 -53
  310. package/src/lib/plugins/openapi/playground/Spinner.tsx +87 -87
  311. package/src/lib/plugins/openapi/playground/createUrl.ts +25 -25
  312. package/src/lib/plugins/openapi/playground/fileUtils.ts +36 -36
  313. package/src/lib/plugins/openapi/playground/rememberedIdentity.ts +26 -26
  314. package/src/lib/plugins/openapi/playground/request-panel/UrlPath.tsx +31 -31
  315. package/src/lib/plugins/openapi/playground/request-panel/UrlQueryParams.tsx +29 -29
  316. package/src/lib/plugins/openapi/playground/request-panel/useKeyValueFieldManager.ts +340 -340
  317. package/src/lib/plugins/openapi/playground/result-panel/ResponseStatusBar.tsx +117 -117
  318. package/src/lib/plugins/openapi/playground/result-panel/convertToTypes.ts +36 -36
  319. package/src/lib/plugins/openapi/playground/serializeQueryParams.ts +125 -125
  320. package/src/lib/plugins/openapi/playground/useRememberSkipLoginDialog.tsx +23 -23
  321. package/src/lib/plugins/openapi/processors/removeExtensions.ts +29 -29
  322. package/src/lib/plugins/openapi/processors/removeParameters.ts +103 -103
  323. package/src/lib/plugins/openapi/processors/removePaths.ts +57 -57
  324. package/src/lib/plugins/openapi/processors/traverse.ts +1 -1
  325. package/src/lib/plugins/openapi/schema/SchemaExampleAndDefault.tsx +39 -39
  326. package/src/lib/plugins/openapi/schema/UnionView.tsx +132 -132
  327. package/src/lib/plugins/openapi/schema/union-helpers.ts +123 -123
  328. package/src/lib/plugins/openapi/schema/utils.ts +49 -49
  329. package/src/lib/plugins/openapi/state.ts +36 -36
  330. package/src/lib/plugins/openapi/util/buildTagCategories.ts +54 -54
  331. package/src/lib/plugins/openapi/util/createHttpSnippet.ts +135 -135
  332. package/src/lib/plugins/openapi/util/createNavigationCategory.tsx +39 -39
  333. package/src/lib/plugins/openapi/util/generateSchemaExample.ts +191 -191
  334. package/src/lib/plugins/openapi/util/getRoutes.tsx +265 -265
  335. package/src/lib/plugins/openapi/util/methodColorMap.tsx +11 -11
  336. package/src/lib/plugins/openapi/util/methodToColor.ts +27 -27
  337. package/src/lib/plugins/openapi/util/sanitizeMarkdownForMetatag.tsx +32 -32
  338. package/src/lib/plugins/openapi/util/useWarmupSchema.ts +23 -23
  339. package/src/lib/plugins/search-inkeep/index.tsx +108 -108
  340. package/src/lib/plugins/search-inkeep/inkeep.ts +24 -24
  341. package/src/lib/plugins/search-pagefind/get-results.tsx +74 -74
  342. package/src/lib/plugins/search-pagefind/index.tsx +21 -21
  343. package/src/lib/plugins/search-pagefind/types.ts +118 -118
  344. package/src/lib/shiki-constants.ts +24 -24
  345. package/src/lib/testing/index.tsx +146 -146
  346. package/src/lib/ui/Accordion.tsx +55 -55
  347. package/src/lib/ui/Alert.tsx +84 -84
  348. package/src/lib/ui/AlertDialog.tsx +195 -195
  349. package/src/lib/ui/AspectRatio.tsx +5 -5
  350. package/src/lib/ui/Badge.tsx +48 -48
  351. package/src/lib/ui/Breadcrumb.tsx +115 -115
  352. package/src/lib/ui/Button.tsx +65 -65
  353. package/src/lib/ui/ButtonGroup.tsx +80 -80
  354. package/src/lib/ui/Callout.tsx +113 -113
  355. package/src/lib/ui/Card.tsx +95 -95
  356. package/src/lib/ui/Carousel.tsx +259 -259
  357. package/src/lib/ui/Checkbox.tsx +28 -28
  358. package/src/lib/ui/CodeBlock.tsx +92 -92
  359. package/src/lib/ui/CodeTabPanel.tsx +13 -13
  360. package/src/lib/ui/CodeTabs.tsx +161 -161
  361. package/src/lib/ui/Collapsible.tsx +31 -31
  362. package/src/lib/ui/Dialog.tsx +138 -138
  363. package/src/lib/ui/DismissibleAlert.tsx +74 -74
  364. package/src/lib/ui/Drawer.tsx +121 -121
  365. package/src/lib/ui/DropdownMenu.tsx +254 -254
  366. package/src/lib/ui/EmbeddedCodeBlock.tsx +99 -99
  367. package/src/lib/ui/Form.tsx +176 -176
  368. package/src/lib/ui/Frame.tsx +81 -81
  369. package/src/lib/ui/HoverCard.tsx +26 -26
  370. package/src/lib/ui/Input.tsx +23 -23
  371. package/src/lib/ui/InputGroup.tsx +168 -168
  372. package/src/lib/ui/Item.tsx +213 -213
  373. package/src/lib/ui/Kbd.tsx +28 -28
  374. package/src/lib/ui/Label.tsx +23 -23
  375. package/src/lib/ui/NativeSelect.tsx +48 -48
  376. package/src/lib/ui/NavigationMenu.tsx +169 -169
  377. package/src/lib/ui/Pagination.tsx +115 -115
  378. package/src/lib/ui/Popover.tsx +28 -28
  379. package/src/lib/ui/Progress.tsx +25 -25
  380. package/src/lib/ui/RadioGroup.tsx +41 -41
  381. package/src/lib/ui/ReactComponentDoc.tsx +68 -68
  382. package/src/lib/ui/ScrollArea.tsx +45 -45
  383. package/src/lib/ui/Secret.tsx +133 -133
  384. package/src/lib/ui/Select.tsx +184 -184
  385. package/src/lib/ui/Separator.tsx +25 -25
  386. package/src/lib/ui/Skeleton.tsx +15 -15
  387. package/src/lib/ui/Slider.tsx +25 -25
  388. package/src/lib/ui/Stepper.tsx +8 -8
  389. package/src/lib/ui/Switch.tsx +26 -26
  390. package/src/lib/ui/SyntaxHighlight.tsx +54 -54
  391. package/src/lib/ui/Tabs.tsx +52 -52
  392. package/src/lib/ui/Textarea.tsx +22 -22
  393. package/src/lib/ui/Toggle.tsx +42 -42
  394. package/src/lib/ui/ToggleGroup.tsx +58 -58
  395. package/src/lib/ui/Tooltip.tsx +65 -65
  396. package/src/lib/ui/Value.tsx +42 -42
  397. package/src/lib/ui/util.tsx +8 -8
  398. package/src/lib/util/cn.ts +6 -6
  399. package/src/lib/util/createVariantComponent.tsx +61 -61
  400. package/src/lib/util/ensureArray.ts +3 -3
  401. package/src/lib/util/flattenAllOf.ts +72 -72
  402. package/src/lib/util/flattenAllOfProcessor.ts +74 -74
  403. package/src/lib/util/hastToJsx.tsx +67 -67
  404. package/src/lib/util/humanFileSize.ts +15 -15
  405. package/src/lib/util/invariant.ts +52 -52
  406. package/src/lib/util/joinUrl.ts +60 -60
  407. package/src/lib/util/logInit.ts +9 -9
  408. package/src/lib/util/objectEntries.ts +5 -5
  409. package/src/lib/util/os.ts +18 -18
  410. package/src/lib/util/pastellize.ts +25 -25
  411. package/src/lib/util/problemJson.ts +63 -63
  412. package/src/lib/util/readFrontmatter.ts +14 -14
  413. package/src/lib/util/renderIf.ts +4 -4
  414. package/src/lib/util/scrollIntoViewIfNeeded.ts +18 -18
  415. package/src/lib/util/slugify.ts +21 -21
  416. package/src/lib/util/syncZustandState.ts +22 -22
  417. package/src/lib/util/traverse.ts +70 -70
  418. package/src/lib/util/types.ts +7 -7
  419. package/src/lib/util/url.ts +18 -18
  420. package/src/lib/util/useCopyToClipboard.ts +17 -17
  421. package/src/lib/util/useExposedProps.tsx +27 -27
  422. package/src/lib/util/useIsomorphicLayoutEffect.ts +6 -6
  423. package/src/lib/util/useLatest.ts +18 -18
  424. package/src/lib/util/useOnScreen.ts +34 -34
  425. package/src/lib/util/useScrollToAnchor.ts +70 -70
  426. package/src/lib/util/useScrollToTop.ts +18 -18
  427. package/src/types.d.ts +57 -53
  428. package/src/vite/api/SchemaManager.ts +371 -371
  429. package/src/vite/api/schema-codegen.ts +163 -163
  430. package/src/vite/config.ts +5 -1
  431. package/src/vite/css/collect.ts +42 -42
  432. package/src/vite/css/plugin.ts +105 -105
  433. package/src/vite/debug.ts +18 -18
  434. package/src/vite/dev-portal-env.ts +93 -0
  435. package/src/vite/html.ts +54 -54
  436. package/src/vite/index.ts +2 -2
  437. package/src/vite/mdx/rehype-extract-toc-with-jsx-export.ts +19 -19
  438. package/src/vite/mdx/rehype-extract-toc-with-jsx.ts +70 -70
  439. package/src/vite/mdx/remark-code-tabs.ts +47 -47
  440. package/src/vite/mdx/remark-inject-filepath.ts +13 -13
  441. package/src/vite/mdx/remark-last-modified.ts +103 -103
  442. package/src/vite/mdx/remark-link-rewrite.ts +23 -23
  443. package/src/vite/mdx/remark-normalize-image-url.ts +15 -15
  444. package/src/vite/mdx/remark-static-generation.ts +149 -149
  445. package/src/vite/mdx/utils.ts +32 -32
  446. package/src/vite/output.ts +261 -261
  447. package/src/vite/package-root.ts +12 -12
  448. package/src/vite/pagefind-dev-index.ts +100 -100
  449. package/src/vite/plugin-api-keys.ts +6 -1
  450. package/src/vite/plugin-api.ts +4 -1
  451. package/src/vite/plugin-auth.ts +5 -1
  452. package/src/vite/plugin-component.ts +1 -1
  453. package/src/vite/plugin-config-reload.ts +49 -49
  454. package/src/vite/plugin-doc-metadata.ts +45 -45
  455. package/src/vite/plugin-docs.ts +4 -1
  456. package/src/vite/plugin-metadata.ts +30 -30
  457. package/src/vite/plugin-modules.ts +144 -0
  458. package/src/vite/plugin-shiki-register.ts +97 -97
  459. package/src/vite/plugin-theme.ts +399 -399
  460. package/src/vite/plugin.ts +2 -0
  461. package/src/vite/prerender/utils.ts +76 -76
  462. package/src/vite/prerender/worker.ts +118 -118
  463. package/src/vite/reporter.ts +34 -34
  464. package/src/vite/shadcn-registry.ts +48 -48
  465. package/src/vite/sitemap.ts +78 -78
  466. package/src/vite/ssr-templates/cloudflare.ts +19 -19
  467. package/src/vite/ssr-templates/node.ts +25 -25
  468. package/src/vite/ssr-templates/vercel.ts +22 -22
  469. package/src/vite/zuplo.ts +30 -30
  470. package/src/vite-env.d.ts +6 -6
  471. package/src/zuplo/enrich-with-zuplo-mcp.ts +168 -168
  472. package/src/zuplo/enrich-with-zuplo.ts +256 -256
  473. package/src/zuplo/policy-types.ts +46 -46
  474. package/src/zuplo/with-zuplo-processors.ts +36 -36
  475. package/src/zuplo/with-zuplo.ts +14 -14
  476. package/LICENSE.md +0 -18
  477. package/dist/declarations/lib/components/navigation/ZudokuLogo.d.ts +0 -6
package/src/lib/oas/parser/schemas/v3.0.json CHANGED
@@ -1,1489 +1,1489 @@
1
- {
2
- "id": "https://spec.openapis.org/oas/3.0/schema/2021-09-28",
3
- "$schema": "http://json-schema.org/draft-04/schema#",
4
- "description": "The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3",
5
- "type": "object",
6
- "required": ["openapi", "info", "paths"],
7
- "properties": {
8
- "openapi": {
9
- "type": "string",
10
- "pattern": "^3\\.0\\.\\d(-.+)?$"
11
- },
12
- "info": {
13
- "$ref": "#/definitions/Info"
14
- },
15
- "externalDocs": {
16
- "$ref": "#/definitions/ExternalDocumentation"
17
- },
18
- "servers": {
19
- "type": "array",
20
- "items": {
21
- "$ref": "#/definitions/Server"
22
- }
23
- },
24
- "security": {
25
- "type": "array",
26
- "items": {
27
- "$ref": "#/definitions/SecurityRequirement"
28
- }
29
- },
30
- "tags": {
31
- "type": "array",
32
- "items": {
33
- "$ref": "#/definitions/Tag"
34
- },
35
- "uniqueItems": true
36
- },
37
- "paths": {
38
- "$ref": "#/definitions/Paths"
39
- },
40
- "components": {
41
- "$ref": "#/definitions/Components"
42
- }
43
- },
44
- "patternProperties": {
45
- "^x-": {}
46
- },
47
- "additionalProperties": false,
48
- "definitions": {
49
- "Reference": {
50
- "type": "object",
51
- "required": ["$ref"],
52
- "patternProperties": {
53
- "^\\$ref$": {
54
- "type": "string",
55
- "format": "uri-reference"
56
- }
57
- }
58
- },
59
- "Info": {
60
- "type": "object",
61
- "required": ["title", "version"],
62
- "properties": {
63
- "title": {
64
- "type": "string"
65
- },
66
- "description": {
67
- "type": "string"
68
- },
69
- "termsOfService": {
70
- "type": "string",
71
- "format": "uri-reference"
72
- },
73
- "contact": {
74
- "$ref": "#/definitions/Contact"
75
- },
76
- "license": {
77
- "$ref": "#/definitions/License"
78
- },
79
- "version": {
80
- "type": "string"
81
- }
82
- },
83
- "patternProperties": {
84
- "^x-": {}
85
- },
86
- "additionalProperties": false
87
- },
88
- "Contact": {
89
- "type": "object",
90
- "properties": {
91
- "name": {
92
- "type": "string"
93
- },
94
- "url": {
95
- "type": "string",
96
- "format": "uri-reference"
97
- },
98
- "email": {
99
- "type": "string",
100
- "format": "email"
101
- }
102
- },
103
- "patternProperties": {
104
- "^x-": {}
105
- },
106
- "additionalProperties": false
107
- },
108
- "License": {
109
- "type": "object",
110
- "required": ["name"],
111
- "properties": {
112
- "name": {
113
- "type": "string"
114
- },
115
- "url": {
116
- "type": "string",
117
- "format": "uri-reference"
118
- }
119
- },
120
- "patternProperties": {
121
- "^x-": {}
122
- },
123
- "additionalProperties": false
124
- },
125
- "Server": {
126
- "type": "object",
127
- "required": ["url"],
128
- "properties": {
129
- "url": {
130
- "type": "string"
131
- },
132
- "description": {
133
- "type": "string"
134
- },
135
- "variables": {
136
- "type": "object",
137
- "additionalProperties": {
138
- "$ref": "#/definitions/ServerVariable"
139
- }
140
- }
141
- },
142
- "patternProperties": {
143
- "^x-": {}
144
- },
145
- "additionalProperties": false
146
- },
147
- "ServerVariable": {
148
- "type": "object",
149
- "required": ["default"],
150
- "properties": {
151
- "enum": {
152
- "type": "array",
153
- "items": {
154
- "type": "string"
155
- }
156
- },
157
- "default": {
158
- "type": "string"
159
- },
160
- "description": {
161
- "type": "string"
162
- }
163
- },
164
- "patternProperties": {
165
- "^x-": {}
166
- },
167
- "additionalProperties": false
168
- },
169
- "Components": {
170
- "type": "object",
171
- "properties": {
172
- "schemas": {
173
- "type": "object",
174
- "patternProperties": {
175
- "^[a-zA-Z0-9\\.\\-_]+$": {
176
- "oneOf": [
177
- {
178
- "$ref": "#/definitions/Schema"
179
- },
180
- {
181
- "$ref": "#/definitions/Reference"
182
- }
183
- ]
184
- }
185
- }
186
- },
187
- "responses": {
188
- "type": "object",
189
- "patternProperties": {
190
- "^[a-zA-Z0-9\\.\\-_]+$": {
191
- "oneOf": [
192
- {
193
- "$ref": "#/definitions/Reference"
194
- },
195
- {
196
- "$ref": "#/definitions/Response"
197
- }
198
- ]
199
- }
200
- }
201
- },
202
- "parameters": {
203
- "type": "object",
204
- "patternProperties": {
205
- "^[a-zA-Z0-9\\.\\-_]+$": {
206
- "oneOf": [
207
- {
208
- "$ref": "#/definitions/Reference"
209
- },
210
- {
211
- "$ref": "#/definitions/Parameter"
212
- }
213
- ]
214
- }
215
- }
216
- },
217
- "examples": {
218
- "type": "object",
219
- "patternProperties": {
220
- "^[a-zA-Z0-9\\.\\-_]+$": {
221
- "oneOf": [
222
- {
223
- "$ref": "#/definitions/Reference"
224
- },
225
- {
226
- "$ref": "#/definitions/Example"
227
- }
228
- ]
229
- }
230
- }
231
- },
232
- "requestBodies": {
233
- "type": "object",
234
- "patternProperties": {
235
- "^[a-zA-Z0-9\\.\\-_]+$": {
236
- "oneOf": [
237
- {
238
- "$ref": "#/definitions/Reference"
239
- },
240
- {
241
- "$ref": "#/definitions/RequestBody"
242
- }
243
- ]
244
- }
245
- }
246
- },
247
- "headers": {
248
- "type": "object",
249
- "patternProperties": {
250
- "^[a-zA-Z0-9\\.\\-_]+$": {
251
- "oneOf": [
252
- {
253
- "$ref": "#/definitions/Reference"
254
- },
255
- {
256
- "$ref": "#/definitions/Header"
257
- }
258
- ]
259
- }
260
- }
261
- },
262
- "securitySchemes": {
263
- "type": "object",
264
- "patternProperties": {
265
- "^[a-zA-Z0-9\\.\\-_]+$": {
266
- "oneOf": [
267
- {
268
- "$ref": "#/definitions/Reference"
269
- },
270
- {
271
- "$ref": "#/definitions/SecurityScheme"
272
- }
273
- ]
274
- }
275
- }
276
- },
277
- "links": {
278
- "type": "object",
279
- "patternProperties": {
280
- "^[a-zA-Z0-9\\.\\-_]+$": {
281
- "oneOf": [
282
- {
283
- "$ref": "#/definitions/Reference"
284
- },
285
- {
286
- "$ref": "#/definitions/Link"
287
- }
288
- ]
289
- }
290
- }
291
- },
292
- "callbacks": {
293
- "type": "object",
294
- "patternProperties": {
295
- "^[a-zA-Z0-9\\.\\-_]+$": {
296
- "oneOf": [
297
- {
298
- "$ref": "#/definitions/Reference"
299
- },
300
- {
301
- "$ref": "#/definitions/Callback"
302
- }
303
- ]
304
- }
305
- }
306
- }
307
- },
308
- "patternProperties": {
309
- "^x-": {}
310
- },
311
- "additionalProperties": false
312
- },
313
- "Schema": {
314
- "type": "object",
315
- "properties": {
316
- "title": {
317
- "type": "string"
318
- },
319
- "multipleOf": {
320
- "type": "number",
321
- "minimum": 0,
322
- "exclusiveMinimum": true
323
- },
324
- "maximum": {
325
- "type": "number"
326
- },
327
- "exclusiveMaximum": {
328
- "type": "boolean",
329
- "default": false
330
- },
331
- "minimum": {
332
- "type": "number"
333
- },
334
- "exclusiveMinimum": {
335
- "type": "boolean",
336
- "default": false
337
- },
338
- "maxLength": {
339
- "type": "integer",
340
- "minimum": 0
341
- },
342
- "minLength": {
343
- "type": "integer",
344
- "minimum": 0,
345
- "default": 0
346
- },
347
- "pattern": {
348
- "type": "string",
349
- "format": "regex"
350
- },
351
- "maxItems": {
352
- "type": "integer",
353
- "minimum": 0
354
- },
355
- "minItems": {
356
- "type": "integer",
357
- "minimum": 0,
358
- "default": 0
359
- },
360
- "uniqueItems": {
361
- "type": "boolean",
362
- "default": false
363
- },
364
- "maxProperties": {
365
- "type": "integer",
366
- "minimum": 0
367
- },
368
- "minProperties": {
369
- "type": "integer",
370
- "minimum": 0,
371
- "default": 0
372
- },
373
- "required": {
374
- "type": "array",
375
- "items": {
376
- "type": "string"
377
- },
378
- "minItems": 1,
379
- "uniqueItems": true
380
- },
381
- "enum": {
382
- "type": "array",
383
- "items": {},
384
- "minItems": 1,
385
- "uniqueItems": false
386
- },
387
- "type": {
388
- "type": "string",
389
- "enum": ["array", "boolean", "integer", "number", "object", "string"]
390
- },
391
- "not": {
392
- "oneOf": [
393
- {
394
- "$ref": "#/definitions/Schema"
395
- },
396
- {
397
- "$ref": "#/definitions/Reference"
398
- }
399
- ]
400
- },
401
- "allOf": {
402
- "type": "array",
403
- "items": {
404
- "oneOf": [
405
- {
406
- "$ref": "#/definitions/Schema"
407
- },
408
- {
409
- "$ref": "#/definitions/Reference"
410
- }
411
- ]
412
- }
413
- },
414
- "oneOf": {
415
- "type": "array",
416
- "items": {
417
- "oneOf": [
418
- {
419
- "$ref": "#/definitions/Schema"
420
- },
421
- {
422
- "$ref": "#/definitions/Reference"
423
- }
424
- ]
425
- }
426
- },
427
- "anyOf": {
428
- "type": "array",
429
- "items": {
430
- "oneOf": [
431
- {
432
- "$ref": "#/definitions/Schema"
433
- },
434
- {
435
- "$ref": "#/definitions/Reference"
436
- }
437
- ]
438
- }
439
- },
440
- "items": {
441
- "oneOf": [
442
- {
443
- "$ref": "#/definitions/Schema"
444
- },
445
- {
446
- "$ref": "#/definitions/Reference"
447
- }
448
- ]
449
- },
450
- "properties": {
451
- "type": "object",
452
- "additionalProperties": {
453
- "oneOf": [
454
- {
455
- "$ref": "#/definitions/Schema"
456
- },
457
- {
458
- "$ref": "#/definitions/Reference"
459
- }
460
- ]
461
- }
462
- },
463
- "additionalProperties": {
464
- "oneOf": [
465
- {
466
- "$ref": "#/definitions/Schema"
467
- },
468
- {
469
- "$ref": "#/definitions/Reference"
470
- },
471
- {
472
- "type": "boolean"
473
- }
474
- ],
475
- "default": true
476
- },
477
- "description": {
478
- "type": "string"
479
- },
480
- "format": {
481
- "type": "string"
482
- },
483
- "default": {},
484
- "nullable": {
485
- "type": "boolean",
486
- "default": false
487
- },
488
- "discriminator": {
489
- "$ref": "#/definitions/Discriminator"
490
- },
491
- "readOnly": {
492
- "type": "boolean",
493
- "default": false
494
- },
495
- "writeOnly": {
496
- "type": "boolean",
497
- "default": false
498
- },
499
- "example": {},
500
- "externalDocs": {
501
- "$ref": "#/definitions/ExternalDocumentation"
502
- },
503
- "deprecated": {
504
- "type": "boolean",
505
- "default": false
506
- },
507
- "xml": {
508
- "$ref": "#/definitions/XML"
509
- }
510
- },
511
- "patternProperties": {
512
- "^x-": {}
513
- },
514
- "additionalProperties": false
515
- },
516
- "Discriminator": {
517
- "type": "object",
518
- "required": ["propertyName"],
519
- "properties": {
520
- "propertyName": {
521
- "type": "string"
522
- },
523
- "mapping": {
524
- "type": "object",
525
- "additionalProperties": {
526
- "type": "string"
527
- }
528
- }
529
- }
530
- },
531
- "XML": {
532
- "type": "object",
533
- "properties": {
534
- "name": {
535
- "type": "string"
536
- },
537
- "namespace": {
538
- "type": "string",
539
- "format": "uri"
540
- },
541
- "prefix": {
542
- "type": "string"
543
- },
544
- "attribute": {
545
- "type": "boolean",
546
- "default": false
547
- },
548
- "wrapped": {
549
- "type": "boolean",
550
- "default": false
551
- }
552
- },
553
- "patternProperties": {
554
- "^x-": {}
555
- },
556
- "additionalProperties": false
557
- },
558
- "Response": {
559
- "type": "object",
560
- "required": ["description"],
561
- "properties": {
562
- "description": {
563
- "type": "string"
564
- },
565
- "headers": {
566
- "type": "object",
567
- "additionalProperties": {
568
- "oneOf": [
569
- {
570
- "$ref": "#/definitions/Header"
571
- },
572
- {
573
- "$ref": "#/definitions/Reference"
574
- }
575
- ]
576
- }
577
- },
578
- "content": {
579
- "type": "object",
580
- "additionalProperties": {
581
- "$ref": "#/definitions/MediaType"
582
- }
583
- },
584
- "links": {
585
- "type": "object",
586
- "additionalProperties": {
587
- "oneOf": [
588
- {
589
- "$ref": "#/definitions/Link"
590
- },
591
- {
592
- "$ref": "#/definitions/Reference"
593
- }
594
- ]
595
- }
596
- }
597
- },
598
- "patternProperties": {
599
- "^x-": {}
600
- },
601
- "additionalProperties": false
602
- },
603
- "MediaType": {
604
- "type": "object",
605
- "properties": {
606
- "schema": {
607
- "oneOf": [
608
- {
609
- "$ref": "#/definitions/Schema"
610
- },
611
- {
612
- "$ref": "#/definitions/Reference"
613
- }
614
- ]
615
- },
616
- "example": {},
617
- "examples": {
618
- "type": "object",
619
- "additionalProperties": {
620
- "oneOf": [
621
- {
622
- "$ref": "#/definitions/Example"
623
- },
624
- {
625
- "$ref": "#/definitions/Reference"
626
- }
627
- ]
628
- }
629
- },
630
- "encoding": {
631
- "type": "object",
632
- "additionalProperties": {
633
- "$ref": "#/definitions/Encoding"
634
- }
635
- }
636
- },
637
- "patternProperties": {
638
- "^x-": {}
639
- },
640
- "additionalProperties": false,
641
- "allOf": [
642
- {
643
- "$ref": "#/definitions/ExampleXORExamples"
644
- }
645
- ]
646
- },
647
- "Example": {
648
- "type": "object",
649
- "properties": {
650
- "summary": {
651
- "type": "string"
652
- },
653
- "description": {
654
- "type": "string"
655
- },
656
- "value": {},
657
- "externalValue": {
658
- "type": "string",
659
- "format": "uri-reference"
660
- }
661
- },
662
- "patternProperties": {
663
- "^x-": {}
664
- },
665
- "additionalProperties": false
666
- },
667
- "Header": {
668
- "type": "object",
669
- "properties": {
670
- "description": {
671
- "type": "string"
672
- },
673
- "required": {
674
- "type": "boolean",
675
- "default": false
676
- },
677
- "deprecated": {
678
- "type": "boolean",
679
- "default": false
680
- },
681
- "allowEmptyValue": {
682
- "type": "boolean",
683
- "default": false
684
- },
685
- "style": {
686
- "type": "string",
687
- "enum": ["simple"],
688
- "default": "simple"
689
- },
690
- "explode": {
691
- "type": "boolean"
692
- },
693
- "allowReserved": {
694
- "type": "boolean",
695
- "default": false
696
- },
697
- "schema": {
698
- "oneOf": [
699
- {
700
- "$ref": "#/definitions/Schema"
701
- },
702
- {
703
- "$ref": "#/definitions/Reference"
704
- }
705
- ]
706
- },
707
- "content": {
708
- "type": "object",
709
- "additionalProperties": {
710
- "$ref": "#/definitions/MediaType"
711
- },
712
- "minProperties": 1,
713
- "maxProperties": 1
714
- },
715
- "example": {},
716
- "examples": {
717
- "type": "object",
718
- "additionalProperties": {
719
- "oneOf": [
720
- {
721
- "$ref": "#/definitions/Example"
722
- },
723
- {
724
- "$ref": "#/definitions/Reference"
725
- }
726
- ]
727
- }
728
- }
729
- },
730
- "patternProperties": {
731
- "^x-": {}
732
- },
733
- "additionalProperties": false,
734
- "allOf": [
735
- {
736
- "$ref": "#/definitions/ExampleXORExamples"
737
- },
738
- {
739
- "$ref": "#/definitions/SchemaXORContent"
740
- }
741
- ]
742
- },
743
- "Paths": {
744
- "type": "object",
745
- "patternProperties": {
746
- "^\\/": {
747
- "$ref": "#/definitions/PathItem"
748
- },
749
- "^x-": {}
750
- },
751
- "additionalProperties": false
752
- },
753
- "PathItem": {
754
- "type": "object",
755
- "properties": {
756
- "$ref": {
757
- "type": "string"
758
- },
759
- "summary": {
760
- "type": "string"
761
- },
762
- "description": {
763
- "type": "string"
764
- },
765
- "servers": {
766
- "type": "array",
767
- "items": {
768
- "$ref": "#/definitions/Server"
769
- }
770
- },
771
- "parameters": {
772
- "type": "array",
773
- "items": {
774
- "oneOf": [
775
- {
776
- "$ref": "#/definitions/Parameter"
777
- },
778
- {
779
- "$ref": "#/definitions/Reference"
780
- }
781
- ]
782
- },
783
- "uniqueItems": true
784
- }
785
- },
786
- "patternProperties": {
787
- "^(get|put|post|delete|options|head|patch|trace)$": {
788
- "$ref": "#/definitions/Operation"
789
- },
790
- "^x-": {}
791
- },
792
- "additionalProperties": false
793
- },
794
- "Operation": {
795
- "type": "object",
796
- "required": ["responses"],
797
- "properties": {
798
- "tags": {
799
- "type": "array",
800
- "items": {
801
- "type": "string"
802
- }
803
- },
804
- "summary": {
805
- "type": "string"
806
- },
807
- "description": {
808
- "type": "string"
809
- },
810
- "externalDocs": {
811
- "$ref": "#/definitions/ExternalDocumentation"
812
- },
813
- "operationId": {
814
- "type": "string"
815
- },
816
- "parameters": {
817
- "type": "array",
818
- "items": {
819
- "oneOf": [
820
- {
821
- "$ref": "#/definitions/Parameter"
822
- },
823
- {
824
- "$ref": "#/definitions/Reference"
825
- }
826
- ]
827
- },
828
- "uniqueItems": true
829
- },
830
- "requestBody": {
831
- "oneOf": [
832
- {
833
- "$ref": "#/definitions/RequestBody"
834
- },
835
- {
836
- "$ref": "#/definitions/Reference"
837
- }
838
- ]
839
- },
840
- "responses": {
841
- "$ref": "#/definitions/Responses"
842
- },
843
- "callbacks": {
844
- "type": "object",
845
- "additionalProperties": {
846
- "oneOf": [
847
- {
848
- "$ref": "#/definitions/Callback"
849
- },
850
- {
851
- "$ref": "#/definitions/Reference"
852
- }
853
- ]
854
- }
855
- },
856
- "deprecated": {
857
- "type": "boolean",
858
- "default": false
859
- },
860
- "security": {
861
- "type": "array",
862
- "items": {
863
- "$ref": "#/definitions/SecurityRequirement"
864
- }
865
- },
866
- "servers": {
867
- "type": "array",
868
- "items": {
869
- "$ref": "#/definitions/Server"
870
- }
871
- }
872
- },
873
- "patternProperties": {
874
- "^x-": {}
875
- },
876
- "additionalProperties": false
877
- },
878
- "Responses": {
879
- "type": "object",
880
- "properties": {
881
- "default": {
882
- "oneOf": [
883
- {
884
- "$ref": "#/definitions/Response"
885
- },
886
- {
887
- "$ref": "#/definitions/Reference"
888
- }
889
- ]
890
- }
891
- },
892
- "patternProperties": {
893
- "^[1-5](?:\\d{2}|XX)$": {
894
- "oneOf": [
895
- {
896
- "$ref": "#/definitions/Response"
897
- },
898
- {
899
- "$ref": "#/definitions/Reference"
900
- }
901
- ]
902
- },
903
- "^x-": {}
904
- },
905
- "minProperties": 1,
906
- "additionalProperties": false
907
- },
908
- "SecurityRequirement": {
909
- "type": "object",
910
- "additionalProperties": {
911
- "type": "array",
912
- "items": {
913
- "type": "string"
914
- }
915
- }
916
- },
917
- "Tag": {
918
- "type": "object",
919
- "required": ["name"],
920
- "properties": {
921
- "name": {
922
- "type": "string"
923
- },
924
- "description": {
925
- "type": "string"
926
- },
927
- "externalDocs": {
928
- "$ref": "#/definitions/ExternalDocumentation"
929
- }
930
- },
931
- "patternProperties": {
932
- "^x-": {}
933
- },
934
- "additionalProperties": false
935
- },
936
- "ExternalDocumentation": {
937
- "type": "object",
938
- "required": ["url"],
939
- "properties": {
940
- "description": {
941
- "type": "string"
942
- },
943
- "url": {
944
- "type": "string",
945
- "format": "uri-reference"
946
- }
947
- },
948
- "patternProperties": {
949
- "^x-": {}
950
- },
951
- "additionalProperties": false
952
- },
953
- "ExampleXORExamples": {
954
- "description": "Example and examples are mutually exclusive",
955
- "not": {
956
- "required": ["example", "examples"]
957
- }
958
- },
959
- "SchemaXORContent": {
960
- "description": "Schema and content are mutually exclusive, at least one is required",
961
- "not": {
962
- "required": ["schema", "content"]
963
- },
964
- "oneOf": [
965
- {
966
- "required": ["schema"]
967
- },
968
- {
969
- "required": ["content"],
970
- "description": "Some properties are not allowed if content is present",
971
- "allOf": [
972
- {
973
- "not": {
974
- "required": ["style"]
975
- }
976
- },
977
- {
978
- "not": {
979
- "required": ["explode"]
980
- }
981
- },
982
- {
983
- "not": {
984
- "required": ["allowReserved"]
985
- }
986
- },
987
- {
988
- "not": {
989
- "required": ["example"]
990
- }
991
- },
992
- {
993
- "not": {
994
- "required": ["examples"]
995
- }
996
- }
997
- ]
998
- }
999
- ]
1000
- },
1001
- "Parameter": {
1002
- "type": "object",
1003
- "properties": {
1004
- "name": {
1005
- "type": "string"
1006
- },
1007
- "in": {
1008
- "type": "string"
1009
- },
1010
- "description": {
1011
- "type": "string"
1012
- },
1013
- "required": {
1014
- "type": "boolean",
1015
- "default": false
1016
- },
1017
- "deprecated": {
1018
- "type": "boolean",
1019
- "default": false
1020
- },
1021
- "allowEmptyValue": {
1022
- "type": "boolean",
1023
- "default": false
1024
- },
1025
- "style": {
1026
- "type": "string"
1027
- },
1028
- "explode": {
1029
- "type": "boolean"
1030
- },
1031
- "allowReserved": {
1032
- "type": "boolean",
1033
- "default": false
1034
- },
1035
- "schema": {
1036
- "oneOf": [
1037
- {
1038
- "$ref": "#/definitions/Schema"
1039
- },
1040
- {
1041
- "$ref": "#/definitions/Reference"
1042
- }
1043
- ]
1044
- },
1045
- "content": {
1046
- "type": "object",
1047
- "additionalProperties": {
1048
- "$ref": "#/definitions/MediaType"
1049
- },
1050
- "minProperties": 1,
1051
- "maxProperties": 1
1052
- },
1053
- "example": {},
1054
- "examples": {
1055
- "type": "object",
1056
- "additionalProperties": {
1057
- "oneOf": [
1058
- {
1059
- "$ref": "#/definitions/Example"
1060
- },
1061
- {
1062
- "$ref": "#/definitions/Reference"
1063
- }
1064
- ]
1065
- }
1066
- }
1067
- },
1068
- "patternProperties": {
1069
- "^x-": {}
1070
- },
1071
- "additionalProperties": false,
1072
- "required": ["name", "in"],
1073
- "allOf": [
1074
- {
1075
- "$ref": "#/definitions/ExampleXORExamples"
1076
- },
1077
- {
1078
- "$ref": "#/definitions/SchemaXORContent"
1079
- },
1080
- {
1081
- "$ref": "#/definitions/ParameterLocation"
1082
- }
1083
- ]
1084
- },
1085
- "ParameterLocation": {
1086
- "description": "Parameter location",
1087
- "oneOf": [
1088
- {
1089
- "description": "Parameter in path",
1090
- "required": ["required"],
1091
- "properties": {
1092
- "in": {
1093
- "enum": ["path"]
1094
- },
1095
- "style": {
1096
- "enum": ["matrix", "label", "simple"],
1097
- "default": "simple"
1098
- },
1099
- "required": {
1100
- "enum": [true]
1101
- }
1102
- }
1103
- },
1104
- {
1105
- "description": "Parameter in query",
1106
- "properties": {
1107
- "in": {
1108
- "enum": ["query"]
1109
- },
1110
- "style": {
1111
- "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"],
1112
- "default": "form"
1113
- }
1114
- }
1115
- },
1116
- {
1117
- "description": "Parameter in header",
1118
- "properties": {
1119
- "in": {
1120
- "enum": ["header"]
1121
- },
1122
- "style": {
1123
- "enum": ["simple"],
1124
- "default": "simple"
1125
- }
1126
- }
1127
- },
1128
- {
1129
- "description": "Parameter in cookie",
1130
- "properties": {
1131
- "in": {
1132
- "enum": ["cookie"]
1133
- },
1134
- "style": {
1135
- "enum": ["form"],
1136
- "default": "form"
1137
- }
1138
- }
1139
- }
1140
- ]
1141
- },
1142
- "RequestBody": {
1143
- "type": "object",
1144
- "required": ["content"],
1145
- "properties": {
1146
- "description": {
1147
- "type": "string"
1148
- },
1149
- "content": {
1150
- "type": "object",
1151
- "additionalProperties": {
1152
- "$ref": "#/definitions/MediaType"
1153
- }
1154
- },
1155
- "required": {
1156
- "type": "boolean",
1157
- "default": false
1158
- }
1159
- },
1160
- "patternProperties": {
1161
- "^x-": {}
1162
- },
1163
- "additionalProperties": false
1164
- },
1165
- "SecurityScheme": {
1166
- "oneOf": [
1167
- {
1168
- "$ref": "#/definitions/APIKeySecurityScheme"
1169
- },
1170
- {
1171
- "$ref": "#/definitions/HTTPSecurityScheme"
1172
- },
1173
- {
1174
- "$ref": "#/definitions/OAuth2SecurityScheme"
1175
- },
1176
- {
1177
- "$ref": "#/definitions/OpenIdConnectSecurityScheme"
1178
- }
1179
- ]
1180
- },
1181
- "APIKeySecurityScheme": {
1182
- "type": "object",
1183
- "required": ["type", "name", "in"],
1184
- "properties": {
1185
- "type": {
1186
- "type": "string",
1187
- "enum": ["apiKey"]
1188
- },
1189
- "name": {
1190
- "type": "string"
1191
- },
1192
- "in": {
1193
- "type": "string",
1194
- "enum": ["header", "query", "cookie"]
1195
- },
1196
- "description": {
1197
- "type": "string"
1198
- }
1199
- },
1200
- "patternProperties": {
1201
- "^x-": {}
1202
- },
1203
- "additionalProperties": false
1204
- },
1205
- "HTTPSecurityScheme": {
1206
- "type": "object",
1207
- "required": ["scheme", "type"],
1208
- "properties": {
1209
- "scheme": {
1210
- "type": "string"
1211
- },
1212
- "bearerFormat": {
1213
- "type": "string"
1214
- },
1215
- "description": {
1216
- "type": "string"
1217
- },
1218
- "type": {
1219
- "type": "string",
1220
- "enum": ["http"]
1221
- }
1222
- },
1223
- "patternProperties": {
1224
- "^x-": {}
1225
- },
1226
- "additionalProperties": false,
1227
- "oneOf": [
1228
- {
1229
- "description": "Bearer",
1230
- "properties": {
1231
- "scheme": {
1232
- "type": "string",
1233
- "pattern": "^[Bb][Ee][Aa][Rr][Ee][Rr]$"
1234
- }
1235
- }
1236
- },
1237
- {
1238
- "description": "Non Bearer",
1239
- "not": {
1240
- "required": ["bearerFormat"]
1241
- },
1242
- "properties": {
1243
- "scheme": {
1244
- "not": {
1245
- "type": "string",
1246
- "pattern": "^[Bb][Ee][Aa][Rr][Ee][Rr]$"
1247
- }
1248
- }
1249
- }
1250
- }
1251
- ]
1252
- },
1253
- "OAuth2SecurityScheme": {
1254
- "type": "object",
1255
- "required": ["type", "flows"],
1256
- "properties": {
1257
- "type": {
1258
- "type": "string",
1259
- "enum": ["oauth2"]
1260
- },
1261
- "flows": {
1262
- "$ref": "#/definitions/OAuthFlows"
1263
- },
1264
- "description": {
1265
- "type": "string"
1266
- }
1267
- },
1268
- "patternProperties": {
1269
- "^x-": {}
1270
- },
1271
- "additionalProperties": false
1272
- },
1273
- "OpenIdConnectSecurityScheme": {
1274
- "type": "object",
1275
- "required": ["type", "openIdConnectUrl"],
1276
- "properties": {
1277
- "type": {
1278
- "type": "string",
1279
- "enum": ["openIdConnect"]
1280
- },
1281
- "openIdConnectUrl": {
1282
- "type": "string",
1283
- "format": "uri-reference"
1284
- },
1285
- "description": {
1286
- "type": "string"
1287
- }
1288
- },
1289
- "patternProperties": {
1290
- "^x-": {}
1291
- },
1292
- "additionalProperties": false
1293
- },
1294
- "OAuthFlows": {
1295
- "type": "object",
1296
- "properties": {
1297
- "implicit": {
1298
- "$ref": "#/definitions/ImplicitOAuthFlow"
1299
- },
1300
- "password": {
1301
- "$ref": "#/definitions/PasswordOAuthFlow"
1302
- },
1303
- "clientCredentials": {
1304
- "$ref": "#/definitions/ClientCredentialsFlow"
1305
- },
1306
- "authorizationCode": {
1307
- "$ref": "#/definitions/AuthorizationCodeOAuthFlow"
1308
- }
1309
- },
1310
- "patternProperties": {
1311
- "^x-": {}
1312
- },
1313
- "additionalProperties": false
1314
- },
1315
- "ImplicitOAuthFlow": {
1316
- "type": "object",
1317
- "required": ["authorizationUrl", "scopes"],
1318
- "properties": {
1319
- "authorizationUrl": {
1320
- "type": "string",
1321
- "format": "uri-reference"
1322
- },
1323
- "refreshUrl": {
1324
- "type": "string",
1325
- "format": "uri-reference"
1326
- },
1327
- "scopes": {
1328
- "type": "object",
1329
- "additionalProperties": {
1330
- "type": "string"
1331
- }
1332
- }
1333
- },
1334
- "patternProperties": {
1335
- "^x-": {}
1336
- },
1337
- "additionalProperties": false
1338
- },
1339
- "PasswordOAuthFlow": {
1340
- "type": "object",
1341
- "required": ["tokenUrl", "scopes"],
1342
- "properties": {
1343
- "tokenUrl": {
1344
- "type": "string",
1345
- "format": "uri-reference"
1346
- },
1347
- "refreshUrl": {
1348
- "type": "string",
1349
- "format": "uri-reference"
1350
- },
1351
- "scopes": {
1352
- "type": "object",
1353
- "additionalProperties": {
1354
- "type": "string"
1355
- }
1356
- }
1357
- },
1358
- "patternProperties": {
1359
- "^x-": {}
1360
- },
1361
- "additionalProperties": false
1362
- },
1363
- "ClientCredentialsFlow": {
1364
- "type": "object",
1365
- "required": ["tokenUrl", "scopes"],
1366
- "properties": {
1367
- "tokenUrl": {
1368
- "type": "string",
1369
- "format": "uri-reference"
1370
- },
1371
- "refreshUrl": {
1372
- "type": "string",
1373
- "format": "uri-reference"
1374
- },
1375
- "scopes": {
1376
- "type": "object",
1377
- "additionalProperties": {
1378
- "type": "string"
1379
- }
1380
- }
1381
- },
1382
- "patternProperties": {
1383
- "^x-": {}
1384
- },
1385
- "additionalProperties": false
1386
- },
1387
- "AuthorizationCodeOAuthFlow": {
1388
- "type": "object",
1389
- "required": ["authorizationUrl", "tokenUrl", "scopes"],
1390
- "properties": {
1391
- "authorizationUrl": {
1392
- "type": "string",
1393
- "format": "uri-reference"
1394
- },
1395
- "tokenUrl": {
1396
- "type": "string",
1397
- "format": "uri-reference"
1398
- },
1399
- "refreshUrl": {
1400
- "type": "string",
1401
- "format": "uri-reference"
1402
- },
1403
- "scopes": {
1404
- "type": "object",
1405
- "additionalProperties": {
1406
- "type": "string"
1407
- }
1408
- }
1409
- },
1410
- "patternProperties": {
1411
- "^x-": {}
1412
- },
1413
- "additionalProperties": false
1414
- },
1415
- "Link": {
1416
- "type": "object",
1417
- "properties": {
1418
- "operationId": {
1419
- "type": "string"
1420
- },
1421
- "operationRef": {
1422
- "type": "string",
1423
- "format": "uri-reference"
1424
- },
1425
- "parameters": {
1426
- "type": "object",
1427
- "additionalProperties": {}
1428
- },
1429
- "requestBody": {},
1430
- "description": {
1431
- "type": "string"
1432
- },
1433
- "server": {
1434
- "$ref": "#/definitions/Server"
1435
- }
1436
- },
1437
- "patternProperties": {
1438
- "^x-": {}
1439
- },
1440
- "additionalProperties": false,
1441
- "not": {
1442
- "description": "Operation Id and Operation Ref are mutually exclusive",
1443
- "required": ["operationId", "operationRef"]
1444
- }
1445
- },
1446
- "Callback": {
1447
- "type": "object",
1448
- "additionalProperties": {
1449
- "$ref": "#/definitions/PathItem"
1450
- },
1451
- "patternProperties": {
1452
- "^x-": {}
1453
- }
1454
- },
1455
- "Encoding": {
1456
- "type": "object",
1457
- "properties": {
1458
- "contentType": {
1459
- "type": "string"
1460
- },
1461
- "headers": {
1462
- "type": "object",
1463
- "additionalProperties": {
1464
- "oneOf": [
1465
- {
1466
- "$ref": "#/definitions/Header"
1467
- },
1468
- {
1469
- "$ref": "#/definitions/Reference"
1470
- }
1471
- ]
1472
- }
1473
- },
1474
- "style": {
1475
- "type": "string",
1476
- "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"]
1477
- },
1478
- "explode": {
1479
- "type": "boolean"
1480
- },
1481
- "allowReserved": {
1482
- "type": "boolean",
1483
- "default": false
1484
- }
1485
- },
1486
- "additionalProperties": false
1487
- }
1488
- }
1489
- }
1
+ {
2
+ "id": "https://spec.openapis.org/oas/3.0/schema/2021-09-28",
3
+ "$schema": "http://json-schema.org/draft-04/schema#",
4
+ "description": "The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3",
5
+ "type": "object",
6
+ "required": ["openapi", "info", "paths"],
7
+ "properties": {
8
+ "openapi": {
9
+ "type": "string",
10
+ "pattern": "^3\\.0\\.\\d(-.+)?$"
11
+ },
12
+ "info": {
13
+ "$ref": "#/definitions/Info"
14
+ },
15
+ "externalDocs": {
16
+ "$ref": "#/definitions/ExternalDocumentation"
17
+ },
18
+ "servers": {
19
+ "type": "array",
20
+ "items": {
21
+ "$ref": "#/definitions/Server"
22
+ }
23
+ },
24
+ "security": {
25
+ "type": "array",
26
+ "items": {
27
+ "$ref": "#/definitions/SecurityRequirement"
28
+ }
29
+ },
30
+ "tags": {
31
+ "type": "array",
32
+ "items": {
33
+ "$ref": "#/definitions/Tag"
34
+ },
35
+ "uniqueItems": true
36
+ },
37
+ "paths": {
38
+ "$ref": "#/definitions/Paths"
39
+ },
40
+ "components": {
41
+ "$ref": "#/definitions/Components"
42
+ }
43
+ },
44
+ "patternProperties": {
45
+ "^x-": {}
46
+ },
47
+ "additionalProperties": false,
48
+ "definitions": {
49
+ "Reference": {
50
+ "type": "object",
51
+ "required": ["$ref"],
52
+ "patternProperties": {
53
+ "^\\$ref$": {
54
+ "type": "string",
55
+ "format": "uri-reference"
56
+ }
57
+ }
58
+ },
59
+ "Info": {
60
+ "type": "object",
61
+ "required": ["title", "version"],
62
+ "properties": {
63
+ "title": {
64
+ "type": "string"
65
+ },
66
+ "description": {
67
+ "type": "string"
68
+ },
69
+ "termsOfService": {
70
+ "type": "string",
71
+ "format": "uri-reference"
72
+ },
73
+ "contact": {
74
+ "$ref": "#/definitions/Contact"
75
+ },
76
+ "license": {
77
+ "$ref": "#/definitions/License"
78
+ },
79
+ "version": {
80
+ "type": "string"
81
+ }
82
+ },
83
+ "patternProperties": {
84
+ "^x-": {}
85
+ },
86
+ "additionalProperties": false
87
+ },
88
+ "Contact": {
89
+ "type": "object",
90
+ "properties": {
91
+ "name": {
92
+ "type": "string"
93
+ },
94
+ "url": {
95
+ "type": "string",
96
+ "format": "uri-reference"
97
+ },
98
+ "email": {
99
+ "type": "string",
100
+ "format": "email"
101
+ }
102
+ },
103
+ "patternProperties": {
104
+ "^x-": {}
105
+ },
106
+ "additionalProperties": false
107
+ },
108
+ "License": {
109
+ "type": "object",
110
+ "required": ["name"],
111
+ "properties": {
112
+ "name": {
113
+ "type": "string"
114
+ },
115
+ "url": {
116
+ "type": "string",
117
+ "format": "uri-reference"
118
+ }
119
+ },
120
+ "patternProperties": {
121
+ "^x-": {}
122
+ },
123
+ "additionalProperties": false
124
+ },
125
+ "Server": {
126
+ "type": "object",
127
+ "required": ["url"],
128
+ "properties": {
129
+ "url": {
130
+ "type": "string"
131
+ },
132
+ "description": {
133
+ "type": "string"
134
+ },
135
+ "variables": {
136
+ "type": "object",
137
+ "additionalProperties": {
138
+ "$ref": "#/definitions/ServerVariable"
139
+ }
140
+ }
141
+ },
142
+ "patternProperties": {
143
+ "^x-": {}
144
+ },
145
+ "additionalProperties": false
146
+ },
147
+ "ServerVariable": {
148
+ "type": "object",
149
+ "required": ["default"],
150
+ "properties": {
151
+ "enum": {
152
+ "type": "array",
153
+ "items": {
154
+ "type": "string"
155
+ }
156
+ },
157
+ "default": {
158
+ "type": "string"
159
+ },
160
+ "description": {
161
+ "type": "string"
162
+ }
163
+ },
164
+ "patternProperties": {
165
+ "^x-": {}
166
+ },
167
+ "additionalProperties": false
168
+ },
169
+ "Components": {
170
+ "type": "object",
171
+ "properties": {
172
+ "schemas": {
173
+ "type": "object",
174
+ "patternProperties": {
175
+ "^[a-zA-Z0-9\\.\\-_]+$": {
176
+ "oneOf": [
177
+ {
178
+ "$ref": "#/definitions/Schema"
179
+ },
180
+ {
181
+ "$ref": "#/definitions/Reference"
182
+ }
183
+ ]
184
+ }
185
+ }
186
+ },
187
+ "responses": {
188
+ "type": "object",
189
+ "patternProperties": {
190
+ "^[a-zA-Z0-9\\.\\-_]+$": {
191
+ "oneOf": [
192
+ {
193
+ "$ref": "#/definitions/Reference"
194
+ },
195
+ {
196
+ "$ref": "#/definitions/Response"
197
+ }
198
+ ]
199
+ }
200
+ }
201
+ },
202
+ "parameters": {
203
+ "type": "object",
204
+ "patternProperties": {
205
+ "^[a-zA-Z0-9\\.\\-_]+$": {
206
+ "oneOf": [
207
+ {
208
+ "$ref": "#/definitions/Reference"
209
+ },
210
+ {
211
+ "$ref": "#/definitions/Parameter"
212
+ }
213
+ ]
214
+ }
215
+ }
216
+ },
217
+ "examples": {
218
+ "type": "object",
219
+ "patternProperties": {
220
+ "^[a-zA-Z0-9\\.\\-_]+$": {
221
+ "oneOf": [
222
+ {
223
+ "$ref": "#/definitions/Reference"
224
+ },
225
+ {
226
+ "$ref": "#/definitions/Example"
227
+ }
228
+ ]
229
+ }
230
+ }
231
+ },
232
+ "requestBodies": {
233
+ "type": "object",
234
+ "patternProperties": {
235
+ "^[a-zA-Z0-9\\.\\-_]+$": {
236
+ "oneOf": [
237
+ {
238
+ "$ref": "#/definitions/Reference"
239
+ },
240
+ {
241
+ "$ref": "#/definitions/RequestBody"
242
+ }
243
+ ]
244
+ }
245
+ }
246
+ },
247
+ "headers": {
248
+ "type": "object",
249
+ "patternProperties": {
250
+ "^[a-zA-Z0-9\\.\\-_]+$": {
251
+ "oneOf": [
252
+ {
253
+ "$ref": "#/definitions/Reference"
254
+ },
255
+ {
256
+ "$ref": "#/definitions/Header"
257
+ }
258
+ ]
259
+ }
260
+ }
261
+ },
262
+ "securitySchemes": {
263
+ "type": "object",
264
+ "patternProperties": {
265
+ "^[a-zA-Z0-9\\.\\-_]+$": {
266
+ "oneOf": [
267
+ {
268
+ "$ref": "#/definitions/Reference"
269
+ },
270
+ {
271
+ "$ref": "#/definitions/SecurityScheme"
272
+ }
273
+ ]
274
+ }
275
+ }
276
+ },
277
+ "links": {
278
+ "type": "object",
279
+ "patternProperties": {
280
+ "^[a-zA-Z0-9\\.\\-_]+$": {
281
+ "oneOf": [
282
+ {
283
+ "$ref": "#/definitions/Reference"
284
+ },
285
+ {
286
+ "$ref": "#/definitions/Link"
287
+ }
288
+ ]
289
+ }
290
+ }
291
+ },
292
+ "callbacks": {
293
+ "type": "object",
294
+ "patternProperties": {
295
+ "^[a-zA-Z0-9\\.\\-_]+$": {
296
+ "oneOf": [
297
+ {
298
+ "$ref": "#/definitions/Reference"
299
+ },
300
+ {
301
+ "$ref": "#/definitions/Callback"
302
+ }
303
+ ]
304
+ }
305
+ }
306
+ }
307
+ },
308
+ "patternProperties": {
309
+ "^x-": {}
310
+ },
311
+ "additionalProperties": false
312
+ },
313
+ "Schema": {
314
+ "type": "object",
315
+ "properties": {
316
+ "title": {
317
+ "type": "string"
318
+ },
319
+ "multipleOf": {
320
+ "type": "number",
321
+ "minimum": 0,
322
+ "exclusiveMinimum": true
323
+ },
324
+ "maximum": {
325
+ "type": "number"
326
+ },
327
+ "exclusiveMaximum": {
328
+ "type": "boolean",
329
+ "default": false
330
+ },
331
+ "minimum": {
332
+ "type": "number"
333
+ },
334
+ "exclusiveMinimum": {
335
+ "type": "boolean",
336
+ "default": false
337
+ },
338
+ "maxLength": {
339
+ "type": "integer",
340
+ "minimum": 0
341
+ },
342
+ "minLength": {
343
+ "type": "integer",
344
+ "minimum": 0,
345
+ "default": 0
346
+ },
347
+ "pattern": {
348
+ "type": "string",
349
+ "format": "regex"
350
+ },
351
+ "maxItems": {
352
+ "type": "integer",
353
+ "minimum": 0
354
+ },
355
+ "minItems": {
356
+ "type": "integer",
357
+ "minimum": 0,
358
+ "default": 0
359
+ },
360
+ "uniqueItems": {
361
+ "type": "boolean",
362
+ "default": false
363
+ },
364
+ "maxProperties": {
365
+ "type": "integer",
366
+ "minimum": 0
367
+ },
368
+ "minProperties": {
369
+ "type": "integer",
370
+ "minimum": 0,
371
+ "default": 0
372
+ },
373
+ "required": {
374
+ "type": "array",
375
+ "items": {
376
+ "type": "string"
377
+ },
378
+ "minItems": 1,
379
+ "uniqueItems": true
380
+ },
381
+ "enum": {
382
+ "type": "array",
383
+ "items": {},
384
+ "minItems": 1,
385
+ "uniqueItems": false
386
+ },
387
+ "type": {
388
+ "type": "string",
389
+ "enum": ["array", "boolean", "integer", "number", "object", "string"]
390
+ },
391
+ "not": {
392
+ "oneOf": [
393
+ {
394
+ "$ref": "#/definitions/Schema"
395
+ },
396
+ {
397
+ "$ref": "#/definitions/Reference"
398
+ }
399
+ ]
400
+ },
401
+ "allOf": {
402
+ "type": "array",
403
+ "items": {
404
+ "oneOf": [
405
+ {
406
+ "$ref": "#/definitions/Schema"
407
+ },
408
+ {
409
+ "$ref": "#/definitions/Reference"
410
+ }
411
+ ]
412
+ }
413
+ },
414
+ "oneOf": {
415
+ "type": "array",
416
+ "items": {
417
+ "oneOf": [
418
+ {
419
+ "$ref": "#/definitions/Schema"
420
+ },
421
+ {
422
+ "$ref": "#/definitions/Reference"
423
+ }
424
+ ]
425
+ }
426
+ },
427
+ "anyOf": {
428
+ "type": "array",
429
+ "items": {
430
+ "oneOf": [
431
+ {
432
+ "$ref": "#/definitions/Schema"
433
+ },
434
+ {
435
+ "$ref": "#/definitions/Reference"
436
+ }
437
+ ]
438
+ }
439
+ },
440
+ "items": {
441
+ "oneOf": [
442
+ {
443
+ "$ref": "#/definitions/Schema"
444
+ },
445
+ {
446
+ "$ref": "#/definitions/Reference"
447
+ }
448
+ ]
449
+ },
450
+ "properties": {
451
+ "type": "object",
452
+ "additionalProperties": {
453
+ "oneOf": [
454
+ {
455
+ "$ref": "#/definitions/Schema"
456
+ },
457
+ {
458
+ "$ref": "#/definitions/Reference"
459
+ }
460
+ ]
461
+ }
462
+ },
463
+ "additionalProperties": {
464
+ "oneOf": [
465
+ {
466
+ "$ref": "#/definitions/Schema"
467
+ },
468
+ {
469
+ "$ref": "#/definitions/Reference"
470
+ },
471
+ {
472
+ "type": "boolean"
473
+ }
474
+ ],
475
+ "default": true
476
+ },
477
+ "description": {
478
+ "type": "string"
479
+ },
480
+ "format": {
481
+ "type": "string"
482
+ },
483
+ "default": {},
484
+ "nullable": {
485
+ "type": "boolean",
486
+ "default": false
487
+ },
488
+ "discriminator": {
489
+ "$ref": "#/definitions/Discriminator"
490
+ },
491
+ "readOnly": {
492
+ "type": "boolean",
493
+ "default": false
494
+ },
495
+ "writeOnly": {
496
+ "type": "boolean",
497
+ "default": false
498
+ },
499
+ "example": {},
500
+ "externalDocs": {
501
+ "$ref": "#/definitions/ExternalDocumentation"
502
+ },
503
+ "deprecated": {
504
+ "type": "boolean",
505
+ "default": false
506
+ },
507
+ "xml": {
508
+ "$ref": "#/definitions/XML"
509
+ }
510
+ },
511
+ "patternProperties": {
512
+ "^x-": {}
513
+ },
514
+ "additionalProperties": false
515
+ },
516
+ "Discriminator": {
517
+ "type": "object",
518
+ "required": ["propertyName"],
519
+ "properties": {
520
+ "propertyName": {
521
+ "type": "string"
522
+ },
523
+ "mapping": {
524
+ "type": "object",
525
+ "additionalProperties": {
526
+ "type": "string"
527
+ }
528
+ }
529
+ }
530
+ },
531
+ "XML": {
532
+ "type": "object",
533
+ "properties": {
534
+ "name": {
535
+ "type": "string"
536
+ },
537
+ "namespace": {
538
+ "type": "string",
539
+ "format": "uri"
540
+ },
541
+ "prefix": {
542
+ "type": "string"
543
+ },
544
+ "attribute": {
545
+ "type": "boolean",
546
+ "default": false
547
+ },
548
+ "wrapped": {
549
+ "type": "boolean",
550
+ "default": false
551
+ }
552
+ },
553
+ "patternProperties": {
554
+ "^x-": {}
555
+ },
556
+ "additionalProperties": false
557
+ },
558
+ "Response": {
559
+ "type": "object",
560
+ "required": ["description"],
561
+ "properties": {
562
+ "description": {
563
+ "type": "string"
564
+ },
565
+ "headers": {
566
+ "type": "object",
567
+ "additionalProperties": {
568
+ "oneOf": [
569
+ {
570
+ "$ref": "#/definitions/Header"
571
+ },
572
+ {
573
+ "$ref": "#/definitions/Reference"
574
+ }
575
+ ]
576
+ }
577
+ },
578
+ "content": {
579
+ "type": "object",
580
+ "additionalProperties": {
581
+ "$ref": "#/definitions/MediaType"
582
+ }
583
+ },
584
+ "links": {
585
+ "type": "object",
586
+ "additionalProperties": {
587
+ "oneOf": [
588
+ {
589
+ "$ref": "#/definitions/Link"
590
+ },
591
+ {
592
+ "$ref": "#/definitions/Reference"
593
+ }
594
+ ]
595
+ }
596
+ }
597
+ },
598
+ "patternProperties": {
599
+ "^x-": {}
600
+ },
601
+ "additionalProperties": false
602
+ },
603
+ "MediaType": {
604
+ "type": "object",
605
+ "properties": {
606
+ "schema": {
607
+ "oneOf": [
608
+ {
609
+ "$ref": "#/definitions/Schema"
610
+ },
611
+ {
612
+ "$ref": "#/definitions/Reference"
613
+ }
614
+ ]
615
+ },
616
+ "example": {},
617
+ "examples": {
618
+ "type": "object",
619
+ "additionalProperties": {
620
+ "oneOf": [
621
+ {
622
+ "$ref": "#/definitions/Example"
623
+ },
624
+ {
625
+ "$ref": "#/definitions/Reference"
626
+ }
627
+ ]
628
+ }
629
+ },
630
+ "encoding": {
631
+ "type": "object",
632
+ "additionalProperties": {
633
+ "$ref": "#/definitions/Encoding"
634
+ }
635
+ }
636
+ },
637
+ "patternProperties": {
638
+ "^x-": {}
639
+ },
640
+ "additionalProperties": false,
641
+ "allOf": [
642
+ {
643
+ "$ref": "#/definitions/ExampleXORExamples"
644
+ }
645
+ ]
646
+ },
647
+ "Example": {
648
+ "type": "object",
649
+ "properties": {
650
+ "summary": {
651
+ "type": "string"
652
+ },
653
+ "description": {
654
+ "type": "string"
655
+ },
656
+ "value": {},
657
+ "externalValue": {
658
+ "type": "string",
659
+ "format": "uri-reference"
660
+ }
661
+ },
662
+ "patternProperties": {
663
+ "^x-": {}
664
+ },
665
+ "additionalProperties": false
666
+ },
667
+ "Header": {
668
+ "type": "object",
669
+ "properties": {
670
+ "description": {
671
+ "type": "string"
672
+ },
673
+ "required": {
674
+ "type": "boolean",
675
+ "default": false
676
+ },
677
+ "deprecated": {
678
+ "type": "boolean",
679
+ "default": false
680
+ },
681
+ "allowEmptyValue": {
682
+ "type": "boolean",
683
+ "default": false
684
+ },
685
+ "style": {
686
+ "type": "string",
687
+ "enum": ["simple"],
688
+ "default": "simple"
689
+ },
690
+ "explode": {
691
+ "type": "boolean"
692
+ },
693
+ "allowReserved": {
694
+ "type": "boolean",
695
+ "default": false
696
+ },
697
+ "schema": {
698
+ "oneOf": [
699
+ {
700
+ "$ref": "#/definitions/Schema"
701
+ },
702
+ {
703
+ "$ref": "#/definitions/Reference"
704
+ }
705
+ ]
706
+ },
707
+ "content": {
708
+ "type": "object",
709
+ "additionalProperties": {
710
+ "$ref": "#/definitions/MediaType"
711
+ },
712
+ "minProperties": 1,
713
+ "maxProperties": 1
714
+ },
715
+ "example": {},
716
+ "examples": {
717
+ "type": "object",
718
+ "additionalProperties": {
719
+ "oneOf": [
720
+ {
721
+ "$ref": "#/definitions/Example"
722
+ },
723
+ {
724
+ "$ref": "#/definitions/Reference"
725
+ }
726
+ ]
727
+ }
728
+ }
729
+ },
730
+ "patternProperties": {
731
+ "^x-": {}
732
+ },
733
+ "additionalProperties": false,
734
+ "allOf": [
735
+ {
736
+ "$ref": "#/definitions/ExampleXORExamples"
737
+ },
738
+ {
739
+ "$ref": "#/definitions/SchemaXORContent"
740
+ }
741
+ ]
742
+ },
743
+ "Paths": {
744
+ "type": "object",
745
+ "patternProperties": {
746
+ "^\\/": {
747
+ "$ref": "#/definitions/PathItem"
748
+ },
749
+ "^x-": {}
750
+ },
751
+ "additionalProperties": false
752
+ },
753
+ "PathItem": {
754
+ "type": "object",
755
+ "properties": {
756
+ "$ref": {
757
+ "type": "string"
758
+ },
759
+ "summary": {
760
+ "type": "string"
761
+ },
762
+ "description": {
763
+ "type": "string"
764
+ },
765
+ "servers": {
766
+ "type": "array",
767
+ "items": {
768
+ "$ref": "#/definitions/Server"
769
+ }
770
+ },
771
+ "parameters": {
772
+ "type": "array",
773
+ "items": {
774
+ "oneOf": [
775
+ {
776
+ "$ref": "#/definitions/Parameter"
777
+ },
778
+ {
779
+ "$ref": "#/definitions/Reference"
780
+ }
781
+ ]
782
+ },
783
+ "uniqueItems": true
784
+ }
785
+ },
786
+ "patternProperties": {
787
+ "^(get|put|post|delete|options|head|patch|trace)$": {
788
+ "$ref": "#/definitions/Operation"
789
+ },
790
+ "^x-": {}
791
+ },
792
+ "additionalProperties": false
793
+ },
794
+ "Operation": {
795
+ "type": "object",
796
+ "required": ["responses"],
797
+ "properties": {
798
+ "tags": {
799
+ "type": "array",
800
+ "items": {
801
+ "type": "string"
802
+ }
803
+ },
804
+ "summary": {
805
+ "type": "string"
806
+ },
807
+ "description": {
808
+ "type": "string"
809
+ },
810
+ "externalDocs": {
811
+ "$ref": "#/definitions/ExternalDocumentation"
812
+ },
813
+ "operationId": {
814
+ "type": "string"
815
+ },
816
+ "parameters": {
817
+ "type": "array",
818
+ "items": {
819
+ "oneOf": [
820
+ {
821
+ "$ref": "#/definitions/Parameter"
822
+ },
823
+ {
824
+ "$ref": "#/definitions/Reference"
825
+ }
826
+ ]
827
+ },
828
+ "uniqueItems": true
829
+ },
830
+ "requestBody": {
831
+ "oneOf": [
832
+ {
833
+ "$ref": "#/definitions/RequestBody"
834
+ },
835
+ {
836
+ "$ref": "#/definitions/Reference"
837
+ }
838
+ ]
839
+ },
840
+ "responses": {
841
+ "$ref": "#/definitions/Responses"
842
+ },
843
+ "callbacks": {
844
+ "type": "object",
845
+ "additionalProperties": {
846
+ "oneOf": [
847
+ {
848
+ "$ref": "#/definitions/Callback"
849
+ },
850
+ {
851
+ "$ref": "#/definitions/Reference"
852
+ }
853
+ ]
854
+ }
855
+ },
856
+ "deprecated": {
857
+ "type": "boolean",
858
+ "default": false
859
+ },
860
+ "security": {
861
+ "type": "array",
862
+ "items": {
863
+ "$ref": "#/definitions/SecurityRequirement"
864
+ }
865
+ },
866
+ "servers": {
867
+ "type": "array",
868
+ "items": {
869
+ "$ref": "#/definitions/Server"
870
+ }
871
+ }
872
+ },
873
+ "patternProperties": {
874
+ "^x-": {}
875
+ },
876
+ "additionalProperties": false
877
+ },
878
+ "Responses": {
879
+ "type": "object",
880
+ "properties": {
881
+ "default": {
882
+ "oneOf": [
883
+ {
884
+ "$ref": "#/definitions/Response"
885
+ },
886
+ {
887
+ "$ref": "#/definitions/Reference"
888
+ }
889
+ ]
890
+ }
891
+ },
892
+ "patternProperties": {
893
+ "^[1-5](?:\\d{2}|XX)$": {
894
+ "oneOf": [
895
+ {
896
+ "$ref": "#/definitions/Response"
897
+ },
898
+ {
899
+ "$ref": "#/definitions/Reference"
900
+ }
901
+ ]
902
+ },
903
+ "^x-": {}
904
+ },
905
+ "minProperties": 1,
906
+ "additionalProperties": false
907
+ },
908
+ "SecurityRequirement": {
909
+ "type": "object",
910
+ "additionalProperties": {
911
+ "type": "array",
912
+ "items": {
913
+ "type": "string"
914
+ }
915
+ }
916
+ },
917
+ "Tag": {
918
+ "type": "object",
919
+ "required": ["name"],
920
+ "properties": {
921
+ "name": {
922
+ "type": "string"
923
+ },
924
+ "description": {
925
+ "type": "string"
926
+ },
927
+ "externalDocs": {
928
+ "$ref": "#/definitions/ExternalDocumentation"
929
+ }
930
+ },
931
+ "patternProperties": {
932
+ "^x-": {}
933
+ },
934
+ "additionalProperties": false
935
+ },
936
+ "ExternalDocumentation": {
937
+ "type": "object",
938
+ "required": ["url"],
939
+ "properties": {
940
+ "description": {
941
+ "type": "string"
942
+ },
943
+ "url": {
944
+ "type": "string",
945
+ "format": "uri-reference"
946
+ }
947
+ },
948
+ "patternProperties": {
949
+ "^x-": {}
950
+ },
951
+ "additionalProperties": false
952
+ },
953
+ "ExampleXORExamples": {
954
+ "description": "Example and examples are mutually exclusive",
955
+ "not": {
956
+ "required": ["example", "examples"]
957
+ }
958
+ },
959
+ "SchemaXORContent": {
960
+ "description": "Schema and content are mutually exclusive, at least one is required",
961
+ "not": {
962
+ "required": ["schema", "content"]
963
+ },
964
+ "oneOf": [
965
+ {
966
+ "required": ["schema"]
967
+ },
968
+ {
969
+ "required": ["content"],
970
+ "description": "Some properties are not allowed if content is present",
971
+ "allOf": [
972
+ {
973
+ "not": {
974
+ "required": ["style"]
975
+ }
976
+ },
977
+ {
978
+ "not": {
979
+ "required": ["explode"]
980
+ }
981
+ },
982
+ {
983
+ "not": {
984
+ "required": ["allowReserved"]
985
+ }
986
+ },
987
+ {
988
+ "not": {
989
+ "required": ["example"]
990
+ }
991
+ },
992
+ {
993
+ "not": {
994
+ "required": ["examples"]
995
+ }
996
+ }
997
+ ]
998
+ }
999
+ ]
1000
+ },
1001
+ "Parameter": {
1002
+ "type": "object",
1003
+ "properties": {
1004
+ "name": {
1005
+ "type": "string"
1006
+ },
1007
+ "in": {
1008
+ "type": "string"
1009
+ },
1010
+ "description": {
1011
+ "type": "string"
1012
+ },
1013
+ "required": {
1014
+ "type": "boolean",
1015
+ "default": false
1016
+ },
1017
+ "deprecated": {
1018
+ "type": "boolean",
1019
+ "default": false
1020
+ },
1021
+ "allowEmptyValue": {
1022
+ "type": "boolean",
1023
+ "default": false
1024
+ },
1025
+ "style": {
1026
+ "type": "string"
1027
+ },
1028
+ "explode": {
1029
+ "type": "boolean"
1030
+ },
1031
+ "allowReserved": {
1032
+ "type": "boolean",
1033
+ "default": false
1034
+ },
1035
+ "schema": {
1036
+ "oneOf": [
1037
+ {
1038
+ "$ref": "#/definitions/Schema"
1039
+ },
1040
+ {
1041
+ "$ref": "#/definitions/Reference"
1042
+ }
1043
+ ]
1044
+ },
1045
+ "content": {
1046
+ "type": "object",
1047
+ "additionalProperties": {
1048
+ "$ref": "#/definitions/MediaType"
1049
+ },
1050
+ "minProperties": 1,
1051
+ "maxProperties": 1
1052
+ },
1053
+ "example": {},
1054
+ "examples": {
1055
+ "type": "object",
1056
+ "additionalProperties": {
1057
+ "oneOf": [
1058
+ {
1059
+ "$ref": "#/definitions/Example"
1060
+ },
1061
+ {
1062
+ "$ref": "#/definitions/Reference"
1063
+ }
1064
+ ]
1065
+ }
1066
+ }
1067
+ },
1068
+ "patternProperties": {
1069
+ "^x-": {}
1070
+ },
1071
+ "additionalProperties": false,
1072
+ "required": ["name", "in"],
1073
+ "allOf": [
1074
+ {
1075
+ "$ref": "#/definitions/ExampleXORExamples"
1076
+ },
1077
+ {
1078
+ "$ref": "#/definitions/SchemaXORContent"
1079
+ },
1080
+ {
1081
+ "$ref": "#/definitions/ParameterLocation"
1082
+ }
1083
+ ]
1084
+ },
1085
+ "ParameterLocation": {
1086
+ "description": "Parameter location",
1087
+ "oneOf": [
1088
+ {
1089
+ "description": "Parameter in path",
1090
+ "required": ["required"],
1091
+ "properties": {
1092
+ "in": {
1093
+ "enum": ["path"]
1094
+ },
1095
+ "style": {
1096
+ "enum": ["matrix", "label", "simple"],
1097
+ "default": "simple"
1098
+ },
1099
+ "required": {
1100
+ "enum": [true]
1101
+ }
1102
+ }
1103
+ },
1104
+ {
1105
+ "description": "Parameter in query",
1106
+ "properties": {
1107
+ "in": {
1108
+ "enum": ["query"]
1109
+ },
1110
+ "style": {
1111
+ "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"],
1112
+ "default": "form"
1113
+ }
1114
+ }
1115
+ },
1116
+ {
1117
+ "description": "Parameter in header",
1118
+ "properties": {
1119
+ "in": {
1120
+ "enum": ["header"]
1121
+ },
1122
+ "style": {
1123
+ "enum": ["simple"],
1124
+ "default": "simple"
1125
+ }
1126
+ }
1127
+ },
1128
+ {
1129
+ "description": "Parameter in cookie",
1130
+ "properties": {
1131
+ "in": {
1132
+ "enum": ["cookie"]
1133
+ },
1134
+ "style": {
1135
+ "enum": ["form"],
1136
+ "default": "form"
1137
+ }
1138
+ }
1139
+ }
1140
+ ]
1141
+ },
1142
+ "RequestBody": {
1143
+ "type": "object",
1144
+ "required": ["content"],
1145
+ "properties": {
1146
+ "description": {
1147
+ "type": "string"
1148
+ },
1149
+ "content": {
1150
+ "type": "object",
1151
+ "additionalProperties": {
1152
+ "$ref": "#/definitions/MediaType"
1153
+ }
1154
+ },
1155
+ "required": {
1156
+ "type": "boolean",
1157
+ "default": false
1158
+ }
1159
+ },
1160
+ "patternProperties": {
1161
+ "^x-": {}
1162
+ },
1163
+ "additionalProperties": false
1164
+ },
1165
+ "SecurityScheme": {
1166
+ "oneOf": [
1167
+ {
1168
+ "$ref": "#/definitions/APIKeySecurityScheme"
1169
+ },
1170
+ {
1171
+ "$ref": "#/definitions/HTTPSecurityScheme"
1172
+ },
1173
+ {
1174
+ "$ref": "#/definitions/OAuth2SecurityScheme"
1175
+ },
1176
+ {
1177
+ "$ref": "#/definitions/OpenIdConnectSecurityScheme"
1178
+ }
1179
+ ]
1180
+ },
1181
+ "APIKeySecurityScheme": {
1182
+ "type": "object",
1183
+ "required": ["type", "name", "in"],
1184
+ "properties": {
1185
+ "type": {
1186
+ "type": "string",
1187
+ "enum": ["apiKey"]
1188
+ },
1189
+ "name": {
1190
+ "type": "string"
1191
+ },
1192
+ "in": {
1193
+ "type": "string",
1194
+ "enum": ["header", "query", "cookie"]
1195
+ },
1196
+ "description": {
1197
+ "type": "string"
1198
+ }
1199
+ },
1200
+ "patternProperties": {
1201
+ "^x-": {}
1202
+ },
1203
+ "additionalProperties": false
1204
+ },
1205
+ "HTTPSecurityScheme": {
1206
+ "type": "object",
1207
+ "required": ["scheme", "type"],
1208
+ "properties": {
1209
+ "scheme": {
1210
+ "type": "string"
1211
+ },
1212
+ "bearerFormat": {
1213
+ "type": "string"
1214
+ },
1215
+ "description": {
1216
+ "type": "string"
1217
+ },
1218
+ "type": {
1219
+ "type": "string",
1220
+ "enum": ["http"]
1221
+ }
1222
+ },
1223
+ "patternProperties": {
1224
+ "^x-": {}
1225
+ },
1226
+ "additionalProperties": false,
1227
+ "oneOf": [
1228
+ {
1229
+ "description": "Bearer",
1230
+ "properties": {
1231
+ "scheme": {
1232
+ "type": "string",
1233
+ "pattern": "^[Bb][Ee][Aa][Rr][Ee][Rr]$"
1234
+ }
1235
+ }
1236
+ },
1237
+ {
1238
+ "description": "Non Bearer",
1239
+ "not": {
1240
+ "required": ["bearerFormat"]
1241
+ },
1242
+ "properties": {
1243
+ "scheme": {
1244
+ "not": {
1245
+ "type": "string",
1246
+ "pattern": "^[Bb][Ee][Aa][Rr][Ee][Rr]$"
1247
+ }
1248
+ }
1249
+ }
1250
+ }
1251
+ ]
1252
+ },
1253
+ "OAuth2SecurityScheme": {
1254
+ "type": "object",
1255
+ "required": ["type", "flows"],
1256
+ "properties": {
1257
+ "type": {
1258
+ "type": "string",
1259
+ "enum": ["oauth2"]
1260
+ },
1261
+ "flows": {
1262
+ "$ref": "#/definitions/OAuthFlows"
1263
+ },
1264
+ "description": {
1265
+ "type": "string"
1266
+ }
1267
+ },
1268
+ "patternProperties": {
1269
+ "^x-": {}
1270
+ },
1271
+ "additionalProperties": false
1272
+ },
1273
+ "OpenIdConnectSecurityScheme": {
1274
+ "type": "object",
1275
+ "required": ["type", "openIdConnectUrl"],
1276
+ "properties": {
1277
+ "type": {
1278
+ "type": "string",
1279
+ "enum": ["openIdConnect"]
1280
+ },
1281
+ "openIdConnectUrl": {
1282
+ "type": "string",
1283
+ "format": "uri-reference"
1284
+ },
1285
+ "description": {
1286
+ "type": "string"
1287
+ }
1288
+ },
1289
+ "patternProperties": {
1290
+ "^x-": {}
1291
+ },
1292
+ "additionalProperties": false
1293
+ },
1294
+ "OAuthFlows": {
1295
+ "type": "object",
1296
+ "properties": {
1297
+ "implicit": {
1298
+ "$ref": "#/definitions/ImplicitOAuthFlow"
1299
+ },
1300
+ "password": {
1301
+ "$ref": "#/definitions/PasswordOAuthFlow"
1302
+ },
1303
+ "clientCredentials": {
1304
+ "$ref": "#/definitions/ClientCredentialsFlow"
1305
+ },
1306
+ "authorizationCode": {
1307
+ "$ref": "#/definitions/AuthorizationCodeOAuthFlow"
1308
+ }
1309
+ },
1310
+ "patternProperties": {
1311
+ "^x-": {}
1312
+ },
1313
+ "additionalProperties": false
1314
+ },
1315
+ "ImplicitOAuthFlow": {
1316
+ "type": "object",
1317
+ "required": ["authorizationUrl", "scopes"],
1318
+ "properties": {
1319
+ "authorizationUrl": {
1320
+ "type": "string",
1321
+ "format": "uri-reference"
1322
+ },
1323
+ "refreshUrl": {
1324
+ "type": "string",
1325
+ "format": "uri-reference"
1326
+ },
1327
+ "scopes": {
1328
+ "type": "object",
1329
+ "additionalProperties": {
1330
+ "type": "string"
1331
+ }
1332
+ }
1333
+ },
1334
+ "patternProperties": {
1335
+ "^x-": {}
1336
+ },
1337
+ "additionalProperties": false
1338
+ },
1339
+ "PasswordOAuthFlow": {
1340
+ "type": "object",
1341
+ "required": ["tokenUrl", "scopes"],
1342
+ "properties": {
1343
+ "tokenUrl": {
1344
+ "type": "string",
1345
+ "format": "uri-reference"
1346
+ },
1347
+ "refreshUrl": {
1348
+ "type": "string",
1349
+ "format": "uri-reference"
1350
+ },
1351
+ "scopes": {
1352
+ "type": "object",
1353
+ "additionalProperties": {
1354
+ "type": "string"
1355
+ }
1356
+ }
1357
+ },
1358
+ "patternProperties": {
1359
+ "^x-": {}
1360
+ },
1361
+ "additionalProperties": false
1362
+ },
1363
+ "ClientCredentialsFlow": {
1364
+ "type": "object",
1365
+ "required": ["tokenUrl", "scopes"],
1366
+ "properties": {
1367
+ "tokenUrl": {
1368
+ "type": "string",
1369
+ "format": "uri-reference"
1370
+ },
1371
+ "refreshUrl": {
1372
+ "type": "string",
1373
+ "format": "uri-reference"
1374
+ },
1375
+ "scopes": {
1376
+ "type": "object",
1377
+ "additionalProperties": {
1378
+ "type": "string"
1379
+ }
1380
+ }
1381
+ },
1382
+ "patternProperties": {
1383
+ "^x-": {}
1384
+ },
1385
+ "additionalProperties": false
1386
+ },
1387
+ "AuthorizationCodeOAuthFlow": {
1388
+ "type": "object",
1389
+ "required": ["authorizationUrl", "tokenUrl", "scopes"],
1390
+ "properties": {
1391
+ "authorizationUrl": {
1392
+ "type": "string",
1393
+ "format": "uri-reference"
1394
+ },
1395
+ "tokenUrl": {
1396
+ "type": "string",
1397
+ "format": "uri-reference"
1398
+ },
1399
+ "refreshUrl": {
1400
+ "type": "string",
1401
+ "format": "uri-reference"
1402
+ },
1403
+ "scopes": {
1404
+ "type": "object",
1405
+ "additionalProperties": {
1406
+ "type": "string"
1407
+ }
1408
+ }
1409
+ },
1410
+ "patternProperties": {
1411
+ "^x-": {}
1412
+ },
1413
+ "additionalProperties": false
1414
+ },
1415
+ "Link": {
1416
+ "type": "object",
1417
+ "properties": {
1418
+ "operationId": {
1419
+ "type": "string"
1420
+ },
1421
+ "operationRef": {
1422
+ "type": "string",
1423
+ "format": "uri-reference"
1424
+ },
1425
+ "parameters": {
1426
+ "type": "object",
1427
+ "additionalProperties": {}
1428
+ },
1429
+ "requestBody": {},
1430
+ "description": {
1431
+ "type": "string"
1432
+ },
1433
+ "server": {
1434
+ "$ref": "#/definitions/Server"
1435
+ }
1436
+ },
1437
+ "patternProperties": {
1438
+ "^x-": {}
1439
+ },
1440
+ "additionalProperties": false,
1441
+ "not": {
1442
+ "description": "Operation Id and Operation Ref are mutually exclusive",
1443
+ "required": ["operationId", "operationRef"]
1444
+ }
1445
+ },
1446
+ "Callback": {
1447
+ "type": "object",
1448
+ "additionalProperties": {
1449
+ "$ref": "#/definitions/PathItem"
1450
+ },
1451
+ "patternProperties": {
1452
+ "^x-": {}
1453
+ }
1454
+ },
1455
+ "Encoding": {
1456
+ "type": "object",
1457
+ "properties": {
1458
+ "contentType": {
1459
+ "type": "string"
1460
+ },
1461
+ "headers": {
1462
+ "type": "object",
1463
+ "additionalProperties": {
1464
+ "oneOf": [
1465
+ {
1466
+ "$ref": "#/definitions/Header"
1467
+ },
1468
+ {
1469
+ "$ref": "#/definitions/Reference"
1470
+ }
1471
+ ]
1472
+ }
1473
+ },
1474
+ "style": {
1475
+ "type": "string",
1476
+ "enum": ["form", "spaceDelimited", "pipeDelimited", "deepObject"]
1477
+ },
1478
+ "explode": {
1479
+ "type": "boolean"
1480
+ },
1481
+ "allowReserved": {
1482
+ "type": "boolean",
1483
+ "default": false
1484
+ }
1485
+ },
1486
+ "additionalProperties": false
1487
+ }
1488
+ }
1489
+ }