Skip to content

Commit

Permalink
Add audit info to viewpoint (#292)
Browse files Browse the repository at this point in the history
* Add audit info to viewpoint

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
jasollien authored Aug 28, 2023
1 parent 3b6653c commit c2584b0
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1101,12 +1101,20 @@ Retrieve a **collection** of all viewpoints related to a topic.

GET /bcf/3.0/projects/F445F4F2-4D02-4B2A-B612-5E456BEF9137/topics/B345F4F2-3A04-B43B-A713-5E456BEF8228/viewpoints

Note: For viewpoints without audit information (For example viewpoints created in older BCF versions), you still need to return audit information in the API according to the rules below.

- If comments are linked to this viewpoint, return audit information of the oldest linked comment
- If no comments are linked to the viewpoint, return audit information of the issue


**Example Response**

Response Code: 200 - OK
Body:
[{
"guid": "b24a82e9-f67b-43b8-bda0-4946abf39624",
"creation_date": "2013-10-21T17:34:22.409Z",
"creation_author: "[email protected]",
"perspective_camera": {
"camera_view_point": {
"x": 0.0,
Expand Down Expand Up @@ -1152,6 +1160,8 @@ Retrieve a **collection** of all viewpoints related to a topic.
}]
}, {
"guid": "a11a82e7-e66c-34b4-ada1-5846abf39133",
"creation_date": "2013-10-21T17:34:22.409Z",
"creation_author: "[email protected]",
"perspective_camera": {
"camera_view_point": {
"x": 0.0,
Expand Down Expand Up @@ -1569,6 +1579,8 @@ Retrieve a specific viewpoint.
Body:
{
"guid": "a11a82e7-e66c-34b4-ada1-5846abf39133",
"creation_date": "2013-10-21T17:34:22.409Z",
"creation_author: "[email protected]",
"index": 10,
"perspective_camera": {
"camera_view_point": {
Expand Down
8 changes: 8 additions & 0 deletions Schemas_draft-03/Collaboration/Viewpoint/viewpoint_GET.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@
"snapshot": {
"$ref": "snapshot_GET.json"
},
"creation_date": {
"required": true,
"type": "string"
},
"creation_author": {
"required": true,
"type": "string"
},
"authorization": {
"type": "object",
"required": false,
Expand Down

0 comments on commit c2584b0

Please sign in to comment.