Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Comment OData API #9

Closed
tusmester opened this issue Feb 19, 2019 · 4 comments

Comments

Projects
None yet
5 participants
@tusmester
Copy link
Member

commented Feb 19, 2019

Add actions for managing doc preview comments.

The content and the version is appointed by the OData resource (path and parameters).

GetPreviewComments

Required permissions: Preview

Parameters

  • content version (in the url)
  • page

Response: comment json objects

[
	{
		"id": "abc-123",
		"createdBy": { 
                       "id": 22222,
                       "path": "/Root/IMS/Builtin/Portal/Somebody",
                       "username": "sn\\somebody",
                       "displayName": "Somebody",
                       "avatarUrl": "https://example.com/image.png"
                 },
		"creationDate": "2019-02-28T00:27:46.22Z",
		"text": "....",
		"page": 12,
		"x": 12,
		"y": 234
	}
]

AddPreviewComment

Required permissions: Open

Parameters

  • content version (in the url)
  • page
  • coordinates (X, Y)
  • text

Response: comment json object
See above.

DeletePreviewComment

Required permissions: Open

Parameters

  • content version (in the url)
  • comment id

Response: json object

{
   "modified": true
}

(true if the comment was really deleted, otherwise false)

@tusmester tusmester added this to the Sprint 179 milestone Feb 19, 2019

@gallayl

This comment has been minimized.

Copy link

commented Feb 28, 2019

a minor remarks on GetPreviewComments: Is the creationDate an UTC date? Can we get it in a standard UTC string format? (e.g. 2019-02-28T00:27:46.22Z)

@tusmester

This comment has been minimized.

Copy link
Member Author

commented Mar 1, 2019

a minor remarks on GetPreviewComments: Is the creationDate an UTC date? Can we get it in a standard UTC string format? (e.g. 2019-02-28T00:27:46.22Z)

Thanks, I corrected the sample above, the real action returns the date in a correct format ofc.

@tusmester tusmester removed the discussion label Mar 1, 2019

@kultsar kultsar modified the milestones: Sprint 179, Sprint 180 Mar 13, 2019

@B3zo0

This comment has been minimized.

Copy link
Member

commented Mar 19, 2019

Can we have x and y values as doubles please?

@B3zo0 B3zo0 assigned tusmester and unassigned B3zo0 Mar 19, 2019

@kultsar kultsar modified the milestones: Sprint 180, Sprint 181, Sprint 182 Mar 27, 2019

@kultsar kultsar modified the milestones: Sprint 182, Sprint 183 Apr 17, 2019

@kultsar kultsar modified the milestones: Sprint 183, Sprint 184 May 2, 2019

@kultsar kultsar modified the milestones: Sprint 184, Sprint 185 May 15, 2019

@kultsar kultsar modified the milestones: Sprint 185, Sprint 186 May 29, 2019

@herflis

This comment has been minimized.

Copy link
Contributor

commented Jun 11, 2019

@herflis herflis modified the milestones: Sprint 186, Sprint 187 Jun 18, 2019

@tusmester tusmester closed this Jun 24, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.