V3

examples/v3/petstore.md

@@ -0,0 +1,385 @@
+# Swagger Petstore - OpenAPI 3.0
+This is a sample Pet Store Server based on the OpenAPI 3.0 specification.  You can find out more about
+Swagger at [https://swagger.io](https://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!
+You can now help us improve the API whether it's by making changes to the definition itself or to the code.
+That way, with time, we can improve the API in general, and expose some of the new features in OAS3.
+
+Some useful links:
+
+- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)
+- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml)
+
+## Version: 1.0.11
+
+### Terms of service
+http://swagger.io/terms/
+
+**Contact information:**  
+[email protected]  
+
+**License:** [Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)
+
+[Find out more about Swagger](http://swagger.io)
+
+---
+## pet
+Everything about your Pets
+[Find out more](http://swagger.io)
+
+### [PUT] /pet
+**Update an existing pet**
+
+Update an existing pet by Id
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Successful operation | **application/json**: [Pet](#pet)<br>**application/xml**: [Pet](#pet)<br> |
+| 400 | Invalid ID supplied |  |
+| 404 | Pet not found |  |
+| 422 | Validation exception |  |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### [POST] /pet
+**Add a new pet to the store**
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Successful operation | **application/json**: [Pet](#pet)<br>**application/xml**: [Pet](#pet)<br> |
+| 400 | Invalid input |  |
+| 422 | Validation exception |  |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### [GET] /pet/findByStatus
+**Finds Pets by status**
+
+Multiple status values can be provided with comma separated strings
+
+#### Responses
+
+| Code | Description | Schema | Links |
+| ---- | ----------- | ------ | ----- |
+| 200 | successful operation | **application/json**: [ [Pet](#pet) ]<br>**application/xml**: [ [Pet](#pet) ]<br> | **address**<br>Address link description<br>Parameters {<br>"userId": "$request.path.id",<br>"entityId": "$request.entity.id"<br>}<br> |
+| 400 | Invalid status value |  |  |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### ~~[GET] /pet/findByTags~~
+
+***DEPRECATED***
+
+**Finds Pets by tags**
+
+Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [ [Pet](#pet) ]<br>**application/xml**: [ [Pet](#pet) ]<br> |
+| 400 | Invalid tag value |  |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### [GET] /pet/{petId}
+**Find pet by ID**
+
+Returns a single pet
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [Pet](#pet)<br>**application/xml**: [Pet](#pet)<br> |
+| 400 | Invalid ID supplied |  |
+| 404 | Pet not found |  |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| api_key |  |  |
+| petstore_auth | write:pets | read:pets |
+
+### [POST] /pet/{petId}
+**Updates a pet in the store with form data**
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 400 | Invalid input |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### [DELETE] /pet/{petId}
+**Deletes a pet**
+
+delete a pet
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 400 | Invalid pet value |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+### [POST] /pet/{petId}/uploadImage
+**uploads an image**
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [ApiResponse](#apiresponse)<br> |
+
+##### Security
+
+| Security Schema | Scopes |  |
+| --------------- | ------ | --- |
+| petstore_auth | write:pets | read:pets |
+
+---
+## store
+Access to Petstore orders
+[Find out more about our store](http://swagger.io)
+
+### [GET] /store/inventory
+**Returns pet inventories by status**
+
+Returns a map of status codes to quantities
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: object<br> |
+
+##### Security
+
+| Security Schema | Scopes |
+| --------------- | ------ |
+| api_key |  |
+
+### [POST] /store/order
+**Place an order for a pet**
+
+Place a new order in the store
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [Order](#order)<br> |
+| 400 | Invalid input |  |
+| 422 | Validation exception |  |
+
+### [GET] /store/order/{orderId}
+**Find purchase order by ID**
+
+For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [Order](#order)<br>**application/xml**: [Order](#order)<br> |
+| 400 | Invalid ID supplied |  |
+| 404 | Order not found |  |
+
+### [DELETE] /store/order/{orderId}
+**Delete purchase order by ID**
+
+For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 400 | Invalid ID supplied |
+| 404 | Order not found |
+
+---
+## user
+Operations about user
+
+### [POST] /user
+**Create user**
+
+This can only be done by the logged in user.
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| default | successful operation | **application/json**: [User](#user)<br>**application/xml**: [User](#user)<br> |
+
+### [POST] /user/createWithList
+**Creates list of users with given input array**
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | Successful operation | **application/json**: [User](#user)<br>**application/xml**: [User](#user)<br> |
+| default | successful operation |  |
+
+### [GET] /user/login
+**Logs user into the system**
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation<br>**Headers:**<br>**X-Rate-Limit**: calls per hour allowed by the user<br>**X-Expires-After**: date in UTC when token expires<br> | **application/xml**: string<br>**application/json**: string<br> |
+| 400 | Invalid username/password supplied |  |
+
+### [GET] /user/logout
+**Logs out current logged in user session**
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| default | successful operation |
+
+### [GET] /user/{username}
+**Get user by user name**
+
+#### Responses
+
+| Code | Description | Schema |
+| ---- | ----------- | ------ |
+| 200 | successful operation | **application/json**: [User](#user)<br>**application/xml**: [User](#user)<br> |
+| 400 | Invalid username supplied |  |
+| 404 | User not found |  |
+
+### [PUT] /user/{username}
+**Update user**
+
+This can only be done by the logged in user.
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| default | successful operation |
+
+### [DELETE] /user/{username}
+**Delete user**
+
+This can only be done by the logged in user.
+
+#### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 400 | Invalid username supplied |
+| 404 | User not found |
+
+---
+### Models
+
+#### Order
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long | *Example:* `10` | No |
+| petId | long | *Example:* `198772` | No |
+| quantity | integer | *Example:* `7` | No |
+| shipDate | dateTime |  | No |
+| status | string | Order Status<br>*Enum:* `"placed"`, `"approved"`, `"delivered"`<br>*Example:* `"approved"` | No |
+| complete | boolean |  | No |
+
+#### Customer
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long | *Example:* `100000` | No |
+| username | string | *Example:* `"fehguy"` | No |
+| address | [ [Address](#address) ] |  | No |
+
+#### Address
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| street | string | *Example:* `"437 Lytton"` | No |
+| city | string | *Example:* `"Palo Alto"` | No |
+| state | string | *Example:* `"CA"` | No |
+| zip | string | *Example:* `"94301"` | No |
+
+#### Category
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long | *Example:* `1` | No |
+| name | string | *Example:* `"Dogs"` | No |
+
+#### User
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long | *Example:* `10` | No |
+| username | string | *Example:* `"theUser"` | No |
+| firstName | string | *Example:* `"John"` | No |
+| lastName | string | *Example:* `"James"` | No |
+| email | string | *Example:* `"[email protected]"` | No |
+| password | string | *Example:* `"12345"` | No |
+| phone | string | *Example:* `"12345"` | No |
+| userStatus | integer | User Status<br>*Example:* `1` | No |
+
+#### Tag
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long |  | No |
+| name | string |  | No |
+
+#### Pet
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| id | long | *Example:* `10` | No |
+| name | string | *Example:* `"doggie"` | Yes |
+| category | [Category](#category) |  | No |
+| photoUrls | [ string ] |  | Yes |
+| tags | [ [Tag](#tag) ] |  | No |
+| status | string | pet status in the store<br>*Enum:* `"available"`, `"pending"`, `"sold"` | No |
+
+#### ApiResponse
+
+| Name | Type | Description | Required |
+| ---- | ---- | ----------- | -------- |
+| code | integer |  | No |
+| type | string |  | No |
+| message | string |  | No |