tree: 927018b67ccac95ecbcc0996ad3ab215ed090c6d [path history] [tgz]
  1. sources/
  2. ditto-api-1.yml
  3. ditto-api-2.yml
  4. README.md
openapi/README.md

Eclipse Ditto :: Documentation :: OpenAPI Specification

This folder contains the OpenAPI OpenAPI Specification version 2 documentation for Eclipse Ditto.

You can view it as nicely rendered HTML by importing the file for API version 2 into the Swagger Online Editor.

Extend/update api docs

To extend or update the OpenAPI of Ditto you can add or change the files in the sources directory.

Build api docs

  1. Install swagger-cli: $ cd sources && npm install
  2. Build bundled docs:
// go to sources
$ cd sources

// only v2
$ npm run build-v2

// both
$ npm run build