diff options
| author | Tim Bunce <Tim.Bunce@pobox.com> | 2010-11-23 10:41:14 +0000 |
|---|---|---|
| committer | Tim Bunce <Tim.Bunce@pobox.com> | 2010-11-23 10:41:14 +0000 |
| commit | be3fd3963a8da39b3702ebd5b13b1f5b2085d9b1 (patch) | |
| tree | b28f27fcab4d62e3dffcd68e8169a1535c6bc8dc | |
| parent | Simplify the element titles to make them easy to link to.Plus other refinements. (diff) | |
| download | net-http-spore-be3fd3963a8da39b3702ebd5b13b1f5b2085d9b1.tar.gz | |
Some more clarifications and wishes.
| -rw-r--r-- | spec/spore_description.pod | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/spec/spore_description.pod b/spec/spore_description.pod index cd702c7..0feef05 100644 --- a/spec/spore_description.pod +++ b/spec/spore_description.pod @@ -90,7 +90,7 @@ An optional version number for the current description, expressed as a string "version" : "0.1" -XXX Any semantics or just for documentation? +This is purely for documentation. =head3 authentication @@ -102,7 +102,7 @@ The default is false. =head3 methods -A mandatory hash of method descriptions. +A mandatory hash of method names and specifications. See L</METHOD DESCRIPTION>. "methods" : { ... } @@ -170,7 +170,11 @@ An optional list of valid HTTP response status values for this method 204 ] -An exception will be thrown if some other status is returned. +An exception will be thrown if C<expected> is specified and some other status +value is returned. Otherwise an exception won't be thrown, even for error status values. + +XXX a global api_expected would be handy. +XXX a global way to express "throw exception for all 4xx and 5xx (unless expected)" would be good. =head3 description @@ -193,7 +197,7 @@ An optional base url for this method, if different to L</api_base_url> "base_url" : "http://api.twitter.com/1" -Should not including a trailing slash. +Should not include a trailing slash. XXX would be nice to be able to express this as a relative url (relative to api_base_url) That could be handled at build time. |