API Routes - jrchew15/word-play-puzzles GitHub Wiki

API Routes

User/Authentication

Sign Up

Request

Require Authentication: False
URL: https://word-play-puzzles.herokuapp.com/api/users
Method: POST
Headers: Content-type: application/json
Body:

{
  "email": "email@address.com",
  "username": "AnyUniqueString",
  "password": "unhashed-password",
  "profilePicture": "image_url.png",
  "theme": "light or dark",
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "email": "email@address.com",
  "username": "AnyUniqueString",
  "profilePicture": "image_url.png",
  "theme": "light or dark",
  "createdAt": "12-25-2022 00:00:00 GMT"
}

Error Response

Status Code: 401
Headers: Content-type: application/json
Body:

{
  "errors":["Username is required","Invalid email address","Username already exists","Email already exists"]
}

Log In

Request

Require Authentication: False
URL: https://word-play-puzzles.herokuapp.com/api/session
Method: POST
Headers: Content-type: application/json
Body:

{
  "credential": "email or username",
  "password": "unhashed-password"
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "email": "email@address.com",
  "username": "AnyUniqueString",
  "profilePicture": "image_url.png",
  "theme": "light or dark",
  "createdAt": "12-25-2022 00:00:00 GMT",
  "openSessions": [ {"SessionObject1"}, {"SessionObject2"} ]
}

Error Response

Status Code: 401
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find user with provided credentials."]
}

Log Out

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/session
Method: DELETE
Headers: None
Body: None

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "message": "Successfully Logged Out",
  "status": 201
}

Get Details of a User by User ID

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/users/:userId
Method: GET
Headers: None
Body: None

Successful Response

Status Code: 200
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "email": "email@address.com",
  "username": "AnyUniqueString",
  "profilePicture": "image_url.png",
  "createdAt": "12-25-2022 00:00:00 GMT",
  "totalPuzzlesSolved": 4
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find user"]
}

Update User Information

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/user/:userId
Method: PUT
Headers: Content-type: application/json
Body:

{
  "email": "updated_email@address.com",
  "username": "updated_username",
  "profilePicture": "updated_image_url.png"
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "email": "updated_email@address.com",
  "username": "updated_username",
  "profilePicture": "updated_image_url.png",
  "theme": "light or dark",
  "createdAt": "12-25-2022 00:00:00 GMT"
}

Error Response

Status Code: 401
Headers: Content-type: application/json
Body:

{
  "errors":["Username is required","Invalid email address","Username already exists","Email already exists"]
}

Word-gon

Get Word-Gon Puzzle Details

Request

Require Authentication: False
URL: https://word-play-puzzles.herokuapp.com/api/word-gon/:wordGonId
Method: GET
Headers: None
Body: None

Successful Response

Status Code: 200
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "userId": 1,
  "letters": "abcdefghijkl",
  "shape": "square or trapezoid or pentagon",
  "num_attempts": 6,
  "puzzle_day": "null or DD-MM-YYYY",
  "user": {"userObj"}
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Puzzle not found"]
}

Word-Gon Session

Start a Word-Gon Puzzle

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/wordgons/:wordgonId/sessions
Method: POST
Headers: Content-Type: application/json
Body:

{
  "userId": 1,
  "puzzleId": 1
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "userId": 1,
  "puzzleId": 1,
  "guesses": "",
  "num_guesses": 0,
  "completed": false
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find puzzle"]
}

Get the open sessions of the current user

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/word-gon-session/current
Method: GET
Headers: None
Body: None

Successful Response

Status Code: 200
Headers: Content-type: application/json
Body:

{
  {
    "id": 1,
    "userId": 1,
    "puzzleId": 1,
    "guesses": "comma,separated,guesses",
    "num_guesses": 3,
    "completed": false
  }
}

Update guesses on a session

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/word-gon-session/:wordGonSessionId
Method: PUT
Headers: Content-type: application/json
Body:

{
  "guesses": "comma,separated,guesses,add,more,guesses",
  "num_guesses": 6,
  "completed": false
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "id": 1,
  "userId": 1,
  "puzzleId": 1,
  "guesses": "comma,separated,guesses,add,more,guesses",
  "num_guesses": 6,
  "completed": false
}

Delete a session

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/word-gon-session/:wordGonSessionId
Method: DELETE
Headers: None
Body: None

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
  "message": "Successfully Deleted",
  "status": 201
}

Comments

Get comments by puzzle ID

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/word-gon/:wordGonId/comments
Method: GET
Headers: None
Body: None

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
    "comments": [
        {
            "id": 1,
            "puzzleId": 1,
            "userId": 1,
            "body": "long string",
            "replyTo": "commentId",
            "createdAt": "12-25-2022 00:00:00 GMT",
            "user":{
                "id":1,
                "username": "username",
                "profilePicture": "image_url.png"
            }
        },
        {
            "id": 2,
            "puzzleId": 1,
            "userId": 1,
            "body": "another long string",
            "replyTo": "null",
            "createdAt": "12-25-2022 00:00:00 GMT",
            "user":{
                "id":1,
                "username": "username",
                "profilePicture": "image_url.png"
            }
        }
    ]
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find puzzle"]
}

Write a comment/reply

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/word-gon/:wordGonId/comments
Method: POST
Headers: Content-Type: application/json
Body:

{
    "body": "long string",
    "replyTo": "commentId",
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
    "id": 1,
    "puzzleId": 1,
    "userId": 1,
    "body": "long string",
    "replyTo": "commentId",
    "createdAt": "12-25-2022 00:00:00 GMT",
    "user":{
        "id":1,
        "username": "username",
        "profilePicture": "image_url.png"
    }
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find puzzle"]
}

Edit a comment

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/comments/:commentId
Method: PUT
Headers: Content-Type: application/json
Body:

{
    "body": "editted string"
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find comment"]
}

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
    "id": 1,
    "puzzleId": 1,
    "userId": 1,
    "body": "editted string",
    "replyTo": "commentId",
    "createdAt": "12-25-2022 00:00:00 GMT",
    "user":{
        "id":1,
        "username": "username",
        "profilePicture": "image_url.png"
    }
}

Delete a comment

Request

Require Authentication: True
URL: https://word-play-puzzles.herokuapp.com/api/comments/:commentId
Method: DELETE
Headers: None
Body: None

Successful Response

Status Code: 201
Headers: Content-type: application/json
Body:

{
    "message": "Successfully deleted",
    "status": 201
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Could not find comment"]
}

Words

Check Word Validity

Request

Require Authentication: False
URL: https://word-play-puzzles.herokuapp.com/api/words/:word
Method: GET
Headers: None
Body: None

Successful Response

Status Code: 200
Headers: Content-type: application/json
Body:

{
  "word":"apple",
}

Error Response

Status Code: 404
Headers: Content-type: application/json
Body:

{
  "errors":["Word not found"]
}