diff --git a/samples/html/index.html b/samples/html/index.html index bab16472c30..7ce9ee130e2 100644 --- a/samples/html/index.html +++ b/samples/html/index.html @@ -18,8 +18,321 @@ +
+
put: /pet
+
Pet
+
updatePet Update an existing pet
+
+ +

Parameters

+
+
body (optional)
+ +
Body Parameter — Pet object that needs to be added to the store
+ +
+

Return type

+ +
+ + +
+
+ +
+
post: /pet
+
Pet
+
addPet Add a new pet to the store
+
+ +

Parameters

+
+
body (optional)
+ +
Body Parameter — Pet object that needs to be added to the store
+ +
+

Return type

+ +
+ + +
+
+ +
+
get: /pet/findByStatus
+
Pet
+
findPetsByStatus Finds Pets by status
+
Multiple status values can be provided with comma seperated strings
+ +

Parameters

+
+
status (optional)
+ +
Query Parameter — Status values that need to be considered for filter
+ +
+

Return type

+ +
array[Pet]
+ + +

Example data

+
Content-Type: application/json
+
[ {\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n} ]
+ +

Example data

+
Content-Type: application/xml
+
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
+ +
+
+ +
+
get: /pet/findByTags
+
Pet
+
findPetsByTags Finds Pets by tags
+
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+ +

Parameters

+
+
tags (optional)
+ +
Query Parameter — Tags to filter by
+ +
+

Return type

+ +
array[Pet]
+ + +

Example data

+
Content-Type: application/json
+
[ {\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n} ]
+ +

Example data

+
Content-Type: application/xml
+
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
+ +
+
+ +
+
get: /pet/{petId}
+
Pet
+
getPetById Find pet by ID
+
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
+ +

Parameters

+
+
petId (required)
+ +
Path Parameter — ID of pet that needs to be fetched
+ +
+

Return type

+ +
Pet
+ + +

Example data

+
Content-Type: application/json
+
{\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n}
+ +

Example data

+
Content-Type: application/xml
+
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
+ +
+
+ +
+
post: /pet/{petId}
+
Pet
+
updatePetWithForm Updates a pet in the store with form data
+
+ +

Parameters

+
+
petId (required)
+ +
Path Parameter — ID of pet that needs to be updated
+
name (optional)
+ +
Form Parameter — Updated name of the pet
+
status (optional)
+ +
Form Parameter — Updated status of the pet
+ +
+

Return type

+ +
+ + +
+
+ +
+
delete: /pet/{petId}
+
Pet
+
deletePet Deletes a pet
+
+ +

Parameters

+
+
api_key (optional)
+ +
Header Parameter
+
petId (required)
+ +
Path Parameter — Pet id to delete
+ +
+

Return type

+ +
+ + +
+
+ +
+
post: /pet/{petId}/uploadImage
+
Pet
+
uploadFile uploads an image
+
+ +

Parameters

+
+
petId (required)
+ +
Path Parameter — ID of pet to update
+
additionalMetadata (optional)
+ +
Form Parameter — Additional data to pass to server
+
file (optional)
+ +
Form Parameter — file to upload
+ +
+

Return type

+ +
+ + +
+
+ +
+
get: /store/inventory
+
Store
+
getInventory Returns pet inventories by status
+
Returns a map of status codes to quantities
+ +

Parameters

+
+ +
+

Return type

+ +
map[String, Integer]
+ + +

Example data

+
Content-Type: application/json
+
{\n  "key" : 123\n}
+ +

Example data

+
Content-Type: application/xml
+
not implemented com.wordnik.swagger.models.properties.MapProperty@5076b51c
+ +
+
+ +
+
post: /store/order
+
Store
+
placeOrder Place an order for a pet
+
+ +

Parameters

+
+
body (optional)
+ +
Body Parameter — order placed for purchasing the pet
+ +
+

Return type

+ +
Order
+ + +

Example data

+
Content-Type: application/json
+
{\n  "id" : 123456789,\n  "petId" : 123456789,\n  "complete" : true,\n  "status" : "aeiou",\n  "quantity" : 123,\n  "shipDate" : "2015-05-12T09:58:06.953+0000"\n}
+ +

Example data

+
Content-Type: application/xml
+
\n  123456\n  123456\n  0\n  2015-05-12T05:58:06.956Z\n  string\n  true\n
+ +
+
+ +
+
get: /store/order/{orderId}
+
Store
+
getOrderById Find purchase order by ID
+
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
+ +

Parameters

+
+
orderId (required)
+ +
Path Parameter — ID of pet that needs to be fetched
+ +
+

Return type

+ +
Order
+ + +

Example data

+
Content-Type: application/json
+
{\n  "id" : 123456789,\n  "petId" : 123456789,\n  "complete" : true,\n  "status" : "aeiou",\n  "quantity" : 123,\n  "shipDate" : "2015-05-12T09:58:06.957+0000"\n}
+ +

Example data

+
Content-Type: application/xml
+
\n  123456\n  123456\n  0\n  2015-05-12T05:58:06.957Z\n  string\n  true\n
+ +
+
+ +
+
delete: /store/order/{orderId}
+
Store
+
deleteOrder Delete purchase order by ID
+
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
+ +

Parameters

+
+
orderId (required)
+ +
Path Parameter — ID of the order that needs to be deleted
+ +
+

Return type

