Add comment in changeset list/retrieve API's doc and templates/change…

…set_detail.html
product-definition-center · Sep 7, 2015 · c87cc68 · c87cc68
1 parent dc11643
commit c87cc68
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/pdc/apps/changeset/templates/changeset_detail.html b/pdc/apps/changeset/templates/changeset_detail.html
@@ -9,6 +9,9 @@ <h1 class="page-header">{{ changeset }}</h1>
 <dd>{{ changeset.author }}</dd>
 <dt>{% trans "Date" %}</dt>
 <dd>{{ changeset.committed_on|date:"Y-m-d H:i:s" }}</dd>
+<dt>{% trans "Comment" %}</dt>
+<dd>{{ changeset.comment }}</dd>
+
 </dl>
 
 <h2 class="sub-header">{% trans "Changes" %}</h2>

diff --git a/pdc/apps/changeset/views.py b/pdc/apps/changeset/views.py
@@ -83,14 +83,15 @@ def list(self, request, *args, **kwargs):
                             "committed_on": "2015-02-03T05:51:17.262Z",
                             "changes": [
                                 {
+                                    "id": 1
                                     "resource": "person",
-                                    "resource_id": 2,
+                                    "resource_id": "2",
                                     "old_value": "old",
                                     "new_value": "new"
                                 }
-                            ]
+                            ],
+                            "comment": "xxx"
                         }
-
                     },
                     ...
                 ]
@@ -106,16 +107,18 @@ def list(self, request, *args, **kwargs):
                 "previous": null,
                 "results": [
                         {
+                            "id": 1
                             "author": "xxx",
                             "committed_on": "2015-02-03T05:51:17.262Z",
                             "changes": [
                                 {
                                     "resource": "person",
-                                    "resource_id": 2,
+                                    "resource_id": "2",
                                     "old_value": "old",
                                     "new_value": "new"
                                 }
-                            ]
+                            ],
+                            "comment": "xxx"
                         }
                 ]
             }
@@ -144,7 +147,20 @@ def retrieve(self, request, *args, **kwargs):
 
             curl -H "Content-Type: application/json" $URL:changeset-detail:1$
             # output
-            {"author": "xxx", "committed_on": "2015-02-03T05:51:17.262Z", "changes": [{"resource": "person", "resource_id": 2, "old_value": "old", "new_value": "new"}]}
+            {
+                "id": 1,
+                "author": "xxx",
+                "committed_on": "2015-02-03T05:51:17.262Z",
+                "changes": [
+                   {
+                       "resource": "person",
+                       "resource_id": "2",
+                       "old_value": "old",
+                       "new_value": "new"
+                   }
+                ],
+                "comment": "xxx"
+            }
         """
         return super(ChangesetViewSet, self).retrieve(request, *args, **kwargs)