Update docs in GlobalComponent views.

Make /update fields consistent with /create and new client arguments.
product-definition-center · Oct 16, 2015 · e6c51ea · e6c51ea
1 parent ed37d52
commit e6c51ea
Showing 1 changed file with 11 additions and 8 deletions.
diff --git a/pdc/apps/component/views.py b/pdc/apps/component/views.py
@@ -221,6 +221,7 @@ def create(self, request, *args, **kwargs):
                 'dist_git_path':       string,         # optional
                 'upstream':            dict,           # optional
             }
+
         __Response__:
 
             {
@@ -262,15 +263,17 @@ def update(self, request, *args, **kwargs):
 
         __Method__:
 
-        PUT: for full fields update
-            {'name': 'new_name', 'dist_git_path': 'new_dist_git_path'}
+        PUT/PATCH: for update
+
+        __Data__:
 
-        PATCH: for partial update
-            {'name': 'new_name'}
-            or
-            {'dist_git_path': 'new_dist_git_path'}
-            or
-            {'name': 'new_name', 'dist_git_path': 'new_dist_git_path'}
+            # accept any field(s) from 'name', 'dist_git_path' and 'upstream'
+            {'name': 'new_name',
+             'dist_git_path': 'new_dist_git_path',
+             'upstream': {'homepage': 'homepage',
+                          'scm_type': 'scm-type',
+                          'scm_url': 'url'}
+            }
 
         __URL__: $LINK:globalcomponent-detail:instance_pk$