Opened 6 years ago

Last modified 3 years ago

#3007 new task

use swagger.io for data api specification

Reported by: tardyp Owned by:
Priority: major Milestone: 0.9.+
Version: master Keywords:
Cc:

Description

Our data api is specified in 4 places.

  • Documentation
  • data unit tests
  • mq unit tests
  • implementation

There is an attempt to extract the spec from implementation with the cmdline "buildbot dataspec", so that it can be used in frontend unit tests, but the format is proprietary.

http://swagger.io/ Implements a specification for REST apis which is pretty solid. I think this can address all our usecase, so that we can have 2 specifications.

  • swagger spec
  • implementation

The other usecases (doc, tests, js spec) shall all derive from the swagger spec.

Put to 0.9.+ as this is not particularly needed for 0.9.0. Current solution works, but is fairly inefficient

Change History (1)

Note: See TracTickets for help on using tickets.