Skip to content

Commit c25bb01

Browse files
committed
Add example of extends property
1 parent 0e3fc04 commit c25bb01

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

versions/1.0.0.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ The list of actions MUST be applied in sequential order to ensure a consistent o
7070

7171
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).
7272

73+
In the following example the `extends` property specifies that the overlay is designed to update the Redocly Museum OpenAPI document.
74+
75+
```yaml
76+
overlay: 1.0.0
77+
info:
78+
title: Overlay for the Redocly Museum API
79+
version: 1.0.0
80+
extends: 'https://raw.githubusercontent.com/Redocly/museum-openapi-example/refs/heads/main/openapi.yaml'
81+
...
82+
```
83+
7384
#### Info Object
7485

7586
The object provides metadata about the Overlay.

0 commit comments

Comments
 (0)