Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

- transformed numbers in booleans

- renamed authentication in api_authentication
- made name and version mandatory
- added api_auth_type and auth_type
  • Loading branch information...
commit a917f3e31ce61e99044ed563c3dbf7273f00b629 1 parent 9d0d0bc
@ngrunwald ngrunwald authored
Showing with 20 additions and 5 deletions.
  1. +20 −5 spore_description.pod
View
25 spore_description.pod
@@ -48,7 +48,7 @@ This part describes the API itself:
=over 4
-=item B<name> (optional)
+=item B<name> (required)
A simple name to describe the specification
@@ -75,17 +75,25 @@ A list of supported format
- json
- xml
-=item B<version> (optinal)
+=item B<version> (required)
The version number of the current description
version: 0.1
-=item B<authentication> (optional)
+=item B<api_authentication> (optional)
A boolean to specify if this API requires authentication for all the methods
- authentication: 1
+ api_authentication: true
+
+=item B<api_auth_type> (optional)
+
+A list of supported authentication methods
+
+ api_auth_type:
+ - simple
+ - oauth
=item B<methods> (required)
@@ -151,7 +159,14 @@ documentation.
A boolean to specify if this method requires authentication
- authentication: 0
+ authentication: false
+
+=item B<auth_type> (optional)
+
+A list of supported authentication methods
+
+ auth_type:
+ - digest
=item B<base_url> (optional)
Please sign in to comment.
Something went wrong with that request. Please try again.