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

@@ -26,6 +26,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -t modules/openapi-generator/src/main/resources/asciidoc-documentation --additional-properties=specDir=modules/openapi-generator/src/main/resources/asciidoc-documentation,snippetDir=. -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g asciidoc -o samples/documentation/asciidoc $@"
ags="generate -t modules/openapi-generator/src/main/resources/asciidoc-documentation --additional-properties=specDir=modules/openapi-generator/src/main/resources/asciidoc-documentation,snippetDir=. -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g asciidoc -o samples/documentation/asciidoc $@"
java ${JAVA_OPTS} -jar ${executable} ${ags}

View File

@@ -27,6 +27,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -t modules/openapi-generator/src/main/resources/confluenceWikiDocs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g cwiki -o samples/documentation/cwiki $@"
ags="generate -t modules/openapi-generator/src/main/resources/confluenceWikiDocs -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g cwiki -o samples/documentation/cwiki $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -27,6 +27,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g dynamic-html -o samples/documentation/dynamic-html $@"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g dynamic-html -o samples/documentation/dynamic-html $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -27,6 +27,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -t modules/openapi-generator/src/main/resources/htmlDocs -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html -o samples/documentation/html $@"
ags="generate -t modules/openapi-generator/src/main/resources/htmlDocs -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g html -o samples/documentation/html $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -27,6 +27,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g html2 -o samples/documentation/html2 -t modules/openapi-generator/src/main/resources/htmlDocs2/ --additional-properties hideGenerationTimestamp=true $@"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g html2 -o samples/documentation/html2 -t modules/openapi-generator/src/main/resources/htmlDocs2/ --additional-properties hideGenerationTimestamp=true $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -26,6 +26,6 @@ fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -t modules/openapi-generator/src/main/resources/markdown-documentation -i modules/openapi-generator/src/test/resources/2_0/petstore.yaml -g markdown -o samples/documentation/markdown $@"
ags="generate -t modules/openapi-generator/src/main/resources/markdown-documentation -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g markdown -o samples/documentation/markdown $@"
java ${JAVA_OPTS} -jar ${executable} ${ags}

View File

