From e0649c6661fe734b8f5ffbdbcabb988abd80b377 Mon Sep 17 00:00:00 2001 From: Nils Grunwald Date: Wed, 15 Sep 2010 04:20:47 +0200 Subject: fixed various spelling mistakes and some rewriting --- spec/spore.pod | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) (limited to 'spec') 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) 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 (optional) -If the API have a fixed URL +If the API has a fixed URL =item B (optional) @@ -37,11 +37,11 @@ A list of supported format (eg: JSON, XML) =item B (optinal) -A version of the current description +The version number of the current description =item B (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 (required) @@ -49,7 +49,7 @@ A list of methods =back -The desciption B contains a list of at least one method. +The desciption B contain a list of at least one method =over 4 @@ -59,24 +59,24 @@ An HTTP method (GET/POST/PUT/DELETE) =item B (required) -Path for the given method. The path can contains B. A placeholder -B begins with a <:>: +Path for the given method. The path can contain B. A placeholder +B begin with a <:>: /:database =item B (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 (optional) A list of required parameters. Parameters that are required B be -repeted in the B field. +repeated in the B field =item B (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 (optional) @@ -87,11 +87,11 @@ documentation. =item B (optional) -A boolean to define if this method requires authentication +A boolean to specify if this method requires authentication =item B (optional) -If this method require a different api_base_url +Specify an url if this method requires a different api_base_url =item B (optional) -- cgit v1.2.3