Fixed netmaster return codes, updated copy, added missing descriptions

Signed-off-by: Bill Robinson <dseevr@users.noreply.github.com>
contiv · Mar 24, 2017 · 56e739a · 56e739a
1 parent 63567ce
commit 56e739a
Show file tree

Hide file tree

Showing 11 changed files with 444 additions and 238 deletions.
diff --git a/spec/auth_proxy.raml b/spec/auth_proxy.raml
@@ -42,6 +42,7 @@ securedBy: custom_scheme
 
   /health:
     get:
+      description: Returns the health status of Contiv API server and its netmaster
       securedBy: [ null ]
       responses:
         200:
@@ -66,12 +67,13 @@ securedBy: custom_scheme
 
   /version:
     get:
+      description: Returns the Contiv API server version
       securedBy: [ null ]
       responses:
         200:
           body:
             application/json: |
-              { "version": "1.0.0-beta" }
+              { "version": "1.0.0" }
 
   /authorizations:
     type: {collection: {provider: auth_proxy}}

diff --git a/spec/auth_proxy/libraries/auth_proxy.raml b/spec/auth_proxy/libraries/auth_proxy.raml
@@ -18,7 +18,7 @@ types:
             required: false
             description: omitted in case netmaster is unhealthy
     example: |
-      {"netmaster":{"status":"healthy","version":"pv1.0.0-alpha-01-27-2017.23-16-47.UTC"},"status":"healthy","version":"1.0.0-alpha"}
+      {"netmaster":{"status":"healthy","version":"1.0.0"},"status":"healthy","version":"1.0.0"}
       
   ldap_configuration:
     properties:
@@ -95,7 +95,7 @@ types:
     properties:
       username:
         type: string
-        description: user name. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)
+        description: "username. If a local user doesn't exist by that name, AD authentication will be tried using sAMAccountName=username in BaseDN scope of the AD server (see ldap configuration for more details)"
       password: string
     example:
       username: johndoe

diff --git a/spec/auth_proxy/schemas/collection-item.raml b/spec/auth_proxy/schemas/collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body:
@@ -12,11 +12,25 @@ get:
         application/json: |
           {"message": "<<resourcePathName|!singularize>> not found" }
 delete:
-  description: deletes <<resourcePathName|!singularize>>.
+  description: Deletes a <<resourcePathName|!singularize>>.
   responses:
     204:
 put?:
-  description: updates/creates <<resourcePathName|!singularize>>
+  description: Updates a <<resourcePathName|!singularize>>
+  body:
+    application/json:
+      type: <<provider>>.upd_<<resourcePathName|!singularize>>
+  responses:
+    200:
+      body:
+        application/json:
+          type: <<provider>>.<<resourcePathName|!singularize>>
+    404:
+      body:
+        application/json: |
+          {"message": "<<resourcePathName|!singularize>> not found" }
+patch?:
+  description: Updates part of a <<resourcePathName|!singularize>>
   body:
     application/json: 
       type: <<provider>>.upd_<<resourcePathName|!singularize>>
@@ -29,4 +43,3 @@ put?:
       body:
         application/json: |
           {"message": "<<resourcePathName|!singularize>> not found" }
-
diff --git a/spec/auth_proxy/schemas/collection.raml b/spec/auth_proxy/schemas/collection.raml
@@ -1,14 +1,14 @@
 #%RAML 1.0 ResourceType
 description: A collection of <<resourcePathName>>
 get:
-  description: returns a list of <<resourcePathName|!singularize>>.
+  description: Returns a list of <<resourcePathName|!pluralize>>.
   responses:
     200:
       body:
         application/json:
-          type: <<provider>>.<<resourcePathName>>
+          type: <<provider>>.<<resourcePathName|!pluralize>>
 post:
-  description: Add a new <<resourcePathName|!singularize>>.
+  description: Create a new <<resourcePathName|!singularize>>.
   body:
     application/json:
       type: <<provider>>.<<resourcePathName|!singularize>>

diff --git a/spec/auth_proxy/schemas/non-upd-collection-item.raml b/spec/auth_proxy/schemas/non-upd-collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body:
@@ -12,7 +12,7 @@ get:
         application/json: |
           {"message": "<<resourcePathName|!singularize>> not found" }
 delete:
-  description: deletes <<resourcePathName|!singularize>>.
+  description: Deletes a <<resourcePathName|!singularize>>.
   responses:
     204:
 
diff --git a/spec/auth_proxy/schemas/ro-collection-item.raml b/spec/auth_proxy/schemas/ro-collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body:

diff --git a/spec/docs/contiv.html b/spec/docs/contiv.html
diff --git a/spec/netmaster/schemas/collection-item.raml b/spec/netmaster/schemas/collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body:
@@ -12,19 +12,20 @@ get:
         application/json: |
           {"message": "<<resourcePathName|!singularize>> not found" }
 post:
-  description: Add a new <<resourcePathName|!singularize>>.
+  description: Creates a new <<resourcePathName|!singularize>>.
   body:
     application/json:
       type: <<provider>>.<<resourcePathName|!singularize>>
   responses:
-    201:
+    200:
     404:
 delete:
-  description: deletes <<resourcePathName|!singularize>>.
+  description: Deletes a <<resourcePathName|!singularize>>.
   responses:
-    204:
+    200:
+    404:
 put?:
-  description: updates/creates <<resourcePathName|!singularize>>
+  description: Updates a <<resourcePathName|!singularize>>
   body:
     application/json: 
       type: <<provider>>.upd_<<resourcePathName|!singularize>>

diff --git a/spec/netmaster/schemas/collection.raml b/spec/netmaster/schemas/collection.raml
@@ -1,9 +1,9 @@
 #%RAML 1.0 ResourceType
 description: A collection of <<resourcePathName>>
 get:
-  description: returns a list of <<resourcePathName|!singularize>>.
+  description: Returns a list of <<resourcePathName|!pluralize>>.
   responses:
     200:
       body:
         application/json:
-          type: <<provider>>.<<resourcePathName>>
+          type: <<provider>>.<<resourcePathName|!pluralize>>
diff --git a/spec/netmaster/schemas/non-upd-collection-item.raml b/spec/netmaster/schemas/non-upd-collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body:
@@ -12,7 +12,7 @@ get:
         application/json: |
           {"message": "<<resourcePathName|!singularize>> not found" }
 delete:
-  description: deletes <<resourcePathName|!singularize>>.
+  description: Deletes a <<resourcePathName|!singularize>>.
   responses:
-    204:
+    200:
 
diff --git a/spec/netmaster/schemas/ro-collection-item.raml b/spec/netmaster/schemas/ro-collection-item.raml
@@ -1,7 +1,7 @@
 #%RAML 1.0 ResourceType
 description: Entity representing <<resourcePathName|!singularize>>
 get:
-  description: returns <<resourcePathName|!singularize>>.
+  description: Returns a <<resourcePathName|!singularize>>.
   responses:
     200:
       body: