migrate doc samples to oas3.0 spec (#6293)

This commit is contained in:
William Cheng
2020-05-14 12:22:40 +08:00
committed by GitHub
parent 81d307d8ca
commit 9c4b37299a
34 changed files with 1045 additions and 394 deletions

View File

@@ -1 +1 @@
4.3.0-SNAPSHOT
5.0.0-SNAPSHOT

View File

@@ -24,6 +24,8 @@ This is a sample server Petstore server. For this sample, you can use the api ke
* *APIKey* KeyParamName: _api_key_, KeyInQuery: _false_, KeyInHeader: _true_
* *APIKey* KeyParamName: _AUTH_KEY_, KeyInQuery: _false_, KeyInHeader: _false_
* *OAuth* AuthorizationUrl: _http://petstore.swagger.io/api/oauth/dialog_, TokenUrl: __
@@ -60,7 +62,7 @@ Add a new pet to the store
|===
|Name| Description| Required| Default| Pattern
| body
| Pet
| Pet object that needs to be added to the store <<Pet>>
| X
|
@@ -74,10 +76,13 @@ Add a new pet to the store
===== Return Type
<<Pet>>
-
===== Content Type
* application/xml
* application/json
===== Responses
@@ -87,6 +92,11 @@ Add a new pet to the store
| Code | Message | Datatype
| 200
| successful operation
| <<Pet>>
| 405
| Invalid input
| <<>>
@@ -502,7 +512,7 @@ Update an existing pet
|===
|Name| Description| Required| Default| Pattern
| body
| Pet
| Pet object that needs to be added to the store <<Pet>>
| X
|
@@ -516,10 +526,13 @@ Update an existing pet
===== Return Type
<<Pet>>
-
===== Content Type
* application/xml
* application/json
===== Responses
@@ -529,6 +542,11 @@ Update an existing pet
| Code | Message | Datatype
| 200
| successful operation
| <<Pet>>
| 400
| Invalid ID supplied
| <<>>
@@ -1044,7 +1062,7 @@ Place an order for a pet
|===
|Name| Description| Required| Default| Pattern
| body
| Order
| order placed for purchasing the pet <<Order>>
| X
|
@@ -1136,7 +1154,7 @@ This can only be done by the logged in user.
|===
|Name| Description| Required| Default| Pattern
| body
| User
| Created user object <<User>>
| X
|
@@ -1216,7 +1234,7 @@ Creates list of users with given input array
|===
|Name| Description| Required| Default| Pattern
| body
| User
| List of user object <<User>>
| X
|
@@ -1296,7 +1314,7 @@ Creates list of users with given input array
|===
|Name| Description| Required| Default| Pattern
| body
| User
| List of user object <<User>>
| X
|
@@ -1561,7 +1579,7 @@ Logs user into the system
| The user name for login
| X
| null
|
| /^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$/
| password
| The password for login in clear text
@@ -1729,7 +1747,7 @@ This can only be done by the logged in user.
|===
|Name| Description| Required| Default| Pattern
| body
| User
| Updated user object <<User>>
| X
|
@@ -1849,6 +1867,56 @@ A category for a pet
|===
[#InlineObject]
=== _InlineObject_
[.fields-InlineObject]
[cols="2,1,2,4,1"]
|===
| Field Name| Required| Type| Description| Format
| name
|
| String
| Updated name of the pet
|
| status
|
| String
| Updated status of the pet
|
|===
[#InlineObject1]
=== _InlineObject1_
[.fields-InlineObject1]
[cols="2,1,2,4,1"]
|===
| Field Name| Required| Type| Description| Format
| additionalMetadata
|
| String
| Additional data to pass to server
|
| file
|
| File
| file to upload
| binary
|===
[#Order]
=== _Order_ Pet Order