{ "opencollection": "1.0.0", "info": { "name": "Helpcenter ArticleComment API", "version": "1.0.0" }, "items": [ { "info": { "name": "ArticleComment", "type": "folder" }, "items": [ { "info": { "name": "List all translation comments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/comments", "params": [ { "name": "include", "value": "", "type": "query", "description": "Allowed values: ticket" }, { "name": "limit", "value": "", "type": "query", "description": "No. of comments to fetch" }, { "name": "from", "value": "", "type": "query", "description": "Index number starting from which the comments must be fetched" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sort comments by the @commentedTime@ attribute. The default sorting order is ascending. @-commentedTime@ denotes descending order of sorting." }, { "name": "articleId", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ] }, "docs": "This API lists a particular number of comments recorded on an article translation, based on the limit specified." }, { "info": { "name": "Create a translation comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/comments", "params": [ { "name": "articleId", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API adds a comment to an article translation." }, { "info": { "name": "Get a article translation comment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/comments/:commentId", "params": [ { "name": "articleId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ] }, "docs": "This API fetches an article translation comment from the portal." }, { "info": { "name": "Update a translation comment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/comments/:commentId", "params": [ { "name": "articleId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This API updates an existing article translation comment." }, { "info": { "name": "Delete a translation comment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/articles/:articleId/translations/:locale/comments/:commentId", "params": [ { "name": "articleId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" }, { "name": "locale", "value": "", "type": "path" } ] }, "docs": "This API deletes an existing article translation comment." } ] } ], "bundled": true }