[Buildbot] #3007: use swagger.io for data api specification
Buildbot trac
trac at buildbot.net
Wed Nov 5 12:19:27 UTC 2014
#3007: use swagger.io for data api specification
-------------------+-------------------
Reporter: tardyp | Owner:
Type: task | Status: new
Priority: major | Milestone: 0.9.+
Version: master | Keywords:
-------------------+-------------------
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
--
Ticket URL: <http://trac.buildbot.net/ticket/3007>
Buildbot <http://buildbot.net/>
Buildbot: build/test automation
More information about the bugs
mailing list