@scalar/openapi-types 0.2.0 → 0.2.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 (246) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/index.js +2 -1
  3. package/dist/index.js.map +7 -0
  4. package/dist/openapi-types.js +28 -33
  5. package/dist/openapi-types.js.map +7 -0
  6. package/dist/openapi-types.test-d.js +52 -0
  7. package/dist/openapi-types.test-d.js.map +7 -0
  8. package/dist/schemas/3.1/compliance/callback-object.test.js +97 -0
  9. package/dist/schemas/3.1/compliance/callback-object.test.js.map +7 -0
  10. package/dist/schemas/3.1/compliance/contact-object.test.js +19 -0
  11. package/dist/schemas/3.1/compliance/contact-object.test.js.map +7 -0
  12. package/dist/schemas/3.1/compliance/example-object.test.js +91 -0
  13. package/dist/schemas/3.1/compliance/example-object.test.js.map +7 -0
  14. package/dist/schemas/3.1/compliance/external-documentation-object.test.js +17 -0
  15. package/dist/schemas/3.1/compliance/external-documentation-object.test.js.map +7 -0
  16. package/dist/schemas/3.1/compliance/header-object.test.js +47 -0
  17. package/dist/schemas/3.1/compliance/header-object.test.js.map +7 -0
  18. package/dist/schemas/3.1/compliance/info-object.test.js +41 -0
  19. package/dist/schemas/3.1/compliance/info-object.test.js.map +7 -0
  20. package/dist/schemas/3.1/compliance/license-object.test.js +17 -0
  21. package/dist/schemas/3.1/compliance/license-object.test.js.map +7 -0
  22. package/dist/schemas/3.1/compliance/media-type-object.test.js +69 -0
  23. package/dist/schemas/3.1/compliance/media-type-object.test.js.map +7 -0
  24. package/dist/schemas/3.1/compliance/openapi-object.test.js +381 -0
  25. package/dist/schemas/3.1/compliance/openapi-object.test.js.map +7 -0
  26. package/dist/schemas/3.1/compliance/operation-object.test.js +467 -0
  27. package/dist/schemas/3.1/compliance/operation-object.test.js.map +7 -0
  28. package/dist/schemas/3.1/compliance/parameter-object.test.js +155 -0
  29. package/dist/schemas/3.1/compliance/parameter-object.test.js.map +7 -0
  30. package/dist/schemas/3.1/compliance/path-item-object.test.js +103 -0
  31. package/dist/schemas/3.1/compliance/path-item-object.test.js.map +7 -0
  32. package/dist/schemas/3.1/compliance/reference-object.test.js +282 -0
  33. package/dist/schemas/3.1/compliance/reference-object.test.js.map +7 -0
  34. package/dist/schemas/3.1/compliance/request-body-object.test.js +97 -0
  35. package/dist/schemas/3.1/compliance/request-body-object.test.js.map +7 -0
  36. package/dist/schemas/3.1/compliance/response-object.test.js +131 -0
  37. package/dist/schemas/3.1/compliance/response-object.test.js.map +7 -0
  38. package/dist/schemas/3.1/compliance/responses-object.test.js +53 -0
  39. package/dist/schemas/3.1/compliance/responses-object.test.js.map +7 -0
  40. package/dist/schemas/3.1/compliance/runtime-expression.test.js +165 -0
  41. package/dist/schemas/3.1/compliance/runtime-expression.test.js.map +7 -0
  42. package/dist/schemas/3.1/compliance/schema-object.test.js +470 -0
  43. package/dist/schemas/3.1/compliance/schema-object.test.js.map +7 -0
  44. package/dist/schemas/3.1/compliance/security-requirement-object.test.js +54 -0
  45. package/dist/schemas/3.1/compliance/security-requirement-object.test.js.map +7 -0
  46. package/dist/schemas/3.1/compliance/security-scheme-object.test.js +123 -0
  47. package/dist/schemas/3.1/compliance/security-scheme-object.test.js.map +7 -0
  48. package/dist/schemas/3.1/compliance/server-object.test.js +17 -0
  49. package/dist/schemas/3.1/compliance/server-object.test.js.map +7 -0
  50. package/dist/schemas/3.1/compliance/tag-object.test.js +17 -0
  51. package/dist/schemas/3.1/compliance/tag-object.test.js.map +7 -0
  52. package/dist/schemas/3.1/processed/base-path-item-object.js +27 -33
  53. package/dist/schemas/3.1/processed/base-path-item-object.js.map +7 -0
  54. package/dist/schemas/3.1/processed/callback-object.js +7 -16
  55. package/dist/schemas/3.1/processed/callback-object.js.map +7 -0
  56. package/dist/schemas/3.1/processed/components-object.js +55 -62
  57. package/dist/schemas/3.1/processed/components-object.js.map +7 -0
  58. package/dist/schemas/3.1/processed/contact-object.js +11 -17
  59. package/dist/schemas/3.1/processed/contact-object.js.map +7 -0
  60. package/dist/schemas/3.1/processed/discriminator-object.js +15 -26
  61. package/dist/schemas/3.1/processed/discriminator-object.js.map +7 -0
  62. package/dist/schemas/3.1/processed/encoding-object.js +17 -28
  63. package/dist/schemas/3.1/processed/encoding-object.js.map +7 -0
  64. package/dist/schemas/3.1/processed/example-object.js +23 -33
  65. package/dist/schemas/3.1/processed/example-object.js.map +7 -0
  66. package/dist/schemas/3.1/processed/external-documentation-object.js +9 -15
  67. package/dist/schemas/3.1/processed/external-documentation-object.js.map +7 -0
  68. package/dist/schemas/3.1/processed/header-object.js +48 -64
  69. package/dist/schemas/3.1/processed/header-object.js.map +7 -0
  70. package/dist/schemas/3.1/processed/index.js +87 -30
  71. package/dist/schemas/3.1/processed/index.js.map +7 -0
  72. package/dist/schemas/3.1/processed/info-object.js +36 -43
  73. package/dist/schemas/3.1/processed/info-object.js.map +7 -0
  74. package/dist/schemas/3.1/processed/license-object.js +13 -19
  75. package/dist/schemas/3.1/processed/license-object.js.map +7 -0
  76. package/dist/schemas/3.1/processed/link-object.js +36 -50
  77. package/dist/schemas/3.1/processed/link-object.js.map +7 -0
  78. package/dist/schemas/3.1/processed/media-type-object-without-encoding.js +26 -32
  79. package/dist/schemas/3.1/processed/media-type-object-without-encoding.js.map +7 -0
  80. package/dist/schemas/3.1/processed/media-type-object.js +30 -36
  81. package/dist/schemas/3.1/processed/media-type-object.js.map +7 -0
  82. package/dist/schemas/3.1/processed/openapi-object.js +70 -78
  83. package/dist/schemas/3.1/processed/openapi-object.js.map +7 -0
  84. package/dist/schemas/3.1/processed/operation-object-without-callbacks.js +64 -70
  85. package/dist/schemas/3.1/processed/operation-object-without-callbacks.js.map +7 -0
  86. package/dist/schemas/3.1/processed/operation-object.js +14 -20
  87. package/dist/schemas/3.1/processed/operation-object.js.map +7 -0
  88. package/dist/schemas/3.1/processed/parameter-object.js +83 -91
  89. package/dist/schemas/3.1/processed/parameter-object.js.map +7 -0
  90. package/dist/schemas/3.1/processed/path-item-object-without-callbacks.js +38 -46
  91. package/dist/schemas/3.1/processed/path-item-object-without-callbacks.js.map +7 -0
  92. package/dist/schemas/3.1/processed/path-item-object.js +38 -46
  93. package/dist/schemas/3.1/processed/path-item-object.js.map +7 -0
  94. package/dist/schemas/3.1/processed/paths-object.js +16 -22
  95. package/dist/schemas/3.1/processed/paths-object.js.map +7 -0
  96. package/dist/schemas/3.1/processed/request-body-object.js +25 -31
  97. package/dist/schemas/3.1/processed/request-body-object.js.map +7 -0
  98. package/dist/schemas/3.1/processed/response-object.js +28 -34
  99. package/dist/schemas/3.1/processed/response-object.js.map +7 -0
  100. package/dist/schemas/3.1/processed/responses-object.js +17 -30
  101. package/dist/schemas/3.1/processed/responses-object.js.map +7 -0
  102. package/dist/schemas/3.1/processed/runtime-expression.js +50 -81
  103. package/dist/schemas/3.1/processed/runtime-expression.js.map +7 -0
  104. package/dist/schemas/3.1/processed/schema-object.js +88 -89
  105. package/dist/schemas/3.1/processed/schema-object.js.map +7 -0
  106. package/dist/schemas/3.1/processed/schema-object.test.js +310 -0
  107. package/dist/schemas/3.1/processed/schema-object.test.js.map +7 -0
  108. package/dist/schemas/3.1/processed/security-requirement-object.js +20 -36
  109. package/dist/schemas/3.1/processed/security-requirement-object.js.map +7 -0
  110. package/dist/schemas/3.1/processed/security-scheme-object.js +114 -142
  111. package/dist/schemas/3.1/processed/security-scheme-object.js.map +7 -0
  112. package/dist/schemas/3.1/processed/server-object.js +19 -25
  113. package/dist/schemas/3.1/processed/server-object.js.map +7 -0
  114. package/dist/schemas/3.1/processed/server-variable-object.js +19 -25
  115. package/dist/schemas/3.1/processed/server-variable-object.js.map +7 -0
  116. package/dist/schemas/3.1/processed/tag-object.js +12 -19
  117. package/dist/schemas/3.1/processed/tag-object.js.map +7 -0
  118. package/dist/schemas/3.1/processed/webhooks-object.js +6 -18
  119. package/dist/schemas/3.1/processed/webhooks-object.js.map +7 -0
  120. package/dist/schemas/3.1/processed/xml-object.js +28 -38
  121. package/dist/schemas/3.1/processed/xml-object.js.map +7 -0
  122. package/dist/schemas/3.1/unprocessed/base-path-item-object.js +16 -22
  123. package/dist/schemas/3.1/unprocessed/base-path-item-object.js.map +7 -0
  124. package/dist/schemas/3.1/unprocessed/callback-object.js +6 -15
  125. package/dist/schemas/3.1/unprocessed/callback-object.js.map +7 -0
  126. package/dist/schemas/3.1/unprocessed/components-object.js +58 -65
  127. package/dist/schemas/3.1/unprocessed/components-object.js.map +7 -0
  128. package/dist/schemas/3.1/unprocessed/contact-object.js +6 -12
  129. package/dist/schemas/3.1/unprocessed/contact-object.js.map +7 -0
  130. package/dist/schemas/3.1/unprocessed/discriminator-object.js +6 -17
  131. package/dist/schemas/3.1/unprocessed/discriminator-object.js.map +7 -0
  132. package/dist/schemas/3.1/unprocessed/encoding-object.js +14 -25
  133. package/dist/schemas/3.1/unprocessed/encoding-object.js.map +7 -0
  134. package/dist/schemas/3.1/unprocessed/example-object.js +6 -16
  135. package/dist/schemas/3.1/unprocessed/example-object.js.map +7 -0
  136. package/dist/schemas/3.1/unprocessed/external-documentation-object.js +6 -12
  137. package/dist/schemas/3.1/unprocessed/external-documentation-object.js.map +7 -0
  138. package/dist/schemas/3.1/unprocessed/header-object.js +25 -41
  139. package/dist/schemas/3.1/unprocessed/header-object.js.map +7 -0
  140. package/dist/schemas/3.1/unprocessed/index.js +89 -31
  141. package/dist/schemas/3.1/unprocessed/index.js.map +7 -0
  142. package/dist/schemas/3.1/unprocessed/info-object.js +6 -13
  143. package/dist/schemas/3.1/unprocessed/info-object.js.map +7 -0
  144. package/dist/schemas/3.1/unprocessed/license-object.js +6 -12
  145. package/dist/schemas/3.1/unprocessed/license-object.js.map +7 -0
  146. package/dist/schemas/3.1/unprocessed/link-object.js +6 -20
  147. package/dist/schemas/3.1/unprocessed/link-object.js.map +7 -0
  148. package/dist/schemas/3.1/unprocessed/media-type-object-without-encoding.js +6 -12
  149. package/dist/schemas/3.1/unprocessed/media-type-object-without-encoding.js.map +7 -0
  150. package/dist/schemas/3.1/unprocessed/media-type-object.js +33 -39
  151. package/dist/schemas/3.1/unprocessed/media-type-object.js.map +7 -0
  152. package/dist/schemas/3.1/unprocessed/openapi-object.js +6 -12
  153. package/dist/schemas/3.1/unprocessed/openapi-object.js.map +7 -0
  154. package/dist/schemas/3.1/unprocessed/operation-object-without-callbacks.js +38 -44
  155. package/dist/schemas/3.1/unprocessed/operation-object-without-callbacks.js.map +7 -0
  156. package/dist/schemas/3.1/unprocessed/operation-object.js +15 -21
  157. package/dist/schemas/3.1/unprocessed/operation-object.js.map +7 -0
  158. package/dist/schemas/3.1/unprocessed/parameter-object.js +22 -30
  159. package/dist/schemas/3.1/unprocessed/parameter-object.js.map +7 -0
  160. package/dist/schemas/3.1/unprocessed/path-item-object-without-callbacks.js +38 -46
  161. package/dist/schemas/3.1/unprocessed/path-item-object-without-callbacks.js.map +7 -0
  162. package/dist/schemas/3.1/unprocessed/path-item-object.js +52 -60
  163. package/dist/schemas/3.1/unprocessed/path-item-object.js.map +7 -0
  164. package/dist/schemas/3.1/unprocessed/paths-object.js +6 -14
  165. package/dist/schemas/3.1/unprocessed/paths-object.js.map +7 -0
  166. package/dist/schemas/3.1/unprocessed/reference-object.js +20 -28
  167. package/dist/schemas/3.1/unprocessed/reference-object.js.map +7 -0
  168. package/dist/schemas/3.1/unprocessed/request-body-object.js +6 -12
  169. package/dist/schemas/3.1/unprocessed/request-body-object.js.map +7 -0
  170. package/dist/schemas/3.1/unprocessed/response-object.js +27 -33
  171. package/dist/schemas/3.1/unprocessed/response-object.js.map +7 -0
  172. package/dist/schemas/3.1/unprocessed/responses-object.js +18 -31
  173. package/dist/schemas/3.1/unprocessed/responses-object.js.map +7 -0
  174. package/dist/schemas/3.1/unprocessed/runtime-expression.js +6 -17
  175. package/dist/schemas/3.1/unprocessed/runtime-expression.js.map +7 -0
  176. package/dist/schemas/3.1/unprocessed/schema-object.js +31 -32
  177. package/dist/schemas/3.1/unprocessed/schema-object.js.map +7 -0
  178. package/dist/schemas/3.1/unprocessed/security-requirement-object.js +6 -23
  179. package/dist/schemas/3.1/unprocessed/security-requirement-object.js.map +7 -0
  180. package/dist/schemas/3.1/unprocessed/security-scheme-object.js +41 -29
  181. package/dist/schemas/3.1/unprocessed/security-scheme-object.js.map +7 -0
  182. package/dist/schemas/3.1/unprocessed/server-object.js +6 -12
  183. package/dist/schemas/3.1/unprocessed/server-object.js.map +7 -0
  184. package/dist/schemas/3.1/unprocessed/server-variable-object.js +6 -12
  185. package/dist/schemas/3.1/unprocessed/server-variable-object.js.map +7 -0
  186. package/dist/schemas/3.1/unprocessed/tag-object.js +6 -13
  187. package/dist/schemas/3.1/unprocessed/tag-object.js.map +7 -0
  188. package/dist/schemas/3.1/unprocessed/webhooks-object.js +6 -18
  189. package/dist/schemas/3.1/unprocessed/webhooks-object.js.map +7 -0
  190. package/dist/schemas/3.1/unprocessed/xml-object.js +6 -16
  191. package/dist/schemas/3.1/unprocessed/xml-object.js.map +7 -0
  192. package/dist/schemas/extensions/index.d.ts +1 -0
  193. package/dist/schemas/extensions/index.d.ts.map +1 -1
  194. package/dist/schemas/extensions/index.js +29 -10
  195. package/dist/schemas/extensions/index.js.map +7 -0
  196. package/dist/schemas/extensions/x-additional-properties-name.js +6 -12
  197. package/dist/schemas/extensions/x-additional-properties-name.js.map +7 -0
  198. package/dist/schemas/extensions/x-additional-properties-name.test.js +28 -0
  199. package/dist/schemas/extensions/x-additional-properties-name.test.js.map +7 -0
  200. package/dist/schemas/extensions/x-code-samples.js +12 -10
  201. package/dist/schemas/extensions/x-code-samples.js.map +7 -0
  202. package/dist/schemas/extensions/x-code-samples.test.js +82 -0
  203. package/dist/schemas/extensions/x-code-samples.test.js.map +7 -0
  204. package/dist/schemas/extensions/x-display-name.js +8 -0
  205. package/dist/schemas/extensions/x-display-name.js.map +7 -0
  206. package/dist/schemas/extensions/x-display-name.test.js +28 -0
  207. package/dist/schemas/extensions/x-display-name.test.js.map +7 -0
  208. package/dist/schemas/extensions/x-enum-descriptions.js +6 -18
  209. package/dist/schemas/extensions/x-enum-descriptions.js.map +7 -0
  210. package/dist/schemas/extensions/x-enum-descriptions.test.js +36 -0
  211. package/dist/schemas/extensions/x-enum-descriptions.test.js.map +7 -0
  212. package/dist/schemas/extensions/x-internal.js +6 -5
  213. package/dist/schemas/extensions/x-internal.js.map +7 -0
  214. package/dist/schemas/extensions/x-internal.test.js +20 -0
  215. package/dist/schemas/extensions/x-internal.test.js.map +7 -0
  216. package/dist/schemas/extensions/x-scalar-icon.js +6 -5
  217. package/dist/schemas/extensions/x-scalar-icon.js.map +7 -0
  218. package/dist/schemas/extensions/x-scalar-icon.test.js +14 -0
  219. package/dist/schemas/extensions/x-scalar-icon.test.js.map +7 -0
  220. package/dist/schemas/extensions/x-scalar-ignore.js +6 -5
  221. package/dist/schemas/extensions/x-scalar-ignore.js.map +7 -0
  222. package/dist/schemas/extensions/x-scalar-ignore.test.js +20 -0
  223. package/dist/schemas/extensions/x-scalar-ignore.test.js.map +7 -0
  224. package/dist/schemas/extensions/x-scalar-redirect-uri.js +6 -5
  225. package/dist/schemas/extensions/x-scalar-redirect-uri.js.map +7 -0
  226. package/dist/schemas/extensions/x-scalar-redirect-uri.test.js +23 -0
  227. package/dist/schemas/extensions/x-scalar-redirect-uri.test.js.map +7 -0
  228. package/dist/schemas/extensions/x-scalar-sdk-installation.d.ts +25 -0
  229. package/dist/schemas/extensions/x-scalar-sdk-installation.d.ts.map +1 -0
  230. package/dist/schemas/extensions/x-scalar-sdk-installation.js +12 -0
  231. package/dist/schemas/extensions/x-scalar-sdk-installation.js.map +7 -0
  232. package/dist/schemas/extensions/x-scalar-sdk-installation.test.js +25 -0
  233. package/dist/schemas/extensions/x-scalar-sdk-installation.test.js.map +7 -0
  234. package/dist/schemas/extensions/x-scalar-stability.js +10 -19
  235. package/dist/schemas/extensions/x-scalar-stability.js.map +7 -0
  236. package/dist/schemas/extensions/x-scalar-stability.test.js +33 -0
  237. package/dist/schemas/extensions/x-scalar-stability.test.js.map +7 -0
  238. package/dist/schemas/extensions/x-tag-groups.js +14 -17
  239. package/dist/schemas/extensions/x-tag-groups.js.map +7 -0
  240. package/dist/schemas/extensions/x-tag-groups.test.js +55 -0
  241. package/dist/schemas/extensions/x-tag-groups.test.js.map +7 -0
  242. package/dist/schemas/extensions/x-use-pkce.js +11 -10
  243. package/dist/schemas/extensions/x-use-pkce.js.map +7 -0
  244. package/dist/schemas/extensions/x-use-pkce.test.js +34 -0
  245. package/dist/schemas/extensions/x-use-pkce.test.js.map +7 -0
  246. package/package.json +12 -13
