From aa87b43f378257b2eaf5efa4e9f8d3e87b1aa991 Mon Sep 17 00:00:00 2001 From: Nils Knappmeier Date: Fri, 1 Jul 2016 09:53:54 +0200 Subject: [PATCH] Bump to version: v0.17.0 --- CHANGELOG.md | 4 +++ README.md | 4 +-- handlebars-partials.md | 71 ++++++++++++------------------------------ package.json | 2 +- 4 files changed, 27 insertions(+), 54 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2592699..4c5a709 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,10 @@ # Release notes +# Version 0.17.0 (Fri, 01 Jul 2016 07:53:44 GMT) + +* [cc65bcb](https://github.com/bootprint/bootprint-openapi/commit/cc65bcb) Add baseUrl property to generated output body (#71) - Taylor Hicks + # Version 0.16.0 (Fri, 22 Apr 2016 04:45:01 GMT) * [31de1ba](https://github.com/bootprint/bootprint-openapi/commit/31de1ba) Improved the look of the security definitions which now properly converts markdown to HTML in the description field. - aberman diff --git a/README.md b/README.md index c87c941..cde0bb2 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # bootprint-openapi [![NPM version](https://badge.fury.io/js/bootprint-openapi.svg)](http://badge.fury.io/js/bootprint-openapi) - [![Travis Build Status](https://travis-ci.org/bootprint/bootprint-openapi.svg?branch=master)](https://travis-ci.org/bootprint/bootprint-openapi) - [![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint-openapi.svg)](https://coveralls.io/r/bootprint/bootprint-openapi) +[![Travis Build Status](https://travis-ci.org/bootprint/bootprint-openapi.svg?branch=master)](https://travis-ci.org/bootprint/bootprint-openapi) +[![Coverage Status](https://img.shields.io/coveralls/bootprint/bootprint-openapi.svg)](https://coveralls.io/r/bootprint/bootprint-openapi) > Converts a openapi-definition into a static html page diff --git a/handlebars-partials.md b/handlebars-partials.md index d5ea0af..747cb16 100644 --- a/handlebars-partials.md +++ b/handlebars-partials.md @@ -26,91 +26,60 @@ │ │ │ ├── swagger/list-of-labels │ │ │ │ Renders an array of strings as list of labels │ │ │ ├── *swagger/list-of-labels* -│ │ │ │ │ │ │ └─┬ swagger/model │ │ │ │ Renders a json-schema model within swagger... │ │ │ └─┬ json-schema/main-panel -│ │ │ │ │ │ │ ├── json-schema/datatype │ │ │ │ Enum values │ │ │ ├── json-schema/reference -│ │ │ │ │ │ │ └─┬ json-schema/body -│ │ │ │ │ │ │ ├─┬ json-schema/type-object │ │ │ │ │ Renders the properties of an `object` │ │ │ │ ├─┬ json-schema/properties -│ │ │ │ │ │ │ │ │ │ │ ├── *json-schema/datatype* -│ │ │ │ │ │ │ │ │ │ │ └── *json-schema/body* -│ │ │ │ │ │ │ │ │ └─┬ json-schema/additionalProperties -│ │ │ │ │ │ │ │ │ ├── *json-schema/datatype* -│ │ │ │ │ │ │ │ │ └── *json-schema/body* -│ │ │ │ │ │ │ ├─┬ json-schema/array-items -│ │ │ │ │ │ │ │ │ ├── *json-schema/datatype* -│ │ │ │ │ │ │ │ │ └── *json-schema/body* -│ │ │ │ │ │ │ ├── *json-schema/type-object* -│ │ │ │ │ │ │ ├─┬ json-schema/allOf -│ │ │ │ │ │ │ │ │ ├── *json-schema/reference* -│ │ │ │ │ │ │ │ │ └── *json-schema/body* -│ │ │ │ │ │ │ └─┬ json-schema/anyOf -│ │ │ │ │ │ │ ├── *json-schema/datatype* -│ │ │ │ │ │ │ └── *json-schema/body* -│ │ │ │ │ ├─┬ swagger/parameters │ │ │ │ Renders the parameter table within a operation... │ │ │ ├── swagger/parameterRow │ │ │ │ Display a single parameter in a table row. │ │ │ └── *swagger/parameterRow* -│ │ │ │ │ ├─┬ swagger/responses │ │ │ │ Renders the responses section of an operation │ │ │ ├── *swagger/list-of-labels* -│ │ │ │ │ │ │ ├── *swagger/list-of-labels* -│ │ │ │ │ │ │ ├─┬ swagger/response │ │ │ │ │ Renders details about a single response │ │ │ │ ├── *swagger/model* -│ │ │ │ │ │ │ │ │ ├─┬ swagger/responseHeaderRow │ │ │ │ │ │ Display a single parameter in a table row. │ │ │ │ │ ├── *json-schema/datatype* -│ │ │ │ │ │ │ │ │ │ │ └── *json-schema/datatype* -│ │ │ │ │ │ │ │ │ └── *swagger/responseHeaderRow* -│ │ │ │ │ │ │ └── *swagger/response* -│ │ │ │ │ └── swagger/security │ │ Renders the security definitions of the... │ ├─┬ swagger/parameterDefinitions │ │ │ Global parameter definitions (see... │ │ └── *swagger/parameterRow* -│ │ │ ├─┬ swagger/responseDefinitions │ │ │ Renders the response definitions │ │ └── *swagger/response* -│ │ │ └─┬ swagger/definitions │ │ Renders the definition-section of the HTML-page. │ └── *swagger/model* -│ └── base/footer This partial is displayed at the bottom of the... @@ -118,7 +87,7 @@ ## base/body -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) This partial renders the of the HTML page. @@ -170,7 +139,7 @@ the Bootprint-result. ## base/title -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the page title @@ -304,7 +273,7 @@ Uses the following partials: ## swagger/definitions -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the definition-section of the HTML-page. @@ -320,7 +289,7 @@ Uses the following partials: ## swagger/list-of-labels -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders an array of strings as list of labels @@ -334,7 +303,7 @@ Renders an array of strings as list of labels ## swagger/model -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders a json-schema model within swagger (calls json-schema-partials). @@ -351,7 +320,7 @@ Uses the following partials: ## swagger/operation -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) This partial renders a box containing information about a single operation of the service @@ -372,7 +341,7 @@ Uses the following partials: ## swagger/parameterDefinitions -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Global parameter definitions (see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject) @@ -388,7 +357,7 @@ Uses the following partials: ## swagger/parameterRow -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Display a single parameter in a table row. @@ -405,7 +374,7 @@ Display a single parameter in a table row. ## swagger/parameters -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the parameter table within a operation definition. @@ -425,7 +394,7 @@ Uses the following partials: ## swagger/path -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders a single path definition with all its methods (GET, POST). @@ -442,7 +411,7 @@ Uses the following partials: ## swagger/paths -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the paths-section of the Rest-Service definition @@ -456,7 +425,7 @@ Uses the following partials: ## swagger/request-body -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the request-body section of an operation. @@ -475,7 +444,7 @@ Uses the following partials: ## swagger/response -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders details about a single response @@ -493,7 +462,7 @@ Uses the following partials: ## swagger/responseDefinitions -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the response definitions @@ -507,7 +476,7 @@ Uses the following partials: ## swagger/responseHeaderRow -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Display a single parameter in a table row. @@ -525,7 +494,7 @@ Uses the following partials: ## swagger/responses -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the responses section of an operation @@ -545,7 +514,7 @@ Uses the following partials: ## swagger/security -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the security definitions of the Rest-service. @@ -559,7 +528,7 @@ Renders the security definitions of the Rest-service. ## swagger/securityDefinitions -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders the security-section of the HTML-page @@ -572,7 +541,7 @@ TODO: Parameters ## swagger/summary -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders a summary of this services ignoring tags, containing references to all operations and paths @@ -584,7 +553,7 @@ Renders a summary of this services ignoring tags, containing references to all o ## swagger/tags -(jump to source in bootprint-openapi@0.16.0) +(jump to source in bootprint-openapi@0.17.0) Renders a summary based on the tags of this services, containing references to all operations and paths diff --git a/package.json b/package.json index 6577d07..0991459 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "bootprint-openapi", - "version": "0.16.0", + "version": "0.17.0", "description": "Converts a openapi-definition into a static html page", "main": "index.js", "preferGlobal": true,