Skip to content

Releases: Springworks/swagger-md

v3.0.0

18 Sep 13:08
Compare
Choose a tag to compare

3.0.0 (2017-09-18)

Features

  • print the status code name for each response (cbad2b0)

BREAKING CHANGES

  • This changes the returned markdown.

v2.0.1

08 Apr 12:44
Compare
Choose a tag to compare

<a name"2.0.1">

2.0.1 (2017-04-08)

Bug Fixes

v2.0.0

01 Feb 20:44
Compare
Choose a tag to compare

<a name"2.0.0">

2.0.0 (2017-02-01)

Bug Fixes

  • test: fix tests with babel when using npm 2 (0b4a9d8f)

Features

  • add function resolveApiSpec (eaa5538c)

Breaking Changes

  • $ref is printed like $ref: \${$ref}``. Most refs should be resolved but in the case a ref is not resolved, it's better to print the entire URI. Number types are printed a bit less redundantly, instead of sayinginteger, int32it will just say`int32`. When numbers are used in ranges it might say`0 < int32 <= 200`.

    (1e7f8b4b)

  • Attempt to resolve and inline all $refs. Merge schemas that extend other schemas using allOf.

    (61287826)

  • convertToMarkdown takes and optional options object instead of an optional response example provider function. Pass the function as response_example_provider in the options object instead.

    (6c0d0f51)

  • The convertToMarkdown function returns a Promise<string> instead of a string.

    (fe0bc49f)

v1.7.1

21 Nov 23:19
Compare
Choose a tag to compare

<a name"1.7.1">

1.7.1 (2016-11-21)

Bug Fixes

  • update semantic-release to version 6.3.2 (#131) (bedc18bb)

v1.7.0

23 Aug 13:38
Compare
Choose a tag to compare

<a name"1.7.0">

1.7.0 (2016-08-23)

Features

  • include type of range in range format (f2abb618)

v1.6.0

23 Aug 12:01
Compare
Choose a tag to compare

<a name"1.6.0">

1.6.0 (2016-08-23)

Features

  • render request params as tables (161d0fda, closes #54)

v1.5.1

22 Aug 10:44
Compare
Choose a tag to compare

<a name"1.5.1">

1.5.1 (2016-08-22)

Bug Fixes

  • docs: hint for CommonJS module environment (#87) (0c92de17)

v1.5.0

22 Aug 07:59
Compare
Choose a tag to compare

<a name"1.5.0">

1.5.0 (2016-08-22)

Features

v1.4.0

20 Aug 07:32
Compare
Choose a tag to compare

<a name"1.4.0">

1.4.0 (2016-08-20)

Features

v1.3.0

03 Aug 15:09
Compare
Choose a tag to compare

<a name"1.3.0">

1.3.0 (2016-08-03)

Features

  • mark deprecated in table of contents (5bfe1b45)