@redocly/openapi-core 0.0.0-snapshot.1768989764 → 0.0.0-snapshot.1768999175

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 (40) hide show
  1. package/lib/oas-types.d.ts +0 -190
  2. package/lib/oas-types.d.ts.map +1 -1
  3. package/lib/types/arazzo.d.ts.map +1 -1
  4. package/lib/types/arazzo.js +44 -210
  5. package/lib/types/arazzo.js.map +1 -1
  6. package/lib/types/asyncapi2.d.ts.map +1 -1
  7. package/lib/types/asyncapi2.js +57 -385
  8. package/lib/types/asyncapi2.js.map +1 -1
  9. package/lib/types/asyncapi3.d.ts.map +1 -1
  10. package/lib/types/asyncapi3.js +47 -228
  11. package/lib/types/asyncapi3.js.map +1 -1
  12. package/lib/types/index.d.ts +2 -18
  13. package/lib/types/index.d.ts.map +1 -1
  14. package/lib/types/index.js +2 -4
  15. package/lib/types/index.js.map +1 -1
  16. package/lib/types/oas2.d.ts +0 -22
  17. package/lib/types/oas2.d.ts.map +1 -1
  18. package/lib/types/oas3.d.ts +0 -44
  19. package/lib/types/oas3.d.ts.map +1 -1
  20. package/lib/types/oas3.js +71 -345
  21. package/lib/types/oas3.js.map +1 -1
  22. package/lib/types/oas3_1.d.ts +0 -46
  23. package/lib/types/oas3_1.d.ts.map +1 -1
  24. package/lib/types/oas3_1.js +29 -38
  25. package/lib/types/oas3_1.js.map +1 -1
  26. package/lib/types/oas3_2.d.ts +0 -46
  27. package/lib/types/oas3_2.d.ts.map +1 -1
  28. package/lib/types/oas3_2.js +23 -101
  29. package/lib/types/oas3_2.js.map +1 -1
  30. package/lib/types/openrpc.d.ts +0 -32
  31. package/lib/types/openrpc.d.ts.map +1 -1
  32. package/lib/types/openrpc.js +46 -215
  33. package/lib/types/openrpc.js.map +1 -1
  34. package/lib/types/overlay.d.ts.map +1 -1
  35. package/lib/types/overlay.js +7 -34
  36. package/lib/types/overlay.js.map +1 -1
  37. package/lib/types/redocly-yaml.d.ts.map +1 -1
  38. package/lib/types/redocly-yaml.js +0 -2
  39. package/lib/types/redocly-yaml.js.map +1 -1
  40. package/package.json +1 -1
package/lib/types/oas3.js CHANGED
@@ -17,129 +17,70 @@ const Root = {
17
17
  },
18
18
  required: ['openapi', 'paths', 'info'],
19
19
  extensionsPrefix: 'x-',
20
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/openapi#openapi',
21
- description: 'REQUIRED. This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.',
22
20
  };
23
21
  const Tag = {
24
22
  properties: {
25
- name: {
26
- type: 'string',
27
- description: 'REQUIRED. The name of the tag.',
28
- },
29
- description: {
30
- type: 'string',
31
- description: 'A description for the tag.',
32
- },
23
+ name: { type: 'string' },
24
+ description: { type: 'string' },
33
25
  externalDocs: 'ExternalDocs',
34
26
  'x-traitTag': { type: 'boolean' },
35
27
  'x-displayName': { type: 'string' },
36
28
  },
37
29
  required: ['name'],
38
30
  extensionsPrefix: 'x-',
39
- description: `The Tag Object represents a tag used by the OAS. It is not mandatory to have a tag object per tag used by the OAS but each tag object can contain additional metadata.`,
40
- documentationLink: `https://spec.openapis.org/oas/v3.1.0#tag-object`,
41
31
  };