@@ -1,93 +1,85 @@
1
- import { z } from 'zod';
2
- import { ExampleObjectSchema } from './example-object.js';
3
- import { MediaTypeObjectSchema } from './media-type-object.js';
4
- import { SchemaObjectSchema } from './schema-object.js';
5
-
6
- /**
7
- * Parameter Object
8
- *
9
- * Describes a single operation parameter.
10
- *
11
- * A unique parameter is defined by a combination of a name and location.
12
- *
13
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#parameter-object
14
- */
1
+ import { z } from "zod";
2
+ import { ExampleObjectSchema } from "./example-object.js";
3
+ import { MediaTypeObjectSchema } from "./media-type-object.js";
4
+ import { SchemaObjectSchema } from "./schema-object.js";
15
5
  const ParameterObjectSchema = z.object({
16
- /**
17
- * REQUIRED. The name of the parameter. Parameter names are case sensitive.
18
- *
19
- * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the
20
- * Paths Object. See Path Templating for further information.
21
- * - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition
22
- * SHALL be ignored.
23
- * - For all other cases, the name corresponds to the parameter name used by the in property.
24
- **/
25
- name: z.string(),
26
- /**
27
- * REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
28
- **/
29
- in: z.enum(['query', 'header', 'path', 'cookie']),
30
- /**
31
- * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich
32
- * text representation.
33
- **/
34
- description: z.string().optional(),
35
- /**
36
- * Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and
37
- * its value MUST be true. Otherwise, the property MAY be included and its default value is false.
38
- **/
39
- required: z.boolean().optional(),
40
- /**
41
- * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
42
- **/
43
- deprecated: z.boolean().optional(),
44
- /**
45
- * Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a
46
- * parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be
47
- * serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is
48
- * likely to be removed in a later revision.
49
- **/
50
- allowEmptyValue: z.boolean().optional(),
51
- /**
52
- * Describes how the parameter value will be serialized depending on the type of the parameter value. Default values
53
- * (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.
54
- **/
55
- style: z.enum(['matrix', 'label', 'form', 'simple', 'spaceDelimited', 'pipeDelimited', 'deepObject']).optional(),
56
- /**
57
- * When this is true, parameter values of type array or object generate separate parameters for each value of the
58
- * array or key-value pair of the map. For other types of parameters this property has no effect. When style is form,
59
- * the default value is true. For all other styles, the default value is false. */
60
- explode: z.boolean().optional(),
61
- /**
62
- * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;=
63
- * to be included without percent-encoding. This property only applies to parameters with an in value of query.
64
- * The default value is false.
65
- **/
66
- allowReserved: z.boolean().optional(),
67
- /**
68
- * The schema defining the type used for the parameter.
69
- **/
70
- schema: SchemaObjectSchema.optional(),
71
- /**
72
- * Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties
73
- * if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema
74
- * that contains an example, the example value SHALL override the example provided by the schema. To represent
75
- * examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the
76
- * example with escaping where necessary.
77
- **/
78
- example: z.any().optional(),
79
- /**
80
- * Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as
81
- * specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore,
82
- * if referencing a schema that contains an example, the examples value SHALL override the example provided by the
83
- * schema.
84
- **/
85
- examples: z.record(z.string(), ExampleObjectSchema).optional(),
86
- /**
87
- * A map containing the representations for the parameter. The key is the media type and the value describes it.
88
- * The map MUST only contain one entry.
89
- **/
90
- content: z.record(z.string(), MediaTypeObjectSchema).optional(),
6
+ /**
7
+ * REQUIRED. The name of the parameter. Parameter names are case sensitive.
8
+ *
9
+ * - If in is "path", the name field MUST correspond to a template expression occurring within the path field in the
10
+ * Paths Object. See Path Templating for further information.
11
+ * - If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition
12
+ * SHALL be ignored.
13
+ * - For all other cases, the name corresponds to the parameter name used by the in property.
14
+ **/
15
+ name: z.string(),
16
+ /**
17
+ * REQUIRED. The location of the parameter. Possible values are "query", "header", "path" or "cookie".
18
+ **/
19
+ in: z.enum(["query", "header", "path", "cookie"]),
20
+ /**
21
+ * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich
22
+ * text representation.
23
+ **/
24
+ description: z.string().optional(),
25
+ /**
26
+ * Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and
27
+ * its value MUST be true. Otherwise, the property MAY be included and its default value is false.
28
+ **/
29
+ required: z.boolean().optional(),
30
+ /**
31
+ * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
32
+ **/
33
+ deprecated: z.boolean().optional(),
34
+ /**
35
+ * Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a
36
+ * parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be
37
+ * serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is
38
+ * likely to be removed in a later revision.
39
+ **/
40
+ allowEmptyValue: z.boolean().optional(),
41
+ /**
42
+ * Describes how the parameter value will be serialized depending on the type of the parameter value. Default values
43
+ * (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.
44
+ **/
45
+ style: z.enum(["matrix", "label", "form", "simple", "spaceDelimited", "pipeDelimited", "deepObject"]).optional(),
46
+ /**
47
+ * When this is true, parameter values of type array or object generate separate parameters for each value of the
48
+ * array or key-value pair of the map. For other types of parameters this property has no effect. When style is form,
49
+ * the default value is true. For all other styles, the default value is false. */
50
+ explode: z.boolean().optional(),
51
+ /**
52
+ * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;=
53
+ * to be included without percent-encoding. This property only applies to parameters with an in value of query.
54
+ * The default value is false.
55
+ **/
56
+ allowReserved: z.boolean().optional(),
57
+ /**
58
+ * The schema defining the type used for the parameter.
59
+ **/
60
+ schema: SchemaObjectSchema.optional(),
61
+ /**
62
+ * Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties
63
+ * if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema
64
+ * that contains an example, the example value SHALL override the example provided by the schema. To represent
65
+ * examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the
66
+ * example with escaping where necessary.
67
+ **/
68
+ example: z.any().optional(),
69
+ /**
70
+ * Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as
71
+ * specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore,
72
+ * if referencing a schema that contains an example, the examples value SHALL override the example provided by the
73
+ * schema.
74
+ **/
75
+ examples: z.record(z.string(), ExampleObjectSchema).optional(),
76
+ /**
77
+ * A map containing the representations for the parameter. The key is the media type and the value describes it.
78
+ * The map MUST only contain one entry.
79
+ **/
80
+ content: z.record(z.string(), MediaTypeObjectSchema).optional()
91
81
  });
