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
Copy file name to clipboardExpand all lines: versions/3.0.md
+9-1Lines changed: 9 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,7 @@ Additional utilities can also take advantage of the resulting files, such as tes
26
26
- [Format](#format)
27
27
- [File Structure](#file-structure)
28
28
- [Data Types](#data-types)
29
+
-[Relative References In Urls](#relativeReferences)
29
30
- [Schema](#schema)
30
31
- [OpenAPI Object](#openapi-object)
31
32
- [Info Object](#info-object)
@@ -167,6 +168,13 @@ date | `string` | `date` | As defined by `full-date` - [RFC3339](http://xml2rfc.
167
168
dateTime | `string` | `date-time` | As defined by `date-time` - [RFC3339](http://xml2rfc.ietf.org/public/rfc/html/rfc3339.html#anchor14)
168
169
password | `string` | `password` | Used to hint UIs the input needs to be obscured.
169
170
171
+
### <aname="relativeReferences"></a>Relative References In URLs
172
+
173
+
Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [RFC 3986](https://tools.ietf.org/html/rfc3986#section-4.2).
174
+
Relative references are resolved using the URLs defined in the [Servers array](#servers) as a Base URI.
175
+
176
+
Relative references used in $ref are processed as per [JSON Reference](https://tools.ietf.org/html/draft-pbryan-zyp-json-ref-03), i.e. using the URL of the current document as the base URI.
177
+
170
178
### Schema
171
179
172
180
#### <aname="oasObject"></a>OpenAPI Object
@@ -315,7 +323,7 @@ An object representing a Server.
315
323
316
324
Field Name | Type | Description
317
325
---|:---:|---
318
-
<a name="serverUrlTemplate"></a>url | `string` | A URL to the target host. This URL supports template variables and may be relative, to indicate that the host ___location is relative to the ___location where the OpenAPI Specification is being served. Templates are _optional_ and specified by the [Host Template Parameter](#hostTemplateParameter) syntax. Template substitutions will be made when a variable is named in `{`brackets`}`.
326
+
<a name="serverUrlTemplate"></a>url | `string` | A absolute URL to the target host. This URL supports template variables and may be relative, to indicate that the host ___location is relative to the ___location where the OpenAPI Specification is being served. Templates are _optional_ and specified by the [Host Template Parameter](#hostTemplateParameter) syntax. Template substitutions will be made when a variable is named in `{`brackets`}`.
319
327
<a name="hostDescription"></a>description | `string` | An optional string describing the host designated by the URL.
320
328
<a name="hostTemplates"></a>templates | [Templates Object](#hostTemplatesObject) | An object holding templates for substitution in the URL template
0 commit comments