Add a machine parseable API page

Question

tarekziade opened this issue 10 years ago · 3 comments

As discussed, let's add a machine parseable spec of the APIs

Ideally, it needs to publish argument constraints. stuff like: 0 < integer <= 100

Answer 1 · 2014-05-21T09:01:29.000Z

Seems that swagger is more adapted to our needs here. see https://github.com/wordnik/swagger-spec.

Plan is to have a manual file to start with, and then automate it.
Pointer to an express implementation here: https://www.npmjs.org/package/swagger-node-express-1.2

Answer 2 · 2014-06-10T16:03:47.000Z

I'm available to help evaluate and define a format. Is this in the pipeline for Q2, Q3, or best effort?

Answer 3 · 2014-06-12T10:17:11.000Z

@jvehent it's in the pipeline for Q2 - so end of june. Happy to work on it with you. Ping me when available