42
32
  const TagGroup = {
43
33
  properties: {
44
- name: {
45
- type: 'string',
46
- description: 'The display name for the tag, used in the navigation bar and as a section heading.',
47
- },
48
- tags: {
49
- type: 'array',
50
- description: 'List of tags to include in this group.',
51
- items: { type: 'string' },
52
- },
34
+ name: { type: 'string' },
35
+ tags: { type: 'array', items: { type: 'string' } },
53
36
  },
54
37
  extensionsPrefix: 'x-',
55
- description: 'The x-tagGroups extension is used at the top level of an OpenAPI description.',
56
- documentationLink: 'https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-tag-groups#taggroup-object',
57
38
  };
58
39
  const ExternalDocs = {
59
40
  properties: {
60
- description: {
61
- type: 'string',
62
- description: 'A description of the target documentation. Used as the link anchor text in Redocly. If not provided, the url is used as the link anchor text.',
63
- },
64
- url: {
65
- type: 'string',
66
- description: 'REQUIRED. The URL for the target documentation.',
67
- },
41
+ description: { type: 'string' },
42
+ url: { type: 'string' },
68
43
  },
69
44
  required: ['url'],
70
45
  extensionsPrefix: 'x-',
71
- description: 'Additional external documentation for this operation.',
72
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/external-docs',
73
46
  };
74
47
  const Server = {
75
48
  properties: {
76
- url: {
77
- type: 'string',
78
- description: 'REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions are made when a variable is named in { curly braces }.',
79
- },
80
- description: {
81
- type: 'string',
82
- description: 'An optional string describing the host designated by the URL.',
83
- },
49
+ url: { type: 'string' },
50
+ description: { type: 'string' },
84
51
  variables: 'ServerVariablesMap',
85
52
  },
86
53
  required: ['url'],
87
54
  extensionsPrefix: 'x-',
88
- description: 'A server object to be used by the target operation.',
89
55
  };
90
56
  const ServerVariable = {
91
57
  properties: {
92
58
  enum: {
93
59
  type: 'array',
94
60
  items: { type: 'string' },
95
- description: 'An enumeration of string values to be used if the substitution options are from a limited set. The array MUST NOT be empty. If defined, the array MUST contain the default value.',
96
- },
97
- default: {
98
- type: 'string',
99
- description: `REQUIRED. The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional. If the enum is defined, the value MUST exist in the enum's values.`,
100
- },
101
- description: {
102
- type: 'string',
103
- description: 'An optional description for the server variable.',
104
61
  },
62
+ default: { type: 'string' },
63
+ description: { type: 'string' },
105
64
  },
106
65
  required: ['default'],
107
66
  extensionsPrefix: 'x-',
108
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/server-variables#server-variables',
109
- description: 'Server variables are used when you need to make a substitution into the server URL such as when the subdomain is unique per tenant.',
110
67
  };
111
68
  const SecurityRequirement = {
112
69
  properties: {},
113
70
  additionalProperties: { type: 'array', items: { type: 'string' } },
114
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/security#security-requirement-object',
115
- description: 'A declaration of which security mechanisms can be used across the API. 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. Individual operations can override this definition. To make security optional, an empty security requirement ({}) can be included in the array.',
116
71
  };
117
72
  const Info = {
118
73
  properties: {
119
- title: {
120
- type: 'string',
121
- description: 'REQUIRED. The title of the API.',
122
- },
123
- version: {
124
- type: 'string',
125
- description: 'REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).',
126
- },
127
- description: {
128
- type: 'string',
129
- description: 'RECOMMENDED. A description of the API (Markdown may be used).',
130
- },
131
- termsOfService: {
132
- type: 'string',
133
- description: 'A URL to the Terms of Service for the API.',
134
- },
74
+ title: { type: 'string' },
75
+ version: { type: 'string' },
76
+ description: { type: 'string' },
77
+ termsOfService: { type: 'string' },
135
78
  contact: 'Contact',
136
79
  license: 'License',
137
80
  'x-logo': 'Logo',
138
81
  },
139
82
  required: ['title', 'version'],
140
83
  extensionsPrefix: 'x-',
141
- description: 'REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.',
142
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/info#info',
143
84
  };
