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.

Sign up for GitHub

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

Jump to bottom

Doc - URI space #64

Open
coreation opened this issue Mar 31, 2012 · 1 comment
Open

Doc - URI space #64

coreation opened this issue Mar 31, 2012 · 1 comment
Assignees
@coreation

Comments

@coreation
Copy link
Member

Currently there is no view on the URI space of TDT, so documentation on this should be made !!
@ghost ghost assigned coreation Mar 31, 2012
@marc-portier
Copy link
Contributor

effectively this becomes the documentation of the REST-API

suggestion:

  • use a templating syntax to capture uri-patterns (http://code.google.com/p/uri-templates/)
  • mention which methods are supported (and also support OPTIONS method to make the system self-documenting on that part)
  • and also mention the response-codes (special attention for the error-conditions hinting at the normal client-resolution strategies) and the returned representations

@marc-portier marc-portier mentioned this issue Apr 1, 2012
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@coreation coreation

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@marc-portier @coreation