@scalar/workspace-store 0.15.8 → 0.16.2

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 (285) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/dist/client.d.ts +1 -1
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +2 -2
  5. package/dist/client.js.map +2 -2
  6. package/dist/mutators/index.d.ts +6 -24
  7. package/dist/mutators/index.d.ts.map +1 -1
  8. package/dist/mutators/index.js +0 -2
  9. package/dist/mutators/index.js.map +2 -2
  10. package/dist/navigation/helpers/traverse-description.d.ts +1 -1
  11. package/dist/navigation/helpers/traverse-description.d.ts.map +1 -1
  12. package/dist/navigation/helpers/traverse-description.js.map +1 -1
  13. package/dist/navigation/helpers/traverse-document.d.ts +2 -182
  14. package/dist/navigation/helpers/traverse-document.d.ts.map +1 -1
  15. package/dist/navigation/helpers/traverse-document.js.map +2 -2
  16. package/dist/navigation/helpers/traverse-paths.d.ts.map +1 -1
  17. package/dist/navigation/helpers/traverse-paths.js +1 -1
  18. package/dist/navigation/helpers/traverse-paths.js.map +2 -2
  19. package/dist/navigation/helpers/traverse-schemas.d.ts +2 -1
  20. package/dist/navigation/helpers/traverse-schemas.d.ts.map +1 -1
  21. package/dist/navigation/helpers/traverse-schemas.js.map +2 -2
  22. package/dist/navigation/helpers/traverse-tags.d.ts +2 -1
  23. package/dist/navigation/helpers/traverse-tags.d.ts.map +1 -1
  24. package/dist/navigation/helpers/traverse-tags.js +1 -0
  25. package/dist/navigation/helpers/traverse-tags.js.map +2 -2
  26. package/dist/navigation/helpers/traverse-webhooks.d.ts +2 -1
  27. package/dist/navigation/helpers/traverse-webhooks.d.ts.map +1 -1
  28. package/dist/navigation/helpers/traverse-webhooks.js +1 -1
  29. package/dist/navigation/helpers/traverse-webhooks.js.map +2 -2
  30. package/dist/navigation/types.d.ts +2 -1
  31. package/dist/navigation/types.d.ts.map +1 -1
  32. package/dist/schemas/extensions/document/x-internal.d.ts +4 -0
  33. package/dist/schemas/extensions/document/x-internal.d.ts.map +1 -1
  34. package/dist/schemas/extensions/document/x-internal.js.map +1 -1
  35. package/dist/schemas/extensions/document/x-scalar-icon.d.ts +4 -0
  36. package/dist/schemas/extensions/document/x-scalar-icon.d.ts.map +1 -1
  37. package/dist/schemas/extensions/document/x-scalar-icon.js.map +1 -1
  38. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts +4 -0
  39. package/dist/schemas/extensions/document/x-scalar-ignore.d.ts.map +1 -1
  40. package/dist/schemas/extensions/document/x-scalar-ignore.js.map +1 -1
  41. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts +8 -2
  42. package/dist/schemas/extensions/document/x-scalar-sdk-installation.d.ts.map +1 -1
  43. package/dist/schemas/extensions/document/x-scalar-sdk-installation.js.map +2 -2
  44. package/dist/schemas/extensions/document/x-tags.d.ts +3 -0
  45. package/dist/schemas/extensions/document/x-tags.d.ts.map +1 -1
  46. package/dist/schemas/extensions/document/x-tags.js.map +1 -1
  47. package/dist/schemas/extensions/operation/index.d.ts +2 -0
  48. package/dist/schemas/extensions/operation/index.d.ts.map +1 -0
  49. package/dist/schemas/extensions/operation/index.js +1 -0
  50. package/dist/schemas/extensions/operation/x-badge.d.ts +62 -22
  51. package/dist/schemas/extensions/operation/x-badge.d.ts.map +1 -1
  52. package/dist/schemas/extensions/operation/x-badge.js +24 -3
  53. package/dist/schemas/extensions/operation/x-badge.js.map +2 -2
  54. package/dist/schemas/extensions/operation/x-code-samples.d.ts +10 -0
  55. package/dist/schemas/extensions/operation/x-code-samples.d.ts.map +1 -1
  56. package/dist/schemas/extensions/operation/x-code-samples.js.map +1 -1
  57. package/dist/schemas/extensions/operation/x-post-response.d.ts +18 -0
  58. package/dist/schemas/extensions/operation/x-post-response.d.ts.map +1 -1
  59. package/dist/schemas/extensions/operation/x-post-response.js.map +1 -1
  60. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts +11 -0
  61. package/dist/schemas/extensions/operation/x-scalar-stability.d.ts.map +1 -1
  62. package/dist/schemas/extensions/operation/x-scalar-stability.js.map +1 -1
  63. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts +10 -0
  64. package/dist/schemas/extensions/schema/x-additional-properties-name.d.ts.map +1 -1
  65. package/dist/schemas/extensions/schema/x-additional-properties-name.js.map +1 -1
  66. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts +30 -0
  67. package/dist/schemas/extensions/schema/x-enum-descriptions.d.ts.map +1 -1
  68. package/dist/schemas/extensions/schema/x-enum-descriptions.js.map +1 -1
  69. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts +38 -0
  70. package/dist/schemas/extensions/schema/x-enum-varnames.d.ts.map +1 -1
  71. package/dist/schemas/extensions/schema/x-enum-varnames.js.map +1 -1
  72. package/dist/schemas/extensions/schema/x-variable.d.ts +3 -0
  73. package/dist/schemas/extensions/schema/x-variable.d.ts.map +1 -1
  74. package/dist/schemas/extensions/schema/x-variable.js.map +1 -1
  75. package/dist/schemas/extensions/security/x-default-scopes.d.ts +33 -0
  76. package/dist/schemas/extensions/security/x-default-scopes.d.ts.map +1 -0
  77. package/dist/schemas/extensions/security/x-default-scopes.js +8 -0
  78. package/dist/schemas/extensions/security/x-default-scopes.js.map +7 -0
  79. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts +16 -0
  80. package/dist/schemas/extensions/security/x-scalar-credentials-location.d.ts.map +1 -1
  81. package/dist/schemas/extensions/security/x-scalar-credentials-location.js.map +1 -1
  82. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts +15 -1
  83. package/dist/schemas/extensions/security/x-scalar-security-body.d.ts.map +1 -1
  84. package/dist/schemas/extensions/security/x-scalar-security-body.js +2 -2
  85. package/dist/schemas/extensions/security/x-scalar-security-body.js.map +2 -2
  86. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts +15 -1
  87. package/dist/schemas/extensions/security/x-scalar-security-query.d.ts.map +1 -1
  88. package/dist/schemas/extensions/security/x-scalar-security-query.js +2 -2
  89. package/dist/schemas/extensions/security/x-scalar-security-query.js.map +2 -2
  90. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts +68 -3
  91. package/dist/schemas/extensions/security/x-scalar-security-secrets.d.ts.map +1 -1
  92. package/dist/schemas/extensions/security/x-scalar-security-secrets.js +15 -3
  93. package/dist/schemas/extensions/security/x-scalar-security-secrets.js.map +2 -2
  94. package/dist/schemas/extensions/security/x-tokenName.d.ts +12 -1
  95. package/dist/schemas/extensions/security/x-tokenName.d.ts.map +1 -1
  96. package/dist/schemas/extensions/security/x-tokenName.js +2 -2
  97. package/dist/schemas/extensions/security/x-tokenName.js.map +2 -2
  98. package/dist/schemas/extensions/security/x-use-pkce.d.ts +7 -1
  99. package/dist/schemas/extensions/security/x-use-pkce.d.ts.map +1 -1
  100. package/dist/schemas/extensions/security/x-use-pkce.js +1 -3
  101. package/dist/schemas/extensions/security/x-use-pkce.js.map +2 -2
  102. package/dist/schemas/extensions/tag/x-display-name.d.ts +11 -0
  103. package/dist/schemas/extensions/tag/x-display-name.d.ts.map +1 -1
  104. package/dist/schemas/extensions/tag/x-display-name.js.map +1 -1
  105. package/dist/schemas/extensions/tag/x-tag-groups.d.ts +18 -0
  106. package/dist/schemas/extensions/tag/x-tag-groups.d.ts.map +1 -1
  107. package/dist/schemas/extensions/tag/x-tag-groups.js.map +2 -2
  108. package/dist/schemas/inmemory-workspace.d.ts +207 -86
  109. package/dist/schemas/inmemory-workspace.d.ts.map +1 -1
  110. package/dist/schemas/inmemory-workspace.js +4 -1
  111. package/dist/schemas/inmemory-workspace.js.map +2 -2
  112. package/dist/schemas/navigation.d.ts +50 -1
  113. package/dist/schemas/navigation.d.ts.map +1 -1
  114. package/dist/schemas/navigation.js +5 -9
  115. package/dist/schemas/navigation.js.map +2 -2
  116. package/dist/schemas/reference-config/appearance.d.ts +9 -2
  117. package/dist/schemas/reference-config/appearance.d.ts.map +1 -1
  118. package/dist/schemas/reference-config/appearance.js.map +2 -2
  119. package/dist/schemas/reference-config/features.d.ts +11 -2
  120. package/dist/schemas/reference-config/features.d.ts.map +1 -1
  121. package/dist/schemas/reference-config/features.js.map +2 -2
  122. package/dist/schemas/reference-config/index.d.ts +114 -45
  123. package/dist/schemas/reference-config/index.d.ts.map +1 -1
  124. package/dist/schemas/reference-config/index.js +5 -5
  125. package/dist/schemas/reference-config/index.js.map +2 -2
  126. package/dist/schemas/reference-config/meta.d.ts +8 -2
  127. package/dist/schemas/reference-config/meta.d.ts.map +1 -1
  128. package/dist/schemas/reference-config/meta.js.map +2 -2
  129. package/dist/schemas/reference-config/routing.d.ts +4 -2
  130. package/dist/schemas/reference-config/routing.d.ts.map +1 -1
  131. package/dist/schemas/reference-config/routing.js.map +2 -2
  132. package/dist/schemas/reference-config/settings.d.ts +105 -45
  133. package/dist/schemas/reference-config/settings.d.ts.map +1 -1
  134. package/dist/schemas/reference-config/settings.js.map +2 -2
  135. package/dist/schemas/v3.1/strict/callback.d.ts +4 -0
  136. package/dist/schemas/v3.1/strict/callback.d.ts.map +1 -1
  137. package/dist/schemas/v3.1/strict/callback.js +2 -2
  138. package/dist/schemas/v3.1/strict/callback.js.map +2 -2
  139. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts +19 -3
  140. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.d.ts.map +1 -1
  141. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-cookies.js.map +2 -2
  142. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts +10 -4
  143. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.d.ts.map +1 -1
  144. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-environments.js.map +2 -2
  145. package/dist/schemas/v3.1/strict/components.d.ts +34 -0
  146. package/dist/schemas/v3.1/strict/components.d.ts.map +1 -1
  147. package/dist/schemas/v3.1/strict/components.js +1 -1
  148. package/dist/schemas/v3.1/strict/components.js.map +2 -2
  149. package/dist/schemas/v3.1/strict/contact.d.ts +9 -0
  150. package/dist/schemas/v3.1/strict/contact.d.ts.map +1 -1
  151. package/dist/schemas/v3.1/strict/contact.js.map +1 -1
  152. package/dist/schemas/v3.1/strict/discriminator.d.ts +11 -0
  153. package/dist/schemas/v3.1/strict/discriminator.d.ts.map +1 -1
  154. package/dist/schemas/v3.1/strict/discriminator.js.map +1 -1
  155. package/dist/schemas/v3.1/strict/encoding.d.ts +15 -0
  156. package/dist/schemas/v3.1/strict/encoding.d.ts.map +1 -1
  157. package/dist/schemas/v3.1/strict/encoding.js +1 -1
  158. package/dist/schemas/v3.1/strict/encoding.js.map +2 -2
  159. package/dist/schemas/v3.1/strict/example.d.ts +15 -0
  160. package/dist/schemas/v3.1/strict/example.d.ts.map +1 -1
  161. package/dist/schemas/v3.1/strict/example.js.map +1 -1
  162. package/dist/schemas/v3.1/strict/external-documentation.d.ts +9 -2
  163. package/dist/schemas/v3.1/strict/external-documentation.d.ts.map +1 -1
  164. package/dist/schemas/v3.1/strict/external-documentation.js +3 -3
  165. package/dist/schemas/v3.1/strict/external-documentation.js.map +2 -2
  166. package/dist/schemas/v3.1/strict/header.d.ts +41 -0
  167. package/dist/schemas/v3.1/strict/header.d.ts.map +1 -1
  168. package/dist/schemas/v3.1/strict/header.js +2 -2
  169. package/dist/schemas/v3.1/strict/header.js.map +2 -2
  170. package/dist/schemas/v3.1/strict/info.d.ts +24 -2
  171. package/dist/schemas/v3.1/strict/info.d.ts.map +1 -1
  172. package/dist/schemas/v3.1/strict/info.js +7 -5
  173. package/dist/schemas/v3.1/strict/info.js.map +2 -2
  174. package/dist/schemas/v3.1/strict/license.d.ts +9 -0
  175. package/dist/schemas/v3.1/strict/license.d.ts.map +1 -1
  176. package/dist/schemas/v3.1/strict/license.js.map +1 -1
  177. package/dist/schemas/v3.1/strict/link.d.ts +22 -0
  178. package/dist/schemas/v3.1/strict/link.d.ts.map +1 -1
  179. package/dist/schemas/v3.1/strict/link.js.map +2 -2
  180. package/dist/schemas/v3.1/strict/media-type.d.ts +19 -0
  181. package/dist/schemas/v3.1/strict/media-type.d.ts.map +1 -1
  182. package/dist/schemas/v3.1/strict/media-type.js +2 -2
  183. package/dist/schemas/v3.1/strict/media-type.js.map +2 -2
  184. package/dist/schemas/v3.1/strict/oauth-flow.d.ts +171 -29
  185. package/dist/schemas/v3.1/strict/oauth-flow.d.ts.map +1 -1
  186. package/dist/schemas/v3.1/strict/oauth-flow.js +43 -15
  187. package/dist/schemas/v3.1/strict/oauth-flow.js.map +2 -2
  188. package/dist/schemas/v3.1/strict/oauthflows.d.ts +78 -12
  189. package/dist/schemas/v3.1/strict/oauthflows.d.ts.map +1 -1
  190. package/dist/schemas/v3.1/strict/oauthflows.js.map +2 -2
  191. package/dist/schemas/v3.1/strict/openapi-document.d.ts +3369 -1476
  192. package/dist/schemas/v3.1/strict/openapi-document.d.ts.map +1 -1
  193. package/dist/schemas/v3.1/strict/openapi-document.js +45 -44
  194. package/dist/schemas/v3.1/strict/openapi-document.js.map +2 -2
  195. package/dist/schemas/v3.1/strict/operation.d.ts +44 -17
  196. package/dist/schemas/v3.1/strict/operation.d.ts.map +1 -1
  197. package/dist/schemas/v3.1/strict/operation.js +2 -3
  198. package/dist/schemas/v3.1/strict/operation.js.map +2 -2
  199. package/dist/schemas/v3.1/strict/parameter.d.ts +45 -0
  200. package/dist/schemas/v3.1/strict/parameter.d.ts.map +1 -1
  201. package/dist/schemas/v3.1/strict/parameter.js.map +2 -2
  202. package/dist/schemas/v3.1/strict/path-item.d.ts +38 -0
  203. package/dist/schemas/v3.1/strict/path-item.d.ts.map +1 -1
  204. package/dist/schemas/v3.1/strict/path-item.js +1 -1
  205. package/dist/schemas/v3.1/strict/path-item.js.map +2 -2
  206. package/dist/schemas/v3.1/strict/paths.d.ts +5 -0
  207. package/dist/schemas/v3.1/strict/paths.d.ts.map +1 -1
  208. package/dist/schemas/v3.1/strict/paths.js +1 -1
  209. package/dist/schemas/v3.1/strict/paths.js.map +2 -2
  210. package/dist/schemas/v3.1/strict/reference.d.ts +21 -4
  211. package/dist/schemas/v3.1/strict/reference.d.ts.map +1 -1
  212. package/dist/schemas/v3.1/strict/reference.js.map +2 -2
  213. package/dist/schemas/v3.1/strict/request-body.d.ts +10 -0
  214. package/dist/schemas/v3.1/strict/request-body.d.ts.map +1 -1
  215. package/dist/schemas/v3.1/strict/request-body.js +1 -1
  216. package/dist/schemas/v3.1/strict/request-body.js.map +2 -2
  217. package/dist/schemas/v3.1/strict/response.d.ts +17 -0
  218. package/dist/schemas/v3.1/strict/response.d.ts.map +1 -1
  219. package/dist/schemas/v3.1/strict/response.js +1 -1
  220. package/dist/schemas/v3.1/strict/response.js.map +2 -2
  221. package/dist/schemas/v3.1/strict/responses.d.ts +12 -0
  222. package/dist/schemas/v3.1/strict/responses.d.ts.map +1 -1
  223. package/dist/schemas/v3.1/strict/responses.js +1 -1
  224. package/dist/schemas/v3.1/strict/responses.js.map +2 -2
  225. package/dist/schemas/v3.1/strict/schema.d.ts +144 -1
  226. package/dist/schemas/v3.1/strict/schema.d.ts.map +1 -1
  227. package/dist/schemas/v3.1/strict/schema.js +40 -60
  228. package/dist/schemas/v3.1/strict/schema.js.map +2 -2
  229. package/dist/schemas/v3.1/strict/security-requirement.d.ts +12 -0
  230. package/dist/schemas/v3.1/strict/security-requirement.d.ts.map +1 -1
  231. package/dist/schemas/v3.1/strict/security-requirement.js.map +1 -1
  232. package/dist/schemas/v3.1/strict/security-scheme.d.ts +49 -8
  233. package/dist/schemas/v3.1/strict/security-scheme.d.ts.map +1 -1
  234. package/dist/schemas/v3.1/strict/security-scheme.js +3 -1
  235. package/dist/schemas/v3.1/strict/security-scheme.js.map +2 -2
  236. package/dist/schemas/v3.1/strict/server-variable.d.ts +9 -0
  237. package/dist/schemas/v3.1/strict/server-variable.d.ts.map +1 -1
  238. package/dist/schemas/v3.1/strict/server-variable.js.map +1 -1
  239. package/dist/schemas/v3.1/strict/server.d.ts +10 -0
  240. package/dist/schemas/v3.1/strict/server.d.ts.map +1 -1
  241. package/dist/schemas/v3.1/strict/server.js +1 -1
  242. package/dist/schemas/v3.1/strict/server.js.map +2 -2
  243. package/dist/schemas/v3.1/strict/tag.d.ts +13 -0
  244. package/dist/schemas/v3.1/strict/tag.d.ts.map +1 -1
  245. package/dist/schemas/v3.1/strict/tag.js +1 -1
  246. package/dist/schemas/v3.1/strict/tag.js.map +2 -2
  247. package/dist/schemas/v3.1/strict/type-guards.d.ts +1 -1
  248. package/dist/schemas/v3.1/strict/type-guards.d.ts.map +1 -1
  249. package/dist/schemas/v3.1/strict/type-guards.js.map +1 -1
  250. package/dist/schemas/v3.1/strict/xml.d.ts +17 -0
  251. package/dist/schemas/v3.1/strict/xml.d.ts.map +1 -1
  252. package/dist/schemas/v3.1/strict/xml.js.map +1 -1
  253. package/dist/schemas/workspace-specification/config.d.ts +101 -44
  254. package/dist/schemas/workspace-specification/config.d.ts.map +1 -1
  255. package/dist/schemas/workspace-specification/config.js.map +2 -2
  256. package/dist/schemas/workspace-specification/index.d.ts +110 -44
  257. package/dist/schemas/workspace-specification/index.d.ts.map +1 -1
  258. package/dist/schemas/workspace-specification/index.js.map +2 -2
  259. package/dist/schemas/workspace-specification/info.d.ts +4 -0
  260. package/dist/schemas/workspace-specification/info.d.ts.map +1 -1
  261. package/dist/schemas/workspace-specification/info.js.map +1 -1
  262. package/dist/schemas/workspace.d.ts +707 -300
  263. package/dist/schemas/workspace.d.ts.map +1 -1
  264. package/dist/schemas/workspace.js +11 -3
  265. package/dist/schemas/workspace.js.map +2 -2
  266. package/dist/server.d.ts +6 -5
  267. package/dist/server.d.ts.map +1 -1
  268. package/dist/server.js.map +2 -2
  269. package/package.json +9 -14
  270. package/dist/mutators/request-example.d.ts +0 -21
  271. package/dist/mutators/request-example.d.ts.map +0 -1
  272. package/dist/mutators/request-example.js +0 -55
  273. package/dist/mutators/request-example.js.map +0 -7
  274. package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts +0 -4
  275. package/dist/schemas/extensions/security/x-scalar-redirect-uri.d.ts.map +0 -1
  276. package/dist/schemas/extensions/security/x-scalar-redirect-uri.js +0 -8
  277. package/dist/schemas/extensions/security/x-scalar-redirect-uri.js.map +0 -7
  278. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts +0 -38
  279. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.d.ts.map +0 -1
  280. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js +0 -45
  281. package/dist/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example.js.map +0 -7
  282. package/dist/types.d.ts +0 -18
  283. package/dist/types.d.ts.map +0 -1
  284. package/dist/types.js +0 -1
  285. /package/dist/{types.js.map → schemas/extensions/operation/index.js.map} +0 -0
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/operation.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport { XInternalSchema } from '@/schemas/extensions/document/x-internal'\nimport { XScalarIgnoreSchema } from '@/schemas/extensions/document/x-scalar-ignore'\nimport { XBadgesSchema } from '@/schemas/extensions/operation/x-badge'\nimport { XCodeSamplesSchema } from '@/schemas/extensions/operation/x-code-samples'\nimport { XScalarStabilitySchema } from '@/schemas/extensions/operation/x-scalar-stability'\nimport { xScalarClientConfigRequestExampleSchema } from '@/schemas/v3.1/strict/client-config-extensions/x-scalar-client-config-request-example'\nimport {\n CallbackObjectRef,\n ExternalDocumentationObjectRef,\n ParameterObjectRef,\n RequestBodyObjectRef,\n ResponsesObjectRef,\n SecurityRequirementObjectRef,\n ServerObjectRef,\n} from '@/schemas/v3.1/strict/ref-definitions'\n\nimport { reference } from './reference'\n\nconst OperationExtensionsSchema = Type.Partial(\n Type.Object({\n 'x-scalar-client-config-request-example': Type.Record(Type.String(), xScalarClientConfigRequestExampleSchema),\n }),\n)\n\nexport const OperationObjectSchemaDefinition = compose(\n Type.Object({\n /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */\n tags: Type.Optional(Type.Array(Type.String())),\n /** A short summary of what the operation does. */\n summary: Type.Optional(Type.String()),\n /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Additional external documentation for this operation. */\n externalDocs: Type.Optional(ExternalDocumentationObjectRef),\n /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */\n operationId: Type.Optional(Type.String()),\n /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),\n /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */\n requestBody: Type.Optional(Type.Union([RequestBodyObjectRef, reference(RequestBodyObjectRef)])),\n /** The list of possible responses as they are returned from executing this operation. */\n responses: Type.Optional(ResponsesObjectRef),\n /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */\n security: Type.Optional(Type.Array(SecurityRequirementObjectRef)),\n /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */\n servers: Type.Optional(Type.Array(ServerObjectRef)),\n /** A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. */\n callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObjectRef, reference(CallbackObjectRef)]))),\n }),\n OperationExtensionsSchema,\n XBadgesSchema,\n XInternalSchema,\n XScalarIgnoreSchema,\n XCodeSamplesSchema,\n XScalarStabilitySchema,\n)\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,eAAe;AACxB,SAAS,uBAAuB;AAChC,SAAS,2BAA2B;AACpC,SAAS,qBAAqB;AAC9B,SAAS,0BAA0B;AACnC,SAAS,8BAA8B;AACvC,SAAS,+CAA+C;AACxD;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAS,iBAAiB;AAE1B,MAAM,4BAA4B,KAAK;AAAA,EACrC,KAAK,OAAO;AAAA,IACV,0CAA0C,KAAK,OAAO,KAAK,OAAO,GAAG,uCAAuC;AAAA,EAC9G,CAAC;AACH;AAEO,MAAM,kCAAkC;AAAA,EAC7C,KAAK,OAAO;AAAA;AAAA,IAEV,MAAM,KAAK,SAAS,KAAK,MAAM,KAAK,OAAO,CAAC,CAAC;AAAA;AAAA,IAE7C,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,cAAc,KAAK,SAAS,8BAA8B;AAAA;AAAA,IAE1D,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,YAAY,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,IAErG,aAAa,KAAK,SAAS,KAAK,MAAM,CAAC,sBAAsB,UAAU,oBAAoB,CAAC,CAAC,CAAC;AAAA;AAAA,IAE9F,WAAW,KAAK,SAAS,kBAAkB;AAAA;AAAA,IAE3C,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,IAExC,UAAU,KAAK,SAAS,KAAK,MAAM,4BAA4B,CAAC;AAAA;AAAA,IAEhE,SAAS,KAAK,SAAS,KAAK,MAAM,eAAe,CAAC;AAAA;AAAA,IAElD,WAAW,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,mBAAmB,UAAU,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAAA,EACpH,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport { type XInternal, XInternalSchema } from '@/schemas/extensions/document/x-internal'\nimport { type XScalarIgnore, XScalarIgnoreSchema } from '@/schemas/extensions/document/x-scalar-ignore'\nimport { type XBadges, XBadgesSchema } from '@/schemas/extensions/operation/x-badge'\nimport { type XCodeSamples, XCodeSamplesSchema } from '@/schemas/extensions/operation/x-code-samples'\nimport { type XScalarStability, XScalarStabilitySchema } from '@/schemas/extensions/operation/x-scalar-stability'\n\nimport type { CallbackObject } from './callback'\nimport type { ExternalDocumentationObject } from './external-documentation'\nimport type { ParameterObject } from './parameter'\nimport {\n CallbackObjectRef,\n ExternalDocumentationObjectRef,\n ParameterObjectRef,\n RequestBodyObjectRef,\n ResponsesObjectRef,\n SecurityRequirementObjectRef,\n ServerObjectRef,\n} from './ref-definitions'\nimport { type ReferenceType, reference } from './reference'\nimport type { RequestBodyObject } from './request-body'\nimport type { ResponsesObject } from './responses'\nimport type { SecurityRequirementObject } from './security-requirement'\nimport type { ServerObject } from './server'\n\nconst OperationExtensionsSchema = Type.Partial(\n Type.Object({\n 'x-scalar-selected-security': Type.Optional(Type.Array(SecurityRequirementObjectRef)),\n }),\n)\n\ntype OperationExtensions = {\n 'x-scalar-selected-security'?: SecurityRequirementObject[]\n}\n\nexport const OperationObjectSchemaDefinition = compose(\n Type.Object({\n /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */\n tags: Type.Optional(Type.Array(Type.String())),\n /** A short summary of what the operation does. */\n summary: Type.Optional(Type.String()),\n /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Additional external documentation for this operation. */\n externalDocs: Type.Optional(ExternalDocumentationObjectRef),\n /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */\n operationId: Type.Optional(Type.String()),\n /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),\n /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */\n requestBody: Type.Optional(Type.Union([RequestBodyObjectRef, reference(RequestBodyObjectRef)])),\n /** The list of possible responses as they are returned from executing this operation. */\n responses: Type.Optional(ResponsesObjectRef),\n /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */\n security: Type.Optional(Type.Array(SecurityRequirementObjectRef)),\n /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */\n servers: Type.Optional(Type.Array(ServerObjectRef)),\n /** A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. */\n callbacks: Type.Optional(Type.Record(Type.String(), Type.Union([CallbackObjectRef, reference(CallbackObjectRef)]))),\n }),\n OperationExtensionsSchema,\n XBadgesSchema,\n XInternalSchema,\n XScalarIgnoreSchema,\n XCodeSamplesSchema,\n XScalarStabilitySchema,\n)\n\nexport type OperationObject = {\n /** A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier. */\n tags?: string[]\n /** A short summary of what the operation does. */\n summary?: string\n /** A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation. */\n description?: string\n /** Additional external documentation for this operation. */\n externalDocs?: ExternalDocumentationObject\n /** Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions. */\n operationId?: string\n /** A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters?: ReferenceType<ParameterObject>[]\n /** The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible. */\n requestBody?: ReferenceType<RequestBodyObject>\n /** The list of possible responses as they are returned from executing this operation. */\n responses?: ResponsesObject\n /** Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false. */\n deprecated?: boolean\n /** A declaration of which security mechanisms can be used for this operation. The list of values includes alternative Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied to authorize a request. To make security optional, an empty security requirement ({}) can be included in the array. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used. */\n security?: SecurityRequirementObject[]\n /** An alternative servers array to service this operation. If a servers array is specified at the Path Item Object or OpenAPI Object level, it will be overridden by this value. */\n servers?: ServerObject[]\n /** A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. */\n callbacks?: Record<string, ReferenceType<CallbackObject>>\n} & OperationExtensions &\n XBadges &\n XInternal &\n XScalarIgnore &\n XCodeSamples &\n XScalarStability\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,eAAe;AACxB,SAAyB,uBAAuB;AAChD,SAA6B,2BAA2B;AACxD,SAAuB,qBAAqB;AAC5C,SAA4B,0BAA0B;AACtD,SAAgC,8BAA8B;AAK9D;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAA6B,iBAAiB;AAM9C,MAAM,4BAA4B,KAAK;AAAA,EACrC,KAAK,OAAO;AAAA,IACV,8BAA8B,KAAK,SAAS,KAAK,MAAM,4BAA4B,CAAC;AAAA,EACtF,CAAC;AACH;AAMO,MAAM,kCAAkC;AAAA,EAC7C,KAAK,OAAO;AAAA;AAAA,IAEV,MAAM,KAAK,SAAS,KAAK,MAAM,KAAK,OAAO,CAAC,CAAC;AAAA;AAAA,IAE7C,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,cAAc,KAAK,SAAS,8BAA8B;AAAA;AAAA,IAE1D,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAExC,YAAY,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,IAErG,aAAa,KAAK,SAAS,KAAK,MAAM,CAAC,sBAAsB,UAAU,oBAAoB,CAAC,CAAC,CAAC;AAAA;AAAA,IAE9F,WAAW,KAAK,SAAS,kBAAkB;AAAA;AAAA,IAE3C,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,IAExC,UAAU,KAAK,SAAS,KAAK,MAAM,4BAA4B,CAAC;AAAA;AAAA,IAEhE,SAAS,KAAK,SAAS,KAAK,MAAM,eAAe,CAAC;AAAA;AAAA,IAElD,WAAW,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,mBAAmB,UAAU,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAAA,EACpH,CAAC;AAAA,EACD;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,7 @@
1
+ import type { ExampleObject } from '../../../schemas/v3.1/strict/example.js';
2
+ import type { MediaTypeObject } from '../../../schemas/v3.1/strict/media-type.js';
3
+ import { type ReferenceType } from '../../../schemas/v3.1/strict/reference.js';
4
+ import type { SchemaObject } from '../../../schemas/v3.1/strict/schema.js';
1
5
  export declare const ParameterObjectBaseSchema: import("@scalar/typebox").TObject<{
2
6
  /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
3
7
  * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
@@ -15,6 +19,23 @@ export declare const ParameterObjectBaseSchema: import("@scalar/typebox").TObjec
15
19
  /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
16
20
  allowEmptyValue: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
17
21
  }>;