92
-
93
- export { ParameterObjectSchema };
82
+ export {
83
+ ParameterObjectSchema
84
+ };
85
+ //# sourceMappingURL=parameter-object.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/parameter-object.ts"],
4
+ "sourcesContent": ["import { z } from 'zod'\nimport { ExampleObjectSchema } from './example-object'\nimport { MediaTypeObjectSchema } from './media-type-object'\nimport { SchemaObjectSchema } from './schema-object'\n\n/**\n * Parameter Object\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 https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#parameter-object\n */\nexport const ParameterObjectSchema = z.object({\n /**\n * REQUIRED. The name of the parameter. Parameter names are case sensitive.\n *\n * - If in is \"path\", the name field MUST correspond to a template expression occurring within the path field in the\n * 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\n * SHALL be ignored.\n * - For all other cases, the name corresponds to the parameter name used by the in property.\n **/\n name: z.string(),\n /**\n * REQUIRED. The location of the parameter. Possible values are \"query\", \"header\", \"path\" or \"cookie\".\n **/\n in: z.enum(['query', 'header', 'path', 'cookie']),\n /**\n * A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich\n * text representation.\n **/\n description: z.string().optional(),\n /**\n * Determines whether this parameter is mandatory. If the parameter location is \"path\", this property is REQUIRED and\n * its value MUST be true. Otherwise, the property MAY be included and its default value is false.\n **/\n required: z.boolean().optional(),\n /**\n * Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.\n **/\n deprecated: z.boolean().optional(),\n /**\n * Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a\n * parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be\n * serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is\n * likely to be removed in a later revision.\n **/\n allowEmptyValue: z.boolean().optional(),\n /**\n * Describes how the parameter value will be serialized depending on the type of the parameter value. Default values\n * (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.\n **/\n style: z.enum(['matrix', 'label', 'form', 'simple', 'spaceDelimited', 'pipeDelimited', 'deepObject']).optional(),\n /**\n * When this is true, parameter values of type array or object generate separate parameters for each value of the\n * array or key-value pair of the map. For other types of parameters this property has no effect. When style is form,\n * the default value is true. For all other styles, the default value is false. */\n explode: z.boolean().optional(),\n /**\n * Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;=\n * to be included without percent-encoding. This property only applies to parameters with an in value of query.\n * The default value is false.\n **/\n allowReserved: z.boolean().optional(),\n /**\n * The schema defining the type used for the parameter.\n **/\n schema: SchemaObjectSchema.optional(),\n /**\n * Example of the parameter's potential value. The example SHOULD match the specified schema and encoding properties\n * if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema\n * that contains an example, the example value SHALL override the example provided by the schema. To represent\n * examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the\n * example with escaping where necessary.\n **/\n example: z.any().optional(),\n /**\n * Examples of the parameter's potential value. Each example SHOULD contain a value in the correct format as\n * specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore,\n * if referencing a schema that contains an example, the examples value SHALL override the example provided by the\n * schema.\n **/\n examples: z.record(z.string(), ExampleObjectSchema).optional(),\n /**\n * A map containing the representations for the parameter. The key is the media type and the value describes it.\n * The map MUST only contain one entry.\n **/\n content: z.record(z.string(), MediaTypeObjectSchema).optional(),\n})\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAClB,SAAS,2BAA2B;AACpC,SAAS,6BAA6B;AACtC,SAAS,0BAA0B;AAW5B,MAAM,wBAAwB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAU5C,MAAM,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAIf,IAAI,EAAE,KAAK,CAAC,SAAS,UAAU,QAAQ,QAAQ,CAAC;AAAA;AAAA;AAAA;AAAA;AAAA,EAKhD,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKjC,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAI/B,YAAY,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOjC,iBAAiB,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAKtC,OAAO,EAAE,KAAK,CAAC,UAAU,SAAS,QAAQ,UAAU,kBAAkB,iBAAiB,YAAY,CAAC,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAK/G,SAAS,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM9B,eAAe,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAIpC,QAAQ,mBAAmB,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQpC,SAAS,EAAE,IAAI,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAO1B,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,mBAAmB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAK7D,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,qBAAqB,EAAE,SAAS;AAChE,CAAC;",
6
+ "names": []
7
+ }
@@ -1,48 +1,40 @@
1
- import { BasePathItemObjectSchema } from './base-path-item-object.js';
2
- import { OperationObjectSchemaWithoutCallbacks } from './operation-object-without-callbacks.js';
3
-
4
- /**
5
- * Path Item Object (without callbacks)
6
- *
7
- * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path
8
- * itself is still exposed to the documentation viewer but they will not know which operations and parameters are
9
- * available.
10
- *
11
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object
12
- */
1
+ import { BasePathItemObjectSchema } from "./base-path-item-object.js";
2
+ import { OperationObjectSchemaWithoutCallbacks } from "./operation-object-without-callbacks.js";
13
3
  const PathItemObjectSchemaWithoutCallbacks = BasePathItemObjectSchema.extend({
14
- /**
15
- * A definition of a GET operation on this path.
16
- */
17
- get: OperationObjectSchemaWithoutCallbacks.optional(),
18
- /**
19
- * A definition of a PUT operation on this path.
20
- */
21
- put: OperationObjectSchemaWithoutCallbacks.optional(),
22
- /**
23
- * A definition of a POST operation on this path.
24
- */
25
- post: OperationObjectSchemaWithoutCallbacks.optional(),
26
- /**
27
- * A definition of a DELETE operation on this path.
28
- */
29
- delete: OperationObjectSchemaWithoutCallbacks.optional(),
30
- /**
31
- * A definition of a OPTIONS operation on this path.
32
- */
33
- options: OperationObjectSchemaWithoutCallbacks.optional(),
34
- /**
35
- * A definition of a HEAD operation on this path.
36
- */
37
- head: OperationObjectSchemaWithoutCallbacks.optional(),
38
- /**
39
- * A definition of a PATCH operation on this path.
40
- */
41
- patch: OperationObjectSchemaWithoutCallbacks.optional(),
42
- /**
43
- * A definition of a TRACE operation on this path.
44
- */
45
- trace: OperationObjectSchemaWithoutCallbacks.optional(),
4
+ /**
5
+ * A definition of a GET operation on this path.
6
+ */
7
+ get: OperationObjectSchemaWithoutCallbacks.optional(),
8
+ /**
9
+ * A definition of a PUT operation on this path.
10
+ */
11
+ put: OperationObjectSchemaWithoutCallbacks.optional(),
12
+ /**
13
+ * A definition of a POST operation on this path.
14
+ */
15
+ post: OperationObjectSchemaWithoutCallbacks.optional(),
16
+ /**
17
+ * A definition of a DELETE operation on this path.
18
+ */
19
+ delete: OperationObjectSchemaWithoutCallbacks.optional(),
20
+ /**
21
+ * A definition of a OPTIONS operation on this path.
22
+ */
23
+ options: OperationObjectSchemaWithoutCallbacks.optional(),
24
+ /**
25
+ * A definition of a HEAD operation on this path.
26
+ */
27
+ head: OperationObjectSchemaWithoutCallbacks.optional(),
28
+ /**
29
+ * A definition of a PATCH operation on this path.
30
+ */
31
+ patch: OperationObjectSchemaWithoutCallbacks.optional(),
32
+ /**
33
+ * A definition of a TRACE operation on this path.
34
+ */
35
+ trace: OperationObjectSchemaWithoutCallbacks.optional()
46
36
  });
