Back to explore

storage

Comments

Credits: 0.000001

Create

POST /v1/comments/Create

Create a new comment

Request

subjectstring

comment subject

textstring

comment items

Response

commentobject

The created comment

Request

Response

{
    "comment": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "subject": "New Comment",
        "text": "This is my comment"
    }
}

Credits: 0.000001

Delete

POST /v1/comments/Delete

Delete a comment

Request

idstring

specify the id of the comment

Response

commentobject

Request

Response

{
    "comment": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "subject": "Update Comment",
        "text": "Updated comment text"
    }
}

Credits: 0.000001

Events

POST /v1/comments/Events

Subscribe to comments events

Request

idstring

optionally specify a comment id

Response

commentobject

the comment which the operation occured on

eventstring

the event which occured; create, delete, update

Request

Response

{
    "event": "deleted",
    "comment": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "subject": "Update Comment",
        "text": "Updated comment text"
    }
}

Credits: 0.000001

List

POST /v1/comments/List

List all the comments

Request

{}

Response

commentsarray

the comment of comments

Request

Response

{
    "comments": [
        {
            "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
            "created": "2021-09-29T13:33:03+01:00",
            "updated": "2021-09-29T13:33:03+01:00",
            "subject": "New Comment",
            "text": "This is my comment"
        }
    ]
}

Credits: 0.000001

Read

POST /v1/comments/Read

Read a comment

Request

idstring

the comment id

Response

commentobject

The comment

Request

Response

{
    "comment": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:33:03+01:00",
        "subject": "New Comment",
        "text": "This is my comment"
    }
}

Credits: 0.000001

Update

POST /v1/comments/Update

Update a comment

Request

commentobject

Response

commentobject

Request

Response

{
    "comment": {
        "id": "63c0cdf8-2121-11ec-a881-0242e36f037a",
        "created": "2021-09-29T13:33:03+01:00",
        "updated": "2021-09-29T13:50:20+01:00",
        "subject": "Update Comment",
        "text": "Updated comment text"
    }
}