Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a machine parseable API page #40

Closed
tarekziade opened this issue May 14, 2014 · 3 comments
Closed

Add a machine parseable API page #40

tarekziade opened this issue May 14, 2014 · 3 comments
Assignees

Comments

@tarekziade
Copy link
Contributor

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

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

@almet
Copy link
Contributor

almet commented May 21, 2014

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

@tarekziade tarekziade changed the title Add a SPORE spec Add a machine parseable API page May 21, 2014
@jvehent
Copy link

jvehent commented Jun 10, 2014

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

@tarekziade
Copy link
Contributor Author

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

@tarekziade tarekziade self-assigned this Jun 12, 2014
@Natim Natim closed this as completed Jul 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants