{ "opencollection": "1.0.0", "info": { "name": "Drupal JSON: Comments API", "version": "1.1" }, "request": { "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "items": [ { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "Get a comment", "type": "http" }, "http": { "method": "GET", "url": "https://example.com/jsonapi/comment/:id", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The numeric ID of the entity." } ] }, "docs": "Retrieves a single comment entity by its numeric ID. Returns the comment body, author, timestamps, and the entity it is attached to. Anonymous users can read published comments." }, { "info": { "name": "Update a comment", "type": "http" }, "http": { "method": "PATCH", "url": "https://example.com/jsonapi/comment/:id", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "The numeric ID of the entity." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing comment entity by its numeric ID. Comment authors can edit their own comments within the configured edit window; administrators can edit any comment. Requires authentication." }, { "info": { "name": "Delete a comment", "type": "http" }, "http": { "method": "DELETE", "url": "https://example.com/jsonapi/comment/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The numeric ID of the entity." } ] }, "docs": "Permanently deletes a comment entity by its numeric ID. Requires comment administration permissions and authentication." }, { "info": { "name": "Create a comment", "type": "http" }, "http": { "method": "POST", "url": "https://example.com/jsonapi/comment", "headers": [ { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new comment attached to a specified entity. The request body must include the comment body, target entity type, target entity ID, and field name. Requires comment posting permissions." } ] } ], "bundled": true }