Skip to content

Register x-oai-traits #25

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

Register x-oai-traits #25

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion _includes/extension-entry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
### Schema

```yaml
{{page.schema}}
{{page.schema|jsonify}}
```

### Example
Expand Down
22 changes: 22 additions & 0 deletions registries/_extension/x-oai-traits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
owner: ralfhandl
issue:
description: Identify in an OpenAPI Description where Overlay updates should be applied.
schema:
type: array
items:
type: string
layout: default
---

{% capture summary %}
The `x-oai-traits` extension is used identify places in an OpenAPI Description where Overlay updates should be applied. Its value is an array of strings, each string identifying a feature that an Overlay should apply.
{% endcapture %}

{% capture example %}
See:

* [Traits Example in Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html#traits-example)
{% endcapture %}

{% include extension-entry.md summary=summary example=example %}