Skip to content

Commit b9a852e

Browse files
committed
Markdown links are API Description, not API URLs
While the Markdown links don't behave quite like either category, they definitely belong more in the "API Description URIs" part as the text even compares their behavior to "the context of the API description" rather than the actual API's server URL.
1 parent 62948f1 commit b9a852e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

versions/3.1.1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -294,15 +294,15 @@ In practice, this is usually the retrieval URI of the document, which MAY be det
294294

295295
If a URI contains a fragment identifier, then the fragment should be resolved per the fragment resolution mechanism of the referenced document. If the representation of the referenced document is JSON or YAML, then the fragment identifier SHOULD be interpreted as a JSON-Pointer as per [RFC6901](https://tools.ietf.org/html/rfc6901).
296296

297+
Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description.
298+
297299
### Relative References in API URLs
298300

299301
API endpoints are by definition accessed as locations, and are described by this specification as **_URLs_**.
300302

301303
Unless specified otherwise, all fields that are URLs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
302304
Unless specified otherwise, relative references are resolved using the URLs defined in the [Server Object](#server-object) as a Base URL. Note that these themselves MAY be relative to the referring document.
303305

304-
Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description.
305-
306306
### Schema
307307

308308
This section describes the structure of the OpenAPI Description format.

0 commit comments

Comments
 (0)