Update LICENCE

2024-10-03 16:38:44 +03:00 · 2018-09-20 00:23:17 +02:00 · 2018-09-20 00:23:17 +02:00 · 8026b600bf
commit 8026b600bf
parent 624f6811c7
28 changed files with 144 additions and 70 deletions
--- a/1
+++ b/1
@ -1,4 +1,5 @@
 Copyright (c) 2015-2017 Kam Low
+Code from bootprint-openapi and bootprint-json-schema Copyright (c) 2015 Nils Knappmeier

 MIT License

--- a/app/helpers/schemaRange.js
+++ b/app/helpers/schemaRange.js
@ -1,4 +1,10 @@
 var util = require('util')
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/

 /**
 *
--- a/app/helpers/swaggerCollectionFormat.js
+++ b/app/helpers/swaggerCollectionFormat.js
@ -1,3 +1,10 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 module.exports = function(value, paramName) {
  return {
    'csv': 'Array values passed separated by comma: `?' + paramName + '=aaa,bbb`',
--- a/app/helpers/swaggerEndpoint.js
+++ b/app/helpers/swaggerEndpoint.js
@ -1,3 +1,10 @@
+/**
+* Copyright (c) 2015 Nils Knappmeier
+* https://github.com/bootprint/bootprint-openapi
+*
+* @license MIT
+**/
+
 module.exports = function(options) {
  var data = options.data.root;
  var endpoint = 'http';
--- a/app/views/partials/json-schema/additionalProperties.hbs
+++ b/app/views/partials/json-schema/additionalProperties.hbs
@ -1,4 +1,7 @@
 {{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
  Show a subschema for additionaProperties of a `object` definition.
 --}}
 <section class="json-schema-additionalProperties">
--- a/app/views/partials/json-schema/allOf.hbs
+++ b/app/views/partials/json-schema/allOf.hbs
@ -1,6 +1,9 @@
-{{!
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
  Renders a json-schema "allOf"-definition.
-}}
+--}}
 <section class="json-schema-allOf">
  {{! Display ref (i.e. superclasses)}}
  <section class="json-schema-allOf-inherited">
--- a/app/views/partials/json-schema/anyOf.hbs
+++ b/app/views/partials/json-schema/anyOf.hbs
@ -1,6 +1,9 @@
-{{!
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
  Renders a json-schema "anyOf"-definition.
-}}
+--}}
 <section class="json-schema-anyOf">
  {{! Display ref (i.e. superclasses)}}
  <dl>
--- a/app/views/partials/json-schema/array-items.hbs
+++ b/app/views/partials/json-schema/array-items.hbs
@ -1,6 +1,9 @@
-{{!
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
  Renders a json-schema "items"-definition of array-types.
-}}
+--}}
 <section class="json-schema-array-items">
  {{>json-schema/datatype .}}
  <div class="json-inner-schema">
