Permalink
Browse files

REST interfaces by definition cannot have out-of-band description doc…

…uments
  • Loading branch information...
1 parent 8890991 commit 918b4c7db839a64a9e812b2041ff1c092dd522cc @daxim daxim committed with fcuny Mar 13, 2011
Showing with 8 additions and 5 deletions.
  1. +4 −3 spore_description.pod
  2. +3 −2 spore_implementation.pod
  3. +1 −0 t/spelling.t
View
@@ -6,17 +6,18 @@ Spore (B<S>pecifications to a B<Po>rtable B<R>EST B<E>nvironment) Description Im
=head1 ABSTRACT
-Spore is a specification for describing REST API that can be parsed and used
+Spore is a specification for describing HTTP APIs which happen to suffice some
+constraints laid out by the REST architectural style. It can be parsed and used
automatically by client implementations to communicate with the described API.
-This document describes how to write the description for a REST API in
+This document describes how to write the description for such an API in
order to be used with a SPORE Client Implementation.
=head1 TERMINOLOGY
=head2 API
-An I<API> is a REST application that can exchange data with client
+An I<API> is the interface to an 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
perform specific operations.
View
@@ -6,7 +6,8 @@ Spore (B<S>pecifications to a B<Po>rtable B<R>EST B<E>nvironment) Description Im
=head1 ABSTRACT
-Spore is a specification for describing REST API that can be parsed and used
+Spore is a specification for describing HTTP APIs which happen to suffice some
+constraints laid out by the REST architectural style. It can be parsed and used
automatically by client implementations to communicate with the described API.
This document describes what features are required in a Spore client
@@ -18,7 +19,7 @@ implementation.
=item API
-An I<API> is a REST application that can exchange data with client
+An I<API> is the interface to an 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
perform specific operations.
View
@@ -26,6 +26,7 @@ Perrad
## computerese
API
+APIs
CGI
JSGI
JSON

0 comments on commit 918b4c7

Please sign in to comment.