Skip to content

Commit

Permalink
Bump to version: v0.17.0
Browse files Browse the repository at this point in the history
  • Loading branch information
nknapp committed Jul 1, 2016
1 parent cc65bcb commit aa87b43
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 54 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Release notes

<a name="current-release"></a>
# 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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
71 changes: 20 additions & 51 deletions handlebars-partials.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,99 +26,68 @@
│ │ │ ├── <b><a href="#swaggerlist-of-labels">swagger/list-of-labels</a></b>
│ │ │ │ <i>Renders an array of strings as list of labels</i>
│ │ │ ├── <b><a href="#swaggerlist-of-labels">*swagger/list-of-labels*</a></b>
│ │ │ │
│ │ │ └─┬ <b><a href="#swaggermodel">swagger/model</a></b>
│ │ │ │ <i>Renders a json-schema model within swagger...</i>
│ │ │ └─┬ <b><a href="#json-schemamain-panel">json-schema/main-panel</a></b>
│ │ │ │
│ │ │ ├── <b><a href="#json-schemadatatype">json-schema/datatype</a></b>
│ │ │ │ <i>Enum values</i>
│ │ │ ├── <b><a href="#json-schemareference">json-schema/reference</a></b>
│ │ │ │
│ │ │ └─┬ <b><a href="#json-schemabody">json-schema/body</a></b>
│ │ │ │
│ │ │ ├─┬ <b><a href="#json-schematype-object">json-schema/type-object</a></b>
│ │ │ │ │ <i>Renders the properties of an `object`</i>
│ │ │ │ ├─┬ <b><a href="#json-schemaproperties">json-schema/properties</a></b>
│ │ │ │ │ │
│ │ │ │ │ ├── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │ │ │
│ │ │ │ │ └── <b><a href="#json-schemabody">*json-schema/body*</a></b>
│ │ │ │ │
│ │ │ │ └─┬ <b><a href="#json-schemaadditionalproperties">json-schema/additionalProperties</a></b>
│ │ │ │ │
│ │ │ │ ├── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │ │
│ │ │ │ └── <b><a href="#json-schemabody">*json-schema/body*</a></b>
│ │ │ │
│ │ │ ├─┬ <b><a href="#json-schemaarray-items">json-schema/array-items</a></b>
│ │ │ │ │
│ │ │ │ ├── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │ │
│ │ │ │ └── <b><a href="#json-schemabody">*json-schema/body*</a></b>
│ │ │ │
│ │ │ ├── <b><a href="#json-schematype-object">*json-schema/type-object*</a></b>
│ │ │ │
│ │ │ ├─┬ <b><a href="#json-schemaallof">json-schema/allOf</a></b>
│ │ │ │ │
│ │ │ │ ├── <b><a href="#json-schemareference">*json-schema/reference*</a></b>
│ │ │ │ │
│ │ │ │ └── <b><a href="#json-schemabody">*json-schema/body*</a></b>
│ │ │ │
│ │ │ └─┬ <b><a href="#json-schemaanyof">json-schema/anyOf</a></b>
│ │ │ │
│ │ │ ├── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │
│ │ │ └── <b><a href="#json-schemabody">*json-schema/body*</a></b>
│ │ │
│ │ ├─┬ <b><a href="#swaggerparameters">swagger/parameters</a></b>
│ │ │ │ <i>Renders the parameter table within a operation...</i>
│ │ │ ├── <b><a href="#swaggerparameterrow">swagger/parameterRow</a></b>
│ │ │ │ <i>Display a single parameter in a table row.</i>
│ │ │ └── <b><a href="#swaggerparameterrow">*swagger/parameterRow*</a></b>
│ │ │
│ │ ├─┬ <b><a href="#swaggerresponses">swagger/responses</a></b>
│ │ │ │ <i>Renders the responses section of an operation</i>
│ │ │ ├── <b><a href="#swaggerlist-of-labels">*swagger/list-of-labels*</a></b>
│ │ │ │
│ │ │ ├── <b><a href="#swaggerlist-of-labels">*swagger/list-of-labels*</a></b>
│ │ │ │
│ │ │ ├─┬ <b><a href="#swaggerresponse">swagger/response</a></b>
│ │ │ │ │ <i>Renders details about a single response</i>
│ │ │ │ ├── <b><a href="#swaggermodel">*swagger/model*</a></b>
│ │ │ │ │
│ │ │ │ ├─┬ <b><a href="#swaggerresponseheaderrow">swagger/responseHeaderRow</a></b>
│ │ │ │ │ │ <i>Display a single parameter in a table row.</i>
│ │ │ │ │ ├── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │ │ │
│ │ │ │ │ └── <b><a href="#json-schemadatatype">*json-schema/datatype*</a></b>
│ │ │ │ │
│ │ │ │ └── <b><a href="#swaggerresponseheaderrow">*swagger/responseHeaderRow*</a></b>
│ │ │ │
│ │ │ └── <b><a href="#swaggerresponse">*swagger/response*</a></b>
│ │ │
│ │ └── <b><a href="#swaggersecurity">swagger/security</a></b>
│ │ <i>Renders the security definitions of the...</i>
│ ├─┬ <b><a href="#swaggerparameterdefinitions">swagger/parameterDefinitions</a></b>
│ │ │ <i>Global parameter definitions (see...</i>
│ │ └── <b><a href="#swaggerparameterrow">*swagger/parameterRow*</a></b>
│ │
│ ├─┬ <b><a href="#swaggerresponsedefinitions">swagger/responseDefinitions</a></b>
│ │ │ <i>Renders the response definitions</i>
│ │ └── <b><a href="#swaggerresponse">*swagger/response*</a></b>
│ │
│ └─┬ <b><a href="#swaggerdefinitions">swagger/definitions</a></b>
│ │ <i>Renders the definition-section of the HTML-page.</i>
│ └── <b><a href="#swaggermodel">*swagger/model*</a></b>
└── <b><a href="#basefooter">base/footer</a></b>
<i>This partial is displayed at the bottom of the...</i>
</code></pre>
# Partial reference

## base/body

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/base/body.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/base/body.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


This partial renders the <body> of the HTML page.
Expand Down Expand Up @@ -170,7 +139,7 @@ the Bootprint-result.

## base/title

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/base/title.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/base/title.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the page title
Expand Down Expand Up @@ -304,7 +273,7 @@ Uses the following partials:

## swagger/definitions

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/definitions.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/definitions.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the definition-section of the HTML-page.
Expand All @@ -320,7 +289,7 @@ Uses the following partials:

## swagger/list-of-labels

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/list-of-labels.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/list-of-labels.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders an array of strings as list of labels
Expand All @@ -334,7 +303,7 @@ Renders an array of strings as list of labels

## swagger/model

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/model.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/model.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders a json-schema model within swagger (calls json-schema-partials).
Expand All @@ -351,7 +320,7 @@ Uses the following partials:

## swagger/operation

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/operation.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/operation.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


This partial renders a box containing information about a single operation of the service
Expand All @@ -372,7 +341,7 @@ Uses the following partials:

## swagger/parameterDefinitions

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/parameterDefinitions.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/parameterDefinitions.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Global parameter definitions (see https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject)
Expand All @@ -388,7 +357,7 @@ Uses the following partials:

## swagger/parameterRow

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/parameterRow.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/parameterRow.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Display a single parameter in a table row.
Expand All @@ -405,7 +374,7 @@ Display a single parameter in a table row.

## swagger/parameters

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/parameters.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/parameters.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the parameter table within a operation definition.
Expand All @@ -425,7 +394,7 @@ Uses the following partials:

## swagger/path

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/path.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/path.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders a single path definition with all its methods (GET, POST).
Expand All @@ -442,7 +411,7 @@ Uses the following partials:

## swagger/paths

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/paths.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/paths.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the paths-section of the Rest-Service definition
Expand All @@ -456,7 +425,7 @@ Uses the following partials:

## swagger/request-body

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/request-body.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/request-body.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the request-body section of an operation.
Expand All @@ -475,7 +444,7 @@ Uses the following partials:

## swagger/response

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/response.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/response.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders details about a single response
Expand All @@ -493,7 +462,7 @@ Uses the following partials:

## swagger/responseDefinitions

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/responseDefinitions.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/responseDefinitions.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the response definitions
Expand All @@ -507,7 +476,7 @@ Uses the following partials:

## swagger/responseHeaderRow

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/responseHeaderRow.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/responseHeaderRow.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Display a single parameter in a table row.
Expand All @@ -525,7 +494,7 @@ Uses the following partials:

## swagger/responses

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/responses.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/responses.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the responses section of an operation
Expand All @@ -545,7 +514,7 @@ Uses the following partials:

## swagger/security

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/security.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/security.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the security definitions of the Rest-service.
Expand All @@ -559,7 +528,7 @@ Renders the security definitions of the Rest-service.

## swagger/securityDefinitions

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/securityDefinitions.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/securityDefinitions.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders the security-section of the HTML-page
Expand All @@ -572,7 +541,7 @@ TODO: Parameters

## swagger/summary

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/summary.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/summary.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders a summary of this services ignoring tags, containing references to all operations and paths
Expand All @@ -584,7 +553,7 @@ Renders a summary of this services ignoring tags, containing references to all o

## swagger/tags

(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.16.0/handlebars/partials/swagger/tags.hbs">jump to source in <code>bootprint-openapi@0.16.0</code></a>)
(<a href="https://github.com/bootprint/bootprint-openapi/blob/v0.17.0/handlebars/partials/swagger/tags.hbs">jump to source in <code>bootprint-openapi@0.17.0</code></a>)


Renders a summary based on the tags of this services, containing references to all operations and paths
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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,
Expand Down

0 comments on commit aa87b43

Please sign in to comment.