From b9a852e7d2b2479be296d6391cb2778145f63441 Mon Sep 17 00:00:00 2001 From: "Henry H. Andrews" Date: Mon, 9 Sep 2024 19:31:57 -0700 Subject: [PATCH] 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. --- versions/3.1.1.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/versions/3.1.1.md b/versions/3.1.1.md index c91c8a9e35..28cf2fb18d 100644 --- a/versions/3.1.1.md +++ b/versions/3.1.1.md @@ -294,6 +294,8 @@ In practice, this is usually the retrieval URI of the document, which MAY be det 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). +Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description. + ### Relative References in API URLs API endpoints are by definition accessed as locations, and are described by this specification as **_URLs_**. @@ -301,8 +303,6 @@ API endpoints are by definition accessed as locations, and are described by this 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). 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. -Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description. - ### Schema This section describes the structure of the OpenAPI Description format.