47
-
48
- export { PathItemObjectSchemaWithoutCallbacks };
37
+ export {
38
+ PathItemObjectSchemaWithoutCallbacks
39
+ };
40
+ //# sourceMappingURL=path-item-object-without-callbacks.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/path-item-object-without-callbacks.ts"],
4
+ "sourcesContent": ["import type { z } from 'zod'\nimport { BasePathItemObjectSchema } from './base-path-item-object'\nimport { OperationObjectSchemaWithoutCallbacks } from './operation-object-without-callbacks'\n\ntype PathItemObjectSchemaWithoutCallbacks = z.infer<typeof BasePathItemObjectSchema> & {\n get?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n put?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n post?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n delete?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n options?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n head?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n patch?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n trace?: z.infer<typeof OperationObjectSchemaWithoutCallbacks>\n}\n\n/**\n * Path Item Object (without callbacks)\n *\n * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path\n * itself is still exposed to the documentation viewer but they will not know which operations and parameters are\n * available.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object\n */\nexport const PathItemObjectSchemaWithoutCallbacks: z.ZodType<PathItemObjectSchemaWithoutCallbacks> =\n BasePathItemObjectSchema.extend({\n /**\n * A definition of a GET operation on this path.\n */\n get: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a PUT operation on this path.\n */\n put: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a POST operation on this path.\n */\n post: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a DELETE operation on this path.\n */\n delete: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a OPTIONS operation on this path.\n */\n options: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a HEAD operation on this path.\n */\n head: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a PATCH operation on this path.\n */\n patch: OperationObjectSchemaWithoutCallbacks.optional(),\n /**\n * A definition of a TRACE operation on this path.\n */\n trace: OperationObjectSchemaWithoutCallbacks.optional(),\n })\n"],
5
+ "mappings": "AACA,SAAS,gCAAgC;AACzC,SAAS,6CAA6C;AAsB/C,MAAM,uCACX,yBAAyB,OAAO;AAAA;AAAA;AAAA;AAAA,EAI9B,KAAK,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIpD,KAAK,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIpD,MAAM,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIrD,QAAQ,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIvD,SAAS,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIxD,MAAM,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAIrD,OAAO,sCAAsC,SAAS;AAAA;AAAA;AAAA;AAAA,EAItD,OAAO,sCAAsC,SAAS;AACxD,CAAC;",
6
+ "names": []
7
+ }
@@ -1,48 +1,40 @@
1
- import { BasePathItemObjectSchema } from './base-path-item-object.js';
2
- import { OperationObjectSchema } from './operation-object.js';
3
-
4
- /**
5
- * Path Item Object
6
- *
7
- * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path
8
- * itself is still exposed to the documentation viewer but they will not know which operations and parameters are
9
- * available.
10
- *
11
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object
12
- */
1
+ import { BasePathItemObjectSchema } from "./base-path-item-object.js";
2
+ import { OperationObjectSchema } from "./operation-object.js";
13
3
  const PathItemObjectSchema = BasePathItemObjectSchema.extend({
14
- /**
15
- * A definition of a GET operation on this path.
16
- */
17
- get: OperationObjectSchema.optional(),
18
- /**
19
- * A definition of a PUT operation on this path.
20
- */
21
- put: OperationObjectSchema.optional(),
22
- /**
23
- * A definition of a POST operation on this path.
24
- */
25
- post: OperationObjectSchema.optional(),
26
- /**
27
- * A definition of a DELETE operation on this path.
28
- */
29
- delete: OperationObjectSchema.optional(),
30
- /**
31
- * A definition of a OPTIONS operation on this path.
32
- */
33
- options: OperationObjectSchema.optional(),
34
- /**
35
- * A definition of a HEAD operation on this path.
36
- */
37
- head: OperationObjectSchema.optional(),
38
- /**
39
- * A definition of a PATCH operation on this path.
40
- */
41
- patch: OperationObjectSchema.optional(),
42
- /**
43
- * A definition of a TRACE operation on this path.
44
- */
45
- trace: OperationObjectSchema.optional(),
4
+ /**
5
+ * A definition of a GET operation on this path.
6
+ */
7
+ get: OperationObjectSchema.optional(),
8
+ /**
9
+ * A definition of a PUT operation on this path.
10
+ */
11
+ put: OperationObjectSchema.optional(),
12
+ /**
13
+ * A definition of a POST operation on this path.
14
+ */
15
+ post: OperationObjectSchema.optional(),
16
+ /**
17
+ * A definition of a DELETE operation on this path.
18
+ */
19
+ delete: OperationObjectSchema.optional(),
20
+ /**
21
+ * A definition of a OPTIONS operation on this path.
22
+ */
23
+ options: OperationObjectSchema.optional(),
24
+ /**
25
+ * A definition of a HEAD operation on this path.
26
+ */
27
+ head: OperationObjectSchema.optional(),
28
+ /**
29
+ * A definition of a PATCH operation on this path.
30
+ */
31
+ patch: OperationObjectSchema.optional(),
32
+ /**
33
+ * A definition of a TRACE operation on this path.
34
+ */
35
+ trace: OperationObjectSchema.optional()
46
36
  });