144
85
  const Logo = {
145
86
  properties: {
@@ -148,72 +89,38 @@ const Logo = {
148
89
  backgroundColor: { type: 'string' },
149
90
  href: { type: 'string' },
150
91
  },
151
- documentationLink: 'https://redocly.com/docs-legacy/api-reference-docs/specification-extensions/x-logo#x-logo',
152
- description: 'A commonly used specification extension containing the information about the API logo.',
153
92
  };
154
93
  const Contact = {
155
94
  properties: {
156
- name: {
157
- type: 'string',
158
- description: 'The identifying name of the contact person or organization.',
159
- },
160
- url: {
161
- type: 'string',
162
- description: 'The URL pointing to the contact information.',
163
- },
164
- email: {
165
- type: 'string',
166
- description: 'The email address of the contact person or organization.',
167
- },
95
+ name: { type: 'string' },
96
+ url: { type: 'string' },
97
+ email: { type: 'string' },
168
98
  },
169
99
  extensionsPrefix: 'x-',
170
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/contact',
171
- description: 'The contact information for the exposed API.',
172
100
  };
173
101
  const License = {
174
102
  properties: {
175
- name: {
176
- type: 'string',
177
- description: 'REQUIRED. The license name used for the API.',
178
- },
179
- url: {
180
- type: 'string',
181
- description: 'The URL pointing to the contact information.',
182
- },
103
+ name: { type: 'string' },
104
+ url: { type: 'string' },
183
105
  },
184
106
  required: ['name'],
185
107
  extensionsPrefix: 'x-',
186
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/license#license',
187
- description: 'The license information for the exposed API.',
188
108
  };
189
109
  const Paths = {
190
110
  properties: {},
191
111
  additionalProperties: (_value, key) => key.startsWith('/') ? 'PathItem' : undefined,
192
- description: 'The Paths Object is a map of a paths to the path item object. A path starts with a /.',
193
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/paths#paths-object',
194
112
  };
195
113
  const WebhooksMap = {
196
114
  properties: {},
197
115
  additionalProperties: () => 'PathItem',
198
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/webhooks#types',
199
116
  };
200
117
  const PathItem = {
201
118
  properties: {
202
- $ref: {
203
- type: 'string',
204
- description: 'Allows for a referenced definition of this path item. 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.',
205
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/reference',
206
- }, // TODO: verify special $ref handling for Path Item
119
+ $ref: { type: 'string' }, // TODO: verify special $ref handling for Path Item
207
120
  servers: 'ServerList',
208
121
  parameters: 'ParameterList',
209
- summary: {
210
- type: 'string',
211
- description: 'An optional, string summary, intended to apply to all operations in this path.',
212
- },
213
- description: {
214
- type: 'string',
215
- description: 'An optional, string description, intended to apply to all operations in this path.',
216
- },
122
+ summary: { type: 'string' },
123
+ description: { type: 'string' },
217
124
  get: 'Operation',
218
125
  put: 'Operation',
219
126
  post: 'Operation',
@@ -222,49 +129,23 @@ const PathItem = {
222
129
  head: 'Operation',
223
130
  patch: 'Operation',
224
131
  trace: 'Operation',
132
+ 'x-query': 'Operation',
225
133
  },
226
134
  extensionsPrefix: 'x-',
227
- description: 'Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available.',
228
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/path-item#path-item-object',
229
135
  };
230
136
  const Parameter = {
231
137
  properties: {
232
- name: {
233
- type: 'string',
234
- description: 'REQUIRED. The name of the parameter. Parameter names are case sensitive.',
235
- },
236
- in: {
237
- enum: ['query', 'header', 'path', 'cookie'],
238
- description: 'REQUIRED. The location of the parameter. Possible values are "query", "header", "path", or "cookie".',
239
- },
240
- description: {
241
- type: 'string',
242
- description: 'A brief description of the parameter. This could contain examples of use.',
243
- },
244
- required: {
245
- type: 'boolean',
246
- description: 'Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.',
247
- },
248
- deprecated: {
249
- type: 'boolean',
250
- description: 'Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.',
251
- },
252
- allowEmptyValue: {
253
- type: 'boolean',
254
- description: 'Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.',
255
- },
138
+ name: { type: 'string' },
139
+ in: { enum: ['query', 'header', 'path', 'cookie'] },
140
+ description: { type: 'string' },
141
+ required: { type: 'boolean' },
142
+ deprecated: { type: 'boolean' },
143
+ allowEmptyValue: { type: 'boolean' },
256
144
  style: {
257
145
  enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
258
- description: 'Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.',
259
- },
260
- explode: {
261
- type: 'boolean',
262
- description: 'When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.',
263
- },
264
- allowReserved: {
265
- type: 'boolean',
266
- description: `Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.`,
267
146
  },
147
+ explode: { type: 'boolean' },
148
+ allowReserved: { type: 'boolean' },
268
149
  schema: 'Schema',
269
150
  example: { isExample: true },
270
151
  examples: 'ExamplesMap',
@@ -273,32 +154,17 @@ const Parameter = {
273
154
  required: ['name', 'in'],
274
155
  requiredOneOf: ['schema', 'content'],
275
156
  extensionsPrefix: 'x-',
276
- description: 'Describes a request parameter, which excludes the request body. A unique parameter is defined by a unique combination of the name and in values.',
277
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/parameter',
278
157
  };
279
158
  const Operation = {
280
159
  properties: {
281
160
  tags: {
282
161
  type: 'array',
283
162
  items: { type: 'string' },
284
- description: 'A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.',
285
- },
286
- summary: {
287
- type: 'string',
288
- description: 'A short summary of what the operation does.',
289
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/operation#summary',
290
- },
291
- description: {
292
- type: 'string',
293
- description: 'A verbose explanation of the operation behavior.',
294
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/operation#description',
295
163
  },
164
+ summary: { type: 'string' },
165
+ description: { type: 'string' },
296
166
  externalDocs: 'ExternalDocs',
297
- operationId: {
298
- type: 'string',
299
- description: 'The operationId is path segment or path fragment in deep links to a specific operation.',
300
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/operation#operationid',
301
- },
167
+ operationId: { type: 'string' },
302
168
  parameters: 'ParameterList',
303
169
  security: 'SecurityRequirementList',
304
170
  servers: 'ServerList',
@@ -312,8 +178,6 @@ const Operation = {
312
178
  },
313
179
  required: ['responses'],
314
180
  extensionsPrefix: 'x-',
315
- description: `The Operation Object describes a single API operation on a path, including its parameters, responses, and request body (if applicable). Each path can support more than one operation, but those operations must be unique. A unique operation is a combination of a path and an HTTP method, so two GET or two POST methods for the same path are not allowed.`,
316
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/operation',
317
181
  };
318
182
  const XCodeSample = {
319
183
  properties: {
@@ -321,130 +185,76 @@ const XCodeSample = {
321
185
  label: { type: 'string' },
322
186
  source: { type: 'string' },
323
187
  },
324
- documentationLink: 'https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-code-samples',
325
- description: 'Code samples are snippets of code shown alongside API operations in reference documentation, giving users a quick way to start to interact with an API from their own code. The x-codeSamples addition to OpenAPI allows you to add or override any existing code samples for a particular language or endpoint.',
326
188
  };
327
189
  const RequestBody = {
328
190
  properties: {
329
- description: {
330
- type: 'string',
331
- description: 'A brief description of the request body. This could contain examples of use.',
332
- },
333
- required: {
334
- type: 'boolean',
335
- description: 'Determines if the request body is required in the request. Defaults to false.',
336
- },
191
+ description: { type: 'string' },
192
+ required: { type: 'boolean' },
337
193
  content: 'MediaTypesMap',
338
194
  },
339
195
  required: ['content'],
340
196
  extensionsPrefix: 'x-',
341
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/request-body',
342
- description: 'The request body is defined inside of operations (including paths and webhooks). The request body can also be defined inside of the named requestBodies object in components.',
343
197
  };
344
198
  const MediaTypesMap = {
345
199
  properties: {},
346
200
  additionalProperties: 'MediaType',
347
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/media-type#types',
348
201
  };
349
202
  const MediaType = {
350
203
  properties: {
351
204
  schema: 'Schema',
352
- example: {
353
- isExample: true,
354
- description: 'Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.',
355
- },
205
+ example: { isExample: true },
356
206
  examples: 'ExamplesMap',
357
207
  encoding: 'EncodingMap',
358
208
  },
359
209
  extensionsPrefix: 'x-',
360
- description: 'The Media Type Object is one of the important building blocks of OpenAPI.',
361
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/media-type',
362
210
  };
363
211
  const Example = {
364
212
  properties: {
365
- value: {
366
- resolvable: false,
367
- description: 'Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.',
368
- },
213
+ value: { resolvable: false },
369
214
  summary: { type: 'string' },
370
- description: { type: 'string', description: 'Long description for the example.' },
371
- externalValue: {
372
- type: 'string',
373
- description: 'A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.',
374
- },
215
+ description: { type: 'string' },
216
+ externalValue: { type: 'string' },
375
217
  },
376
218
  extensionsPrefix: 'x-',
377
- description: 'Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.',
378
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/example',
379
219
  };
380
220
  const Encoding = {
381
221
  properties: {
382
- contentType: {
383
- type: 'string',
384
- description: `The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types.`,
385
- },
222
+ contentType: { type: 'string' },
386
223
  headers: 'HeadersMap',
387
224
  style: {
388
225
  enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
389
- description: 'Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.',
390
- },
391
- explode: {
392
- type: 'boolean',
393
- description: 'When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.',
394
- },
395
- allowReserved: {
396
- type: 'boolean',
397
- description: `Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986] Section 2.2 :/?#[]@!$&'()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.`,
398
226
  },
227
+ explode: { type: 'boolean' },
228
+ allowReserved: { type: 'boolean' },
399
229
  },
400
230
  extensionsPrefix: 'x-',
401
- description: 'A single encoding definition applied to a single schema property.',
402
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/encoding#types',
403
231
  };
404
232
  const EnumDescriptions = {
405
233
  properties: {},
406
234
  additionalProperties: { type: 'string' },
407
- description: 'The enum (short for "enumeration") fields in OpenAPI allow you to restrict the value of a field to a list of allowed values. These values need to be short and machine-readable, but that can make them harder for humans to parse and work with.',
408
- documentationLink: 'https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-enum-descriptions',
409
235
  };
410
236
  const Header = {
411
237
  properties: {
412
- description: {
413
- type: 'string',
414
- description: 'A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.',
415
- },
416
- required: {
417
- type: 'boolean',
418
- description: 'Determines whether this parameter is mandatory. Its default value is false.',
419
- },
238
+ description: { type: 'string' },
239
+ required: { type: 'boolean' },
420
240
  deprecated: { type: 'boolean' },
421
- allowEmptyValue: {
422
- type: 'boolean',
423
- description: 'Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.',
424
- },
241
+ allowEmptyValue: { type: 'boolean' },
425
242
  style: {
426
243
  enum: ['form', 'simple', 'label', 'matrix', 'spaceDelimited', 'pipeDelimited', 'deepObject'],
427
244
  },
428
245
  explode: { type: 'boolean' },
429
246
  allowReserved: { type: 'boolean' },
430
247
  schema: 'Schema',
431
- example: {
432
- isExample: true,
433
- description: `Example of the header's potential value. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema that contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.`,
434
- },
248
+ example: { isExample: true },
435
249
  examples: 'ExamplesMap',
436
250
  content: 'MediaTypesMap',
437
251
  },
438
252
  requiredOneOf: ['schema', 'content'],
439
253
  extensionsPrefix: 'x-',
440
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/header#header-object',
441
- description: 'The header object is used to describe a response header in the headers map.',
442
254
  };
443
255
  const Responses = {
444
256
  properties: { default: 'Response' },
445
257
  additionalProperties: (_v, key) => responseCodeRegexp.test(key) ? 'Response' : undefined,
446
- description: 'The list of possible responses as they are returned from executing this operation.',
447
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/named-responses',
448
258
  };
449
259
  const Response = {
450
260
  properties: {
@@ -452,45 +262,28 @@ const Response = {
452
262
  headers: 'HeadersMap',
453
263
  content: 'MediaTypesMap',
454
264
  links: 'LinksMap',
455
- 'x-summary': {
456
- type: 'string',
457
- documentationLink: 'https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-summary#openapi-extension-x-summary',
458
- description: 'Use x-summary to add a short custom text to describe the response in the API documentation.',
459
- },
265
+ 'x-summary': { type: 'string' },
460
266
  },
461
267
  required: ['description'],
462
268
  extensionsPrefix: 'x-',
463
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/response',
464
- description: 'The response object describes a single response in the Responses Map.',
465
269
  };
466
270
  const Link = {
467
271
  properties: {
468
- operationRef: {
469
- type: 'string',
470
- description: 'A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.',
471
- },
472
- operationId: {
473
- type: 'string',
474
- description: 'The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.',
475
- },
272
+ operationRef: { type: 'string' },
273
+ operationId: { type: 'string' },
476
274
  parameters: null, // TODO: figure out how to describe/validate this
477
275
  requestBody: null, // TODO: figure out how to describe/validate this
478
- description: { type: 'string', description: 'A description of the link.' },
276
+ description: { type: 'string' },
479
277
  server: 'Server',
480
278
  },
481
279
  extensionsPrefix: 'x-',
482
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/links',
483
- description: 'The Link object represents a possible design-time link for a response. The presence of a link does not guarantee the caller’s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.',
484
280
  };
485
281
  // draft-00
486
282
  const Schema = {
487
283
  properties: {
488
284
  externalDocs: 'ExternalDocs',
489
285
  discriminator: 'Discriminator',
490
- title: {
491
- type: 'string',
492
- description: 'Value MUST be a string. Multiple types via an array are not supported.',
493
- },
286
+ title: { type: 'string' },
494
287
  multipleOf: { type: 'number', minimum: 0 },
495
288
  maximum: { type: 'number' },
496
289
  minimum: { type: 'number' },
@@ -498,10 +291,7 @@ const Schema = {
498
291
  exclusiveMinimum: { type: 'boolean' },
499
292
  maxLength: { type: 'integer', minimum: 0 },
500
293
  minLength: { type: 'integer', minimum: 0 },
501
- pattern: {
502
- type: 'string',
503
- description: '(This string SHOULD be a valid regular expression, according to the Ecma-262 Edition 5.1 regular expression dialect)',
504
- },
294
+ pattern: { type: 'string' },
505
295
  maxItems: { type: 'integer', minimum: 0 },
506
296
  minItems: { type: 'integer', minimum: 0 },
507
297
  uniqueItems: { type: 'boolean' },
@@ -511,17 +301,10 @@ const Schema = {
511
301
  enum: { type: 'array' },
512
302
  type: {
513
303
  enum: ['object', 'array', 'string', 'number', 'integer', 'boolean'],
514
- description: 'Value MUST be a string. Multiple types via an array are not supported.',
515
304
  },
516
- allOf: listOf('Schema', {
517
- description: 'Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.',
518
- }),
519
- anyOf: listOf('Schema', {
520
- description: 'Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.',
521
- }),
522
- oneOf: listOf('Schema', {
523
- description: 'Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.',
524
- }),
305
+ allOf: listOf('Schema'),
306
+ anyOf: listOf('Schema'),
307
+ oneOf: listOf('Schema'),
525
308
  not: 'Schema',
526
309
  properties: 'SchemaProperties',
527
310
  items: (value) => {
@@ -540,14 +323,8 @@ const Schema = {
540
323
  return 'Schema';
541
324
  }
542
325
  },
543
- description: {
544
- type: 'string',
545
- description: 'CommonMark syntax MAY be used for rich text representation.',
546
- },
547
- format: {
548
- type: 'string',
549
- description: `See Data Type Formats for further details. While relying on JSON Schema's defined formats, the OAS offers a few additional predefined formats.`,
550
- },
326
+ description: { type: 'string' },
327
+ format: { type: 'string' },
551
328
  default: null,
552
329
  nullable: { type: 'boolean' },
553
330
  readOnly: { type: 'boolean' },
@@ -560,8 +337,6 @@ const Schema = {
560
337
  'x-explicitMappingOnly': { type: 'boolean' },
561
338
  },
562
339
  extensionsPrefix: 'x-',
563
- description: 'The schema defining the content of the request, response, or parameter.',
564
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/schemas',
565
340
  };
566
341
  const Xml = {
567
342
  properties: {
@@ -572,7 +347,6 @@ const Xml = {
572
347
  wrapped: { type: 'boolean' },
573
348
  },
574
349
  extensionsPrefix: 'x-',
575
- description: 'This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.',
576
350
  };
577
351
  const SchemaProperties = {
578
352
  properties: {},
@@ -588,20 +362,14 @@ const DiscriminatorMapping = {
588
362
  return { type: 'string' };
589
363
  }
590
364
  },
591
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/discriminator#types',
592
365
  };
593
366
  const Discriminator = {
594
367
  properties: {
595
- propertyName: {
596
- type: 'string',
597
- description: 'REQUIRED. The name of the property in the payload that will hold the discriminator value.',
598
- },
368
+ propertyName: { type: 'string' },
599
369
  mapping: 'DiscriminatorMapping',
600
370
  },
601
371
  required: ['propertyName'],
602
372
  extensionsPrefix: 'x-',
603
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/discriminator#discriminator-object',
604
- description: 'When request bodies or response payloads may be one of a number of different schemas, a discriminator object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated with it.',
605
373
  };
606
374
  const Components = {
607
375
  properties: {
@@ -616,7 +384,6 @@ const Components = {
616
384
  callbacks: 'NamedCallbacks',
617
385
  },
618
386
  extensionsPrefix: 'x-',
619
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/components#components',
620
387
  };
621
388
  const ImplicitFlow = {
622
389
  properties: {
@@ -626,7 +393,6 @@ const ImplicitFlow = {
626
393
  },
627
394
  required: ['authorizationUrl', 'scopes'],
628
395
  extensionsPrefix: 'x-',
629
- description: 'Configuration for the OAuth Implicit flow.',
630
396
  };
631
397
  const PasswordFlow = {
632
398
  properties: {
@@ -636,7 +402,6 @@ const PasswordFlow = {
636
402
  },
637
403
  required: ['tokenUrl', 'scopes'],
638
404
  extensionsPrefix: 'x-',
639
- description: 'Object Configuration for the OAuth Resource Owner Password flow.',
640
405
  };
641
406
  const ClientCredentials = {
642
407
  properties: {
@@ -646,7 +411,6 @@ const ClientCredentials = {
646
411
  },
647
412
  required: ['tokenUrl', 'scopes'],
648
413
  extensionsPrefix: 'x-',
649
- description: 'Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.',
650
414
  };
651
415
  const AuthorizationCode = {
652
416
  properties: {
@@ -665,7 +429,6 @@ const AuthorizationCode = {
665
429
  },
666
430
  required: ['authorizationUrl', 'tokenUrl', 'scopes'],
667
431
  extensionsPrefix: 'x-',
668
- description: 'Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.',
669
432
  };
670
433
  const OAuth2Flows = {
671
434
  properties: {
@@ -675,40 +438,17 @@ const OAuth2Flows = {
675
438
  authorizationCode: 'AuthorizationCode',
676
439
  },
677
440
  extensionsPrefix: 'x-',
678
- description: 'Configuration details for a supported OAuth Flow.',
679
441
  };
680
442
  const SecurityScheme = {
681
443
  properties: {
682
- type: {
683
- enum: ['apiKey', 'http', 'oauth2', 'openIdConnect'],
684
- description: 'REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".',
685
- },
686
- description: {
687
- type: 'string',
688
- description: 'A short description for security scheme.',
689
- },
690
- name: {
691
- type: 'string',
692
- description: 'REQUIRED. The name of the header, query or cookie parameter to be used.',
693
- },
694
- in: {
695
- type: 'string',
696
- enum: ['query', 'header', 'cookie'],
697
- description: 'REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".',
698
- },
699
- scheme: {
700
- type: 'string',
701
- description: 'A short description for security scheme.',
702
- },
703
- bearerFormat: {
704
- type: 'string',
705
- description: 'A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.',
706
- },
444
+ type: { enum: ['apiKey', 'http', 'oauth2', 'openIdConnect'] },
445
+ description: { type: 'string' },
446
+ name: { type: 'string' },
447
+ in: { type: 'string', enum: ['query', 'header', 'cookie'] },
448
+ scheme: { type: 'string' },
449
+ bearerFormat: { type: 'string' },
707
450
  flows: 'OAuth2Flows',
708
- openIdConnectUrl: {
709
- type: 'string',
710
- description: 'REQUIRED. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.',
711
- },
451
+ openIdConnectUrl: { type: 'string' },
712
452
  'x-defaultClientId': { type: 'string' },
713
453
  },
714
454
  required(value) {
@@ -746,28 +486,18 @@ const XUsePkce = {
746
486
  disableManualConfiguration: { type: 'boolean' },
747
487
  hideClientSecretInput: { type: 'boolean' },
748
488
  },
749
- description: 'The x-usePkce allows you to enable Proof Key for Code Exchange (PKCE) for the Oauth2 or OpenID Connect authorization code flow in the Replay.',
750
- documentationLink: 'https://redocly.com/docs/realm/content/api-docs/openapi-extensions/x-use-pkce#openapi-extension-x-usepkce',
751
489
  };
752
490
  export const Oas3Types = {
753
491
  Root,
754
492
  Tag,
755
- TagList: listOf('Tag', {
756
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/tags',
757
- description: `A list of tags used by the document with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.`,
758
- }),
493
+ TagList: listOf('Tag'),
759
494
  TagGroups: listOf('TagGroup'),
760
495
  TagGroup,
761
496
  ExternalDocs,
762
497
  Server,
763
- ServerList: listOf('Server', {
764
- description: 'A list of servers available to the API.',
765
- documentationLink: 'https://redocly.com/learn/openapi/openapi-visual-reference/servers#servers',
766
- }),
498
+ ServerList: listOf('Server'),
767
499
  ServerVariable,
768
- ServerVariablesMap: mapOf('ServerVariable', {
769
- description: `A map between a variable name and its value. The value is used for substitution in the server's URL template.`,
770
- }),
500
+ ServerVariablesMap: mapOf('ServerVariable'),
771
501
  SecurityRequirement,
772
502
  SecurityRequirementList: listOf('SecurityRequirement'),
773
503
  Info,
@@ -776,13 +506,9 @@ export const Oas3Types = {
776
506
  Paths,
777
507
  PathItem,
778
508
  Parameter,
779
- ParameterList: listOf('Parameter', {
780
- description: '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 at the OpenAPI Object’s components/parameters.',
781
- }),
509
+ ParameterList: listOf('Parameter'),
782
510
  Operation,
783
- Callback: mapOf('PathItem', {
784
- description: 'https://redocly.com/learn/openapi/openapi-visual-reference/callbacks#callback-object',
785
- }),
511
+ Callback: mapOf('PathItem'),
786
512
  CallbacksMap: mapOf('Callback'),
787
513
  RequestBody,
788
514
  MediaTypesMap,