Skip to content

feat(docs): add Overlay example #41

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
jeremyfiel wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(docs): add Overlay example #41

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
13 changes: 13 additions & 0 deletions overlay/museum-api.overlay.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
overlay: 1.0.0
info:
title: Sample Overlay Configuration
version: 1.0.0
description: "This is a sample Overlay definition to modify the Musuem api"
extends: openapi.yaml
actions:
- target: $.info.description
update: >-
"This description comes from the Overlay"
- target: $.paths['/museum-hours']
descript: "not a valid field(misspelled)"
remove: true