@@ -1,32 +0,0 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
while [ -h "$SCRIPT" ] ; do
ls=`ls -ld "$SCRIPT"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
SCRIPT="$link"
else
SCRIPT=`dirname "$SCRIPT"`/"$link"
fi
done
if [ ! -d "${APP_DIR}" ]; then
APP_DIR=`dirname "$SCRIPT"`/..
APP_DIR=`cd "${APP_DIR}"; pwd`
fi
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
if [ ! -f "$executable" ]
then
mvn clean package
fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g dynamic-html -o samples/dynamic-html $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -1,32 +0,0 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
while [ -h "$SCRIPT" ] ; do
ls=`ls -ld "$SCRIPT"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
SCRIPT="$link"
else
SCRIPT=`dirname "$SCRIPT"`/"$link"
fi
done
if [ ! -d "${APP_DIR}" ]; then
APP_DIR=`dirname "$SCRIPT"`/..
APP_DIR=`cd "${APP_DIR}"; pwd`
fi
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
if [ ! -f "$executable" ]
then
mvn clean package
fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g html -o samples/html $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -1,32 +0,0 @@
#!/bin/sh
SCRIPT="$0"
echo "# START SCRIPT: $SCRIPT"
while [ -h "$SCRIPT" ] ; do
ls=`ls -ld "$SCRIPT"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
SCRIPT="$link"
else
SCRIPT=`dirname "$SCRIPT"`/"$link"
fi
done
if [ ! -d "${APP_DIR}" ]; then
APP_DIR=`dirname "$SCRIPT"`/..
APP_DIR=`cd "${APP_DIR}"; pwd`
fi
executable="./modules/openapi-generator-cli/target/openapi-generator-cli.jar"
if [ ! -f "$executable" ]
then
mvn clean package
fi
# if you've executed sbt assembly previously it will use that instead.
export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
ags="generate -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -g html2 -o samples/html2 --additional-properties hideGenerationTimestamp=true $@"
java $JAVA_OPTS -jar $executable $ags

View File

@@ -5,6 +5,6 @@ If Not Exist %executable% (
)
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate --artifact-id "asciidoc-petstore-documentation" -t modules\openapi-generator\src\main\resources\asciidoc-documentation --additional-properties=specDir=modules\openapi-generator\src\main\resources\asciidoc-documentation,snippetDir=. -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g asciidoc -o samples\documentation\asciidoc
set ags=generate --artifact-id "asciidoc-petstore-documentation" -t modules\openapi-generator\src\main\resources\asciidoc-documentation --additional-properties=specDir=modules\openapi-generator\src\main\resources\asciidoc-documentation,snippetDir=. -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g asciidoc -o samples\documentation\asciidoc
java %JAVA_OPTS% -jar %executable% %ags%

View File

@@ -5,6 +5,6 @@ If Not Exist %executable% (
)
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g dynamic-html -o samples\client\petstore\dynamic-html
set ags=generate -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g dynamic-html -o samples\client\petstore\dynamic-html
java %JAVA_OPTS% -jar %executable% %ags%

View File

@@ -5,6 +5,6 @@ If Not Exist %executable% (
)
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html -o samples\documentation\html
set ags=generate -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g html -o samples\documentation\html
java %JAVA_OPTS% -jar %executable% %ags%

View File

@@ -5,6 +5,6 @@ If Not Exist %executable% (
)
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g html2 -o samples\documentation\html2
set ags=generate -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g html2 -o samples\documentation\html2
java %JAVA_OPTS% -jar %executable% %ags%

View File

@@ -5,6 +5,6 @@ If Not Exist %executable% (
)
REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
set ags=generate --artifact-id "markdown-petstore-documentation" -i modules\openapi-generator\src\test\resources\2_0\petstore.yaml -g markdown -o samples\documentation\petstore\markdown
set ags=generate --artifact-id "markdown-petstore-documentation" -i modules\openapi-generator\src\test\resources\3_0\petstore.yaml -g markdown -o samples\documentation\petstore\markdown
java %JAVA_OPTS% -jar %executable% %ags%

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

View File

@@ -1 +1 @@
4.3.1-SNAPSHOT
5.0.0-SNAPSHOT

View File

@@ -22,25 +22,46 @@ h3. addPet
|| Protocol | {noformat:nopanel=true}http{noformat} |
|| Path | {noformat:nopanel=true}/pet{noformat} |
|| Base Path | {noformat:nopanel=true}http://petstore.swagger.io/v2{noformat} |
|| Produces | {noformat:nopanel=true}application/xmlapplication/json{noformat} |
----
h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |Pet object that needs to be added to the store | Pet | (/) | | | |
|Pet |Pet object that needs to be added to the store | Pet | (/) | | | |
----
h4. Responses
|| Status Code | {status:colour=Green|title=200|subtle=false} |
|| Message | successful operation |
|| Response Type | Pet |
|| Response Model | [Pet Model|#PetModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : {
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/Pet"
}
},
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Pet"
}
}
}
}{code} |
|| Status Code | {status:colour=Green|title=405|subtle=false} |
|| Message | Invalid input |
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid input",
"content" : { }
"description" : "Invalid input"
}{code} |
@@ -77,8 +98,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid pet value",
"content" : { }
"description" : "Invalid pet value"
}{code} |
@@ -140,8 +160,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid status value",
"content" : { }
"description" : "Invalid status value"
}{code} |
@@ -203,8 +222,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid tag value",
"content" : { }
"description" : "Invalid tag value"
}{code} |
@@ -260,8 +278,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid ID supplied",
"content" : { }
"description" : "Invalid ID supplied"
}{code} |
@@ -271,8 +288,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Pet not found",
"content" : { }
"description" : "Pet not found"
}{code} |
@@ -289,25 +305,46 @@ h3. updatePet
|| Protocol | {noformat:nopanel=true}http{noformat} |
|| Path | {noformat:nopanel=true}/pet{noformat} |
|| Base Path | {noformat:nopanel=true}http://petstore.swagger.io/v2{noformat} |
|| Produces | {noformat:nopanel=true}application/xmlapplication/json{noformat} |
----
h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |Pet object that needs to be added to the store | Pet | (/) | | | |
|Pet |Pet object that needs to be added to the store | Pet | (/) | | | |
----
h4. Responses
|| Status Code | {status:colour=Green|title=200|subtle=false} |
|| Message | successful operation |
|| Response Type | Pet |
|| Response Model | [Pet Model|#PetModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : {
"application/xml" : {
"schema" : {
"$ref" : "#/components/schemas/Pet"
}
},
"application/json" : {
"schema" : {
"$ref" : "#/components/schemas/Pet"
}
}
}
}{code} |
|| Status Code | {status:colour=Green|title=400|subtle=false} |
|| Message | Invalid ID supplied |
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid ID supplied",
"content" : { }
"description" : "Invalid ID supplied"
}{code} |
@@ -317,8 +354,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Pet not found",
"content" : { }
"description" : "Pet not found"
}{code} |
@@ -328,8 +364,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Validation exception",
"content" : { }
"description" : "Validation exception"
}{code} |
@@ -363,8 +398,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid input",
"content" : { }
"description" : "Invalid input"
}{code} |
@@ -439,8 +473,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid ID supplied",
"content" : { }
"description" : "Invalid ID supplied"
}{code} |
@@ -450,8 +483,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Order not found",
"content" : { }
"description" : "Order not found"
}{code} |
@@ -549,8 +581,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid ID supplied",
"content" : { }
"description" : "Invalid ID supplied"
}{code} |
@@ -560,8 +591,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Order not found",
"content" : { }
"description" : "Order not found"
}{code} |
@@ -584,7 +614,7 @@ h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |order placed for purchasing the pet | Order | (/) | | | |
|Order |order placed for purchasing the pet | Order | (/) | | | |
----
@@ -617,8 +647,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid Order",
"content" : { }
"description" : "Invalid Order"
}{code} |
@@ -641,7 +670,7 @@ h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |Created user object | User | (/) | | | |
|User |Created user object | User | (/) | | | |
----
@@ -652,8 +681,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : { }
"description" : "successful operation"
}{code} |
@@ -676,7 +704,7 @@ h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |List of user object | array[User] | (/) | | | |
|User |List of user object | array[User] | (/) | | | |
----
@@ -687,8 +715,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : { }
"description" : "successful operation"
}{code} |
@@ -711,7 +738,7 @@ h4. Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |List of user object | array[User] | (/) | | | |
|User |List of user object | array[User] | (/) | | | |
----
@@ -722,8 +749,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : { }
"description" : "successful operation"
}{code} |
@@ -757,8 +783,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid username supplied",
"content" : { }
"description" : "Invalid username supplied"
}{code} |
@@ -768,8 +793,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "User not found",
"content" : { }
"description" : "User not found"
}{code} |
@@ -825,8 +849,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid username supplied",
"content" : { }
"description" : "Invalid username supplied"
}{code} |
@@ -836,8 +859,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "User not found",
"content" : { }
"description" : "User not found"
}{code} |
@@ -862,7 +884,7 @@ h4. Parameters
h5. Query Parameters
||Name||Description||Required||Default||Pattern||
|username |The user name for login | String | (/) |null | | ||password |The password for login in clear text | String | (/) |null | | |
|username |The user name for login | String | (/) |null | /^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$/ | ||password |The password for login in clear text | String | (/) |null | | |
----
h4. Responses
@@ -873,8 +895,19 @@ h4. Responses
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"headers" : {
"Set-Cookie" : {
"description" : "Cookie authentication key for use with the `auth_cookie` apiKey authentication.",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"example" : "AUTH_KEY=abcde12345; Path=/; HttpOnly"
}
},
"X-Rate-Limit" : {
"description" : "calls per hour allowed by the user",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "integer",
"format" : "int32"
@@ -882,6 +915,8 @@ h4. Responses
},
"X-Expires-After" : {
"description" : "date in UTC when toekn expires",
"style" : "simple",
"explode" : false,
"schema" : {
"type" : "string",
"format" : "date-time"
@@ -909,8 +944,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid username/password supplied",
"content" : { }
"description" : "Invalid username/password supplied"
}{code} |
@@ -941,8 +975,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "successful operation",
"content" : { }
"description" : "successful operation"
}{code} |
@@ -968,7 +1001,7 @@ h5. Path Parameters
h5. Body Parameter
||Name||Description||Type||Required||Default||Pattern||Enum||
|body |Updated user object | User | (/) | | | |
|User |Updated user object | User | (/) | | | |
----
@@ -979,8 +1012,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "Invalid user supplied",
"content" : { }
"description" : "Invalid user supplied"
}{code} |
@@ -990,8 +1022,7 @@ h4. Responses
|| Response Type | |
|| Response Model | [ Model|#ModelAnchor|Jump to model] |
|| Response Schema | {code:collapse=true}{
"description" : "User not found",
"content" : { }
"description" : "User not found"
}{code} |
@@ -1018,6 +1049,22 @@ h2. Models
||Field Name||Required||Type||Description||Enum||
|id |(x) |{noformat:nopanel=true}Long{noformat} | | |
|name |(x) |{noformat:nopanel=true}String{noformat} | | |
{anchor:InlineObjectModelAnchor}
h3. InlineObject
||Field Name||Required||Type||Description||Enum||
|name |(x) |{noformat:nopanel=true}String{noformat} |Updated name of the pet | |
|status |(x) |{noformat:nopanel=true}String{noformat} |Updated status of the pet | |
{anchor:InlineObject1ModelAnchor}
h3. InlineObject1
||Field Name||Required||Type||Description||Enum||
|additionalMetadata |(x) |{noformat:nopanel=true}String{noformat} |Additional data to pass to server | |
|file |(x) |{noformat:nopanel=true}File{noformat} |file to upload | |
{anchor:OrderModelAnchor}
h3. Order

View File

@@ -1 +1 @@
3.2.1-SNAPSHOT
5.0.0-SNAPSHOT

View File

@@ -0,0 +1,12 @@
<h2>InlineObject</h2>
<ul class="parameter">
<li class="param-required-false">name : String
<br/>Updated name of the pet
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">status : String
<br/>Updated status of the pet
</li>
</ul>

View File

@@ -0,0 +1,12 @@
<h2>InlineObject1</h2>
<ul class="parameter">
<li class="param-required-false">additionalMetadata : String
<br/>Additional data to pass to server
</li>
</ul>
<ul class="parameter">
<li class="param-required-false">file : File
<br/>file to upload
</li>
</ul>

View File

@@ -11,7 +11,7 @@
<h3 class="section">HTTP Method</h3>
<code>POST</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<div class="model" data-model="Pet"><a href="">Pet</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">
@@ -142,7 +142,7 @@
<h3 class="section">HTTP Method</h3>
<code>PUT</code>
<h3 class="section">Response Type</h3>
<div class="model" data-model=""><a href=""></a></div>
<div class="model" data-model="Pet"><a href="">Pet</a></div>
<h3 class="section">Parameters</h3>
<ul>
<li class="parameter">

View File

@@ -45,7 +45,7 @@
<span class="param-in">Body: </span>
<span class="param-name">User</span>
<span class="param-type">List(array)</span>
<span class="param-type">List(User)</span>
<p class="param-description">List of user object</p>
</li>
@@ -69,7 +69,7 @@
<span class="param-in">Body: </span>
<span class="param-name">User</span>
<span class="param-type">List(array)</span>
<span class="param-type">List(User)</span>
<p class="param-description">List of user object</p>
</li>

View File

@@ -1 +1 @@
3.3.4-SNAPSHOT
5.0.0-SNAPSHOT

View File

@@ -190,6 +190,7 @@ font-style: italic;
<h2>Access</h2>
<ol>
<li>APIKey KeyParamName:api_key KeyInQuery:false KeyInHeader:true</li>
<li>APIKey KeyParamName:AUTH_KEY KeyInQuery:false KeyInHeader:false</li>
<li>OAuth AuthorizationUrl:http://petstore.swagger.io/api/oauth/dialogTokenUrl:</li>
</ol>
@@ -255,12 +256,58 @@ font-style: italic;
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#Pet">Pet</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
"category" : {
"name" : "name",
"id" : 6
},
"tags" : [ {
"name" : "name",
"id" : 1
}, {
"name" : "name",
"id" : 1
} ],
"status" : "available"
}</code></pre>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
</tags>
<status>aeiou</status>
</Pet></code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<a href="#Pet">Pet</a>
<h4 class="field-label">405</h4>
Invalid input
<a href="#"></a>
@@ -560,12 +607,58 @@ font-style: italic;
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#Pet">Pet</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"photoUrls" : [ "photoUrls", "photoUrls" ],
"name" : "doggie",
"id" : 0,
"category" : {
"name" : "name",
"id" : 6
},
"tags" : [ {
"name" : "name",
"id" : 1
}, {
"name" : "name",
"id" : 1
} ],
"status" : "available"
}</code></pre>
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/xml</div>
<pre class="example"><code><Pet>
<id>123456789</id>
<name>doggie</name>
<photoUrls>
<photoUrls>aeiou</photoUrls>
</photoUrls>
<tags>
</tags>
<status>aeiou</status>
</Pet></code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/xml</code></li>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
successful operation
<a href="#Pet">Pet</a>
<h4 class="field-label">400</h4>
Invalid ID supplied
<a href="#"></a>
@@ -826,6 +919,11 @@ font-style: italic;
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
@@ -893,6 +991,11 @@ font-style: italic;
<div class="method-notes">This can only be done by the logged in user.</div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
@@ -924,10 +1027,15 @@ font-style: italic;
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">User <a href="#array">array</a> (required)</div>
<div class="param">User <a href="#User">User</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
@@ -955,10 +1063,15 @@ font-style: italic;
<div class="method-notes"></div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">User <a href="#array">array</a> (required)</div>
<div class="param">User <a href="#User">User</a> (required)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> &mdash; </div>
@@ -1168,6 +1281,11 @@ font-style: italic;
<div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; name that need to be deleted default: null </div>
</div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
@@ -1206,6 +1324,8 @@ font-style: italic;
<li><a href="#Pet"><code>Pet</code> - a Pet</a></li>
<li><a href="#Tag"><code>Tag</code> - Pet Tag</a></li>
<li><a href="#User"><code>User</code> - a User</a></li>
<li><a href="#inline_object"><code>inline_object</code> - </a></li>
<li><a href="#inline_object_1"><code>inline_object_1</code> - </a></li>
</ol>
<div class="model">
@@ -1275,5 +1395,21 @@ font-style: italic;
<div class="param">userStatus (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> User Status format: int32</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="inline_object"><code>inline_object</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Updated name of the pet </div>
<div class="param">status (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Updated status of the pet </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="inline_object_1"><code>inline_object_1</code> - </a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'></div>
<div class="field-items">
<div class="param">additionalMetadata (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Additional data to pass to server </div>
<div class="param">file (optional)</div><div class="param-desc"><span class="param-type"><a href="#file">File</a></span> file to upload format: binary</div>
</div> <!-- field-items -->
</div>
</body>
</html>

View File

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

File diff suppressed because it is too large Load Diff

View File

@@ -1 +1 @@
4.2.3-SNAPSHOT
5.0.0-SNAPSHOT

View File

@@ -16,7 +16,7 @@ Method | HTTP request | Description
<a name="addPet"></a>
# **addPet**
> addPet(body)
> Pet addPet(pet)
Add a new pet to the store
@@ -24,11 +24,11 @@ Add a new pet to the store
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
null (empty response body)
[**Pet**](..//Models/Pet.md)
### Authorization
@@ -37,7 +37,7 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
<a name="deletePet"></a>
# **deletePet**
@@ -148,7 +148,7 @@ Name | Type | Description | Notes
<a name="updatePet"></a>
# **updatePet**
> updatePet(body)
> Pet updatePet(pet)
Update an existing pet
@@ -156,11 +156,11 @@ Update an existing pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](..//Models/Pet.md)| Pet object that needs to be added to the store |
### Return type
null (empty response body)
[**Pet**](..//Models/Pet.md)
### Authorization
@@ -169,7 +169,7 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Accept**: application/xml, application/json
<a name="updatePetWithForm"></a>
# **updatePetWithForm**

View File

@@ -50,7 +50,7 @@ This endpoint does not need any parameter.
### Return type
[**Map**](/Models/integer.md)
[**Map**](..//Models/integer.md)
### Authorization
@@ -77,7 +77,7 @@ Name | Type | Description | Notes
### Return type
[**Order**](/Models/Order.md)
[**Order**](..//Models/Order.md)
### Authorization
@@ -90,7 +90,7 @@ No authorization required
<a name="placeOrder"></a>
# **placeOrder**
> Order placeOrder(body)
> Order placeOrder(order)
Place an order for a pet
@@ -98,11 +98,11 @@ Place an order for a pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](/Models/Order.md)| order placed for purchasing the pet |
**order** | [**Order**](..//Models/Order.md)| order placed for purchasing the pet |
### Return type
[**Order**](/Models/Order.md)
[**Order**](..//Models/Order.md)
### Authorization
@@ -110,6 +110,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/xml, application/json

View File

@@ -16,7 +16,7 @@ Method | HTTP request | Description
<a name="createUser"></a>
# **createUser**
> createUser(body)
> createUser(user)
Create user
@@ -26,7 +26,7 @@ Create user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](/Models/User.md)| Created user object |
**user** | [**User**](..//Models/User.md)| Created user object |
### Return type
@@ -34,16 +34,16 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
> createUsersWithArrayInput(user)
Creates list of users with given input array
@@ -51,7 +51,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List**](/Models/User.md)| List of user object |
**user** | [**List**](..//Models/User.md)| List of user object |
### Return type
@@ -59,16 +59,16 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
> createUsersWithListInput(user)
Creates list of users with given input array
@@ -76,7 +76,7 @@ Creates list of users with given input array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**List**](/Models/User.md)| List of user object |
**user** | [**List**](..//Models/User.md)| List of user object |
### Return type
@@ -84,11 +84,11 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
<a name="deleteUser"></a>
@@ -111,7 +111,7 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
@@ -132,7 +132,7 @@ Name | Type | Description | Notes
### Return type
[**User**](/Models/User.md)
[**User**](..//Models/User.md)
### Authorization
@@ -158,7 +158,7 @@ Name | Type | Description | Notes
### Return type
[**String**](/Models/string.md)
[**String**](..//Models/string.md)
### Authorization
@@ -184,7 +184,7 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
@@ -193,7 +193,7 @@ No authorization required
<a name="updateUser"></a>
# **updateUser**
> updateUser(username, body)
> updateUser(username, user)
Updated user
@@ -204,7 +204,7 @@ Updated user
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted | [default to null]
**body** | [**User**](/Models/User.md)| Updated user object |
**user** | [**User**](..//Models/User.md)| Updated user object |
### Return type
@@ -212,10 +212,10 @@ null (empty response body)
### Authorization
No authorization required
[auth_cookie](../README.md#auth_cookie)
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined

View File

@@ -0,0 +1,10 @@
# InlineObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | [**String**](string.md) | Updated name of the pet | [optional] [default to null]
**status** | [**String**](string.md) | Updated status of the pet | [optional] [default to null]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -0,0 +1,10 @@
# InlineObject1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additionalMetadata** | [**String**](string.md) | Additional data to pass to server | [optional] [default to null]
**file** | [**File**](file.md) | file to upload | [optional] [default to null]
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

View File

@@ -34,6 +34,8 @@ Class | Method | HTTP request | Description
- [ApiResponse](.//Models/ApiResponse.md)
- [Category](.//Models/Category.md)
- [InlineObject](.//Models/InlineObject.md)
- [InlineObject1](.//Models/InlineObject1.md)
- [Order](.//Models/Order.md)
- [Pet](.//Models/Pet.md)
- [Tag](.//Models/Tag.md)
@@ -50,6 +52,13 @@ Class | Method | HTTP request | Description
- **API key parameter name**: api_key
- **Location**: HTTP header
<a name="auth_cookie"></a>
### auth_cookie
- **Type**: API key
- **API key parameter name**: AUTH_KEY
- **Location**:
<a name="petstore_auth"></a>
### petstore_auth