Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 9.2k
V3 Yaml Examples#985
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.
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
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
V3 Yaml Examples #985
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7139bdc
Merge remote-tracking branch 'refs/remotes/origin/OpenAPI.next' into …
darrelmiller c7d3e1f
Yaml V3 examples
darrelmiller 2e1e291
Merge remote-tracking branch 'refs/remotes/origin/OpenAPI.next' into …
darrelmiller c195cac
Fixed a few nits in the examples
darrelmiller 978555b
Fixed quoted response key
darrelmiller bf129f9
Merge remote-tracking branch 'refs/remotes/origin/OpenAPI.next' into …
darrelmiller File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| openapi: "3.0.0" | ||
| info: | ||
| title: Simple API overview | ||
| version: v2 | ||
| paths: | ||
| /: | ||
| get: | ||
| operationId: listVersionsv2 | ||
| summary: List API versions | ||
| responses: | ||
| 200: | ||
| description: |- | ||
| 200 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| - { | ||
| "versions": [ | ||
| { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "status": "EXPERIMENTAL", | ||
| "updated": "2013-07-23T11:33:21Z", | ||
| "id": "v3.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v3/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| 300: | ||
| description: |- | ||
| 300 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| - | | ||
| { | ||
| "versions": [ | ||
| { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "status": "EXPERIMENTAL", | ||
| "updated": "2013-07-23T11:33:21Z", | ||
| "id": "v3.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v3/", | ||
| "rel": "self" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| /v2: | ||
| get: | ||
| operationId: getVersionDetailsv2 | ||
| summary: Show API version details | ||
| responses: | ||
| 200: | ||
| description: |- | ||
| 200 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| - { | ||
| "version": { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "media-types": [ | ||
| { | ||
| "base": "application/xml", | ||
| "type": "application/vnd.openstack.compute+xml;version=2" | ||
| }, | ||
| { | ||
| "base": "application/json", | ||
| "type": "application/vnd.openstack.compute+json;version=2" | ||
| } | ||
| ], | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://127.0.0.1:8774/v2/", | ||
| "rel": "self" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | ||
| "type": "application/pdf", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| 203: | ||
| description: |- | ||
| 203 response | ||
| content: | ||
| application/json: | ||
| examples: | ||
| - { | ||
| "version": { | ||
| "status": "CURRENT", | ||
| "updated": "2011-01-21T11:33:21Z", | ||
| "media-types": [ | ||
| { | ||
| "base": "application/xml", | ||
| "type": "application/vnd.openstack.compute+xml;version=2" | ||
| }, | ||
| { | ||
| "base": "application/json", | ||
| "type": "application/vnd.openstack.compute+json;version=2" | ||
| } | ||
| ], | ||
| "id": "v2.0", | ||
| "links": [ | ||
| { | ||
| "href": "http://23.253.228.211:8774/v2/", | ||
| "rel": "self" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/os-compute-devguide-2.pdf", | ||
| "type": "application/pdf", | ||
| "rel": "describedby" | ||
| }, | ||
| { | ||
| "href": "http://docs.openstack.org/api/openstack-compute/2/wadl/os-compute-2.wadl", | ||
| "type": "application/vnd.sun.wadl+xml", | ||
| "rel": "describedby" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| openapi: "3.0.0" | ||
| info: | ||
| version: 1.0.0 | ||
| title: Swagger Petstore | ||
| description: A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification | ||
| termsOfService: http://swagger.io/terms/ | ||
| contact: | ||
| name: Swagger API Team | ||
| email: foo@example.com | ||
| url: http://madskristensen.net | ||
| license: | ||
| name: MIT | ||
| url: http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT | ||
| servers: | ||
| - url: http://petstore.swagger.io/api | ||
| paths: | ||
| /pets: | ||
| get: | ||
| description: | | ||
| Returns all pets from the system that the user has access to | ||
| Nam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia. | ||
| Sed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien. | ||
| operationId: findPets | ||
| parameters: | ||
| - name: tags | ||
| in: query | ||
| description: tags to filter by | ||
| required: false | ||
| style: simple | ||
| schema: | ||
| type: array | ||
| items: | ||
| type: string | ||
| - name: limit | ||
| in: query | ||
| description: maximum number of results to return | ||
| required: false | ||
| schema: | ||
| type: integer | ||
| format: int32 | ||
| responses: | ||
| 200: | ||
| description: pet response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: '#/components/schemas/Pet' | ||
| default: | ||
| description: unexpected error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Error' | ||
| post: | ||
| description: Creates a new pet in the store. Duplicates are allowed | ||
| operationId: addPet | ||
| requestBody: | ||
| description: Pet to add to the store | ||
| required: true | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/NewPet' | ||
| responses: | ||
| 200: | ||
| description: pet response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Pet' | ||
| default: | ||
| description: unexpected error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Error' | ||
| /pets/{id}: | ||
| get: | ||
| description: Returns a user based on a single ID, if the user does not have access to the pet | ||
| operationId: find pet by id | ||
| parameters: | ||
| - name: id | ||
| in: path | ||
| description: ID of pet to fetch | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| format: int64 | ||
| responses: | ||
| 200: | ||
| description: pet response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Pet' | ||
| default: | ||
| description: unexpected error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Error' | ||
| delete: | ||
| description: deletes a single pet based on the ID supplied | ||
| operationId: deletePet | ||
| parameters: | ||
| - name: id | ||
| in: path | ||
| description: ID of pet to delete | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| format: int64 | ||
| responses: | ||
| 204: | ||
| description: pet deleted | ||
| default: | ||
| description: unexpected error | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/Error' | ||
| components: | ||
| schemas: | ||
| Pet: | ||
| allOf: | ||
| - $ref: '#/components/schemas/NewPet' | ||
| - required: | ||
| - id | ||
| properties: | ||
| id: | ||
| type: integer | ||
| format: int64 | ||
| NewPet: | ||
| required: | ||
| - name | ||
| properties: | ||
| name: | ||
| type: string | ||
| tag: | ||
| type: string | ||
| Error: | ||
| required: | ||
| - code | ||
| - message | ||
| properties: | ||
| code: | ||
| type: integer | ||
| format: int32 | ||
| message: | ||
| type: string |
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add
relto https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#linkObject?