Skip to content

Latest commit

 

History

History
328 lines (174 loc) · 18.9 KB

CHANGELOG.md

File metadata and controls

328 lines (174 loc) · 18.9 KB

2.3.2 (2024-05-26)

Bug Fixes

  • package.json & package-lock.json to reduce vulnerabilities (4ee40e1)

2.3.1 (2023-11-11)

Bug Fixes

  • chore: technical release dependencies upgrade (230e6b6)

2.3.0 (2023-04-30)

Features

  • headers: show headers in the response when present (3f02648)
  • readability: improve readability by inserting horizontal lines between blocks (94f17ab)

2.2.1 (2023-04-14)

Bug Fixes

  • correct problem of broken build caused by scattered files in multiple directories (fdac96c), closes #169

2.2.0 (2023-04-14)

Features

  • schemes: display schemes if present in the path (bbf610a)

2.1.0 (2023-04-07)

Features

  • deprecated: respect deprecated flag in the path description (c3466df)
  • externaldocs: support external docs in the path (8fee911)
  • schemes: add schemes to the document (7963c18)
  • schemes: make schemes in bold (b0877c1)

2.0.1 (2023-03-07)

Bug Fixes

  • validation: add additional validations (73aeaf8), closes #198

2.0.0 (2022-12-27)

Bug Fixes

  • argparse: fix argparse to respect the recent version (2b71a91)
  • build: fix binary build (13e0051)
  • build: introduce webpack for the binary build (f94b1e0)
  • build: make it one single file so it will work as a binary (df6b03e)
  • build: retire webpack after a long serve (7b43a4f)
  • datatypes: use md class instead of direct markup (77785cb)
  • definitions: use md classes instead of direct markdown (7388984)
  • dummy: dummy commit to re-run semantic-release job (6efe709)
  • examples: fix examples table headers (5748eea)
  • examples: update examples to have nicer tables for securiry definitions (1d7435b)
  • fix export name (180485a)
  • include files with types (391dbc7)
  • instagram: fix instagram yaml specs (1a5d0c2)
  • markdownlint is in use (da46f0a)
  • pathparameters: path parameters to use md class instead of direct markup (a62a3b7)
  • paths: use md class instead of direct markup (746babb)
  • patresponses: make path responses use md class instead of direct markup (07063ac)
  • references: fix partialr dereference (f1bcc7f)
  • securitydefinitions: use md class instead of direct header hashes (7f9d373)
  • security: security to use md classes instead of direct markdown (ef886cc)
  • tables: make number of dashes to match header length (73b6182)

Code Refactoring

  • filenames: rename main files to make it expose an api in the future (44fc7fc)

Features

  • add ts-node (0b12ae3)
  • contact -> typescript (9426bc5)
  • force-version: add temporary solution for v3 documents (1160f4e)
  • make examples to typescript (856f4d4)
  • mdstring: add concat method, which allows to concatenate strings and mdstrings (764c59f)
  • mdstring: add length property (9b6f331)
  • schema: improve schema representations for an objects (e1c477d), closes #130
  • tags: group paths by tags if provided (4a38ad6), closes #188
  • typescript: turn it to ts (8d51e84)
  • version: detect document version (a1087a7)

BREAKING CHANGES

  • filenames: the main executable file has been renamed, index.js is now swagger-markdown.js. no changes if used via npx (npx swagger-markdown). may not work with browser implementations tho
  • version: It won't process document with newer syntax, it requires now to have the document version specified
  • typescript: start to rewrite code to ts so it will be maintainable

2.0.0-beta.15 (2022-12-27)

Features

  • force-version: add temporary solution for v3 documents (1160f4e)

2.0.0-beta.14 (2022-12-27)

Bug Fixes

  • instagram: fix instagram yaml specs (1a5d0c2)

2.0.0-beta.13 (2022-12-27)

Features

  • tags: group paths by tags if provided (4a38ad6), closes #188

