The-DataTank icon indicating copy to clipboard operation
The-DataTank copied to clipboard

Doc - URI space

Open coreation opened this issue 14 years ago • 1 comments

Currently there is no view on the URI space of TDT, so documentation on this should be made !!

coreation avatar Mar 31 '12 12:03 coreation

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 avatar Apr 01 '12 13:04 marc-portier