From 40bb212066cdbafb2f795c0712b0f2db7ef21d5c Mon Sep 17 00:00:00 2001 From: "Philippe Bruhat (BooK)" Date: Tue, 22 Feb 2011 09:17:09 +0100 Subject: correction --- spore_implementation.pod | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) (limited to 'spore_implementation.pod') diff --git a/spore_implementation.pod b/spore_implementation.pod index 0ceb22c..ef06e68 100644 --- a/spore_implementation.pod +++ b/spore_implementation.pod @@ -19,8 +19,8 @@ implementation. =item API An I is a ReST application that can exchange data with client -applications over http/https. It presents one or more method endpoints which -accept http requests with varying headers, parameters and body content to +applications over HTTP/HTTPS. It presents one or more method endpoints which +accept HTTP requests with varying headers, parameters and body content to perform specific operations. =item Client implementation @@ -46,14 +46,14 @@ the workflow if needed. It can be thought of as a plugin to extend Spore. A I is a data structure that contains standardized data and metadata inspired by the CGI specification. It is used by the I to create the http request that will be sent to the +implementation> to create the HTTP request that will be sent to the I. =item Response A I is a data structure that contains standardized data and metadata inspired by the CGI specification. It is created from the -http response sent by the I and is used after being processed by +HTTP response sent by the I and is used after being processed by the I to create the structure returned to the user. =back @@ -63,7 +63,7 @@ the I to create the structure returned to the user. =head2 Client Implementation A I B provide a function or method -(eg. new_from_spec) to generate the specific API methods in the target +(e.g. new_from_spec) to generate the specific API methods in the target system by reading the JSON string from a I (and optionaly directly from the file itself). @@ -83,10 +83,10 @@ specification. =head2 Middleware Each middleware B accept arbitrary initialization parameters. It -B provide a way to only conditionaly use a middleware (eg. B). It +B provide a way to only conditionaly use a middleware (e.g. B). It B also provide a function to which the request environment or an object containing it will be passed. The function can have 3 types of -return values : +return values: =over 4 @@ -104,7 +104,7 @@ made. The response is directly passed to the first stored callback in the chain. No further middlewares are used and no request is sent. Useful -if a middleware needs to shortcicuit the remaining of the chain, for +if a middleware needs to shortcircuit the remaining of the chain, for testing or caching purpose for exemple. =back @@ -119,7 +119,7 @@ L, L and L) except when they would normally be empty. The environment is used by the I to build the final http request that will be sent to +implementation> to build the final HTTP request that will be sent to the I. =over 4 @@ -133,7 +133,7 @@ required. =item * C: The initial portion of the base URL's path, minus the -schema and domain name. This tells the client what is the API virtual +scheme and domain name. This tells the client what is the API virtual "location". This may be an empty string if the method corresponds to the server's root URI. @@ -167,7 +167,7 @@ required. =item * -C: The portion of the request URL that follows the ?, if +C: The portion of the request URL that follows the C, if any. May be empty, but is always required. It will always be empty before the request is actually made and sent. @@ -179,23 +179,23 @@ place by the middlewares. =item * C: A list of key/value pairs. These will be interpolated -in the url with the placeholders when the request is made. The rest of -them will be used in the C part of the uri and the -payload key will define the actual content. B>MAY> be empty but +in the URL with the placeholders when the request is made. The rest of +them will be used in the C part of the URI and the +payload key will define the actual content. B be empty but B always be present. =item * -C: An ordered list of all the intermediate urls that +C: An ordered list of all the intermediate URL that were tried by the fetcher. =item * -C: The scheme of the url. +C: The scheme of the URL. =item * -C: The list of expected HTTP status for this request in the response. +C: The list of expected HTTP statuses for this request in the response. =back -- cgit v1.2.3