47
-
48
- export { PathItemObjectSchema };
37
+ export {
38
+ PathItemObjectSchema
39
+ };
40
+ //# sourceMappingURL=path-item-object.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/path-item-object.ts"],
4
+ "sourcesContent": ["import { BasePathItemObjectSchema } from './base-path-item-object'\nimport { OperationObjectSchema } from './operation-object'\n\n/**\n * Path Item Object\n *\n * Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path\n * itself is still exposed to the documentation viewer but they will not know which operations and parameters are\n * available.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#path-item-object\n */\nexport const PathItemObjectSchema = BasePathItemObjectSchema.extend({\n /**\n * A definition of a GET operation on this path.\n */\n get: OperationObjectSchema.optional(),\n /**\n * A definition of a PUT operation on this path.\n */\n put: OperationObjectSchema.optional(),\n /**\n * A definition of a POST operation on this path.\n */\n post: OperationObjectSchema.optional(),\n /**\n * A definition of a DELETE operation on this path.\n */\n delete: OperationObjectSchema.optional(),\n /**\n * A definition of a OPTIONS operation on this path.\n */\n options: OperationObjectSchema.optional(),\n /**\n * A definition of a HEAD operation on this path.\n */\n head: OperationObjectSchema.optional(),\n /**\n * A definition of a PATCH operation on this path.\n */\n patch: OperationObjectSchema.optional(),\n /**\n * A definition of a TRACE operation on this path.\n */\n trace: OperationObjectSchema.optional(),\n})\n"],
5
+ "mappings": "AAAA,SAAS,gCAAgC;AACzC,SAAS,6BAA6B;AAW/B,MAAM,uBAAuB,yBAAyB,OAAO;AAAA;AAAA;AAAA;AAAA,EAIlE,KAAK,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIpC,KAAK,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIpC,MAAM,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIrC,QAAQ,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIvC,SAAS,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIxC,MAAM,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAIrC,OAAO,sBAAsB,SAAS;AAAA;AAAA;AAAA;AAAA,EAItC,OAAO,sBAAsB,SAAS;AACxC,CAAC;",
6
+ "names": []
7
+ }
@@ -1,23 +1,17 @@
1
- import { z } from 'zod';
2
- import { PathItemObjectSchema } from './path-item-object.js';
3
-
4
- /**
5
- * Paths Object
6
- *
7
- * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the
8
- * Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL)
9
- * constraints.
10
- *
11
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#paths-object
12
- */
1
+ import { z } from "zod";
2
+ import { PathItemObjectSchema } from "./path-item-object.js";
13
3
  const PathsObjectSchema = z.record(
14
- /**
15
- * A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended
16
- * (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full
17
- * URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their
18
- * templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as
19
- * they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use.
20
- */
21
- z.string(), PathItemObjectSchema);
22
-
23
- export { PathsObjectSchema };
4
+ /**
5
+ * A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended
6
+ * (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full
7
+ * URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their
8
+ * templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as
9
+ * they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use.
10
+ */
11
+ z.string(),
12
+ PathItemObjectSchema
13
+ );
14
+ export {
15
+ PathsObjectSchema
16
+ };
17
+ //# sourceMappingURL=paths-object.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/paths-object.ts"],
4
+ "sourcesContent": ["import { z } from 'zod'\nimport { PathItemObjectSchema } from './path-item-object'\n\n/**\n * Paths Object\n *\n * Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the\n * Server Object in order to construct the full URL. The Paths Object MAY be empty, due to Access Control List (ACL)\n * constraints.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#paths-object\n */\nexport const PathsObjectSchema = z.record(\n /**\n * A relative path to an individual endpoint. The field name MUST begin with a forward slash (/). The path is appended\n * (no relative URL resolution) to the expanded URL from the Server Object's url field in order to construct the full\n * URL. Path templating is allowed. When matching URLs, concrete (non-templated) paths would be matched before their\n * templated counterparts. Templated paths with the same hierarchy but different templated names MUST NOT exist as\n * they are identical. In case of ambiguous matching, it's up to the tooling to decide which one to use.\n */\n z.string(),\n PathItemObjectSchema,\n)\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAClB,SAAS,4BAA4B;AAW9B,MAAM,oBAAoB,EAAE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQjC,EAAE,OAAO;AAAA,EACT;AACF;",
6
+ "names": []
7
+ }
@@ -1,33 +1,27 @@
1
- import { z } from 'zod';
2
- import { EncodingObjectSchema } from './encoding-object.js';
3
- import { MediaTypeObjectSchema } from './media-type-object.js';
4
-
5
- /**
6
- * Request Body Object
7
- *
8
- * Describes a single request body.
9
- *
10
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#request-body-object
11
- */
1
+ import { z } from "zod";
2
+ import { EncodingObjectSchema } from "./encoding-object.js";
3
+ import { MediaTypeObjectSchema } from "./media-type-object.js";
12
4
  const RequestBodyObjectSchema = z.object({
13
- /**
14
- * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
15
- */
16
- description: z.string().optional(),
17
- /**
18
- * 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/*"
19
- */
20
- content: z.record(z.string(), MediaTypeObjectSchema),
21
- /**
22
- * Determines if the request body is required in the request. Defaults to false.
23
- */
24
- required: z.boolean().optional(),
25
- /**
26
- * Only mentioned in the example:
27
- *
28
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#request-body-object
29
- */
30
- encoding: z.record(z.string(), EncodingObjectSchema).optional(),
5
+ /**
6
+ * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
7
+ */
8
+ description: z.string().optional(),
9
+ /**
10
+ * 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/*"
11
+ */
12
+ content: z.record(z.string(), MediaTypeObjectSchema),
13
+ /**
14
+ * Determines if the request body is required in the request. Defaults to false.
15
+ */
16
+ required: z.boolean().optional(),
17
+ /**
18
+ * Only mentioned in the example:
19
+ *
20
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#request-body-object
21
+ */
22
+ encoding: z.record(z.string(), EncodingObjectSchema).optional()
31
23
  });
