@loopback/openapi-v3 - npm Package Compare versions

Comparing version 0.10.3 to 0.10.4

CHANGELOG.md

@@ -6,2 +6,10 @@ # Change Log
 
+<a name="0.10.4"></a>
+## [0.10.4](https://github.com/strongloop/loopback-next/compare/@loopback/openapi-v3@0.10.3...@loopback/openapi-v3@0.10.4) (2018-05-20)
+
+
+
+
+**Note:** Version bump only for package @loopback/openapi-v3
+
 <a name="0.10.3"></a>
@@ -8,0 +16,0 @@ ## [0.10.3](https://github.com/strongloop/loopback-next/compare/@loopback/openapi-v3@0.10.2...@loopback/openapi-v3@0.10.3) (2018-05-14)

dist10/src/decorators/parameter.decorator.d.ts

@@ -20,3 +20,21 @@ import { ParameterObject, ParameterLocation, ReferenceObject, SchemaObject } from '@loopback/openapi-v3-types';
 /**
- * Shortcut parameter decorators
+ *
+ * Describe an input parameter of a Controller method. The `@param` decorator
+ * takes an argument of `ParameterObject` to define how to map the parameter
+ * to OpenAPI specification.
+ *
+ * `@param(paramSpec)` must be applied to parameters. For example,
+ * ```ts
+ * class MyController {
+ *   @get('/')
+ *   list(
+ *     @param(offsetSpec) offset?: number,
+ *     @param(pageSizeSpec) pageSize?: number,
+ *   ) {}
+ * }
+ * ```
+ *
+ * @param paramSpec Parameter specification.
+ *
+ * Please also see `@param.*` shortcut parameter decorators
  */
@@ -23,0 +41,0 @@ export declare namespace param {

dist10/src/decorators/parameter.decorator.js

@@ -76,4 +76,24 @@ "use strict";
 };
+// FIXME: Typedoc does not feed `param` as both a function and a namespace.
+// As a workaround, we add the apidocs for `@param` under the namespace.
 /**
- * Shortcut parameter decorators
+ *
+ * Describe an input parameter of a Controller method. The `@param` decorator
+ * takes an argument of `ParameterObject` to define how to map the parameter
+ * to OpenAPI specification.
+ *
+ * `@param(paramSpec)` must be applied to parameters. For example,
+ * ```ts
+ * class MyController {
+ *   @get('/')
+ *   list(
+ *     @param(offsetSpec) offset?: number,
+ *     @param(pageSizeSpec) pageSize?: number,
+ *   ) {}
+ * }
+ * ```
+ *
+ * @param paramSpec Parameter specification.
+ *
+ * Please also see `@param.*` shortcut parameter decorators
  */
