diff options
author | Nils Grunwald <nils@grunwald.fr> | 2010-09-15 04:20:47 +0200 |
---|---|---|
committer | nils <nils@niluge.localdomain> | 2010-09-15 04:21:48 +0200 |
commit | e0649c6661fe734b8f5ffbdbcabb988abd80b377 (patch) | |
tree | 1797857f4dcf2f3673075320364175670fbfe213 | |
parent | some POD and examples (diff) | |
download | net-http-spore-e0649c6661fe734b8f5ffbdbcabb988abd80b377.tar.gz |
fixed various spelling mistakes and some rewriting
-rw-r--r-- | spec/spore.pod | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/spec/spore.pod b/spec/spore.pod index 3cd44d1..add6922 100644 --- a/spec/spore.pod +++ b/spec/spore.pod @@ -6,9 +6,9 @@ Spore - Specifications to a POrtable Rest Environment The ReST (L<http://en.wikipedia.org/wiki/Representational_State_Transfer|Representational -State Transfer>) paradigm have improved the way we communicate between -services and clients. It's easy to understand an API and to implement -the communications. +State Transfer>) paradigm has improved the way we communicate between +services and clients over http. It makes API easy to understand and to implement +client libraries for them. =head1 API DESCRIPTION @@ -29,7 +29,7 @@ A list of authors for this specification =item B<api_base_url> (optional) -If the API have a fixed URL +If the API has a fixed URL =item B<api_format> (optional) @@ -37,11 +37,11 @@ A list of supported format (eg: JSON, XML) =item B<version> (optinal) -A version of the current description +The version number of the current description =item B<authentication> (optional) -A boolean to inform if this API require authentication for all the methods +A boolean to specify if this API requires authentication for all the methods =item B<methods> (required) @@ -49,7 +49,7 @@ A list of methods =back -The desciption B<MUST> contains a list of at least one method. +The desciption B<MUST> contain a list of at least one method =over 4 @@ -59,24 +59,24 @@ An HTTP method (GET/POST/PUT/DELETE) =item B<path> (required) -Path for the given method. The path can contains B<placeholder>. A placeholder -B<MUST> begins with a <:>: +Path for the given method. The path can contain B<placeholders>. A placeholder +B<MUST> begin with a <:>: /:database =item B<params> (optional) -A list of parameters. This list will be used to replace value in placeholder, -and if not used in the path, will be added to the query. +A list of parameters. This list will be used to replace value in placeholders, +and if not used in the path, will be added to the query =item B<required> (optional) A list of required parameters. Parameters that are required B<MUST NOT> be -repeted in the B<params> field. +repeated in the B<params> field =item B<expected> (optional) -A list of accepted HTTP status for this method. (eg: 200, 201). +A list of accepted HTTP status for this method. (eg: 200, 201) =item B<description> (optional) @@ -87,11 +87,11 @@ documentation. =item B<authentication> (optional) -A boolean to define if this method requires authentication +A boolean to specify if this method requires authentication =item B<api_base_url> (optional) -If this method require a different api_base_url +Specify an url if this method requires a different api_base_url =item B<documentation> (optional) |