Skip to content

update examples to use latest versions of the overlay and openapi specifications #290

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

Open
karenetheridge wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −15
Open

update examples to use latest versions of the overlay and openapi specifications #290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions versions/1.2.0-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The `extends` property can be used to indicate that the Overlay was designed to
In the following example the `extends` property specifies that the overlay is designed to update the OpenAPI Tic Tac Toe example document, identified by an absolute URI.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Overlay for the Tic Tac Toe API document
version: 1.0.0
Expand All @@ -106,7 +106,7 @@ extends: 'https://raw.githubusercontent.com/OAI/learn.openapis.org/refs/heads/ma
The `extends` property can also specify a relative URI reference.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Overlay for the Tic Tac Toe API document
version: 1.0.0
Expand Down Expand Up @@ -164,7 +164,7 @@ This object MAY be extended with [Specification Extensions](#specification-exten
When updating properties throughout the target document it may be more efficient to create a single `Action Object` that mirrors the structure of the target document. e.g.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Structured Overlay
version: 1.0.0
Expand Down Expand Up @@ -213,7 +213,7 @@ actions:
One significant advantage of using the JSONPath syntax is that it allows referencing multiple nodes in the target document. This would allow a single update object to be applied to multiple target objects using wildcards and other multi-value selectors.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Update many objects at once
version: 1.0.0
Expand All @@ -232,7 +232,7 @@ actions:
Array elements can be added using the `update` action.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Add an array element
version: 1.0.0
Expand All @@ -246,7 +246,7 @@ actions:
Array elements can be deleted using the `remove` action. Use of array indexes to remove array items should be avoided where possible as indexes will change when items are removed.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Remove an array element
version: 1.0.0
Expand All @@ -272,7 +272,7 @@ actions:
By annotating a target document (such as an [[OpenAPI]] document) using [Specification Extensions](#specification-extensions) such as `x-oai-traits`, the author of the target document MAY identify where overlay updates should be applied.

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: API with a paged collection
version: 1.0.0
Expand Down Expand Up @@ -303,7 +303,7 @@ paths:
With the above OpenAPI document, the following Overlay document will apply the necessary updates to describe how paging is implemented, where that trait has been applied.

```yaml
overlay: 1.0.0
overlay: 1.2.0
info:
title: Apply Traits
version: 1.0.0
Expand All @@ -322,7 +322,7 @@ actions:
resulting in

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: API with a paged collection
version: 1.0.0
Expand Down Expand Up @@ -376,7 +376,7 @@ This example shows how to copy all operations from the `items` path item to the
###### Source Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down Expand Up @@ -409,7 +409,7 @@ actions:
###### Result Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down Expand Up @@ -437,7 +437,7 @@ This example shows how to copy all operations from the `items` path item to the
###### Source Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down Expand Up @@ -472,7 +472,7 @@ actions:
###### Result Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down Expand Up @@ -505,7 +505,7 @@ This example shows how to rename the `items` path item to `new-items` using a se
###### Source Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down Expand Up @@ -542,7 +542,7 @@ actions:
###### Result Description

```yaml
openapi: 3.1.0
openapi: 3.2.0
info:
title: Example API
version: 1.0.0
Expand Down