22
+ type ParameterObjectBase = {
23
+ /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
24
+ * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
25
+ * - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
26
+ * - For all other cases, the name corresponds to the parameter name used by the in field. */
27
+ name: string;
28
+ /** REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie". */
29
+ in: 'query' | 'header' | 'path' | 'cookie';
30
+ /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
31
+ description?: string;
32
+ /** Determines whether this parameter is mandatory. If the parameter location is "path", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */
33
+ required?: boolean;
34
+ /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */
35
+ deprecated?: boolean;
36
+ /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */
37
+ allowEmptyValue?: boolean;
38
+ };
18
39
  export declare const ParameterObjectWithSchemaSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
19
40
  /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
20
41
  * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
@@ -61,6 +82,18 @@ export declare const ParameterObjectWithSchemaSchema: import("@scalar/typebox").
61
82
  '$ref-value': import("@scalar/typebox").TRef<"ExampleObject">;
62
83
  }>]>]>>>;
63
84
  }>]>;
85
+ export type ParameterWithSchemaObject = ParameterObjectBase & {
86
+ /** Describes how the header value will be serialized. The default (and only legal value for headers) is "simple". */
87
+ style?: string;
88
+ /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */
89
+ explode?: boolean;
90
+ /** The schema defining the type used for the header. */
91
+ schema?: ReferenceType<SchemaObject>;
92
+ /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
93
+ example?: any;
94
+ /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */
95
+ examples?: Record<string, ReferenceType<ExampleObject>>;
96
+ };
64
97
  export declare const ParameterObjectWithContentSchema: import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
