Skip to content

Latest commit

 

History

History
26 lines (19 loc) · 905 Bytes

CONTRIBUTE.md

File metadata and controls

26 lines (19 loc) · 905 Bytes

How to contribute

Create/update OpenAPI specification files

  1. Create/update specification files
  2. Run ./generate.sh
  3. Udpate README.md to reflect your changes

Create/update diagrams

  1. Create/update diagram files
  2. Run ./generate.sh diagrams

Note: Supported file types are plantuml, mermaid and bpmn. To add a file type (supported by Kroki), insert find "$FOLDER" -name '*.<FILE_TYPE>' | process '<FILE_TYPE>' at the bottom of ./generate.sh (replacing <FILE_TYPE>) by your file type.

Note: Diagrams are generated in SVG format (supported for all file types by Kroki).

Warning: Do not use same file names for different langages otherwise their outputs will be overwritten. Example: diag1.plantuml and diag1.mermaid will both generate diag1.svg.