Skip to content

Commit ccfd62e

Browse files
lornajaneralfhandl
andauthored
Apply suggestions from code review
Co-authored-by: Ralf Handl <[email protected]>
1 parent bcc188f commit ccfd62e

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

overlay/example-add-filter-parameters.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ actions:
3838
- x-filters-added
3939
```
4040
41-
You can adjust the target expression to apply only to certain paths or methods, or use another approach to identify which operations should be used.
41+
You can adjust the target expression to apply only to certain paths or methods, or use another approach to identify which operations should be updated.
4242
4343
It might be more elegant to first update the `components.parameters` section of an OpenAPI description to add the parameters there, and then refer to those new entries when updating the existing operations.
4444
The Overlay Specification requires that each action is processed in the order it is seen in the Overlay document.

overlay/example-add-license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ has_toc: false
1111
Every API needs a license so people know they can use it, but what if your OpenAPI descriptions don't have a license?
1212
This example shows an Overlay that adds a license to an OpenAPI description.
1313

14-
Here's here's the overlay file, with just one action to add or change the `info.license` fields:
14+
Here's the Overlay file, with just one action to add or change the `info.license` fields:
1515

1616
```yaml
1717
overlay: 1.0.0

overlay/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ has_toc: false
99
# Introduction to OpenAPI Overlay Specification
1010

1111
The [Overlay Specification](https://spec.openapis.org/overlay/latest.html) defines a document format for information that transforms an existing OpenAPI description yet remains separate from the OpenAPI description's source document(s).
12-
The goal of the Overlay Specification is to provide a mechanism for providing consistent, deterministic updates to a given OpenAPI description, as an aid to automation throughout the API lifecycle.
12+
The Overlay Specification defines a mechanism for providing consistent, deterministic updates to a given OpenAPI description, as an aid to automation throughout the API lifecycle.
1313

1414
An Overlay can be applied to an OpenAPI description, resulting in an updated OpenAPI description.
1515

0 commit comments

Comments
 (0)