--- a/app/views/partials/json-schema/body.hbs
+++ b/app/views/partials/json-schema/body.hbs
@ -1,7 +1,10 @@
-{{!
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
  Renders a json-schema without the surrounding panel.
  @param {boolean} showType whether or not to show the plain datatype for primitives
-}}
+--}}

 {{#if description}}
  <section class="json-schema-description">
--- a/app/views/partials/json-schema/datatype.hbs
+++ b/app/views/partials/json-schema/datatype.hbs
@ -1,18 +1,14 @@
-{{!
-  Copyright (c) 2015 Nils Knappmeier
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
  https://github.com/bootprint/bootprint-json-schema

-  @license MIT
-}}
+  When properties are renderered this partial renders the datatype of a property,
+  with a link to the type-definition (in case of a $ref).
+  Depending on the input, it renders an augmented data-type (e.g. "string[]"),
+  the 'format'-value (e.g. "date-time") and "enum"-values.

-{{!
-    When properties are renderered this partial renders the datatype of a property,
-    with a link to the type-definition (in case of a $ref).
-    Depending on the input, it renders an augmented data-type (e.g. "string[]"),
-    the 'format'-value (e.g. "date-time") and "enum"-values.
-
-    @param {boolean} discriminator true, this property is a swagger-discriminator (in which case enums are rendered as links)
-}}
+  @param {boolean} discriminator true, this property is a swagger-discriminator (in which case enums are rendered as links)
+--}}
 <span class="json-property-type">
  {{~#if $ref}}
    {{~>json-schema/reference .}}
--- a/app/views/partials/json-schema/definitions.hbs
+++ b/app/views/partials/json-schema/definitions.hbs
@ -1,4 +1,9 @@
-{{!Renders all subschemas}}
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
+  Renders all subschemas
+--}}
 {{#if definitions}}
  {{#eachSorted definitions}}
    {{>json-schema/main-panel . title=@key anchor=true}}
--- a/app/views/partials/json-schema/properties.hbs
+++ b/app/views/partials/json-schema/properties.hbs
@ -1,11 +1,9 @@
-{{!
-  Copyright (c) 2015 Nils Knappmeier
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
  https://github.com/bootprint/bootprint-json-schema

-  @license MIT
-}}
-
-{{!Renders json-schema object properties.}}
+  Renders json-schema object properties.
+--}}
 {{#if properties}}
 <section class="json-schema-properties">
  <dl>
--- a/app/views/partials/json-schema/reference.hbs
+++ b/app/views/partials/json-schema/reference.hbs
@ -1,11 +1,9 @@
-{{!
-  Copyright (c) 2015 Nils Knappmeier
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
  https://github.com/bootprint/bootprint-json-schema
-
-  @license MIT
-}}
-
-{{!Renders a reference to a subschema}}
+  
+  Renders a reference to a subschema
+--}}
 {{#if $ref}}
  <span class="{{#if type}}json-schema-ref-{{type}}{{/if}}">
    <a class="json-schema-ref" href="{{schemaReferenceHref $ref}}">{{schemaSubschemaName $ref}}</a>
--- a/app/views/partials/json-schema/type-object.hbs
+++ b/app/views/partials/json-schema/type-object.hbs
@ -1,5 +1,8 @@
 {{!--
-    Renders the properties of an `object`
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-json-schema
+
+  Renders the properties of an `object`
 --}}
 {{>json-schema/properties}}
 {{#if additionalProperties}}
--- a/app/views/partials/swagger/definition.hbs
+++ b/app/views/partials/swagger/definition.hbs
@ -1,8 +1,11 @@
-{{!
-    Renders a json.schema inside a panel.
-    @public
-    @readonly
-}}
+{{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders a json.schema inside a panel.
+  @public
+  @readonly
+--}}
 <div id="definition-{{htmlId @key}}" class="definition panel"
  data-traverse-target="definition-{{htmlId @key}}">
  {{#if title}}
--- a/app/views/partials/swagger/definitions.hbs
+++ b/app/views/partials/swagger/definitions.hbs
@ -1,7 +1,10 @@
 {{!--
-    Renders the definition-section of the HTML-page.
-    @param {Definition[]} definitions a list of JSON-subschemas.
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the definition-section of the HTML-page.
+  @param {Definition[]} definitions a list of JSON-subschemas.
+  @api public
 --}}

 {{#if definitions}}
--- a/app/views/partials/swagger/description.hbs
+++ b/app/views/partials/swagger/description.hbs
@ -1,4 +1,7 @@
 {{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
  Renders a json-schema model within swagger (calls json-schema-partials).
  @param {JsonSchema} model a JSON-schema definition
  @param {string} title the name of the definition
--- a/app/views/partials/swagger/list-of-labels.hbs
+++ b/app/views/partials/swagger/list-of-labels.hbs
@ -1,5 +1,8 @@
 {{!--
-    Renders an array of strings as list of labels
-    @param {string[]} values
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders an array of strings as list of labels
+  @param {string[]} values
 --}}
 {{#each values}}<span class="default-label">{{.}}</span> {{/each}}
--- a/app/views/partials/swagger/operation.hbs
+++ b/app/views/partials/swagger/operation.hbs
@ -1,4 +1,7 @@
 {{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
  This partial renders a box containing information about a single operation of the service
  (such as calling a POST on the "/pets" resource).
  @param {Operation} operation a Swagger-Operation object.
--- a/app/views/partials/swagger/parameters.hbs
+++ b/app/views/partials/swagger/parameters.hbs
@ -1,10 +1,13 @@
 {{!--
-    Renders the parameter table within a operation definition.
-    @param {Array<Parameter>|Object<Parameter>} parameters a list of Swagger-Parameter objects
-       If this is an object, an it is expected to be the global parameter list
-       https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject
-       and the key of each entry is display in a column in front of the other columns.
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the parameter table within a operation definition.
+  @param {Array<Parameter>|Object<Parameter>} parameters a list of Swagger-Parameter objects
+     If this is an object, an it is expected to be the global parameter list
+     https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject
+     and the key of each entry is display in a column in front of the other columns.
+  @api public
 --}}

 {{#if parameters}}
--- a/app/views/partials/swagger/path.hbs
+++ b/app/views/partials/swagger/path.hbs
@ -1,4 +1,7 @@
 {{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
  Renders a single path definition with all its methods (GET, POST).
  @param {string} path the request path
  @param {object<Operation>} pathItems a swagger [path-item-object](http://swagger.io/specification/#pathItemObject)
--- a/app/views/partials/swagger/paths.hbs
+++ b/app/views/partials/swagger/paths.hbs
@ -1,7 +1,10 @@
 {{!--
-    Renders the paths-section of the Rest-Service definition
-    @params {Path[]} paths a list of Swagger Path-Objects
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the paths-section of the Rest-Service definition
+  @params {Path[]} paths a list of Swagger Path-Objects
+  @api public
 --}}

 <h1>Paths</h1>
--- a/app/views/partials/swagger/request-body.hbs
+++ b/app/views/partials/swagger/request-body.hbs
@ -1,8 +1,11 @@
 {{!--
-    Renders the request-body section of an operation.
-    @param {string[]} consumes a list of request content type eligible for this operation.
-    @param {Parameter} body the param-Object of the `body`-parameter
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the request-body section of an operation.
+  @param {string[]} consumes a list of request content type eligible for this operation.
+  @param {Parameter} body the param-Object of the `body`-parameter
+  @api public
 --}}

 <section class="swagger-request-body">
--- a/app/views/partials/swagger/responseHeaderRow.hbs
+++ b/app/views/partials/swagger/responseHeaderRow.hbs
@ -1,8 +1,11 @@
 {{!--
-    Display a single parameter in a table row.
-    @param {Header} header a (Header)[https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#headerObject] object 
-    @param {string} name the name of  the response header
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Display a single parameter in a table row.
+  @param {Header} header a (Header)[https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#headerObject] object
+  @param {string} name the name of  the response header
+  @api public
 --}}
 <tr class="swagger-response-header-{{htmlId name}}">
    <td>
--- a/app/views/partials/swagger/responses.hbs
+++ b/app/views/partials/swagger/responses.hbs
@ -1,8 +1,11 @@
 {{!--
-    Renders the responses section of an operation
-    @param {Response[]} responses a list of Swagger-Response definitions
-    @param {string[]} produces a list of response content types produced by the operation
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the responses section of an operation
+  @param {Response[]} responses a list of Swagger-Response definitions
+  @param {string[]} produces a list of response content types produced by the operation
+  @api public
 --}}

 {{#if responses}}
--- a/app/views/partials/swagger/security.hbs
+++ b/app/views/partials/swagger/security.hbs
@ -1,7 +1,10 @@
 {{!--
-    Renders the security definitions of the Rest-service.
-    @param {Security[]} security TODO
-    @api public
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
+  Renders the security definitions of the Rest-service.
+  @param {Security[]} security TODO
+  @api public
 --}}
 {{#if security}}
  <div class="doc-row">
--- a/app/views/partials/swagger/securityDefinitions.hbs
+++ b/app/views/partials/swagger/securityDefinitions.hbs
@ -1,4 +1,7 @@
 {{!--
+  Original work Copyright (c) 2015 Nils Knappmeier
+  https://github.com/bootprint/bootprint-openapi
+
 Renders the security-section of the HTML-page
 TODO: Parameters
 @api public
--- a/app/views/partials/swagger/tags.hbs
+++ b/app/views/partials/swagger/tags.hbs
@ -1,4 +1,3 @@
-{{! Operations sorted by tags }}
 {{#each tags}}
    <h1 id="tag-{{htmlId name}}" class="swagger-summary-tag" data-traverse-target="tag-{{htmlId name}}">{{name}}</h1>
    {{#if description}}