65
98
  /** REQUIRED. The name of the parameter. Parameter names are case sensitive.
66
99
  * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.
@@ -80,6 +113,9 @@ export declare const ParameterObjectWithContentSchema: import("@scalar/typebox")
80
113
  }>, import("@scalar/typebox").TObject<{
81
114
  content: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>>;
82
115
  }>]>;
116
+ export type ParameterWithContentObject = ParameterObjectBase & {
117
+ content?: Record<string, MediaTypeObject>;
118
+ };
83
119
  /**
84
120
  * Describes a single operation parameter.
85
121
  *
@@ -151,4 +187,13 @@ export declare const ParameterObjectSchemaDefinition: import("@scalar/typebox").
151
187
  }>, import("@scalar/typebox").TObject<{
152
188
  content: import("@scalar/typebox").TOptional<import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"MediaTypeObject">>>;
153
189
  }>]>]>;
190
+ /**
191
+ * Describes a single operation parameter.
192
+ *
193
+ * A unique parameter is defined by a combination of a name and location.
194
+ *
195
+ * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.
196
+ */
197
+ export type ParameterObject = ParameterWithSchemaObject | ParameterWithContentObject;
198
+ export {};
154
199
  //# sourceMappingURL=parameter.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/parameter.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,yBAAyB;IACpC;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;EAE5iB,CAAA;AAEF,eAAO,MAAM,+BAA+B;IAjB1C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;IAO1iB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;IAGtI,CAAA;AAED,eAAO,MAAM,gCAAgC;IAjC3C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;IAyB7iB,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;IA/C1C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;IAO1iB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;;IA5BrI;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;MAqC5iB,CAAA"}
