From 2389c8ca7fe59c26e5a7d4a49f7c691e26fac55f Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Mon, 5 Aug 2024 18:02:06 +0200 Subject: [PATCH 1/2] Improved request-response example and one more nit --- versions/3.1.1.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/versions/3.1.1.md b/versions/3.1.1.md index 2cd4b69f8e..9bf3823dec 100644 --- a/versions/3.1.1.md +++ b/versions/3.1.1.md @@ -2100,17 +2100,21 @@ For example, given the following HTTP request: POST /subscribe/myevent?queryUrl=https://clientdomain.com/stillrunning HTTP/1.1 Host: example.org Content-Type: application/json -Content-Length: 187 +Content-Length: 188 { - "failedUrl" : "https://clientdomain.com/failed", - "successUrls" : [ + "failedUrl": "https://clientdomain.com/failed", + "successUrls": [ "https://clientdomain.com/fast", "https://clientdomain.com/medium", "https://clientdomain.com/slow" ] } +``` + +resulting in: +```http 201 Created Location: https://example.org/subscription/1 ``` @@ -3149,7 +3153,7 @@ components: $id: fully_generic_array type: array items: - $dynamicRef: "#generic-array" + $dynamicRef: '#generic-array' $defs: allowAll: $dynamicAnchor: generic-array From 1a324337587a62877c149b48fd570dded03b6bcf Mon Sep 17 00:00:00 2001 From: Ralf Handl Date: Mon, 5 Aug 2024 18:10:04 +0200 Subject: [PATCH 2/2] Inconsistent monospace --- versions/3.1.1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/versions/3.1.1.md b/versions/3.1.1.md index 9bf3823dec..d146824046 100644 --- a/versions/3.1.1.md +++ b/versions/3.1.1.md @@ -294,7 +294,7 @@ Relative references in CommonMark hyperlinks are resolved in their rendered cont This section describes the structure of the OpenAPI Description format. This text is the only normative description of the format. -A JSON Schema is hosted on [`spec.openapis.org`](https://spec.openapis.org) for informational purposes. +A JSON Schema is hosted on [spec.openapis.org](https://spec.openapis.org) for informational purposes. If the JSON Schema differs from this section, then this section MUST be considered authoritative. In the following description, if a field is not explicitly **REQUIRED** or described with a MUST or SHALL, it can be considered OPTIONAL.