32
-
33
- export { RequestBodyObjectSchema };
24
+ export {
25
+ RequestBodyObjectSchema
26
+ };
27
+ //# sourceMappingURL=request-body-object.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/request-body-object.ts"],
4
+ "sourcesContent": ["import { z } from 'zod'\nimport { EncodingObjectSchema } from './encoding-object'\nimport { MediaTypeObjectSchema } from './media-type-object'\n\n/**\n * Request Body Object\n *\n * Describes a single request body.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#request-body-object\n */\nexport const RequestBodyObjectSchema = z.object({\n /**\n * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n */\n description: z.string().optional(),\n /**\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 */\n content: z.record(z.string(), MediaTypeObjectSchema),\n /**\n * Determines if the request body is required in the request. Defaults to false.\n */\n required: z.boolean().optional(),\n /**\n * Only mentioned in the example:\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#request-body-object\n */\n encoding: z.record(z.string(), EncodingObjectSchema).optional(),\n})\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAClB,SAAS,4BAA4B;AACrC,SAAS,6BAA6B;AAS/B,MAAM,0BAA0B,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAI9C,aAAa,EAAE,OAAO,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA,EAIjC,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,qBAAqB;AAAA;AAAA;AAAA;AAAA,EAInD,UAAU,EAAE,QAAQ,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM/B,UAAU,EAAE,OAAO,EAAE,OAAO,GAAG,oBAAoB,EAAE,SAAS;AAChE,CAAC;",
6
+ "names": []
7
+ }
@@ -1,36 +1,30 @@
1
- import { z } from 'zod';
2
- import { HeaderObjectSchema } from './header-object.js';
3
- import { LinkObjectSchema } from './link-object.js';
4
- import { MediaTypeObjectSchema } from './media-type-object.js';
5
-
6
- /**
7
- * Response Object
8
- *
9
- * Describes a single response from an API operation, including design-time, static links to operations based on the response.
10
- *
11
- * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#response-object
12
- */
1
+ import { z } from "zod";
2
+ import { HeaderObjectSchema } from "./header-object.js";
3
+ import { LinkObjectSchema } from "./link-object.js";
4
+ import { MediaTypeObjectSchema } from "./media-type-object.js";
13
5
  const ResponseObjectSchema = z.object({
14
- /**
15
- * REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.
16
- */
17
- description: z.string(),
18
- /**
19
- * Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is
20
- * defined with the name "Content-Type", it SHALL be ignored.
21
- */
22
- headers: z.record(z.string(), HeaderObjectSchema).optional(),
23
- /**
24
- * A map containing descriptions of potential response payloads. The key is a media type or media type range and the
25
- * value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g.
26
- * "text/plain" overrides "text/*"
27
- */
28
- content: z.record(z.string(), MediaTypeObjectSchema).optional(),
29
- /**
30
- * A map of operations links that can be followed from the response. The key of the map is a short name for the link,
31
- * following the naming constraints of the names for Component Objects.
32
- */
33
- links: z.record(z.string(), LinkObjectSchema).optional(),
6
+ /**
7
+ * REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.
8
+ */
9
+ description: z.string(),
10
+ /**
11
+ * Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is
12
+ * defined with the name "Content-Type", it SHALL be ignored.
13
+ */
14
+ headers: z.record(z.string(), HeaderObjectSchema).optional(),
15
+ /**
16
+ * A map containing descriptions of potential response payloads. The key is a media type or media type range and the
17
+ * value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g.
18
+ * "text/plain" overrides "text/*"
19
+ */
20
+ content: z.record(z.string(), MediaTypeObjectSchema).optional(),
21
+ /**
22
+ * A map of operations links that can be followed from the response. The key of the map is a short name for the link,
23
+ * following the naming constraints of the names for Component Objects.
24
+ */
25
+ links: z.record(z.string(), LinkObjectSchema).optional()
34
26
  });
