tree: 741318b0cd2a5d550117108c7f9a8d60e1ccc925 [path history] [tgz]
  1. README.md
  2. ditto-api-1.yml
  3. ditto-api-2.yml
  4. sources/
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 one of the files (for API version 1 or 2) into the Swagger Online Editor.

Build api docs

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

// only v1
$ npm run build-v1

// only v2
$ npm run build-v2

// both
$ npm run build