Skip to content

v2.0.0

Compare
Choose a tag to compare
@syroegkin syroegkin released this 27 Dec 14:21
· 55 commits to master since this release

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