Skip to content

Releases: Betterez/btrz-swagger-express

v3.0.0

10 Sep 22:26
Compare
Choose a tag to compare

Version 3 drops support for the paramType field in request parameters. Instead, use the in field.
Previously, a request parameter may have been defined like this:

{
  path: "/users/{userId}",
  summary: "Returns the user with the given ID",
  method: "GET",
  parameters: [
    {
      paramType: "path",
      name: "userId",
      description: "The ID of the user.",
      type: "string",
      required: true
    }
  ]
}

You should now declare the parameter like this instead:

{
  path: "/users/{userId}",
  summary: "Returns the user with the given ID",
  method: "GET",
  parameters: [
    {
      in: "path",
      name: "userId",
      description: "The ID of the user.",
      type: "string",
      required: true
    }
  ]
}

This brings the parameter schema closer in line with the OpenAPI v3 format.

v1.2.5

01 May 19:34
Compare
Choose a tag to compare

Basically reverting the changes made in v1.2.4

v1.2.4

23 Apr 20:14
Compare
Choose a tag to compare

Appends the endpoint "notes" property to the existing "description" property. Some endpoints currently use this information to provide additional information to the end user.

v1.2.3

05 Apr 14:44
Compare
Choose a tag to compare

Stop crashing when nickname is not in getSpec() declaration.

v1.2.2

27 Mar 22:06
Compare
Choose a tag to compare

Adding some additional error checks. Not an urgent upgrade.

Changing version to remove excessive version info (v1.2.1.1 vs v1.2.2)

v1.2.1

15 Mar 21:33
Compare
Choose a tag to compare

Add check for missing errorResponse object.

v1.2.0

02 Mar 23:17
Compare
Choose a tag to compare
[HG] new version of btrz-swagger-express.

v1.1.5

15 Feb 15:23
Compare
Choose a tag to compare

Modify multiple status code descriptions to output as a bulleted list.

v1.1.4

08 Feb 23:22
Compare
Choose a tag to compare

Fix issue where hiding the doc also hides the endpoint.

v1.1.2

05 Feb 14:59
Compare
Choose a tag to compare

Adding support for native declaration of OpenApi v2.

Also adds support for the deprecated property.