diff options
author | franck cuny <franck@lumberjaph.net> | 2010-08-31 16:54:28 +0200 |
---|---|---|
committer | franck cuny <franck@lumberjaph.net> | 2010-08-31 16:54:28 +0200 |
commit | 78efc7def6a630e0c9bc2306c42b3ee8245701dd (patch) | |
tree | 76430ddeda6fb8f8a583e7b77e7ea5ed0a3ed13f /readme.md | |
parent | start to describe the specification (diff) | |
download | net-http-api-spec-78efc7def6a630e0c9bc2306c42b3ee8245701dd.tar.gz |
format
Diffstat (limited to '')
-rw-r--r-- | readme.md | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/readme.md b/readme.md index c5b682f..8f5b874 100644 --- a/readme.md +++ b/readme.md @@ -16,16 +16,16 @@ ### API method declaration - * path: (required) path of the API method (start after the API base url, start with a /) - * method: (required) which HTTP method to use (GET/POST/PUT/DELETE) - * description: (optional) a description of what the method do - * strict: (optional) should the control of the arguments be strict (yes by default) + * path: (required) path of the API method (start after the API base url, start with a /) + * method: (required) which HTTP method to use (GET/POST/PUT/DELETE) + * description: (optional) a description of what the method do + * strict: (optional) should the control of the arguments be strict (yes by default) * authentication: (optional) does this method require authentication ? (no by default) - * expected: (optional) list of possible HTTP code accepted for this request (eg: [200, 201]) - * params: (optional) list of parameters that will be used for the request - * params_in_url: (optional) should the parameters of the request be sent in the URL instead of body (for POST and PUT request) - * required: (optional) list of required parameters - * documetation: (optional) documentation for this method + * expected: (optional) list of possible HTTP code accepted for this request (eg: [200, 201]) + * params: (optional) list of parameters that will be used for the request + * params_in_url: (optional) should the parameters of the request be sent in the URL instead of body (for POST and PUT request) + * required: (optional) list of required parameters + * documetation: (optional) documentation for this method ### example: GitHub |