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 property / components object #8

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add example property / components object #8

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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Once the SEMOASA format gets some traction and achieves a level of stability, we
* **name** - name
* **(other)** - other properties, TBD
* **schema** (type: Schema Object or reference) - an OAS 3.0-compliant Schema Object describing the expected value of the extension property. May be specified inline, or may be a JSON reference thereto.
* **example** (type: any or reference) - an example of the value of the extension property, for documentation purposes.
* **oas2** (type: OAS2 Context Object) - Specifies usage in OAS2 context.
* **usage** - specifies allowed usage as one of the following:
- `prohibited` - may not be used in oas2.
Expand All @@ -78,6 +79,8 @@ Once the SEMOASA format gets some traction and achieves a level of stability, we
* **\[providerName\]** (patterned field, type: Schema Object) - addressable object name.
* **externalDocs** (type: External Docs Object) - catalog of reusable External Documentation Objects.
* **\[documentName\]** (patterned field, type: Schema Object) - addressable object name.
* **examples** (type: Examples Object) - catalog of reusable examples.
* **\[exampleName\]** (patterned field, type: any) - addressable object name.

## Examples

Expand Down