35
-
36
- export { ResponseObjectSchema };
27
+ export {
28
+ ResponseObjectSchema
29
+ };
30
+ //# sourceMappingURL=response-object.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../../../../src/schemas/3.1/processed/response-object.ts"],
4
+ "sourcesContent": ["import { z } from 'zod'\nimport { HeaderObjectSchema } from './header-object'\nimport { LinkObjectSchema } from './link-object'\nimport { MediaTypeObjectSchema } from './media-type-object'\n\n/**\n * Response Object\n *\n * Describes a single response from an API operation, including design-time, static links to operations based on the response.\n *\n * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#response-object\n */\nexport const ResponseObjectSchema = z.object({\n /**\n * REQUIRED. A description of the response. CommonMark syntax MAY be used for rich text representation.\n */\n description: z.string(),\n /**\n * Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is\n * defined with the name \"Content-Type\", it SHALL be ignored.\n */\n headers: z.record(z.string(), HeaderObjectSchema).optional(),\n /**\n * A map containing descriptions of potential response payloads. The key is a media type or media type range and the\n * value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g.\n * \"text/plain\" overrides \"text/*\"\n */\n content: z.record(z.string(), MediaTypeObjectSchema).optional(),\n /**\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,\n * following the naming constraints of the names for Component Objects.\n */\n links: z.record(z.string(), LinkObjectSchema).optional(),\n})\n"],
5
+ "mappings": "AAAA,SAAS,SAAS;AAClB,SAAS,0BAA0B;AACnC,SAAS,wBAAwB;AACjC,SAAS,6BAA6B;AAS/B,MAAM,uBAAuB,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA,EAI3C,aAAa,EAAE,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA,EAKtB,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,kBAAkB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAM3D,SAAS,EAAE,OAAO,EAAE,OAAO,GAAG,qBAAqB,EAAE,SAAS;AAAA;AAAA;AAAA;AAAA;AAAA,EAK9D,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,gBAAgB,EAAE,SAAS;AACzD,CAAC;",
6
+ "names": []
7
+ }