Skip to content

v1.0.0 - Initial MVP

Latest

Choose a tag to compare

@Grant-Nelson Grant-Nelson released this 26 Jul 03:51
· 4 commits to main since this release

Initial MVP Release

Initial public release of Dr OpenAPI's minimum viable product (MVP)

Features

  • Reads OpenAPI v3 bundle files
    • reads YAML bundles
    • reads JSON bundles
  • Writes a single Markdown
    • includes Mermaid class diagrams
    • includes an index
  • Source code written in Go v1.17
    • designed to be extendable

Known Limitations

  • Can not split markdown into separate files yet
  • Only outputs success (200) codes with application/json media type
  • Can only use references to top level schema in the Components object
  • Reads more information than needed