Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add example of extends property #67

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Add example of extends property #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c25bb01
Add example of extends property
mikekistler Oct 8, 2024
c56b7e4
Add extends example with relative URL
mikekistler Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions versions/1.0.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,27 @@ The list of actions MUST be applied in sequential order to ensure a consistent o

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

In the following example the `extends` property specifies that the overlay is designed to update the OpenAPI Tic Tac Toe example document using an absolute URL.

```yaml
overlay: 1.0.0
info:
title: Overlay for the Tic Tac Toe API document
version: 1.0.0
extends: 'https://raw.githubusercontent.com/OAI/learn.openapis.org/refs/heads/main/examples/v3.1/tictactoe.yaml'
...
```

The `extends` property can also specify a relative URL. In this case, the URL is resolved relative to the location of the Overlay document.

```yaml
overlay: 1.0.0
info:
title: Overlay for the Tic Tac Toe API document
version: 1.0.0
extends: './tictactoe.yaml'
```

#### Info Object

The object provides metadata about the Overlay.
Expand Down