Skip to content
This repository has been archived by the owner on Jan 2, 2018. It is now read-only.

API description / Meta-information #13

Open
mikaa123 opened this issue Jun 14, 2012 · 1 comment
Open

API description / Meta-information #13

mikaa123 opened this issue Jun 14, 2012 · 1 comment

Comments

@mikaa123
Copy link

Hi!
Thank you for the DSL/library; it's going to be incredibly useful to me and a lot of people.

Is there currently any way to describe the API as a whole (meta-information; such as what the API is intended to be used for, what are the different available processes, etc.)?

I think such information could prove valuable for middle to large APIs to see how the different 'services' fit together. What are your thoughts on it?

@mattetti
Copy link
Owner

That's a great idea. I'm not quite sure where that should live tho and that's probably why I was only providing end point specific documentation. Do you have a suggestion to provide more global documentation?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants