diff --git a/versions/1.0.0.md b/versions/1.0.0.md index 67aa6c0..505cb1a 100644 --- a/versions/1.0.0.md +++ b/versions/1.0.0.md @@ -74,6 +74,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.