2.0.0-beta.12 (2022-12-26)

Bug Fixes

  • build: retire webpack after a long serve (7b43a4f)

2.0.0-beta.11 (2022-12-26)

Bug Fixes

  • build: fix binary build (13e0051)

2.0.0-beta.10 (2022-12-26)

Bug Fixes

  • build: introduce webpack for the binary build (f94b1e0)

2.0.0-beta.9 (2022-12-26)

Bug Fixes

  • build: make it one single file so it will work as a binary (df6b03e)

2.0.0-beta.8 (2022-12-26)

Code Refactoring

  • filenames: rename main files to make it expose an api in the future (44fc7fc)

BREAKING CHANGES

  • filenames: the main executable file has been renamed, index.js is now swagger-markdown.js. no changes if used via npx (npx swagger-markdown). may not work with browser implementations tho

2.0.0-beta.7 (2022-12-25)

Features

  • schema: improve schema representations for an objects (e1c477d), closes #130

2.0.0-beta.6 (2022-12-25)

Bug Fixes

  • definitions: use md classes instead of direct markdown (7388984)
  • examples: update examples to have nicer tables for securiry definitions (1d7435b)
  • security: security to use md classes instead of direct markdown (ef886cc)

2.0.0-beta.5 (2022-12-24)

Bug Fixes

  • patresponses: make path responses use md class instead of direct markup (07063ac)

Features

  • mdstring: add concat method, which allows to concatenate strings and mdstrings (764c59f)

2.0.0-beta.4 (2022-12-24)

Bug Fixes

  • examples: fix examples table headers (5748eea)
  • pathparameters: path parameters to use md class instead of direct markup (a62a3b7)
  • tables: make number of dashes to match header length (73b6182)

2.0.0-beta.3 (2022-12-24)

Bug Fixes

  • dummy: dummy commit to re-run semantic-release job (6efe709)

2.0.0-beta.2 (2022-12-24)

Bug Fixes

  • datatypes: use md class instead of direct markup (77785cb)
  • paths: use md class instead of direct markup (746babb)
  • securitydefinitions: use md class instead of direct header hashes (7f9d373)

Features

  • mdstring: add length property (9b6f331)

2.0.0-beta.1 (2022-05-22)

Bug Fixes

  • argparse: fix argparse to respect the recent version (2b71a91)
  • fix export name (180485a)
  • include files with types (391dbc7)
  • markdownlint is in use (da46f0a)
  • references: fix partialr dereference (f1bcc7f)

Features

BREAKING CHANGES

  • version: It won't process document with newer syntax, it requires now to have the document version specified
  • typescript: start to rewrite code to ts so it will be maintainable

1.4.4 (2021-11-07)

Bug Fixes

  • replace map with forEach (a0f07ba)

1.4.3 (2020-10-04)

Bug Fixes

1.4.2 (2020-07-19)

Bug Fixes

  • partiallydereference: must use Object.assign as spread wont make it go through during the build (7e28af0)

1.4.1 (2020-07-19)

Bug Fixes

  • partiallyDereference: shallow copy node (c7f3564)

1.4.0 (2020-07-04)

Bug Fixes

  • escape pipe character in text (463e9ff)

Features

  • prettify narkdown documents (47e1352)

1.3.0 (2020-07-03)

Features

  • append schema example and enum values to description (766f20f)
  • show examples for path and model definitions (37d62b5)
  • use swagger-parser to resolve $refs (6dfc6cc)

1.2.0 (2019-06-24)

Features

  • resolve multiple properties with allOf (9fae4dc)

1.0.1 (2019-06-01)

Bug Fixes

1.1.6 (2019-06-01)

Bug Fixes

  • package.json to reduce vulnerabilities (422e0f0)
  • security types should handle objects (9189823)
  • definitions: avoid undefined (714c912)
  • definitions: Replace newlines with spaces in table (ad72a3b)
  • package: change gitlab plugin to github (d8e6b49)