Page Contents

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

3.4.4 (2020-06-23)

Bug Fixes

  • set node version to >=10.16 to support events.once (e39da1c)

3.4.3 (2020-06-11)

Note: Version bump only for package @loopback/openapi-v3

3.4.2 (2020-05-28)

Note: Version bump only for package @loopback/openapi-v3

3.4.1 (2020-05-20)

Note: Version bump only for package @loopback/openapi-v3

3.4.0 (2020-05-19)

Features

  • openapi-v3: relax [@api](https://github.com/api) to make paths optional with {} as the default (ef3c415)

3.3.1 (2020-05-07)

Note: Version bump only for package @loopback/openapi-v3

3.3.0 (2020-04-29)

Features

  • populate x-typescript-type for openapi schema (02a2633)

3.2.1 (2020-04-23)

Note: Version bump only for package @loopback/openapi-v3

3.2.0 (2020-04-22)

Features

  • rest: ensure OpenAPI spec components are merged (2efa27b)
  • update package.json and .travis.yml for builds (cb2b8e6)
  • rest: add openapi schema consolidation (6a039ed)

3.1.3 (2020-04-11)

Note: Version bump only for package @loopback/openapi-v3

3.1.2 (2020-04-08)

Note: Version bump only for package @loopback/openapi-v3

3.1.1 (2020-03-24)

Note: Version bump only for package @loopback/openapi-v3

3.1.0 (2020-03-17)

Features

  • openapi-v3: add sugar decorators for file requestBody/response (e8c8f38)
  • enable authStrategy to provide OASEnhancer (df7dd2b)

3.0.0 (2020-03-05)

chore

  • remove support for Node.js v8.x (4281d9d)

Features

BREAKING CHANGES

  • Node.js v8.x is now end of life. Please upgrade to version 10 and above. See https://nodejs.org/en/about/releases.

2.0.0 (2020-02-06)

Bug Fixes

  • suport complex objects for query params in api explorer (a4ef640)

BREAKING CHANGES

  • This fix has modified the api definitions described by the decorator ‘param.query.object’, to support Open-API’s url-encoded definition for json query parameters.

Previously, such parameters were described with exploded: true and style: deepObject, i.e exploded encoding, which turned out to be problematic as explained and discussed in, https://github.com/swagger-api/swagger-js/issues/1385 and https://github.com/OAI/OpenAPI-Specification/issues/1706

  {
    "in": "query",
    "style": "deepObject"
    "explode": "true",
    "schema": {}
  }

Exploded encoding worked for simple json objects as below but not for complex objects.

   http://localhost:3000/todos?filter[limit]=2

To address these issues with exploded queries, this fix switches definition of json query params from the exploded, deep-object style to the url-encoded style definition in Open-API spec.

LoopBack already supports receiving url-encoded payload for json query parameters.

For instance, to filter api results from the GET ‘/todo-list’ endpoint in the todo-list example with a specific relation, { “include”: [ { “relation”: “todo” } ] }, the following url-encoded query parameter can be used,

   http://localhost:3000/todos?filter=%7B%22include%22%3A%5B%7B%22relation%22%3A%22todoList%22%7D%5D%7D

The above was possible because the coercion behavior in LoopBack performed json parsing for deep object style json query params before this fix. This fix has modified that behavior by removing json parsing. Since the exploded deep-object definition has been removed from the param.query.object decorator, this new behaviour remains just an internal source code aspect as of now.

In effect, this fix only modifies the open api definitions generated from LoopBack APIs. The ‘style’ and ‘explode’ fields are removed and the ‘schema’ field is moved under ‘content[application/json]’. This is the definition that supports url-encoding as per Open-API spec.

  {
    "in": "query"
    "content": {
      "application/json": {
        "schema": {}
      }
    }
  }

Certain client libraries (like swagger-ui or LoopBack’s api explorer) necessiate using Open-API’s url-encoded style definition for json query params to support “sending” url-encoded payload.

All consumers of LoopBack APIs may need to regenerate api definitions, if their client libraries require them to do so for url-encoding.

Otherwise there wouldn’t be any significant impact on API consumers.

To preserve compatibility with existing REST API clients, this change is backward compatible. All exploded queries like ?filter[limit]=1 will continue to work for json query params, despite the fact that they are described differently in the OpenAPI spec.

Existing api clients will continue to work after an upgrade.

The signature of the ‘param.query.object’ decorator has not changed.

There is no code changes required in the LoopBack APIs after upgrading to this fix. No method signatures or data structures are impacted.

1.13.0 (2020-02-05)

Features

1.12.0 (2020-01-27)

Features

  • support x-ts-type in anyOf/allOf/oneOf/not (28fcc54)
  • openapi-v3: add support for anyOf and oneOf on the jsonToSchemaObject utility (72ba132), closes #3524
  • repository-json-schema: add title to filter schemas (6105883)

1.11.0 (2020-01-07)

Features

  • openapi spec contributor extension point (9fee3f3)

1.10.3 (2019-12-09)

Note: Version bump only for package @loopback/openapi-v3

1.10.2 (2019-11-25)

Note: Version bump only for package @loopback/openapi-v3

1.10.1 (2019-11-12)

Bug Fixes

  • openapi-v3: remove examples from schema (c819f92)

1.10.0 (2019-10-24)

Bug Fixes

  • allow json schema with circular refs to be converted to OpenAPI schema (cd5ca92)
  • openapi-v3: preserve additionalProperties: false (bc7691b)

Features

  • openapi-v3: copy first example from examples to schema (0c7843a)

1.9.10 (2019-10-07)

Note: Version bump only for package @loopback/openapi-v3

1.9.9 (2019-09-28)

Note: Version bump only for package @loopback/openapi-v3

1.9.8 (2019-09-27)

Note: Version bump only for package @loopback/openapi-v3

1.9.7 (2019-09-17)

Note: Version bump only for package @loopback/openapi-v3

1.9.6 (2019-09-06)

Note: Version bump only for package @loopback/openapi-v3

1.9.5 (2019-09-03)

Note: Version bump only for package @loopback/openapi-v3

1.9.4 (2019-08-19)

Note: Version bump only for package @loopback/openapi-v3

1.9.3 (2019-08-15)

Note: Version bump only for package @loopback/openapi-v3

1.9.2 (2019-08-15)

Note: Version bump only for package @loopback/openapi-v3

1.9.1 (2019-07-31)

Bug Fixes

  • enforce JsonSchemaOptions type when building model schema (9bbc932)

1.9.0 (2019-07-26)

Features

  • openapi-v3: allow optional spec for [@param](https://github.com/param).* shortcut decorators (4f155a4)

1.8.0 (2019-07-17)

Features

  • repository-json-schema: add an option to exclude properties from schema (53ac940)

1.7.0 (2019-06-28)

Features

  • openapi-v3: remove dependency on openapi-v3-types (4c2096c)

1.6.4 (2019-06-21)

Note: Version bump only for package @loopback/openapi-v3

1.6.3 (2019-06-20)

Note: Version bump only for package @loopback/openapi-v3

1.6.2 (2019-06-17)

Note: Version bump only for package @loopback/openapi-v3

1.6.1 (2019-06-06)

Note: Version bump only for package @loopback/openapi-v3

1.6.0 (2019-06-03)

Features

  • replace tslint with eslint (44185a7)

1.5.1 (2019-05-31)

Note: Version bump only for package @loopback/openapi-v3

1.5.0 (2019-05-30)

Features

  • helpers for building JSON/OpenAPI schema referencing shared definitions (bf07ff9)

1.4.0 (2019-05-23)

Features

  • openapi-v3: allow controller to reference models via openapispec (d57f272)

1.3.11 (2019-05-14)

Note: Version bump only for package @loopback/openapi-v3

1.3.10 (2019-05-10)

Note: Version bump only for package @loopback/openapi-v3

1.3.9 (2019-05-09)

Note: Version bump only for package @loopback/openapi-v3

1.3.8 (2019-05-06)

Note: Version bump only for package @loopback/openapi-v3

1.3.7 (2019-04-26)

Note: Version bump only for package @loopback/openapi-v3

1.3.6 (2019-04-20)

Note: Version bump only for package @loopback/openapi-v3

1.3.5 (2019-04-11)

Note: Version bump only for package @loopback/openapi-v3

1.3.4 (2019-04-09)

Note: Version bump only for package @loopback/openapi-v3

1.3.3 (2019-04-05)

Note: Version bump only for package @loopback/openapi-v3

1.3.2 (2019-03-22)

Note: Version bump only for package @loopback/openapi-v3

1.3.1 (2019-03-22)

Note: Version bump only for package @loopback/openapi-v3

1.3.0 (2019-03-12)

Features

  • openapi-v3: add operationId based on controller/method names (89f905b)

1.2.3 (2019-03-01)

Note: Version bump only for package @loopback/openapi-v3

1.2.2 (2019-02-25)

Note: Version bump only for package @loopback/openapi-v3

1.2.1 (2019-02-08)

Bug Fixes

  • update to the most recent lodash version (65ee865)

1.2.0 (2019-01-28)

Features

  • repository-json-schema: enumerate fields (15ca819)

1.1.7 (2019-01-15)

Note: Version bump only for package @loopback/openapi-v3

1.1.6 (2019-01-14)

Bug Fixes

  • rework tslint comments disabling “no-unused-variable” rule (a18a3d7)

1.1.5 (2018-12-20)

Note: Version bump only for package @loopback/openapi-v3

1.1.4 (2018-12-13)

Note: Version bump only for package @loopback/openapi-v3

1.1.3 (2018-11-26)

Note: Version bump only for package @loopback/openapi-v3

1.1.2 (2018-11-17)

Bug Fixes

  • repository: make sure model definition is built correctly (2effa30)

1.1.1 (2018-11-14)

Note: Version bump only for package @loopback/openapi-v3

1.1.0 (2018-11-08)

Bug Fixes

  • openapi-v3: generate schemas for x-ts-type (07f0d6c)

Features

  • rest: add support for form request body (2d9e0a8)

1.0.1 (2018-10-17)

Note: Version bump only for package @loopback/openapi-v3

0.15.6 (2018-10-08)

Note: Version bump only for package @loopback/openapi-v3

0.15.5 (2018-10-06)

Note: Version bump only for package @loopback/openapi-v3

0.15.4 (2018-10-05)

Note: Version bump only for package @loopback/openapi-v3

0.15.3 (2018-10-03)

Note: Version bump only for package @loopback/openapi-v3

0.15.2 (2018-09-28)

Note: Version bump only for package @loopback/openapi-v3

0.15.1 (2018-09-27)

Note: Version bump only for package @loopback/openapi-v3

0.15.0 (2018-09-25)

Features

  • builders for Filter and Where schemas (ca8d96e)
  • support built-in JavaScript/Node schema types (d65a17f)

0.14.4 (2018-09-21)

Note: Version bump only for package @loopback/openapi-v3

0.14.3 (2018-09-19)

Note: Version bump only for package @loopback/openapi-v3

0.14.2 (2018-09-14)

Note: Version bump only for package @loopback/openapi-v3

0.14.1 (2018-09-14)

Note: Version bump only for package @loopback/openapi-v3

0.14.0 (2018-09-14)

Features

  • openapi-v3: add support for openapi responses (0ecaecd)

0.13.2 (2018-09-12)

Note: Version bump only for package @loopback/openapi-v3

0.13.1 (2018-09-10)

Note: Version bump only for package @loopback/openapi-v3

0.13.0 (2018-09-08)

Features

  • coerce object arguments from query strings (d095693)

0.12.6 (2018-08-25)

Note: Version bump only for package @loopback/openapi-v3

0.12.5 (2018-08-24)

Bug Fixes

  • openapi-v3: set required to true for path parameters (2b13247)

0.12.4 (2018-08-15)

Note: Version bump only for package @loopback/openapi-v3

0.12.3 (2018-08-08)

Note: Version bump only for package @loopback/openapi-v3

0.12.2 (2018-07-21)

Note: Version bump only for package @loopback/openapi-v3

0.12.1 (2018-07-20)

Note: Version bump only for package @loopback/openapi-v3

0.12.0 (2018-07-20)

Note: Version bump only for package @loopback/openapi-v3

0.11.3 (2018-07-13)

Note: Version bump only for package @loopback/openapi-v3

0.11.2 (2018-07-11)

Note: Version bump only for package @loopback/openapi-v3

0.11.1 (2018-07-10)

Note: Version bump only for package @loopback/openapi-v3

0.11.0 (2018-07-09)

Bug Fixes

  • generate schema for requestBody only if not present (caf66c2)

Features

0.10.12 (2018-06-28)

Note: Version bump only for package @loopback/openapi-v3

0.10.11 (2018-06-27)

Note: Version bump only for package @loopback/openapi-v3

0.10.10 (2018-06-20)

Note: Version bump only for package @loopback/openapi-v3

0.10.9 (2018-06-11)

Note: Version bump only for package @loopback/openapi-v3

0.10.8 (2018-06-09)

Note: Version bump only for package @loopback/openapi-v3

0.10.7 (2018-06-09)

Note: Version bump only for package @loopback/openapi-v3

0.10.6 (2018-06-08)

Bug Fixes

  • make the code compatible with TypeScript 2.9.x (37aba50)

0.10.5 (2018-05-28)

Note: Version bump only for package @loopback/openapi-v3

0.10.4 (2018-05-20)

Note: Version bump only for package @loopback/openapi-v3

0.10.3 (2018-05-14)

Bug Fixes

  • change index.d.ts files to point to dist8 (42ca42d)

0.10.2 (2018-05-14)

Note: Version bump only for package @loopback/openapi-v3

0.10.1 (2018-05-08)

Note: Version bump only for package @loopback/openapi-v3

0.10.0 (2018-05-03)

Features

  • add helper package “dist-util” (532f153)

0.9.0 (2018-05-03)

Features

  • add helper package “dist-util” (532f153)

0.8.1 (2018-04-26)

Note: Version bump only for package @loopback/openapi-v3

0.8.0 (2018-04-25)

Features

  • upgrade to openapi3-ts@0.11.0 (1ed79c9)

0.7.0 (2018-04-16)

Note: Version bump only for package @loopback/openapi-v3

0.6.0 (2018-04-12)

Features

  • metadata: add strongly-typed metadata accessors (45f9f80)

0.5.5 (2018-04-11)

Note: Version bump only for package @loopback/openapi-v3

0.5.4 (2018-04-11)

Bug Fixes

  • change file names to fit advocated naming convention (0331df8)

0.5.3 (2018-04-06)

Note: Version bump only for package @loopback/openapi-v3

0.5.2 (2018-04-04)

Note: Version bump only for package @loopback/openapi-v3

0.5.1 (2018-04-02)

Note: Version bump only for package @loopback/openapi-v3

0.5.0 (2018-03-29)

Bug Fixes

  • metadata: refine clone of decoration spec (544052e)

BREAKING CHANGES

  • metadata: instances of user-defined classes are not cloned any more.

See https://github.com/strongloop/loopback-next/issues/1182. The root cause is that DataSource instances are cloned incorrectly.

0.4.1 (2018-03-23)

Note: Version bump only for package @loopback/openapi-v3

0.4.0 (2018-03-21)

Note: Version bump only for package @loopback/openapi-v3

0.3.3 (2018-03-14)

Note: Version bump only for package @loopback/openapi-v3

0.3.2 (2018-03-13)

Note: Version bump only for package @loopback/openapi-v3

0.3.1 (2018-03-08)

Note: Version bump only for package @loopback/openapi-v3

0.3.0 (2018-03-06)

Bug Fixes

Features

  • upgrade from swagger 2 to openapi 3 (71e5af1)

0.2.0 (2018-03-01)

Note: Version bump only for package @loopback/openapi-v3

0.1.1 (2018-03-01)

Features