Skip to content

Commit 0e3fc04

Browse files
authored
Merge pull request #62 from ralfhandl/1.0.0-minor-nits
Minor nits
2 parents 379f384 + de2b9ff commit 0e3fc04

File tree

1 file changed

+4
-8
lines changed

1 file changed

+4
-8
lines changed

versions/1.0.0.md

+4-8
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@ In order to preserve the ability to round-trip between YAML and JSON formats, [[
4242
- Tags MUST be limited to those allowed by the [JSON Schema ruleset](https://yaml.org/spec/1.2/spec.html#id2803231).
4343
- Keys used in YAML maps MUST be limited to a scalar string, as defined by the [YAML Failsafe schema ruleset](https://yaml.org/spec/1.2/spec.html#id2802346).
4444

45-
### Document Structure
46-
47-
It is RECOMMENDED that the root Overlay document be named: `overlay.json` or `overlay.yaml`.
48-
4945
### Relative References in URLs
5046

5147
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).
@@ -70,9 +66,9 @@ This is the root object of the [Overlay](#overlay).
7066

7167
This object MAY be extended with [Specification Extensions](#specification-extensions).
7268

73-
The list of actions MUST be applied in sequential order to ensure a consistent outcome. Actions are applied to the result of the previous updates. This enables objects to be deleted in one update and then re-created in a subsequent update, for example.
69+
The list of actions MUST be applied in sequential order to ensure a consistent outcome. Actions are applied to the result of the previous action. This enables objects to be deleted in one action and then re-created in a subsequent action, for example.
7470

75-
The `extends` property can be used to indicate that the Overlay was designed to update a specific [[OpenAPI]] document. Where no `extends` is provided it is the responsibility of tooling to apply the Overlay documents to the appropriate OpenAPI document(s).
71+
The `extends` property can be used to indicate that the Overlay was designed to update a specific [[OpenAPI]] document. Where no `extends` is provided it is the responsibility of tooling to apply the Overlay document to the appropriate OpenAPI document(s).
7672

7773
#### Info Object
7874

@@ -107,7 +103,7 @@ To update a primitive property value such as a string, the `target` expression s
107103

108104
Primitive-valued items of an array cannot be replaced or removed individually, only the complete array can be replaced.
109105

110-
The properties of the update object MUST be compatible with the target object referenced by the JSONPath key. When the Overlay document is applied, the properties in the merge object replace properties in the target object with the same name and new properties are appended to the target object.
106+
The properties of the `update` object MUST be compatible with the target object referenced by the JSONPath key. When the Overlay document is applied, the properties in the `update` object replace properties in the target object with the same name and new properties are appended to the target object.
111107

112108
This object MAY be extended with [Specification Extensions](#specification-extensions).
113109

@@ -209,7 +205,7 @@ actions:
209205
remove: true
210206
```
211207

212-
#### Traits Examples
208+
#### Traits Example
213209

214210
By annotating a target document (such as an [[OpenAPI]] document) using specification extensions such as `x-oai-traits`, the author of the target document MAY identify where overlay updates should be applied.
215211

0 commit comments

Comments
 (0)