mirror of
https://github.com/sourcey/spectacle.git
synced 2024-09-11 05:25:36 +03:00
Add perstore expanded example fixture
Fix #46 parsing `schema.$ref` in response block
This commit is contained in:
parent
7da1b10f69
commit
8c946991d6
7
TODO.md
7
TODO.md
@ -1,2 +1,5 @@
|
||||
Render recursive examples
|
||||
Render remote refferences
|
||||
Render recursive examples
|
||||
- code here: https://github.com/sourcey/spectacle/commit/eb20f0292c041857adbd36ceefc10df319f81f3c
|
||||
- needs work: https://github.com/sourcey/spectacle/pull/42
|
||||
Render remote references
|
||||
- https://github.com/sourcey/spectacle/pull/41
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "spectacle-docs",
|
||||
"version": "0.7.2",
|
||||
"version": "0.7.5",
|
||||
"description": "Generate beautiful static API documentation from OpenAPI/Swagger 2.0 specifications",
|
||||
"preferGlobal": true,
|
||||
"bin": {
|
||||
|
@ -16,6 +16,8 @@
|
||||
<button class="close-button" aria-label="Close menu" type="button" data-drawer-close>
|
||||
<span aria-hidden="true">×</span>
|
||||
</button>
|
||||
<div id="logo">
|
||||
<img src="images/cheese.png" title="Cheese Store" /> </div>
|
||||
<nav id="nav" role="navigation">
|
||||
<h5>API Reference</h5>
|
||||
<a href="#introduction">Introduction</a>
|
||||
@ -265,7 +267,7 @@
|
||||
<div class="prop-title">200 OK</div>
|
||||
<div class="prop-ref">
|
||||
<span class="">
|
||||
<a class="json-schema-ref" href="#/definitions/Cheese">Cheese</a>
|
||||
<a class="json-schema-ref" href="#/definitions/Cheese1">Cheese1</a>
|
||||
</span>
|
||||
</div>
|
||||
<!-- <span class="swagger-global"></span> <span class="json-schema-reference"><a href=""></a></span> -->
|
||||
@ -289,17 +291,7 @@
|
||||
<h5>Response Example
|
||||
<span>(200 OK)</span>
|
||||
</h5>
|
||||
<div class="hljs"><pre><code class="lang-json">{
|
||||
<span class="hljs-attr">"category"</span>: {
|
||||
<span class="hljs-attr">"$ref"</span>: <span class="hljs-string"><a href="#definition-Category">"#/definitions/Category"</a></span>
|
||||
},
|
||||
<span class="hljs-attr">"id"</span>: <span class="hljs-string">"integer(int64)"</span>,
|
||||
<span class="hljs-attr">"name"</span>: <span class="hljs-string">"Gorgonzola"</span>,
|
||||
<span class="hljs-attr">"photoUrls"</span>: <span class="hljs-string">"array"</span>,
|
||||
<span class="hljs-attr">"status"</span>: <span class="hljs-string">"string"</span>,
|
||||
<span class="hljs-attr">"tags"</span>: <span class="hljs-string">"array"</span>
|
||||
}
|
||||
</code></pre> </div>
|
||||
<div class="hljs"></div>
|
||||
</section>
|
||||
</div>
|
||||
</div>
|
||||
|
2
test/fixtures/cheese.json
vendored
2
test/fixtures/cheese.json
vendored
@ -73,7 +73,7 @@
|
||||
"200": {
|
||||
"description": "Successful operation",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Cheese"
|
||||
"$ref": "#/definitions/Cheese1"
|
||||
}
|
||||
},
|
||||
"405": {
|
||||
|
210
test/fixtures/petstore-expanded.json
vendored
Normal file
210
test/fixtures/petstore-expanded.json
vendored
Normal file
@ -0,0 +1,210 @@
|
||||
{
|
||||
"swagger": "2.0",
|
||||
"info": {
|
||||
"version": "1.0.0",
|
||||
"title": "Swagger Petstore",
|
||||
"description": "A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification",
|
||||
"termsOfService": "http://swagger.io/terms/",
|
||||
"contact": {
|
||||
"name": "Swagger API Team",
|
||||
"email": "foo@example.com",
|
||||
"url": "http://madskristensen.net"
|
||||
},
|
||||
"license": {
|
||||
"name": "MIT",
|
||||
"url": "http://github.com/gruntjs/grunt/blob/master/LICENSE-MIT"
|
||||
}
|
||||
},
|
||||
"host": "petstore.swagger.io",
|
||||
"basePath": "/api",
|
||||
"schemes": [
|
||||
"http"
|
||||
],
|
||||
"consumes": [
|
||||
"application/json"
|
||||
],
|
||||
"produces": [
|
||||
"application/json"
|
||||
],
|
||||
"paths": {
|
||||
"/pets": {
|
||||
"get": {
|
||||
"description": "Returns all pets from the system that the user has access to\nNam sed condimentum est. Maecenas tempor sagittis sapien, nec rhoncus sem sagittis sit amet. Aenean at gravida augue, ac iaculis sem. Curabitur odio lorem, ornare eget elementum nec, cursus id lectus. Duis mi turpis, pulvinar ac eros ac, tincidunt varius justo. In hac habitasse platea dictumst. Integer at adipiscing ante, a sagittis ligula. Aenean pharetra tempor ante molestie imperdiet. Vivamus id aliquam diam. Cras quis velit non tortor eleifend sagittis. Praesent at enim pharetra urna volutpat venenatis eget eget mauris. In eleifend fermentum facilisis. Praesent enim enim, gravida ac sodales sed, placerat id erat. Suspendisse lacus dolor, consectetur non augue vel, vehicula interdum libero. Morbi euismod sagittis libero sed lacinia.\n\nSed tempus felis lobortis leo pulvinar rutrum. Nam mattis velit nisl, eu condimentum ligula luctus nec. Phasellus semper velit eget aliquet faucibus. In a mattis elit. Phasellus vel urna viverra, condimentum lorem id, rhoncus nibh. Ut pellentesque posuere elementum. Sed a varius odio. Morbi rhoncus ligula libero, vel eleifend nunc tristique vitae. Fusce et sem dui. Aenean nec scelerisque tortor. Fusce malesuada accumsan magna vel tempus. Quisque mollis felis eu dolor tristique, sit amet auctor felis gravida. Sed libero lorem, molestie sed nisl in, accumsan tempor nisi. Fusce sollicitudin massa ut lacinia mattis. Sed vel eleifend lorem. Pellentesque vitae felis pretium, pulvinar elit eu, euismod sapien.\n",
|
||||
"operationId": "findPets",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "tags",
|
||||
"in": "query",
|
||||
"description": "tags to filter by",
|
||||
"required": false,
|
||||
"type": "array",
|
||||
"collectionFormat": "csv",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
{
|
||||
"name": "limit",
|
||||
"in": "query",
|
||||
"description": "maximum number of results to return",
|
||||
"required": false,
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "pet response",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"post": {
|
||||
"description": "Creates a new pet in the store. Duplicates are allowed",
|
||||
"operationId": "addPet",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "pet",
|
||||
"in": "body",
|
||||
"description": "Pet to add to the store",
|
||||
"required": true,
|
||||
"schema": {
|
||||
"$ref": "#/definitions/NewPet"
|
||||
}
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "pet response",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/pets/{id}": {
|
||||
"get": {
|
||||
"description": "Returns a user based on a single ID, if the user does not have access to the pet",
|
||||
"operationId": "find pet by id",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"description": "ID of pet to fetch",
|
||||
"required": true,
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "pet response",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Pet"
|
||||
}
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"delete": {
|
||||
"description": "deletes a single pet based on the ID supplied",
|
||||
"operationId": "deletePet",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "id",
|
||||
"in": "path",
|
||||
"description": "ID of pet to delete",
|
||||
"required": true,
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "pet deleted"
|
||||
},
|
||||
"default": {
|
||||
"description": "unexpected error",
|
||||
"schema": {
|
||||
"$ref": "#/definitions/Error"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"definitions": {
|
||||
"Pet": {
|
||||
"type": "object",
|
||||
"allOf": [
|
||||
{
|
||||
"$ref": "#/definitions/NewPet"
|
||||
},
|
||||
{
|
||||
"required": [
|
||||
"id"
|
||||
],
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"format": "int64"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"NewPet": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name"
|
||||
],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"tag": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Error": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"code",
|
||||
"message"
|
||||
],
|
||||
"properties": {
|
||||
"code": {
|
||||
"type": "integer",
|
||||
"format": "int32"
|
||||
},
|
||||
"message": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue
Block a user