Skip to content

Commit 4a1b95e

Browse files
authored
Merge pull request #3969 from ralfhandl/3.1.1/formatting
3.1.1 formatting improvements
2 parents ef319b2 + 01b0745 commit 4a1b95e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

versions/3.1.1.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,8 @@ Using a `contentEncoding` of `base64url` ensures that URL encoding (as required
287287

288288
The `contentMediaType` keyword is redundant if the media type is already set:
289289

290-
* as the key for a [`MediaType Object`](#mediaTypeObject)
291-
* in the `contentType` field of an [`Encoding Object`](#encodingObject)
290+
* as the key for a [MediaType Object](#mediaTypeObject)
291+
* in the `contentType` field of an [Encoding Object](#encodingObject)
292292

293293
If the Schema Object will be processed by a non-OAS-aware JSON Schema implementation, it may be useful to include `contentMediaType` even if it is redundant. However, if `contentMediaType` contradicts a relevant Media Type Object or Encoding Object, then `contentMediaType` SHALL be ignored.
294294

@@ -321,7 +321,7 @@ Note that some URI fields are named `url` for historical reasons, but the descri
321321

322322
Unless specified otherwise, all properties that are URIs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
323323

324-
Relative references in [`Schema Objects`](#schemaObject), including any that appear as `$id` values, use the nearest parent `$id` as a Base URI, as described by [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-8.2).
324+
Relative references in [Schema Objects](#schemaObject), including any that appear as `$id` values, use the nearest parent `$id` as a Base URI, as described by [JSON Schema Specification Draft 2020-12](https://tools.ietf.org/html/draft-bhutton-json-schema-00#section-8.2).
325325

326326
Relative URI references in other Objects, and in Schema Objects where no parent schema contains an `$id`, MUST be resolved using the referring document's base URI, which is determined in accordance with [RFC3986 §5.1.2 – 5.1.4](https://tools.ietf.org/html/rfc3986#section-5.1.2).
327327
In practice, this is usually the retrieval URI of the document, which MAY be determined based on either its current actual location or a user-supplied expected location.
@@ -333,15 +333,15 @@ If a URI contains a fragment identifier, then the fragment should be resolved pe
333333
API endpoints are by definition accessed as locations, and are described by this specification as ***URLs***.
334334

335335
Unless specified otherwise, all properties that are URLs MAY be relative references as defined by [RFC3986](https://tools.ietf.org/html/rfc3986#section-4.2).
336-
Unless specified otherwise, relative references are resolved using the URLs defined in the [`Server Object`](#serverObject) as a Base URL. Note that these themselves MAY be relative to the referring document.
336+
Unless specified otherwise, relative references are resolved using the URLs defined in the [Server Object](#serverObject) as a Base URL. Note that these themselves MAY be relative to the referring document.
337337

338338
Relative references in CommonMark hyperlinks are resolved in their rendered context, which might differ from the context of the API description.
339339

340340
### Schema
341341

342342
This section describes the structure of the OpenAPI Description format.
343343
This text is the only normative description of the format.
344-
A JSON Schema is hosted on [spec.openapis.org](https://spec.openapis.org) for informational purposes.
344+
A JSON Schema is hosted on [`spec.openapis.org`](https://spec.openapis.org) for informational purposes.
345345
If the JSON Schema differs from this section, then this section MUST be considered authoritative.
346346

347347
In the following description, if a field is not explicitly **REQUIRED** or described with a MUST or SHALL, it can be considered OPTIONAL.
@@ -2709,7 +2709,7 @@ Field Name | Type | Description
27092709

27102710
This object cannot be extended with additional properties and any properties added SHALL be ignored.
27112711

2712-
Note that this restriction on additional properties is a difference between Reference Objects and [`Schema Objects`](#schemaObject) that contain a `$ref` keyword.
2712+
Note that this restriction on additional properties is a difference between Reference Objects and [Schema Objects](#schemaObject) that contain a `$ref` keyword.
27132713

27142714
##### Reference Object Example
27152715

0 commit comments

Comments
 (0)