1
+ {"version":3,"file":"parameter.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/parameter.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,iCAAiC,CAAA;AAC/E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAEhE,eAAO,MAAM,yBAAyB;IACpC;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;EAE5iB,CAAA;AAEF,KAAK,mBAAmB,GAAG;IACzB;;;oGAGgG;IAChG,IAAI,EAAE,MAAM,CAAA;IACZ,0GAA0G;IAC1G,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,4IAA4I;IAC5I,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mNAAmN;IACnN,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,gHAAgH;IAChH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,4iBAA4iB;IAC5iB,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B,CAAA;AAED,eAAO,MAAM,+BAA+B;IAnC1C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;IAyB1iB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;IAGtI,CAAA;AAED,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAC5D,qHAAqH;IACrH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+QAA+Q;IAC/Q,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,wDAAwD;IACxD,MAAM,CAAC,EAAE,aAAa,CAAC,YAAY,CAAC,CAAA;IACpC,kIAAkI;IAClI,OAAO,CAAC,EAAE,GAAG,CAAA;IACb,mIAAmI;IACnI,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAC,CAAA;CACxD,CAAA;AAED,eAAO,MAAM,gCAAgC;IAhE3C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;IAwD7iB,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG,mBAAmB,GAAG;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;CAC1C,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,+BAA+B;IAlF1C;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;IAyB1iB,qHAAqH;;IAErH,+QAA+Q;;IAE/Q,wDAAwD;;;;;;;;;;;IAExD,kIAAkI;;IAElI,mIAAmI;;;;;;;;;;;;IA9CrI;;;oGAGgG;;IAEhG,0GAA0G;;IAE1G,4IAA4I;;IAE5I,mNAAmN;;IAEnN,gHAAgH;;IAEhH,4iBAA4iB;;;;MAwE5iB,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,yBAAyB,GAAG,0BAA0B,CAAA"}
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/parameter.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport { ExampleObjectRef, MediaTypeObjectRef, SchemaObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\nimport { reference } from '@/schemas/v3.1/strict/reference'\n\nexport const ParameterObjectBaseSchema = Type.Object({\n /** REQUIRED. The name of the parameter. Parameter names are case sensitive.\n * - If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\n * - If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n * - For all other cases, the name corresponds to the parameter name used by the in field. */\n name: Type.String(),\n /** REQUIRED. The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\". */\n in: Type.Union([Type.Literal('query'), Type.Literal('header'), Type.Literal('path'), Type.Literal('cookie')]),\n /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Determines whether this parameter is mandatory. If the parameter location is \"path\", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */\n required: Type.Optional(Type.Boolean()),\n /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */\n allowEmptyValue: Type.Optional(Type.Boolean()),\n})\n\nexport const ParameterObjectWithSchemaSchema = compose(\n ParameterObjectBaseSchema,\n Type.Object({\n /** Describes how the header value will be serialized. The default (and only legal value for headers) is \"simple\". */\n style: Type.Optional(Type.String()),\n /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */\n explode: Type.Optional(Type.Boolean()),\n /** The schema defining the type used for the header. */\n schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),\n /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n example: Type.Optional(Type.Any()),\n /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),\n }),\n)\n\nexport const ParameterObjectWithContentSchema = compose(\n ParameterObjectBaseSchema,\n Type.Object({\n content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),\n }),\n)\n\n/**\n * Describes a single operation parameter.\n *\n * A unique parameter is defined by a combination of a name and location.\n *\n * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.\n */\nexport const ParameterObjectSchemaDefinition = Type.Union([\n ParameterObjectWithSchemaSchema,\n ParameterObjectWithContentSchema,\n])\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,eAAe;AACxB,SAAS,kBAAkB,oBAAoB,uBAAuB;AACtE,SAAS,iBAAiB;AAEnB,MAAM,4BAA4B,KAAK,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnD,MAAM,KAAK,OAAO;AAAA;AAAA,EAElB,IAAI,KAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,GAAG,KAAK,QAAQ,QAAQ,GAAG,KAAK,QAAQ,MAAM,GAAG,KAAK,QAAQ,QAAQ,CAAC,CAAC;AAAA;AAAA,EAE5G,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,UAAU,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAEtC,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAExC,iBAAiB,KAAK,SAAS,KAAK,QAAQ,CAAC;AAC/C,CAAC;AAEM,MAAM,kCAAkC;AAAA,EAC7C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,OAAO,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAElC,SAAS,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,IAErC,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC;AAAA;AAAA,IAE/E,SAAS,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,IAEjC,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,kBAAkB,UAAU,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAAA,EACjH,CAAC;AACH;AAEO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA,IACV,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB,CAAC;AAAA,EACvE,CAAC;AACH;AASO,MAAM,kCAAkC,KAAK,MAAM;AAAA,EACxD;AAAA,EACA;AACF,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\nimport type { ExampleObject } from '@/schemas/v3.1/strict/example'\nimport type { MediaTypeObject } from '@/schemas/v3.1/strict/media-type'\nimport { ExampleObjectRef, MediaTypeObjectRef, SchemaObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\nimport { type ReferenceType, reference } from '@/schemas/v3.1/strict/reference'\nimport type { SchemaObject } from '@/schemas/v3.1/strict/schema'\n\nexport const ParameterObjectBaseSchema = Type.Object({\n /** REQUIRED. The name of the parameter. Parameter names are case sensitive.\n * - If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\n * - If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n * - For all other cases, the name corresponds to the parameter name used by the in field. */\n name: Type.String(),\n /** REQUIRED. The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\". */\n in: Type.Union([Type.Literal('query'), Type.Literal('header'), Type.Literal('path'), Type.Literal('cookie')]),\n /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** Determines whether this parameter is mandatory. If the parameter location is \"path\", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */\n required: Type.Optional(Type.Boolean()),\n /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */\n deprecated: Type.Optional(Type.Boolean()),\n /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */\n allowEmptyValue: Type.Optional(Type.Boolean()),\n})\n\ntype ParameterObjectBase = {\n /** REQUIRED. The name of the parameter. Parameter names are case sensitive.\n * - If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the Paths Object. See Path Templating for further information.\n * - If in is \"header\" and the name field is \"Accept\", \"Content-Type\" or \"Authorization\", the parameter definition SHALL be ignored.\n * - For all other cases, the name corresponds to the parameter name used by the in field. */\n name: string\n /** REQUIRED. The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\". */\n in: 'query' | 'header' | 'path' | 'cookie'\n /** A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description?: string\n /** Determines whether this parameter is mandatory. If the parameter location is \"path\", this field is REQUIRED and its value MUST be true. Otherwise, the field MAY be included and its default value is false. */\n required?: boolean\n /** Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. */\n deprecated?: boolean\n /** If true, clients MAY pass a zero-length string value in place of parameters that would otherwise be omitted entirely, which the server SHOULD interpret as the parameter being unused. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Interactions between this field and the parameter's Schema Object are implementation-defined. This field is valid only for query parameters. Use of this field is NOT RECOMMENDED, and it is likely to be removed in a later revision. */\n allowEmptyValue?: boolean\n}\n\nexport const ParameterObjectWithSchemaSchema = compose(\n ParameterObjectBaseSchema,\n Type.Object({\n /** Describes how the header value will be serialized. The default (and only legal value for headers) is \"simple\". */\n style: Type.Optional(Type.String()),\n /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */\n explode: Type.Optional(Type.Boolean()),\n /** The schema defining the type used for the header. */\n schema: Type.Optional(Type.Union([SchemaObjectRef, reference(SchemaObjectRef)])),\n /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n example: Type.Optional(Type.Any()),\n /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n examples: Type.Optional(Type.Record(Type.String(), Type.Union([ExampleObjectRef, reference(ExampleObjectRef)]))),\n }),\n)\n\nexport type ParameterWithSchemaObject = ParameterObjectBase & {\n /** Describes how the header value will be serialized. The default (and only legal value for headers) is \"simple\". */\n style?: string\n /** When this is true, header values of type array or object generate a single header whose value is a comma-separated list of the array items or key-value pairs of the map, see Style Examples. For other data types this field has no effect. The default value is false. */\n explode?: boolean\n /** The schema defining the type used for the header. */\n schema?: ReferenceType<SchemaObject>\n /** Example of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n example?: any\n /** Examples of the header's potential value; see Working With Examples. https://swagger.io/specification/#working-with-examples */\n examples?: Record<string, ReferenceType<ExampleObject>>\n}\n\nexport const ParameterObjectWithContentSchema = compose(\n ParameterObjectBaseSchema,\n Type.Object({\n content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),\n }),\n)\n\nexport type ParameterWithContentObject = ParameterObjectBase & {\n content?: Record<string, MediaTypeObject>\n}\n\n/**\n * Describes a single operation parameter.\n *\n * A unique parameter is defined by a combination of a name and location.\n *\n * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.\n */\nexport const ParameterObjectSchemaDefinition = Type.Union([\n ParameterObjectWithSchemaSchema,\n ParameterObjectWithContentSchema,\n])\n\n/**\n * Describes a single operation parameter.\n *\n * A unique parameter is defined by a combination of a name and location.\n *\n * See Appendix E for a detailed examination of percent-encoding concerns, including interactions with the application/x-www-form-urlencoded query string format.\n */\nexport type ParameterObject = ParameterWithSchemaObject | ParameterWithContentObject\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,eAAe;AAGxB,SAAS,kBAAkB,oBAAoB,uBAAuB;AACtE,SAA6B,iBAAiB;AAGvC,MAAM,4BAA4B,KAAK,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKnD,MAAM,KAAK,OAAO;AAAA;AAAA,EAElB,IAAI,KAAK,MAAM,CAAC,KAAK,QAAQ,OAAO,GAAG,KAAK,QAAQ,QAAQ,GAAG,KAAK,QAAQ,MAAM,GAAG,KAAK,QAAQ,QAAQ,CAAC,CAAC;AAAA;AAAA,EAE5G,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,UAAU,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAEtC,YAAY,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,EAExC,iBAAiB,KAAK,SAAS,KAAK,QAAQ,CAAC;AAC/C,CAAC;AAoBM,MAAM,kCAAkC;AAAA,EAC7C;AAAA,EACA,KAAK,OAAO;AAAA;AAAA,IAEV,OAAO,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAElC,SAAS,KAAK,SAAS,KAAK,QAAQ,CAAC;AAAA;AAAA,IAErC,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC;AAAA;AAAA,IAE/E,SAAS,KAAK,SAAS,KAAK,IAAI,CAAC;AAAA;AAAA,IAEjC,UAAU,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,kBAAkB,UAAU,gBAAgB,CAAC,CAAC,CAAC,CAAC;AAAA,EACjH,CAAC;AACH;AAeO,MAAM,mCAAmC;AAAA,EAC9C;AAAA,EACA,KAAK,OAAO;AAAA,IACV,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB,CAAC;AAAA,EACvE,CAAC;AACH;AAaO,MAAM,kCAAkC,KAAK,MAAM;AAAA,EACxD;AAAA,EACA;AACF,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,7 @@
1
+ import type { OperationObject } from './operation.js';
2
+ import type { ParameterObject } from './parameter.js';
3
+ import { type ReferenceType } from './reference.js';
4
+ import type { ServerObject } from './server.js';
1
5
  export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").TObject<{
2
6
  /**
3
7
  * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.
@@ -122,4 +126,38 @@ export declare const PathItemObjectSchemaDefinition: import("@scalar/typebox").T
122
126
  '$ref-value': import("@scalar/typebox").TRef<"ParameterObject">;
123
127
  }>]>]>>>;
124
128
  }>;
129
+ export type PathItemObject = {
130
+ /**
131
+ * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.
132
+ *
133
+ * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.
134
+ */
135
+ '$ref'?: string;
136
+ /** An optional string summary, intended to apply to all operations in this path. */
137
+ summary?: string;
138
+ /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */
139
+ description?: string;
140
+ /** A definition of a GET operation on this path. */
141
+ get?: ReferenceType<OperationObject>;
142
+ /** A definition of a PUT operation on this path. */
143
+ put?: ReferenceType<OperationObject>;
144
+ /** A definition of a POST operation on this path. */
145
+ post?: ReferenceType<OperationObject>;
146
+ /** A definition of a DELETE operation on this path. */
147
+ delete?: ReferenceType<OperationObject>;
148
+ /** A definition of a PATCH operation on this path. */
149
+ patch?: ReferenceType<OperationObject>;
150
+ /** A definition of a CONNECT operation on this path. */
151
+ connect?: ReferenceType<OperationObject>;
152
+ /** A definition of a OPTIONS operation on this path. */
153
+ options?: ReferenceType<OperationObject>;
154
+ /** A definition of a HEAD operation on this path. */
155
+ head?: ReferenceType<OperationObject>;
156
+ /** A definition of a TRACE operation on this path. */
157
+ trace?: ReferenceType<OperationObject>;
158
+ /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */
159
+ servers?: ServerObject[];
160
+ /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */
161
+ parameters?: ReferenceType<ParameterObject>[];
162
+ };
125
163
  //# sourceMappingURL=path-item.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"path-item.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/path-item.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,8BAA8B;IACzC;;;;OAIG;;IAEH,oFAAoF;;IAEpF,oJAAoJ;;IAEpJ,oDAAoD;;;;;;;;;;;IAEpD,oDAAoD;;;;;;;;;;;IAEpD,qDAAqD;;;;;;;;;;;IAErD,uDAAuD;;;;;;;;;;;IAEvD,sDAAsD;;;;;;;;;;;IAEtD,wDAAwD;;;;;;;;;;;IAExD,wDAAwD;;;;;;;;;;;IAExD,qDAAqD;;;;;;;;;;;IAErD,sDAAsD;;;;;;;;;;;IAEtD,6KAA6K;;IAE7K,6aAA6a;;;;;;;;;;;EAE7a,CAAA"}
1
+ {"version":3,"file":"path-item.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/path-item.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAElD,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAE5C,eAAO,MAAM,8BAA8B;IACzC;;;;OAIG;;IAEH,oFAAoF;;IAEpF,oJAAoJ;;IAEpJ,oDAAoD;;;;;;;;;;;IAEpD,oDAAoD;;;;;;;;;;;IAEpD,qDAAqD;;;;;;;;;;;IAErD,uDAAuD;;;;;;;;;;;IAEvD,sDAAsD;;;;;;;;;;;IAEtD,wDAAwD;;;;;;;;;;;IAExD,wDAAwD;;;;;;;;;;;IAExD,qDAAqD;;;;;;;;;;;IAErD,sDAAsD;;;;;;;;;;;IAEtD,6KAA6K;;IAE7K,6aAA6a;;;;;;;;;;;EAE7a,CAAA;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oJAAoJ;IACpJ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,oDAAoD;IACpD,GAAG,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACpC,oDAAoD;IACpD,GAAG,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACpC,qDAAqD;IACrD,IAAI,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACrC,uDAAuD;IACvD,MAAM,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACvC,sDAAsD;IACtD,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,wDAAwD;IACxD,OAAO,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACxC,wDAAwD;IACxD,OAAO,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACxC,qDAAqD;IACrD,IAAI,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACrC,sDAAsD;IACtD,KAAK,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,CAAA;IACtC,6KAA6K;IAC7K,OAAO,CAAC,EAAE,YAAY,EAAE,CAAA;IACxB,6aAA6a;IAC7a,UAAU,CAAC,EAAE,aAAa,CAAC,eAAe,CAAC,EAAE,CAAA;CAC9C,CAAA"}
@@ -1,5 +1,5 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
2
+ import { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from "./ref-definitions.js";
3
3
  import { reference } from "./reference.js";
4
4
  const PathItemObjectSchemaDefinition = Type.Object({
5
5
  /**
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/path-item.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\nimport { reference } from './reference'\n\nexport const PathItemObjectSchemaDefinition = Type.Object({\n /**\n * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.\n *\n * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.\n */\n '$ref': Type.Optional(Type.String()),\n /** An optional string summary, intended to apply to all operations in this path. */\n summary: Type.Optional(Type.String()),\n /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** A definition of a GET operation on this path. */\n get: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a PUT operation on this path. */\n put: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a POST operation on this path. */\n post: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a DELETE operation on this path. */\n delete: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a PATCH operation on this path. */\n patch: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a CONNECT operation on this path. */\n connect: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a OPTIONS operation on this path. */\n options: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a HEAD operation on this path. */\n head: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a TRACE operation on this path. */\n trace: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */\n servers: Type.Optional(Type.Array(ServerObjectRef)),\n /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,oBAAoB,oBAAoB,uBAAuB;AAExE,SAAS,iBAAiB;AAEnB,MAAM,iCAAiC,KAAK,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxD,QAAQ,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEnC,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,KAAK,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAElF,KAAK,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAElF,MAAM,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEnF,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAErF,OAAO,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEpF,SAAS,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEtF,SAAS,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEtF,MAAM,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEnF,OAAO,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEpF,SAAS,KAAK,SAAS,KAAK,MAAM,eAAe,CAAC;AAAA;AAAA,EAElD,YAAY,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport type { OperationObject } from './operation'\nimport type { ParameterObject } from './parameter'\nimport { OperationObjectRef, ParameterObjectRef, ServerObjectRef } from './ref-definitions'\nimport { type ReferenceType, reference } from './reference'\nimport type { ServerObject } from './server'\n\nexport const PathItemObjectSchemaDefinition = Type.Object({\n /**\n * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.\n *\n * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.\n */\n '$ref': Type.Optional(Type.String()),\n /** An optional string summary, intended to apply to all operations in this path. */\n summary: Type.Optional(Type.String()),\n /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** A definition of a GET operation on this path. */\n get: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a PUT operation on this path. */\n put: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a POST operation on this path. */\n post: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a DELETE operation on this path. */\n delete: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a PATCH operation on this path. */\n patch: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a CONNECT operation on this path. */\n connect: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a OPTIONS operation on this path. */\n options: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a HEAD operation on this path. */\n head: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** A definition of a TRACE operation on this path. */\n trace: Type.Optional(Type.Union([OperationObjectRef, reference(OperationObjectRef)])),\n /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */\n servers: Type.Optional(Type.Array(ServerObjectRef)),\n /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters: Type.Optional(Type.Array(Type.Union([ParameterObjectRef, reference(ParameterObjectRef)]))),\n})\n\nexport type PathItemObject = {\n /**\n * Allows for a referenced definition of this path item. The value MUST be in the form of a URI, and the referenced structure MUST be in the form of a Path Item Object. In case a Path Item Object field appears both in the defined object and the referenced object, the behavior is undefined. See the rules for resolving Relative References.\n *\n * Note: The behavior of $ref with adjacent properties is likely to change in future versions of this specification to bring it into closer alignment with the behavior of the Reference Object.\n */\n '$ref'?: string\n /** An optional string summary, intended to apply to all operations in this path. */\n summary?: string\n /** An optional string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation. */\n description?: string\n /** A definition of a GET operation on this path. */\n get?: ReferenceType<OperationObject>\n /** A definition of a PUT operation on this path. */\n put?: ReferenceType<OperationObject>\n /** A definition of a POST operation on this path. */\n post?: ReferenceType<OperationObject>\n /** A definition of a DELETE operation on this path. */\n delete?: ReferenceType<OperationObject>\n /** A definition of a PATCH operation on this path. */\n patch?: ReferenceType<OperationObject>\n /** A definition of a CONNECT operation on this path. */\n connect?: ReferenceType<OperationObject>\n /** A definition of a OPTIONS operation on this path. */\n options?: ReferenceType<OperationObject>\n /** A definition of a HEAD operation on this path. */\n head?: ReferenceType<OperationObject>\n /** A definition of a TRACE operation on this path. */\n trace?: ReferenceType<OperationObject>\n /** An alternative servers array to service all operations in this path. If a servers array is specified at the OpenAPI Object level, it will be overridden by this value. */\n servers?: ServerObject[]\n /** A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined in the OpenAPI Object's components.parameters. */\n parameters?: ReferenceType<ParameterObject>[]\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAIrB,SAAS,oBAAoB,oBAAoB,uBAAuB;AACxE,SAA6B,iBAAiB;AAGvC,MAAM,iCAAiC,KAAK,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMxD,QAAQ,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEnC,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,KAAK,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAElF,KAAK,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAElF,MAAM,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEnF,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAErF,OAAO,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEpF,SAAS,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEtF,SAAS,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEtF,MAAM,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEnF,OAAO,KAAK,SAAS,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC;AAAA;AAAA,EAEpF,SAAS,KAAK,SAAS,KAAK,MAAM,eAAe,CAAC;AAAA;AAAA,EAElD,YAAY,KAAK,SAAS,KAAK,MAAM,KAAK,MAAM,CAAC,oBAAoB,UAAU,kBAAkB,CAAC,CAAC,CAAC,CAAC;AACvG,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,5 +1,10 @@
1
+ import type { PathItemObject } from './path-item.js';
1
2
  /**
2
3
  * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.
3
4
  */
4
5
  export declare const PathsObjectSchemaDefinition: import("@scalar/typebox").TRecord<import("@scalar/typebox").TString, import("@scalar/typebox").TRef<"PathItemObject">>;
6
+ /**
7
+ * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.
8
+ */
9
+ export type PathsObject = Record<string, PathItemObject>;
5
10
  //# sourceMappingURL=paths.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/paths.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,eAAO,MAAM,2BAA2B,wHAIvC,CAAA"}
1
+ {"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/paths.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAA;AAGjD;;GAEG;AACH,eAAO,MAAM,2BAA2B,wHAIvC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA"}
@@ -1,5 +1,5 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { PathItemObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
2
+ import { PathItemObjectRef } from "./ref-definitions.js";
3
3
  const PathsObjectSchemaDefinition = Type.Record(
4
4
  Type.String(),
5
5
  /** A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. */
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/paths.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { PathItemObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\n/**\n * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.\n */\nexport const PathsObjectSchemaDefinition = Type.Record(\n Type.String(),\n /** A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. */\n PathItemObjectRef,\n)\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,yBAAyB;AAK3B,MAAM,8BAA8B,KAAK;AAAA,EAC9C,KAAK,OAAO;AAAA;AAAA,EAEZ;AACF;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport type { PathItemObject } from './path-item'\nimport { PathItemObjectRef } from './ref-definitions'\n\n/**\n * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.\n */\nexport const PathsObjectSchemaDefinition = Type.Record(\n Type.String(),\n /** A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use. */\n PathItemObjectRef,\n)\n\n/**\n * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL) constraints.\n */\nexport type PathsObject = Record<string, PathItemObject>\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAGrB,SAAS,yBAAyB;AAK3B,MAAM,8BAA8B,KAAK;AAAA,EAC9C,KAAK,OAAO;AAAA;AAAA,EAEZ;AACF;",
6
6
  "names": []
7
7
  }
@@ -1,4 +1,4 @@
1
- import { type Static, type TSchema } from '@scalar/typebox';
1
+ import { type TSchema } from '@scalar/typebox';
2
2
  export declare const ReferenceObjectExtensionsSchema: import("@scalar/typebox").TObject<{
3
3
  /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
4
4
  $status: import("@scalar/typebox").TOptional<import("@scalar/typebox").TUnion<[import("@scalar/typebox").TLiteral<"loading">, import("@scalar/typebox").TLiteral<"error">]>>;
@@ -24,7 +24,24 @@ export declare const ReferenceObjectSchema: import("@scalar/typebox").TIntersect
24
24
  /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
25
25
  $global: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
26
26
  }>]>;
27
- export type ReferenceObject = Static<typeof ReferenceObjectSchema>;
27
+ /**
28
+ * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.
29
+ *
30
+ * The $ref string value contains a URI RFC3986, which identifies the value being referenced.
31
+ *
32
+ * See the rules for resolving Relative References. */
33
+ export type ReferenceObject = {
34
+ /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
35
+ '$ref': string;
36
+ /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */
37
+ summary?: string;
38
+ /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */
39
+ description?: string;
40
+ /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */
41
+ '$status'?: 'loading' | 'error';
42
+ /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */
43
+ '$global'?: boolean;
44
+ };
28
45
  export declare const reference: <T extends TSchema>(schema: T) => import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TIntersect<[import("@scalar/typebox").TObject<{
29
46
  /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */
30
47
  $ref: import("@scalar/typebox").TString;
@@ -40,7 +57,7 @@ export declare const reference: <T extends TSchema>(schema: T) => import("@scala
40
57
  }>]>, import("@scalar/typebox").TObject<{
41
58
  '$ref-value': T;
42
59
  }>]>;
43
- export type ReferenceType<Value> = ReferenceObject & {
60
+ export type ReferenceType<Value> = Value | (ReferenceObject & {
44
61
  '$ref-value': Value;
45
- };
62
+ });
46
63
  //# sourceMappingURL=reference.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,OAAO,EAAQ,MAAM,iBAAiB,CAAA;AAIjE,eAAO,MAAM,+BAA+B;IAC1C,0JAA0J;;IAE1J,+IAA+I;;EAE/I,CAAA;AAEF;;;;;sDAKsD;AACtD,eAAO,MAAM,qBAAqB;IAE9B,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;IAoBhJ,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAElE,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC;IAZlD,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;;;IAyB1E,CAAA;AAEvE,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,eAAe,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,CAAA"}
1
+ {"version":3,"file":"reference.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,OAAO,EAAQ,MAAM,iBAAiB,CAAA;AAIpD,eAAO,MAAM,+BAA+B;IAC1C,0JAA0J;;IAE1J,+IAA+I;;EAE/I,CAAA;AAEF;;;;;sDAKsD;AACtD,eAAO,MAAM,qBAAqB;IAE9B,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;IAoBhJ,CAAA;AAED;;;;;sDAKsD;AACtD,MAAM,MAAM,eAAe,GAAG;IAC5B,6EAA6E;IAC7E,MAAM,EAAE,MAAM,CAAA;IACd,sLAAsL;IACtL,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,oPAAoP;IACpP,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,0JAA0J;IAC1J,SAAS,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC/B,+IAA+I;IAC/I,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB,CAAA;AAED,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,OAAO,EAAE,QAAQ,CAAC;IA7BlD,6EAA6E;;IAE7E,sLAAsL;;IAEtL,oPAAoP;;;IAlBtP,0JAA0J;;IAE1J,+IAA+I;;;;IA0C1E,CAAA;AAEvE,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI,KAAK,GAAG,CAAC,eAAe,GAAG;IAAE,YAAY,EAAE,KAAK,CAAA;CAAE,CAAC,CAAA"}
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/reference.ts"],
4
- "sourcesContent": ["import { type Static, type TSchema, Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\n\nexport const ReferenceObjectExtensionsSchema = Type.Object({\n /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */\n '$status': Type.Optional(Type.Union([Type.Literal('loading'), Type.Literal('error')])),\n /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */\n '$global': Type.Optional(Type.Boolean()),\n})\n\n/**\n * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.\n *\n * The $ref string value contains a URI RFC3986, which identifies the value being referenced.\n *\n * See the rules for resolving Relative References. */\nexport const ReferenceObjectSchema = compose(\n Type.Object({\n /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */\n '$ref': Type.String(),\n /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */\n summary: Type.Optional(Type.String()),\n /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */\n description: Type.Optional(Type.String()),\n }),\n ReferenceObjectExtensionsSchema,\n)\n\nexport type ReferenceObject = Static<typeof ReferenceObjectSchema>\n\nexport const reference = <T extends TSchema>(schema: T) =>\n compose(ReferenceObjectSchema, Type.Object({ '$ref-value': schema }))\n\nexport type ReferenceType<Value> = ReferenceObject & { '$ref-value': Value }\n"],
5
- "mappings": "AAAA,SAAoC,YAAY;AAEhD,SAAS,eAAe;AAEjB,MAAM,kCAAkC,KAAK,OAAO;AAAA;AAAA,EAEzD,WAAW,KAAK,SAAS,KAAK,MAAM,CAAC,KAAK,QAAQ,SAAS,GAAG,KAAK,QAAQ,OAAO,CAAC,CAAC,CAAC;AAAA;AAAA,EAErF,WAAW,KAAK,SAAS,KAAK,QAAQ,CAAC;AACzC,CAAC;AAQM,MAAM,wBAAwB;AAAA,EACnC,KAAK,OAAO;AAAA;AAAA,IAEV,QAAQ,KAAK,OAAO;AAAA;AAAA,IAEpB,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA,EAC1C,CAAC;AAAA,EACD;AACF;AAIO,MAAM,YAAY,CAAoB,WAC3C,QAAQ,uBAAuB,KAAK,OAAO,EAAE,cAAc,OAAO,CAAC,CAAC;",
4
+ "sourcesContent": ["import { type TSchema, Type } from '@scalar/typebox'\n\nimport { compose } from '@/schemas/compose'\n\nexport const ReferenceObjectExtensionsSchema = Type.Object({\n /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */\n '$status': Type.Optional(Type.Union([Type.Literal('loading'), Type.Literal('error')])),\n /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */\n '$global': Type.Optional(Type.Boolean()),\n})\n\n/**\n * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.\n *\n * The $ref string value contains a URI RFC3986, which identifies the value being referenced.\n *\n * See the rules for resolving Relative References. */\nexport const ReferenceObjectSchema = compose(\n Type.Object({\n /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */\n '$ref': Type.String(),\n /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */\n summary: Type.Optional(Type.String()),\n /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */\n description: Type.Optional(Type.String()),\n }),\n ReferenceObjectExtensionsSchema,\n)\n\n/**\n * A simple object to allow referencing other components in the OpenAPI Description, internally and externally.\n *\n * The $ref string value contains a URI RFC3986, which identifies the value being referenced.\n *\n * See the rules for resolving Relative References. */\nexport type ReferenceObject = {\n /** REQUIRED. The reference identifier. This MUST be in the form of a URI. */\n '$ref': string\n /** A short summary which by default SHOULD override that of the referenced component. If the referenced object-type does not allow a summary field, then this field has no effect. */\n summary?: string\n /** A description which by default SHOULD override that of the referenced component. CommonMark syntax MAY be used for rich text representation. If the referenced object-type does not allow a description field, then this field has no effect. */\n description?: string\n /** Indicates the current status of the reference resolution. Can be either 'loading' while fetching the reference or 'error' if the resolution failed. */\n '$status'?: 'loading' | 'error'\n /** Indicates whether this reference should be resolved globally across all documents, rather than just within the current document context. */\n '$global'?: boolean\n}\n\nexport const reference = <T extends TSchema>(schema: T) =>\n compose(ReferenceObjectSchema, Type.Object({ '$ref-value': schema }))\n\nexport type ReferenceType<Value> = Value | (ReferenceObject & { '$ref-value': Value })\n"],
5
+ "mappings": "AAAA,SAAuB,YAAY;AAEnC,SAAS,eAAe;AAEjB,MAAM,kCAAkC,KAAK,OAAO;AAAA;AAAA,EAEzD,WAAW,KAAK,SAAS,KAAK,MAAM,CAAC,KAAK,QAAQ,SAAS,GAAG,KAAK,QAAQ,OAAO,CAAC,CAAC,CAAC;AAAA;AAAA,EAErF,WAAW,KAAK,SAAS,KAAK,QAAQ,CAAC;AACzC,CAAC;AAQM,MAAM,wBAAwB;AAAA,EACnC,KAAK,OAAO;AAAA;AAAA,IAEV,QAAQ,KAAK,OAAO;AAAA;AAAA,IAEpB,SAAS,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,IAEpC,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA,EAC1C,CAAC;AAAA,EACD;AACF;AAqBO,MAAM,YAAY,CAAoB,WAC3C,QAAQ,uBAAuB,KAAK,OAAO,EAAE,cAAc,OAAO,CAAC,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,4 @@
1
+ import type { MediaTypeObject } from './media-type.js';
1
2
  /** Describes a single request body. */
2
3
  export declare const RequestBodyObjectSchemaDefinition: import("@scalar/typebox").TObject<{
3
4
  /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
@@ -7,4 +8,13 @@ export declare const RequestBodyObjectSchemaDefinition: import("@scalar/typebox"
7
8
  /** Determines if the request body is required in the request. Defaults to false. */
8
9
  required: import("@scalar/typebox").TOptional<import("@scalar/typebox").TBoolean>;
9
10
  }>;
11
+ /** Describes a single request body. */
12
+ export type RequestBodyObject = {
13
+ /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
14
+ description?: string;
15
+ /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/* */
16
+ content: Record<string, MediaTypeObject>;
17
+ /** Determines if the request body is required in the request. Defaults to false. */
18
+ required?: boolean;
19
+ };
10
20
  //# sourceMappingURL=request-body.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"request-body.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/request-body.ts"],"names":[],"mappings":"AAIA,uCAAuC;AACvC,eAAO,MAAM,iCAAiC;IAC5C,+IAA+I;;IAE/I,8OAA8O;;IAE9O,oFAAoF;;EAEpF,CAAA"}
1
+ {"version":3,"file":"request-body.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/request-body.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAA;AAGnD,uCAAuC;AACvC,eAAO,MAAM,iCAAiC;IAC5C,+IAA+I;;IAE/I,8OAA8O;;IAE9O,oFAAoF;;EAEpF,CAAA;AAEF,uCAAuC;AACvC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,+IAA+I;IAC/I,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,8OAA8O;IAC9O,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACxC,oFAAoF;IACpF,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA"}
@@ -1,5 +1,5 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { MediaTypeObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
2
+ import { MediaTypeObjectRef } from "./ref-definitions.js";
3
3
  const RequestBodyObjectSchemaDefinition = Type.Object({
4
4
  /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */
5
5
  description: Type.Optional(Type.String()),
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/request-body.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { MediaTypeObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\n/** Describes a single request body. */\nexport const RequestBodyObjectSchemaDefinition = Type.Object({\n /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/* */\n content: Type.Record(Type.String(), MediaTypeObjectRef),\n /** Determines if the request body is required in the request. Defaults to false. */\n required: Type.Optional(Type.Boolean()),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,0BAA0B;AAG5B,MAAM,oCAAoC,KAAK,OAAO;AAAA;AAAA,EAE3D,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB;AAAA;AAAA,EAEtD,UAAU,KAAK,SAAS,KAAK,QAAQ,CAAC;AACxC,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport type { MediaTypeObject } from './media-type'\nimport { MediaTypeObjectRef } from './ref-definitions'\n\n/** Describes a single request body. */\nexport const RequestBodyObjectSchemaDefinition = Type.Object({\n /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description: Type.Optional(Type.String()),\n /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/* */\n content: Type.Record(Type.String(), MediaTypeObjectRef),\n /** Determines if the request body is required in the request. Defaults to false. */\n required: Type.Optional(Type.Boolean()),\n})\n\n/** Describes a single request body. */\nexport type RequestBodyObject = {\n /** A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. */\n description?: string\n /** REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/* */\n content: Record<string, MediaTypeObject>\n /** Determines if the request body is required in the request. Defaults to false. */\n required?: boolean\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAGrB,SAAS,0BAA0B;AAG5B,MAAM,oCAAoC,KAAK,OAAO;AAAA;AAAA,EAE3D,aAAa,KAAK,SAAS,KAAK,OAAO,CAAC;AAAA;AAAA,EAExC,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB;AAAA;AAAA,EAEtD,UAAU,KAAK,SAAS,KAAK,QAAQ,CAAC;AACxC,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,7 @@
1
+ import type { HeaderObject } from '../../../schemas/v3.1/strict/header.js';
2
+ import type { MediaTypeObject } from '../../../schemas/v3.1/strict/media-type.js';
3
+ import type { LinkObject } from './link.js';
4
+ import { type ReferenceType } from './reference.js';
1
5
  export declare const ResponseObjectSchemaDefinition: import("@scalar/typebox").TObject<{
2
6
  /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
3
7
  description: import("@scalar/typebox").TString;
@@ -26,4 +30,17 @@ export declare const ResponseObjectSchemaDefinition: import("@scalar/typebox").T
26
30
  '$ref-value': import("@scalar/typebox").TRef<"LinkObject">;
27
31
  }>]>]>>>;
28
32
  }>;
33
+ /**
34
+ * Describes a single response from an API operation, including design-time, static links to operations based on the response.
35
+ */
36
+ export type ResponseObject = {
37
+ /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
38
+ description: string;
39
+ /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored. */
40
+ headers?: Record<string, ReferenceType<HeaderObject>>;
41
+ /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. "text/plain" overrides "text/*" */
42
+ content?: Record<string, MediaTypeObject>;
43
+ /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */
44
+ links?: Record<string, ReferenceType<LinkObject>>;
45
+ };
29
46
  //# sourceMappingURL=response.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/response.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,8BAA8B;IACzC,2GAA2G;;IAE3G,iLAAiL;;;;;;;;;;;IAEjL,oQAAoQ;;IAEpQ,8LAA8L;;;;;;;;;;;EAE9L,CAAA"}
1
+ {"version":3,"file":"response.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/response.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAA;AAChE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA;AAEvE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAExC,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAE3D,eAAO,MAAM,8BAA8B;IACzC,2GAA2G;;IAE3G,iLAAiL;;;;;;;;;;;IAEjL,oQAAoQ;;IAEpQ,8LAA8L;;;;;;;;;;;EAE9L,CAAA;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,2GAA2G;IAC3G,WAAW,EAAE,MAAM,CAAA;IACnB,iLAAiL;IACjL,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC,CAAA;IACrD,oQAAoQ;IACpQ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAA;IACzC,8LAA8L;IAC9L,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,CAAA;CAClD,CAAA"}
@@ -1,5 +1,5 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
2
+ import { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from "./ref-definitions.js";
3
3
  import { reference } from "./reference.js";
4
4
  const ResponseObjectSchemaDefinition = Type.Object({
5
5
  /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/response.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\nimport { reference } from './reference'\n\nexport const ResponseObjectSchemaDefinition = Type.Object({\n /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */\n description: Type.String(),\n /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored. */\n headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),\n /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/*\" */\n content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),\n /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */\n links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)]))),\n})\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,iBAAiB,eAAe,0BAA0B;AAEnE,SAAS,iBAAiB;AAEnB,MAAM,iCAAiC,KAAK,OAAO;AAAA;AAAA,EAExD,aAAa,KAAK,OAAO;AAAA;AAAA,EAEzB,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,EAE5G,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB,CAAC;AAAA;AAAA,EAErE,OAAO,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,eAAe,UAAU,aAAa,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport type { HeaderObject } from '@/schemas/v3.1/strict/header'\nimport type { MediaTypeObject } from '@/schemas/v3.1/strict/media-type'\n\nimport type { LinkObject } from './link'\nimport { HeaderObjectRef, LinkObjectRef, MediaTypeObjectRef } from './ref-definitions'\nimport { type ReferenceType, reference } from './reference'\n\nexport const ResponseObjectSchemaDefinition = Type.Object({\n /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */\n description: Type.String(),\n /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored. */\n headers: Type.Optional(Type.Record(Type.String(), Type.Union([HeaderObjectRef, reference(HeaderObjectRef)]))),\n /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/*\" */\n content: Type.Optional(Type.Record(Type.String(), MediaTypeObjectRef)),\n /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */\n links: Type.Optional(Type.Record(Type.String(), Type.Union([LinkObjectRef, reference(LinkObjectRef)]))),\n})\n\n/**\n * Describes a single response from an API operation, including design-time, static links to operations based on the response.\n */\nexport type ResponseObject = {\n /** REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation. */\n description: string\n /** Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name \"Content-Type\", it SHALL be ignored. */\n headers?: Record<string, ReferenceType<HeaderObject>>\n /** A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. \"text/plain\" overrides \"text/*\" */\n content?: Record<string, MediaTypeObject>\n /** A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects. */\n links?: Record<string, ReferenceType<LinkObject>>\n}\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAMrB,SAAS,iBAAiB,eAAe,0BAA0B;AACnE,SAA6B,iBAAiB;AAEvC,MAAM,iCAAiC,KAAK,OAAO;AAAA;AAAA,EAExD,aAAa,KAAK,OAAO;AAAA;AAAA,EAEzB,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,iBAAiB,UAAU,eAAe,CAAC,CAAC,CAAC,CAAC;AAAA;AAAA,EAE5G,SAAS,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,kBAAkB,CAAC;AAAA;AAAA,EAErE,OAAO,KAAK,SAAS,KAAK,OAAO,KAAK,OAAO,GAAG,KAAK,MAAM,CAAC,eAAe,UAAU,aAAa,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC;",
6
6
  "names": []
7
7
  }
@@ -1,3 +1,5 @@
1
+ import { type ReferenceType } from './reference.js';
2
+ import type { ResponseObject } from './response.js';
1
3
  /**
2
4
  * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
3
5
  *
@@ -17,4 +19,14 @@ export declare const ResponsesObjectSchemaDefinition: import("@scalar/typebox").
17
19
  }>]>, import("@scalar/typebox").TObject<{
18
20
  '$ref-value': import("@scalar/typebox").TRef<"ResponseObject">;
19
21
  }>]>]>>;
22
+ /**
23
+ * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.
24
+ *
25
+ * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.
26
+ *
27
+ * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.
28
+ *
29
+ * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.
30
+ */
31
+ export type ResponsesObject = Record<string, ReferenceType<ResponseObject>>;
20
32
  //# sourceMappingURL=responses.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/responses.ts"],"names":[],"mappings":"AAMA;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;OAG3C,CAAA"}
1
+ {"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/schemas/v3.1/strict/responses.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,aAAa,EAAa,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAEhD;;;;;;;;GAQG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;;OAG3C,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAA"}
@@ -1,5 +1,5 @@
1
1
  import { Type } from "@scalar/typebox";
2
- import { ResponseObjectRef } from "../../../schemas/v3.1/strict/ref-definitions.js";
2
+ import { ResponseObjectRef } from "./ref-definitions.js";
3
3
  import { reference } from "./reference.js";
4
4
  const ResponsesObjectSchemaDefinition = Type.Record(
5
5
  Type.String(),
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
3
  "sources": ["../../../../src/schemas/v3.1/strict/responses.ts"],
4
- "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { ResponseObjectRef } from '@/schemas/v3.1/strict/ref-definitions'\n\nimport { reference } from './reference'\n\n/**\n * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.\n *\n * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.\n *\n * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.\n *\n * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.\n */\nexport const ResponsesObjectSchemaDefinition = Type.Record(\n Type.String(),\n Type.Union([ResponseObjectRef, reference(ResponseObjectRef)]),\n)\n"],
5
- "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,yBAAyB;AAElC,SAAS,iBAAiB;AAWnB,MAAM,kCAAkC,KAAK;AAAA,EAClD,KAAK,OAAO;AAAA,EACZ,KAAK,MAAM,CAAC,mBAAmB,UAAU,iBAAiB,CAAC,CAAC;AAC9D;",
4
+ "sourcesContent": ["import { Type } from '@scalar/typebox'\n\nimport { ResponseObjectRef } from './ref-definitions'\nimport { type ReferenceType, reference } from './reference'\nimport type { ResponseObject } from './response'\n\n/**\n * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.\n *\n * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.\n *\n * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.\n *\n * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.\n */\nexport const ResponsesObjectSchemaDefinition = Type.Record(\n Type.String(),\n Type.Union([ResponseObjectRef, reference(ResponseObjectRef)]),\n)\n\n/**\n * A container for the expected responses of an operation. The container maps a HTTP response code to the expected response.\n *\n * The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors.\n *\n * The default MAY be used as a default Response Object for all HTTP codes that are not covered individually by the Responses Object.\n *\n * The Responses Object MUST contain at least one response code, and if only one response code is provided it SHOULD be the response for a successful operation call.\n */\nexport type ResponsesObject = Record<string, ReferenceType<ResponseObject>>\n"],
5
+ "mappings": "AAAA,SAAS,YAAY;AAErB,SAAS,yBAAyB;AAClC,SAA6B,iBAAiB;AAYvC,MAAM,kCAAkC,KAAK;AAAA,EAClD,KAAK,OAAO;AAAA,EACZ,KAAK,MAAM,CAAC,mBAAmB,UAAU,iBAAiB,CAAC,CAAC;AAC9D;",
6
6
  "names": []
7
7
  }