endpoints.json

{
    "GET /api": {
        "description": "serves up a json representation of all the available endpoints of the api"
    },
    "GET /api/topics": {
        "description": "serves an array of all topics",
        "queries": [],
        "exampleResponse": {
            "topics": [{ "slug": "football", "description": "Footie!" }]
        }
    },
    "POST /api/topics": {
        "description": "It will insert new topic into topics table by inserting requested body to topics table",
        "queries": [],
        "exampleResponse": {
            "topics": [{ "slug": "football", "description": "Footie!" }]
        }
    },
    "GET /api/articles/:article_id": {
        "description": "It will help us to get all articles which there article_id === :article_id ",
        "queries": [],
        "exampleResponse": {
            "articles": [
                {
                    "title": "Seafood substitutions are increasing",
                    "topic": "cooking",
                    "author": "weegembump",
                    "body": "Text from the article..",
                    "created_at": "2018-05-30T15:59:13.341Z",
                    "votes": 0,
                    "comment_count": 6
                }
            ]
        }
    },
    "DELETE /api/articles/:article_id": {
        "description": "It will delete article which has this article_id from articles table also it will delete comment if article_id has relationship with comments table.",
        "queries": [],
        "exampleResponse": {}
    },
    "GET /api/articles": {
        "description": "serves an array of all topics",
        "queries": ["topic", "sort_by", "order", "limit", "p/page"],
        "exampleResponse": {
            "articles": [
                {
                    "title": "Seafood substitutions are increasing",
                    "topic": "cooking",
                    "article_id": 2,
                    "author": "weegembump",
                    "body": "Text from the article..",
                    "created_at": "2018-05-30T15:59:13.341Z",
                    "votes": 0,
                    "comment_count": "6"
                }
            ]
        }
    },
    "GET /api/articles/:article_id/comments": {
        "description": "It will help us to get all comments with right article_id and limit and p/page number",
        "queries": ["limit", "p/page"],
        "exampleResponse": {
            "comment": [
                {
                    "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
                    "votes": 16,
                    "author": "butter_bridge",
                    "article_id": 9,
                    "created_at": 1586179020000
                }
            ]
        }
    },
    "POST /api/articles/:article_id/comments": {
        "description": "It will us to post/update new comment to comments table by article_id and requested body",
        "queries": [],
        "exampleResponse": {
            "comment": [
                {
                    "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!"
                }
            ]
        }
    },
    "PATCH /api/articles/:article_id": {
        "description": "It will help us to patch/update specific part from articles table",
        "queries": [],
        "exampleResponse": {
            "articles": [
                {
                    "title": "Seafood substitutions are increasing"
                }
            ]
        }
    },
    "DELETE /api/comments/:comment_id": {
        "description": "It will delete comments from table when if comments table have comment_id equal to the params id i.e /:comment_id ",
        "queries": [],
        "exampleResponse": []
    },
    "PATCH /api/comments/:comment_id": {
        "description": "It will help us to to increment or decrement votes of comments by selecting comment by comment_id and update the votes colum by inc_votes value",
        "queries": [],
        "exampleResponse": [
            {
                "comment": {
                    "comment_id": 1,
                    "body": "Oh, I've got compassion running out of my nose, pal! I'm the Sultan of Sentiment!",
                    "article_id": 9,
                    "author": "butter_bridge",
                    "votes": 15,
                    "created_at": "2020-04-06T12:17:00.000Z"
                }
            }
        ]
    },
    "GET /api/users": {
        "description": "It will help us to get all users from users table which have appropriate properties",
        "queries": [],
        "exampleResponse": {
            "users": [
                {
                    "username": "butter_bridge",
                    "name": "jonny",
                    "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
                }
            ]
        }
    },
    "GET /api/users/:username": {
        "description": "It will help us to get single user from users through username parameter.",
        "queries": [],
        "exampleResponse": {
            "user": {
                "username": "butter_bridge",
                "name": "jonny",
                "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
            }
        }
    },

    "POST /api/articles": {
        "description": "It will us to insert new article ot articles table.",
        "queries": [],
        "exampleResponse": {
            "comment": [
                {
                    "author": "jes..",
                    "title": "Running a Node app...",
                    "body": "bunch of body...",
                    "topic": "codding",
                    "article_img_url": "http...",

                    "article_id": 2,
                    "votes": 0,
                    "created_at": "timeStamp",
                    "comment_count": "2"
                }
            ]
        }
    }
}