+ +
+ + +
+
+
post: /user
+
User
createUser Create user
This can only be done by the logged in user.
@@ -40,6 +353,7 @@
post: /user/createWithArray
+
User
createUsersWithArrayInput Creates list of users with given input array
@@ -60,6 +374,7 @@
post: /user/createWithList
+
User
createUsersWithListInput Creates list of users with given input array
@@ -80,6 +395,7 @@
get: /user/login
+
User
loginUser Logs user into the system
@@ -111,6 +427,7 @@
get: /user/logout
+
User
logoutUser Logs out current logged in user session
@@ -128,6 +445,7 @@
get: /user/{username}
+
User
getUserByName Get user by user name
@@ -156,6 +474,7 @@
put: /user/{username}
+
User
updateUser Updated user
This can only be done by the logged in user.
@@ -179,6 +498,7 @@
delete: /user/{username}
+
User
deleteUser Delete user
This can only be done by the logged in user.
@@ -198,310 +518,6 @@
- -
-
put: /pet
-
updatePet Update an existing pet
-
- -

Parameters

-
-
body (optional)
- -
Body Parameter — Pet object that needs to be added to the store
- -
-

Return type

- -
- - -
-
- -
-
post: /pet
-
addPet Add a new pet to the store
-
- -

Parameters

-
-
body (optional)
- -
Body Parameter — Pet object that needs to be added to the store
- -
-

Return type

- -
- - -
-
- -
-
get: /pet/findByStatus
-
findPetsByStatus Finds Pets by status
-
Multiple status values can be provided with comma seperated strings
- -

Parameters

-
-
status (optional)
- -
Query Parameter — Status values that need to be considered for filter
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
[ {\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n} ]
- -

Example data

-
Content-Type: application/xml
-
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
- -
-
- -
-
get: /pet/findByTags
-
findPetsByTags Finds Pets by tags
-
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
- -

Parameters

-
-
tags (optional)
- -
Query Parameter — Tags to filter by
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
[ {\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n} ]
- -

Example data

-
Content-Type: application/xml
-
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
- -
-
- -
-
get: /pet/{petId}
-
getPetById Find pet by ID
-
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
- -

Parameters

-
-
petId (required)
- -
Path Parameter — ID of pet that needs to be fetched
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{\n  "tags" : [ {\n    "id" : 123456789,\n    "name" : "aeiou"\n  } ],\n  "id" : 123456789,\n  "category" : {\n    "id" : 123456789,\n    "name" : "aeiou"\n  },\n  "status" : "aeiou",\n  "name" : "doggie",\n  "photoUrls" : [ "aeiou" ]\n}
- -

Example data

-
Content-Type: application/xml
-
\n  123456\n  \n    123456\n    string\n  \n  doggie\n  string\n  \n    123456\n    string\n  \n  string\n
- -
-
- -
-
post: /pet/{petId}
-
updatePetWithForm Updates a pet in the store with form data
-
- -

Parameters

-
-
petId (required)
- -
Path Parameter — ID of pet that needs to be updated
-
name (optional)
- -
Form Parameter — Updated name of the pet
-
status (optional)
- -
Form Parameter — Updated status of the pet
- -
-

Return type

- -
- - -
-
- -
-
delete: /pet/{petId}
-
deletePet Deletes a pet
-
- -

Parameters

-
-
api_key (optional)
- -
Header Parameter
-
petId (required)
- -
Path Parameter — Pet id to delete
- -
-

Return type

- -
- - -
-
- -
-
post: /pet/{petId}/uploadImage
-
uploadFile uploads an image
-
- -

Parameters

-
-
petId (required)
- -
Path Parameter — ID of pet to update
-
additionalMetadata (optional)
- -
Form Parameter — Additional data to pass to server
-
file (optional)
- -
Form Parameter — file to upload
- -
-

Return type

- -
- - -
-
- - - -
-
get: /store/inventory
-
getInventory Returns pet inventories by status
-
Returns a map of status codes to quantities
- -

Parameters

-
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{\n  "key" : 123\n}
- -

Example data

-
Content-Type: application/xml
-
not implemented com.wordnik.swagger.models.properties.MapProperty@3c536f11
- -
-
- -
-
post: /store/order
-
placeOrder Place an order for a pet
-
- -

Parameters

-
-
body (optional)
- -
Body Parameter — order placed for purchasing the pet
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{\n  "id" : 123456789,\n  "petId" : 123456789,\n  "complete" : true,\n  "status" : "aeiou",\n  "quantity" : 123,\n  "shipDate" : "2015-04-16T14:41:29.883+0000"\n}
- -

Example data

-
Content-Type: application/xml
-
\n  123456\n  123456\n  0\n  2015-04-16T22:41:29.886Z\n  string\n  true\n
- -
-
- -
-
get: /store/order/{orderId}
-
getOrderById Find purchase order by ID
-
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
- -

Parameters

-
-
orderId (required)
- -
Path Parameter — ID of pet that needs to be fetched
- -
-

Return type

- - - - -

Example data

-
Content-Type: application/json
-
{\n  "id" : 123456789,\n  "petId" : 123456789,\n  "complete" : true,\n  "status" : "aeiou",\n  "quantity" : 123,\n  "shipDate" : "2015-04-16T14:41:29.887+0000"\n}
- -

Example data

-
Content-Type: application/xml
-
\n  123456\n  123456\n  0\n  2015-04-16T22:41:29.888Z\n  string\n  true\n
- -
-
- -
-
delete: /store/order/{orderId}
-
deleteOrder Delete purchase order by ID
-
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
- -

Parameters

-
-
orderId (required)
- -
Path Parameter — ID of the order that needs to be deleted
- -
-

Return type

- -
- - -
-
- -

Models

@@ -631,6 +647,7 @@ hr { pre { padding: 10px; + margin-bottom: 2px; } pre.get { @@ -712,6 +729,19 @@ code { font-weight: bold; } +.method-tags { + text-align: right; +} + +.method-tag { + background: none repeat scroll 0% 0% #24A600; + border-radius: 3px; + padding: 2px 10px; + margin: 2px; + color: #FFF; + display: inline-block; + text-decoration: none; +} \ No newline at end of file