mirror of
https://github.com/Redocly/redoc.git
synced 2024-11-24 09:33:44 +03:00
Merge branch 'master' into releases
This commit is contained in:
RedocBot
travis@localhost
commit
bf4e251e58
|
|
@ -9,12 +9,12 @@
|
||||||
<nav>
|
<nav>
|
||||||
<header> ReDoc </header>
|
<header> ReDoc </header>
|
||||||
<form id="schema-url-form">
|
<form id="schema-url-form">
|
||||||
<input id="schema-url-input" value='swagger.yml'>
|
<input id="schema-url-input" value='http://rebilly.github.io/SwaggerTemplateRepo/swagger.yaml'>
|
||||||
<button type="submit"> Explore </button>
|
<button type="submit"> Explore </button>
|
||||||
</form>
|
</form>
|
||||||
</nav>
|
</nav>
|
||||||
|
|
||||||
<redoc scroll-y-offset="body > nav" spec-url='swagger.yml'></redoc>
|
<redoc scroll-y-offset="body > nav" spec-url='http://rebilly.github.io:80/SwaggerTemplateRepo/swagger.yaml'></redoc>
|
||||||
|
|
||||||
<!-- ReDoc built file with all dependencies included -->
|
<!-- ReDoc built file with all dependencies included -->
|
||||||
<script src="main.js"> </script>
|
<script src="main.js"> </script>
|
||||||
|
|
|
||||||
877
demo/swagger.yml
877
demo/swagger.yml
|
|
@ -1,877 +0,0 @@
|
||||||
---
|
|
||||||
swagger: "2.0"
|
|
||||||
info:
|
|
||||||
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters."
|
|
||||||
version: "1.0.0"
|
|
||||||
title: "Swagger Petstore"
|
|
||||||
termsOfService: "http://swagger.io/terms/"
|
|
||||||
contact:
|
|
||||||
email: "apiteam@swagger.io"
|
|
||||||
x-logo:
|
|
||||||
url: "https://rebilly.github.io/ReDoc/petstore-logo.png"
|
|
||||||
license:
|
|
||||||
name: "Apache 2.0"
|
|
||||||
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
|
|
||||||
host: "petstore.swagger.io"
|
|
||||||
basePath: "/v2"
|
|
||||||
tags:
|
|
||||||
-
|
|
||||||
name: "Pagination"
|
|
||||||
x-traitTag: true
|
|
||||||
description: |-
|
|
||||||
Sometimes you just can't get enough. For this reason, we've provided a convenient way to access more data in
|
|
||||||
any request for sequential data. Simply call the url in the next_url parameter and we'll respond with the next
|
|
||||||
set of data.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
...
|
|
||||||
"pagination": {
|
|
||||||
"next_url": "https://api.instagram.com/v1/tags/puppy/media/recent?access_token=fb2e77d.47a0479900504cb3ab4a1f626d174d2d&max_id=13872296",
|
|
||||||
"next_max_id": "13872296"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
On views where pagination is present, we also support the `count` parameter.
|
|
||||||
Simply set this to the number of items you'd like to receive. Note that the default values
|
|
||||||
should be fine for most applications - but if you decide to increase this number there is a maximum value
|
|
||||||
defined on each endpoint.
|
|
||||||
externalDocs:
|
|
||||||
description: "Find out more"
|
|
||||||
url: "http://swagger.io"
|
|
||||||
-
|
|
||||||
name: "JSONP"
|
|
||||||
x-traitTag: true
|
|
||||||
description: |-
|
|
||||||
If you're writing an AJAX application, and you'd like to wrap our response with a callback,
|
|
||||||
all you have to do is specify a callback parameter with any API call:
|
|
||||||
|
|
||||||
```
|
|
||||||
https://api.instagram.com/v1/tags/coffee/media/recent?access_token=fb2e77d.47a0479900504cb3ab4a1f626d174d2d&callback=callbackFunction
|
|
||||||
```
|
|
||||||
Would respond with:
|
|
||||||
|
|
||||||
```js
|
|
||||||
callbackFunction({
|
|
||||||
...
|
|
||||||
});
|
|
||||||
```
|
|
||||||
|
|
||||||
> Example of markdown blockquote
|
|
||||||
externalDocs:
|
|
||||||
description: "Find out more"
|
|
||||||
url: "http://swagger.io"
|
|
||||||
-
|
|
||||||
name: "pet"
|
|
||||||
description: "Everything about your Pets"
|
|
||||||
externalDocs:
|
|
||||||
description: "Find out more"
|
|
||||||
url: "http://swagger.io"
|
|
||||||
-
|
|
||||||
name: "store"
|
|
||||||
description: "Access to Petstore orders"
|
|
||||||
-
|
|
||||||
name: "user"
|
|
||||||
description: "Operations about user"
|
|
||||||
externalDocs:
|
|
||||||
description: "Find out more about our store"
|
|
||||||
url: "http://swagger.io"
|
|
||||||
schemes:
|
|
||||||
- "http"
|
|
||||||
paths:
|
|
||||||
/pet:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
summary: "Add a new pet to the store"
|
|
||||||
description: ""
|
|
||||||
operationId: "addPet"
|
|
||||||
consumes:
|
|
||||||
- "application/json"
|
|
||||||
- "application/xml"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "Pet object that needs to be added to the store"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
responses:
|
|
||||||
405:
|
|
||||||
description: "Invalid input"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
x-code-samples:
|
|
||||||
-
|
|
||||||
lang: PHP
|
|
||||||
source: |-
|
|
||||||
$form = new \PetStore\Entities\Pet();
|
|
||||||
$form->setPetType("Dog");
|
|
||||||
$form->setName("Rex");
|
|
||||||
// set other fields
|
|
||||||
|
|
||||||
try {
|
|
||||||
$pet = $client->pets()->create($form);
|
|
||||||
} catch (UnprocessableEntityException $e) {
|
|
||||||
var_dump($e->getErrors());
|
|
||||||
}
|
|
||||||
-
|
|
||||||
lang: C#
|
|
||||||
source: |-
|
|
||||||
PetStore.v1.Pet pet = new PetStore.v1.Pet();
|
|
||||||
pet.setApiKey("your api key");
|
|
||||||
pet.petType = PetStore.v1.Pet.TYPE_DOG;
|
|
||||||
pet.name = "Rex";
|
|
||||||
// set other fields
|
|
||||||
|
|
||||||
PetStoreResponse response = pet.create();
|
|
||||||
if (response.statusCode == HttpStatusCode.Created)
|
|
||||||
{
|
|
||||||
// Successfully created
|
|
||||||
}
|
|
||||||
else
|
|
||||||
{
|
|
||||||
// Something wrong -- check response for errors
|
|
||||||
Console.WriteLine(response.getRawResponse());
|
|
||||||
}
|
|
||||||
put:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
summary: "Update an existing pet"
|
|
||||||
description: ""
|
|
||||||
operationId: "updatePet"
|
|
||||||
consumes:
|
|
||||||
- "application/json"
|
|
||||||
- "application/xml"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "Pet object that needs to be added to the store"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
responses:
|
|
||||||
400:
|
|
||||||
description: "Invalid ID supplied"
|
|
||||||
404:
|
|
||||||
description: "Pet not found"
|
|
||||||
405:
|
|
||||||
description: "Validation exception"
|
|
||||||
x-code-samples:
|
|
||||||
-
|
|
||||||
lang: PHP
|
|
||||||
source: |-
|
|
||||||
$form = new \PetStore\Entities\Pet();
|
|
||||||
$form->setPetId(1);
|
|
||||||
$form->setPetType("Dog");
|
|
||||||
$form->setName("Rex");
|
|
||||||
// set other fields
|
|
||||||
|
|
||||||
try {
|
|
||||||
$pet = $client->pets()->update($form);
|
|
||||||
} catch (UnprocessableEntityException $e) {
|
|
||||||
var_dump($e->getErrors());
|
|
||||||
}
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
/pet/findByStatus:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
- "Pagination"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Finds Pets by status"
|
|
||||||
description: "Multiple status values can be provided with comma seperated strings"
|
|
||||||
operationId: "findPetsByStatus"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "status"
|
|
||||||
in: "query"
|
|
||||||
description: "Status values that need to be considered for filter"
|
|
||||||
required: true
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
type: "string"
|
|
||||||
enum:
|
|
||||||
- "available"
|
|
||||||
- "pending"
|
|
||||||
- "sold"
|
|
||||||
default: "available"
|
|
||||||
collectionFormat: "csv"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
400:
|
|
||||||
description: "Invalid status value"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
/pet/findByTags:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
- "Pagination"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Finds Pets by tags"
|
|
||||||
description: "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing."
|
|
||||||
operationId: "findPetsByTags"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "tags"
|
|
||||||
in: "query"
|
|
||||||
description: "Tags to filter by"
|
|
||||||
required: true
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
type: "string"
|
|
||||||
collectionFormat: "csv"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
400:
|
|
||||||
description: "Invalid tag value"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
/pet/{petId}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Find pet by ID"
|
|
||||||
description: "Returns a single pet"
|
|
||||||
operationId: "getPetById"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "petId"
|
|
||||||
in: "path"
|
|
||||||
description: "ID of pet to return"
|
|
||||||
required: true
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
400:
|
|
||||||
description: "Invalid ID supplied"
|
|
||||||
404:
|
|
||||||
description: "Pet not found"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
api_key: []
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
summary: "Updates a pet in the store with form data"
|
|
||||||
description: ""
|
|
||||||
operationId: "updatePetWithForm"
|
|
||||||
consumes:
|
|
||||||
- "application/x-www-form-urlencoded"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "petId"
|
|
||||||
in: "path"
|
|
||||||
description: "ID of pet that needs to be updated"
|
|
||||||
required: true
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
-
|
|
||||||
name: "name"
|
|
||||||
in: "formData"
|
|
||||||
description: "Updated name of the pet"
|
|
||||||
required: false
|
|
||||||
type: "string"
|
|
||||||
-
|
|
||||||
name: "status"
|
|
||||||
in: "formData"
|
|
||||||
description: "Updated status of the pet"
|
|
||||||
required: false
|
|
||||||
type: "string"
|
|
||||||
responses:
|
|
||||||
405:
|
|
||||||
description: "Invalid input"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
delete:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
summary: "Deletes a pet"
|
|
||||||
description: ""
|
|
||||||
operationId: "deletePet"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "api_key"
|
|
||||||
in: "header"
|
|
||||||
required: false
|
|
||||||
type: "string"
|
|
||||||
-
|
|
||||||
name: "petId"
|
|
||||||
in: "path"
|
|
||||||
description: "Pet id to delete"
|
|
||||||
required: true
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
responses:
|
|
||||||
400:
|
|
||||||
description: "Invalid pet value"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
/pet/{petId}/uploadImage:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "pet"
|
|
||||||
summary: "uploads an image"
|
|
||||||
description: ""
|
|
||||||
operationId: "uploadFile"
|
|
||||||
consumes:
|
|
||||||
- "multipart/form-data"
|
|
||||||
produces:
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "petId"
|
|
||||||
in: "path"
|
|
||||||
description: "ID of pet to update"
|
|
||||||
required: true
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
-
|
|
||||||
name: "additionalMetadata"
|
|
||||||
in: "formData"
|
|
||||||
description: "Additional data to pass to server"
|
|
||||||
required: false
|
|
||||||
type: "string"
|
|
||||||
-
|
|
||||||
name: "file"
|
|
||||||
in: "formData"
|
|
||||||
description: "file to upload"
|
|
||||||
required: false
|
|
||||||
type: "file"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/ApiResponse"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
petstore_auth:
|
|
||||||
- "write:pets"
|
|
||||||
- "read:pets"
|
|
||||||
/store/inventory:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "store"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Returns pet inventories by status"
|
|
||||||
description: "Returns a map of status codes to quantities"
|
|
||||||
operationId: "getInventory"
|
|
||||||
produces:
|
|
||||||
- "application/json"
|
|
||||||
parameters: []
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
type: "object"
|
|
||||||
additionalProperties:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
security:
|
|
||||||
-
|
|
||||||
api_key: []
|
|
||||||
/store/order:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "store"
|
|
||||||
summary: "Place an order for a pet"
|
|
||||||
description: ""
|
|
||||||
operationId: "placeOrder"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "order placed for purchasing the pet"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Order"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Order"
|
|
||||||
400:
|
|
||||||
description: "Invalid Order"
|
|
||||||
/store/order/{orderId}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "store"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Find purchase order by ID"
|
|
||||||
description: "For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions"
|
|
||||||
operationId: "getOrderById"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "orderId"
|
|
||||||
in: "path"
|
|
||||||
description: "ID of pet that needs to be fetched"
|
|
||||||
required: true
|
|
||||||
type: "integer"
|
|
||||||
maximum: 5
|
|
||||||
minimum: 1
|
|
||||||
format: "int64"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/Order"
|
|
||||||
400:
|
|
||||||
description: "Invalid ID supplied"
|
|
||||||
404:
|
|
||||||
description: "Order not found"
|
|
||||||
delete:
|
|
||||||
tags:
|
|
||||||
- "store"
|
|
||||||
summary: "Delete purchase order by ID"
|
|
||||||
description: "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors"
|
|
||||||
operationId: "deleteOrder"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "orderId"
|
|
||||||
in: "path"
|
|
||||||
description: "ID of the order that needs to be deleted"
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
minimum: 1
|
|
||||||
responses:
|
|
||||||
400:
|
|
||||||
description: "Invalid ID supplied"
|
|
||||||
404:
|
|
||||||
description: "Order not found"
|
|
||||||
/user:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Create user"
|
|
||||||
description: "This can only be done by the logged in user."
|
|
||||||
operationId: "createUser"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "Created user object"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/User"
|
|
||||||
responses:
|
|
||||||
default:
|
|
||||||
description: "successful operation"
|
|
||||||
/user/createWithArray:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Creates list of users with given input array"
|
|
||||||
description: ""
|
|
||||||
operationId: "createUsersWithArrayInput"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "List of user object"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/User"
|
|
||||||
responses:
|
|
||||||
default:
|
|
||||||
description: "successful operation"
|
|
||||||
/user/createWithList:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Creates list of users with given input array"
|
|
||||||
description: ""
|
|
||||||
operationId: "createUsersWithListInput"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "List of user object"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: "array"
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/User"
|
|
||||||
responses:
|
|
||||||
default:
|
|
||||||
description: "successful operation"
|
|
||||||
/user/login:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Logs user into the system"
|
|
||||||
description: ""
|
|
||||||
operationId: "loginUser"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "username"
|
|
||||||
in: "query"
|
|
||||||
description: "The user name for login"
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
-
|
|
||||||
name: "password"
|
|
||||||
in: "query"
|
|
||||||
description: "The password for login in clear text"
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
type: "string"
|
|
||||||
headers:
|
|
||||||
X-Rate-Limit:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
description: "calls per hour allowed by the user"
|
|
||||||
X-Expires-After:
|
|
||||||
type: "string"
|
|
||||||
format: "date-time"
|
|
||||||
description: "date in UTC when toekn expires"
|
|
||||||
400:
|
|
||||||
description: "Invalid username/password supplied"
|
|
||||||
/user/logout:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Logs out current logged in user session"
|
|
||||||
description: ""
|
|
||||||
operationId: "logoutUser"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters: []
|
|
||||||
responses:
|
|
||||||
default:
|
|
||||||
description: "successful operation"
|
|
||||||
/user/{username}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
- "JSONP"
|
|
||||||
summary: "Get user by user name"
|
|
||||||
description: ""
|
|
||||||
operationId: "getUserByName"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "username"
|
|
||||||
in: "path"
|
|
||||||
description: "The name that needs to be fetched. Use user1 for testing. "
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "successful operation"
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/User"
|
|
||||||
400:
|
|
||||||
description: "Invalid username supplied"
|
|
||||||
404:
|
|
||||||
description: "User not found"
|
|
||||||
put:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Updated user"
|
|
||||||
description: "This can only be done by the logged in user."
|
|
||||||
operationId: "updateUser"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "username"
|
|
||||||
in: "path"
|
|
||||||
description: "name that need to be deleted"
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
-
|
|
||||||
in: "body"
|
|
||||||
name: "body"
|
|
||||||
description: "Updated user object"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
$ref: "#/definitions/User"
|
|
||||||
responses:
|
|
||||||
400:
|
|
||||||
description: "Invalid user supplied"
|
|
||||||
404:
|
|
||||||
description: "User not found"
|
|
||||||
delete:
|
|
||||||
tags:
|
|
||||||
- "user"
|
|
||||||
summary: "Delete user"
|
|
||||||
description: "This can only be done by the logged in user."
|
|
||||||
operationId: "deleteUser"
|
|
||||||
produces:
|
|
||||||
- "application/xml"
|
|
||||||
- "application/json"
|
|
||||||
parameters:
|
|
||||||
-
|
|
||||||
name: "username"
|
|
||||||
in: "path"
|
|
||||||
description: "The name that needs to be deleted"
|
|
||||||
required: true
|
|
||||||
type: "string"
|
|
||||||
responses:
|
|
||||||
400:
|
|
||||||
description: "Invalid username supplied"
|
|
||||||
404:
|
|
||||||
description: "User not found"
|
|
||||||
securityDefinitions:
|
|
||||||
petstore_auth:
|
|
||||||
type: "oauth2"
|
|
||||||
authorizationUrl: "http://petstore.swagger.io/api/oauth/dialog"
|
|
||||||
flow: "implicit"
|
|
||||||
scopes:
|
|
||||||
write:pets: "modify pets in your account"
|
|
||||||
read:pets: "read your pets"
|
|
||||||
api_key:
|
|
||||||
type: "apiKey"
|
|
||||||
name: "api_key"
|
|
||||||
in: "header"
|
|
||||||
definitions:
|
|
||||||
Order:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
petId:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
quantity:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
shipDate:
|
|
||||||
type: "string"
|
|
||||||
format: "date-time"
|
|
||||||
status:
|
|
||||||
type: "string"
|
|
||||||
description: "Order Status"
|
|
||||||
enum:
|
|
||||||
- "placed"
|
|
||||||
- "approved"
|
|
||||||
- "delivered"
|
|
||||||
complete:
|
|
||||||
type: "boolean"
|
|
||||||
default: false
|
|
||||||
xml:
|
|
||||||
name: "Order"
|
|
||||||
User:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
username:
|
|
||||||
type: "string"
|
|
||||||
firstName:
|
|
||||||
type: "string"
|
|
||||||
lastName:
|
|
||||||
type: "string"
|
|
||||||
email:
|
|
||||||
type: "string"
|
|
||||||
password:
|
|
||||||
type: "string"
|
|
||||||
phone:
|
|
||||||
type: "string"
|
|
||||||
userStatus:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
description: "User Status"
|
|
||||||
xml:
|
|
||||||
name: "User"
|
|
||||||
Category:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
name:
|
|
||||||
type: "string"
|
|
||||||
xml:
|
|
||||||
name: "Category"
|
|
||||||
Tag:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
id:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
name:
|
|
||||||
type: "string"
|
|
||||||
xml:
|
|
||||||
name: "Tag"
|
|
||||||
Pet:
|
|
||||||
type: "object"
|
|
||||||
required:
|
|
||||||
- "name"
|
|
||||||
- "photoUrls"
|
|
||||||
- "petType"
|
|
||||||
discriminator: "petType"
|
|
||||||
properties:
|
|
||||||
petType:
|
|
||||||
type: "string"
|
|
||||||
id:
|
|
||||||
type: "integer"
|
|
||||||
format: "int64"
|
|
||||||
category:
|
|
||||||
$ref: "#/definitions/Category"
|
|
||||||
name:
|
|
||||||
type: "string"
|
|
||||||
example: "doggie"
|
|
||||||
photoUrls:
|
|
||||||
type: "array"
|
|
||||||
xml:
|
|
||||||
name: "photoUrl"
|
|
||||||
wrapped: true
|
|
||||||
items:
|
|
||||||
type: "string"
|
|
||||||
tags:
|
|
||||||
type: "array"
|
|
||||||
xml:
|
|
||||||
name: "tag"
|
|
||||||
wrapped: true
|
|
||||||
items:
|
|
||||||
$ref: "#/definitions/Tag"
|
|
||||||
status:
|
|
||||||
type: "string"
|
|
||||||
description: "pet status in the store"
|
|
||||||
enum:
|
|
||||||
- "available"
|
|
||||||
- "pending"
|
|
||||||
- "sold"
|
|
||||||
xml:
|
|
||||||
name: "Pet"
|
|
||||||
Cat:
|
|
||||||
description: "A representation of a cat"
|
|
||||||
allOf:
|
|
||||||
-
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
-
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
huntingSkill:
|
|
||||||
type: "string"
|
|
||||||
description: "The measured skill for hunting"
|
|
||||||
default: "lazy"
|
|
||||||
enum:
|
|
||||||
- "clueless"
|
|
||||||
- "lazy"
|
|
||||||
- "adventurous"
|
|
||||||
- "aggressive"
|
|
||||||
required:
|
|
||||||
- "huntingSkill"
|
|
||||||
Dog:
|
|
||||||
description: "A representation of a dog"
|
|
||||||
allOf:
|
|
||||||
-
|
|
||||||
$ref: "#/definitions/Pet"
|
|
||||||
-
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
packSize:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
description: "the size of the pack the dog is from"
|
|
||||||
default: 0
|
|
||||||
minimum: 0
|
|
||||||
required:
|
|
||||||
- "packSize"
|
|
||||||
ApiResponse:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: "integer"
|
|
||||||
format: "int32"
|
|
||||||
type:
|
|
||||||
type: "string"
|
|
||||||
message:
|
|
||||||
type: "string"
|
|
||||||
externalDocs:
|
|
||||||
description: "Find out more about Swagger"
|
|
||||||
url: "http://swagger.io"
|
|
||||||
|
|
@ -14,4 +14,8 @@
|
||||||
<span *ngIf="!data.license.url"> {{data.license.name}} </span>
|
<span *ngIf="!data.license.url"> {{data.license.name}} </span>
|
||||||
</span>
|
</span>
|
||||||
</p>
|
</p>
|
||||||
|
<p>
|
||||||
|
Download OpenAPI (fka Swagger) specification:
|
||||||
|
<a class="openapi-button" target="_blank" attr.href='{{specUrl}}'> Download </a>
|
||||||
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -1,18 +1,22 @@
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
import {RedocComponent, BaseComponent} from '../base';
|
import {SchemaManager, RedocComponent, BaseComponent} from '../base';
|
||||||
|
import OptionsManager from '../../options';
|
||||||
|
|
||||||
@RedocComponent({
|
@RedocComponent({
|
||||||
selector: 'api-info',
|
selector: 'api-info',
|
||||||
styleUrls: ['./lib/components/ApiInfo/api-info.css'],
|
styleUrls: ['./lib/components/ApiInfo/api-info.css'],
|
||||||
templateUrl: './lib/components/ApiInfo/api-info.html'
|
templateUrl: './lib/components/ApiInfo/api-info.html'
|
||||||
})
|
})
|
||||||
|
@Reflect.metadata('parameters', [[SchemaManager], [OptionsManager]])
|
||||||
export default class ApiInfo extends BaseComponent {
|
export default class ApiInfo extends BaseComponent {
|
||||||
constructor(schemaMgr) {
|
constructor(schemaMgr, optionsMgr) {
|
||||||
super(schemaMgr);
|
super(schemaMgr);
|
||||||
|
this.optionsMgr = optionsMgr;
|
||||||
}
|
}
|
||||||
|
|
||||||
prepareModel() {
|
prepareModel() {
|
||||||
this.data = this.componentSchema.info;
|
this.data = this.componentSchema.info;
|
||||||
|
this.specUrl = this.optionsMgr.options.specUrl;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -7,3 +7,11 @@
|
||||||
:host > div {
|
:host > div {
|
||||||
width: 60%;
|
width: 60%;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
a.openapi-button {
|
||||||
|
padding: 3px 8px 4px 8px;
|
||||||
|
color: $primary-color;
|
||||||
|
border: 1px solid $primary-color;
|
||||||
|
margin-left: 0.5em;
|
||||||
|
font-weight: normal;
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -13,7 +13,9 @@ import {
|
||||||
|
|
||||||
import ApiInfo from 'lib/components/ApiInfo/api-info';
|
import ApiInfo from 'lib/components/ApiInfo/api-info';
|
||||||
import SchemaManager from 'lib/utils/SchemaManager';
|
import SchemaManager from 'lib/utils/SchemaManager';
|
||||||
|
import OptionsManager from 'lib/options';
|
||||||
|
|
||||||
|
let optsMgr = new OptionsManager();
|
||||||
|
|
||||||
describe('Redoc components', () => {
|
describe('Redoc components', () => {
|
||||||
describe('ApiInfo Component', () => {
|
describe('ApiInfo Component', () => {
|
||||||
|
|
@ -21,7 +23,8 @@ describe('Redoc components', () => {
|
||||||
let component;
|
let component;
|
||||||
let fixture;
|
let fixture;
|
||||||
beforeEachProviders(() => [
|
beforeEachProviders(() => [
|
||||||
provide(SchemaManager, {useValue: new SchemaManager()})
|
provide(SchemaManager, {useValue: new SchemaManager()}),
|
||||||
|
provide(OptionsManager, {useValue: optsMgr})
|
||||||
]);
|
]);
|
||||||
beforeEach(injectAsync([TestComponentBuilder, SchemaManager], (tcb, schemaMgr) => {
|
beforeEach(injectAsync([TestComponentBuilder, SchemaManager], (tcb, schemaMgr) => {
|
||||||
builder = tcb;
|
builder = tcb;
|
||||||
|
|
|
||||||
|
|
@ -57,9 +57,10 @@ export default class Redoc extends BaseComponent {
|
||||||
}, 400);
|
}, 400);
|
||||||
}
|
}
|
||||||
|
|
||||||
static init(schemaUrl, options) {
|
static init(specUrl, options) {
|
||||||
var optionsMgr = new OptionsManager();
|
var optionsMgr = new OptionsManager();
|
||||||
optionsMgr.options = options;
|
optionsMgr.options = options;
|
||||||
|
optionsMgr.options.specUrl = optionsMgr.options.specUrl || specUrl;
|
||||||
var providers = [
|
var providers = [
|
||||||
provide(OptionsManager, {useValue: optionsMgr})
|
provide(OptionsManager, {useValue: optionsMgr})
|
||||||
];
|
];
|
||||||
|
|
@ -68,7 +69,7 @@ export default class Redoc extends BaseComponent {
|
||||||
Redoc.dispose();
|
Redoc.dispose();
|
||||||
}
|
}
|
||||||
Redoc.showLoadingAnimation();
|
Redoc.showLoadingAnimation();
|
||||||
return SchemaManager.instance().load(schemaUrl)
|
return SchemaManager.instance().load(specUrl)
|
||||||
.then(() => {
|
.then(() => {
|
||||||
if (!_modeLocked && !optionsMgr.options.debugMode) {
|
if (!_modeLocked && !optionsMgr.options.debugMode) {
|
||||||
enableProdMode();
|
enableProdMode();
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ var defaults = {
|
||||||
debugMode: global.redocDebugMode
|
debugMode: global.redocDebugMode
|
||||||
};
|
};
|
||||||
|
|
||||||
var OPTION_NAMES = new Set(['scrollYOffset', 'disableLazySchemas']);
|
var OPTION_NAMES = new Set(['scrollYOffset', 'disableLazySchemas', 'specUrl']);
|
||||||
|
|
||||||
@Reflect.metadata('parameters', [[BrowserDomAdapter]])
|
@Reflect.metadata('parameters', [[BrowserDomAdapter]])
|
||||||
export default class OptionsManager {
|
export default class OptionsManager {
|
||||||
|
|
|
||||||
|
|
@ -1,7 +1,7 @@
|
||||||
{
|
{
|
||||||
"name": "redoc",
|
"name": "redoc",
|
||||||
"description": "Swagger-generated API Reference Documentation",
|
"description": "Swagger-generated API Reference Documentation",
|
||||||
"version": "0.7.9",
|
"version": "0.7.10",
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git://github.com/Rebilly/ReDoc"
|
"url": "git://github.com/Rebilly/ReDoc"
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@
|
||||||
<script>
|
<script>
|
||||||
window.redocError = null;
|
window.redocError = null;
|
||||||
/* init redoc */
|
/* init redoc */
|
||||||
var url = window.location.search.substr(5) || 'swagger.yml';
|
var url = window.location.search.substr(5) || 'http://rebilly.github.io:80/SwaggerTemplateRepo/swagger.json';
|
||||||
Redoc.init(decodeURIComponent(url), {disableLazySchemas: true}).then(function() {}, function(err) {
|
Redoc.init(decodeURIComponent(url), {disableLazySchemas: true}).then(function() {}, function(err) {
|
||||||
window.redocError = err;
|
window.redocError = err;
|
||||||
});
|
});
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user