You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
'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
25
};
23
26
24
27
constTag: NodeType={
25
28
properties: {
26
29
name: {
27
30
type: 'string',
28
-
description: `The name of the tag.`,
31
+
description: 'REQUIRED. The name of the tag.',
29
32
},
30
33
description: {
31
34
type: 'string',
32
-
description: `A short description for the tag. CommonMark syntax MAY be used for rich text representation.`,
'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
+
},
74
84
variables: 'ServerVariablesMap',
75
85
},
76
86
required: ['url'],
77
87
extensionsPrefix: 'x-',
88
+
description: 'A server object to be used by the target operation.',
78
89
};
79
90
80
91
constServerVariable: NodeType={
81
92
properties: {
82
93
enum: {
83
94
type: 'array',
84
95
items: {type: 'string'},
96
+
description:
97
+
'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.',
98
+
},
99
+
default: {
100
+
type: 'string',
101
+
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.`,
102
+
},
103
+
description: {
104
+
type: 'string',
105
+
description: 'An optional description for the server variable.',
'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.',
96
122
};
97
123
98
124
constInfo: NodeType={
99
125
properties: {
100
-
title: {type: 'string'},
101
-
version: {type: 'string'},
102
-
description: {type: 'string'},
103
-
termsOfService: {type: 'string'},
126
+
title: {
127
+
type: 'string',
128
+
description: 'REQUIRED. The title of the API.',
129
+
},
130
+
version: {
131
+
type: 'string',
132
+
description:
133
+
'REQUIRED. The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).',
134
+
},
135
+
description: {
136
+
type: 'string',
137
+
description: 'RECOMMENDED. A description of the API (Markdown may be used).',
138
+
},
139
+
termsOfService: {
140
+
type: 'string',
141
+
description: 'A URL to the Terms of Service for the API.',
142
+
},
104
143
contact: 'Contact',
105
144
license: 'License',
106
145
'x-logo': 'Logo',
107
146
},
108
147
required: ['title','version'],
109
148
extensionsPrefix: 'x-',
149
+
description:
150
+
'REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.',
'The request body applicable for this operation. The requestBody is fully supported in HTTP methods where the HTTP 1.1 specification [RFC7231] Section 4.3.1 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague (such as GET, HEAD and DELETE), requestBody is permitted but does not have well-defined semantics and SHOULD be avoided if possible.',
381
+
'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.',
311
382
};
312
383
313
384
constMediaTypesMap: NodeType={
@@ -323,6 +394,8 @@ const MediaType: NodeType = {
323
394
encoding: 'EncodingMap',
324
395
},
325
396
extensionsPrefix: 'x-',
397
+
description: 'The Media Type Object is one of the important building blocks of OpenAPI.',
'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.',
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.`,
630
709
}),
631
710
TagGroups: listOf('TagGroup'),
632
711
TagGroup,
633
712
ExternalDocs,
634
713
Server,
635
-
ServerList: listOf('Server'),
714
+
ServerList: listOf('Server',{
715
+
description: 'A list of servers available to the API.',
0 commit comments