@@ -80,0 +100,0 @@ (function (param) {

dist8/src/decorators/parameter.decorator.d.ts

@@ -20,3 +20,21 @@ import { ParameterObject, ParameterLocation, ReferenceObject, SchemaObject } from '@loopback/openapi-v3-types';
 /**
- * Shortcut parameter decorators
+ *
+ * Describe an input parameter of a Controller method. The `@param` decorator
+ * takes an argument of `ParameterObject` to define how to map the parameter
+ * to OpenAPI specification.
+ *
+ * `@param(paramSpec)` must be applied to parameters. For example,
+ * ```ts
+ * class MyController {
+ *   @get('/')
+ *   list(
+ *     @param(offsetSpec) offset?: number,
+ *     @param(pageSizeSpec) pageSize?: number,
+ *   ) {}
+ * }
+ * ```
+ *
+ * @param paramSpec Parameter specification.
+ *
+ * Please also see `@param.*` shortcut parameter decorators
  */
@@ -23,0 +41,0 @@ export declare namespace param {

dist8/src/decorators/parameter.decorator.js

@@ -76,4 +76,24 @@ "use strict";
 };
+// FIXME: Typedoc does not feed `param` as both a function and a namespace.
+// As a workaround, we add the apidocs for `@param` under the namespace.
 /**
- * Shortcut parameter decorators
+ *
+ * Describe an input parameter of a Controller method. The `@param` decorator
+ * takes an argument of `ParameterObject` to define how to map the parameter
+ * to OpenAPI specification.
+ *
+ * `@param(paramSpec)` must be applied to parameters. For example,
+ * ```ts
+ * class MyController {
+ *   @get('/')
+ *   list(
+ *     @param(offsetSpec) offset?: number,
+ *     @param(pageSizeSpec) pageSize?: number,
+ *   ) {}
+ * }
+ * ```
+ *
+ * @param paramSpec Parameter specification.
+ *
+ * Please also see `@param.*` shortcut parameter decorators
  */
@@ -80,0 +100,0 @@ (function (param) {

package.json

 {
   "name": "@loopback/openapi-v3",
-  "version": "0.10.3",
+  "version": "0.10.4",
   "description": "Processes openapi v3 related metadata",
@@ -9,9 +9,9 @@ "engines": {
   "devDependencies": {
-    "@loopback/build": "^0.6.4",
-    "@loopback/openapi-spec-builder": "^0.7.3",
-    "@loopback/repository": "^0.10.3",
-    "@loopback/testlab": "^0.10.3",
+    "@loopback/build": "^0.6.5",
+    "@loopback/openapi-spec-builder": "^0.7.4",
+    "@loopback/repository": "^0.10.4",
+    "@loopback/testlab": "^0.10.4",
     "@types/debug": "0.0.30",
     "@types/lodash": "^4.14.106",
-    "@types/node": "^8.10.4"
+    "@types/node": "^10.1.1"
   },
@@ -55,6 +55,6 @@ "scripts": {
   "dependencies": {
-    "@loopback/context": "^0.11.1",
+    "@loopback/context": "^0.11.2",
     "@loopback/dist-util": "^0.3.1",
-    "@loopback/openapi-v3-types": "^0.7.3",
-    "@loopback/repository-json-schema": "^0.9.3",
+    "@loopback/openapi-v3-types": "^0.7.4",
+    "@loopback/repository-json-schema": "^0.9.4",
     "debug": "^3.1.0",
@@ -61,0 +61,0 @@ "lodash": "^4.17.5"

src/decorators/parameter.decorator.ts

@@ -98,4 +98,24 @@ // Copyright IBM Corp. 2018. All Rights Reserved.
 
+// FIXME: Typedoc does not feed `param` as both a function and a namespace.
+// As a workaround, we add the apidocs for `@param` under the namespace.
 /**
- * Shortcut parameter decorators
+ *
+ * Describe an input parameter of a Controller method. The `@param` decorator
+ * takes an argument of `ParameterObject` to define how to map the parameter
+ * to OpenAPI specification.
+ *
+ * `@param(paramSpec)` must be applied to parameters. For example,
+ * ```ts
+ * class MyController {
+ *   @get('/')
+ *   list(
+ *     @param(offsetSpec) offset?: number,
+ *     @param(pageSizeSpec) pageSize?: number,
+ *   ) {}
+ * }
+ * ```
+ *
+ * @param paramSpec Parameter specification.
+ *
+ * Please also see `@param.*` shortcut parameter decorators
  */
@@ -102,0 +122,0 @@ export namespace param {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

186610

increased by1.8%

Lines of code

3728

increased by2.64%

Dependency changes

• + Addedtyped-array-byte-offset@1.0.2(transitive)

• - Removedis-async-function@2.0.0(transitive)

• - Removedis-finalizationregistry@1.0.2(transitive)

• - Removedis-generator-function@1.0.10(transitive)

• - Removedis-map@2.0.3(transitive)

• - Removedis-set@2.0.3(transitive)

• - Removedis-weakmap@2.0.2(transitive)

• - Removedis-weakset@2.0.3(transitive)

• - Removedreflect.getprototypeof@1.0.6(transitive)

• - Removedtyped-array-byte-offset@1.0.3(transitive)

• - Removedwhich-builtin-type@1.1.4(transitive)

• - Removedwhich-collection@1.0.2(transitive)

• Updated@loopback/context@^0.11.2

• Updated@loopback/openapi-v3-types@^0.7.4

• Updated@loopback/repository-json-schema@^0.9.4