Me

• Login is required for all endpoints.
• Me endpoints begin with /api/me

get

GET /api/me

Used to get the current user’s public and personal data:

Returns: Author Response

Method: GET
Content-Type: application/json

update

PUT /api/me

Used to update current user’s settings:

Returns: Author Response

Method: PUT
Content-Type: application/json
Body:
{
    "firstname": "Lindsay",
    "lastname": "Lohan",
    "email": "lindsay@lohan.com",
    "username": "FreakyFriday",
    "bio": "This is lindsay's bio.",
    "password": "freaky-friday"
}

NOTE: all parameters optional

photo

POST /api/me/photo`

Used to upload profile photos for the author:

Response: Author Response

Method: POST
Content-Type: multipart/form-data
Body: Files keyed by name, e.g.:
{
    'profile_banner_photo': ('mybanner.jpg', <data>, 'jpg'),
    'profile_photo': ('myphoto.png', <data>, 'png)
}

delete

DELETE /api/me

Used to delete the current user:

Returns: Author Response

Method: DELETE
Body: Empty

create poem

POST /api/me/poem

Used to create a new poem with the current user as the author:

Returns: Poem Response

Method: POST
Content-Type: application/json
Body: Empty

get all poems

GET /api/me/poem

Used to retrieve all poems by the current user, public and private:

Returns: List of Poems Response

Method: GET

get poem

GET /api/me/poem/<poem_id>

Used to get the specified poem:

Returns: Poem Response

Method: GET

update poem

PUT /api/me/poem/<poem_id>

Used to update the specified poem:

Returns: Poem Response

Method: POST
Content-Type: application/json
Body: {
    "tags": ['kittens', 'space', 'lusha'],
    "title": "Kittens in Space",
    "body": "A kitten in space<br>Lusha the astronaut"
    "is_published": true
}

NOTE: is_published is optional. Set to true to publish. Set to false to unpublish.

delete poem

DELETE /api/me/poem/<poem_id>

Delete the specified poem:

Returns: Poem Response

Method: DELETE
Body: Empty

get all collections

GET /api/me/collection

Used to get a list of all of the current user’s collections, public or private:

Returns: List of Collections Response

Method: GET

create new collection

POST /api/me/collection

Used to create a new collection for the current user:

Returns: Collection Response

Method: POST
Content-Type: application/json
Body: {
    "title": "New Collection",
    "tags": ["a", "cool", "collection"],
    "description": "this collection is cool.",
    "is_public": true
}

NOTE: All arguments optional.

update collection

PUT /api/me/collection/<collection_id>

Used to update an existing collection owned by the current user:

Returns: Collection

Method: PUT
Content-Type: multipart/form-data
Body: {
    image: <an image>
    title: "title"
    tags: ["some", "tags"]
    description: "a description"
    is_public: false
}

delete collection

DELETE /api/me/collection/<collection_id>

Used to delete an existing collection owned by the current user:

Returns: Collection Response

Method: DELETE

get poems in collection

GET /api/me/collection/<collection_id>/poem

Used to get all poems in the given collection owned by the current user:

Returns: List of poems Response

Method: GET

add poem to collection

PUT /api/me/collection/<collection_id>/poem/<poem_id>

Used to add a poem to the given collection:

Returns: Collection Response

Method: PUT
Content-Type: application/json
Body: {
    "is_hidden": true
}

remove poem from collection

DELETE /api/me/collections/<collection_id>/poem/<poem_id>

Used to delete a poem from the specified collection:

Returns: Collection Response

Method: DELETE