endpoints.json

{
  "GET /api": {
    "body": {
      "endpoints": "serves up a json representation of all the available endpoints of the api"
    }
  },
  "GET /api/users": {
    "description": "serves an array containing user objects",
    "result": {
      "body":{
        "users": [{
          "username": "zonamorte",
          "name": "claudio",
          "avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
        },{
          "username": "butter_bridge",
          "name": "jonny",
          "avatar_url": "https://www.healthytherapies.com/wp-content/uploads/2016/06/Lime3.jpg"
        }]
      }
    }
  },
  "GET /api/users/:username": {
    "description": "serves user object with matching username searched containing username, avatar_url and name properties",
    "parameter": "username",
    "result": {
      "body":{
        "user": {
          "username": "zonamorte",
          "name": "claudio",
          "avatar_url": "https://www.golenbock.com/wp-content/uploads/2015/01/placeholder-user.png"
        }
      }
    }
  },
  "GET /api/topics": {
    "description": "serves an array of all topics",
    "queries": [],
    "result": {
      "body": {
        "topics": [{ "slug": "football", "description": "Footie!" }]
      }
    }
  },
  "GET /api/articles": {
    "description": "serves an array of all articles",
    "queries": ["author", "topic", "sort_by", "order"],
    "result": {
      "body":{
        "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
        }]
      }
    }
  },
  "GET /api/articles?topic=": {
    "description": "serves an array of all articles that match the topic query",
    "queries": ["topic"],
    "result": {
      "body":{
        "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
        }]
      }
    }
  },
  "GET /api/articles?limit=[number value]&p=[number value]": {
    "description": "serves a pagination based array of articles with max limit length",
    "queries": ["limit", "p"],
    "result": {
      "body":{
        "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,
            "total_count": "2"
        },{
          "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,
          "total_count": "2"
      }]
      }
    }
  },
  "GET /api/articles?sort_by=[column_name]&order=[asc/desc]": {
    "description": "serves an array of all articles sorted by column name and ordered desc / asc",
    "queries": ["sort_by", "order"],
    "result": {
      "body":{
        "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
        },{
          "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
        }]
      }
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves an object of an article",
    "result": {
      "body": {
        "article": {
          "article_id": 4,
          "title": "Student SUES Mitch!",
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700",
          "comment_count": "4"
        }
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "serves an array of all comments with the requested article_id ordered by most recent first",
    "result": {
      "body": {
        "comments": [{
          "comment_id": 4,
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_id": 3
        }]
      }
    }
  },
  "GET /api/articles/:article_id/comments?limit=[number value]&p=[number value]": {
    "description": "serves a pagination based array of comments with max limit length",
    "queries": ["limit", "p"],
    "result": {
      "body":{
        "comments": [{
          "comment_id": 4,
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_id": 3,
          "total_count": "2"
        },{
          "comment_id": 4,
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_id": 3,
          "total_count": "2"
      }]
      }
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "adds comment to comment database and serves the added comment",
    "result": {
      "body": {
        "comment": {
          "comment_id": 4,
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_id": 3
        }
      }
    }
  },
  "POST /api/articles": {
    "description": "returns an object of the article posted",
    "body": {
      "title": "Seafood substitutions are increasing",
      "topic": "cooking",
      "author": "weegembump",
      "body": "Text from the article..",
      "article_img_url": "https://claudiocamba.com/assets/projects/dishGo/dishGoBanner.png"
    },
    "result": {
      "body":{
        "article": {
            "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": 0,
            "article_img_url": "https://claudiocamba.com/assets/projects/dishGo/dishGoBanner.png"
        }
      }
    }
  },
  "POST /api/topics": {
    "description": "serves an object of topic inserted into the table",
    "body": {    
      "slug": "football",
      "description": "Footie!"
    },
    "result": {
      "body": {
        "topic": { "slug": "football", "description": "Footie!" }
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "Updates article votes and returns the updated article object",
    "body": { "inc_votes" : -15 },
    "result": {
      "body":{
        "article": {
          "article_id": 4,
          "title": "Student SUES Mitch!",
          "topic": "mitch",
          "author": "rogersop",
          "body": "We all love Mitch and his wonderful, unique typing style. However, the volume of his typing has ALLEGEDLY burst another students eardrums, and they are now suing for damages",
          "created_at": "2020-05-06T01:14:00.000Z",
          "votes": 0,
          "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
        }
      }
    }
  },
  "PATCH /api/comments/:comment_id": {
    "description": "Updates comment votes by comment id and returns status 204 with 'No content'",
    "body": { "inc_votes" : -15 },
    "result": {
      "body": {
        "comment":{
          "comment_id": 4,
          "body": "I carry a log — yes. Is it funny to you? It is not to me.",
          "article_id": 1,
          "author": "icellusedkars",
          "votes": -100,
          "created_at": "2020-02-23T12:01:00.000Z"
        }
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "Deletes comment by comment id and returns status 204 with 'No content'",
    "result": {
      "res": {
        "statusMessage": "No Content"
      }
    }
  },
  "DELETE /api/articles/:article_id": {
    "description": "Deletes article by article_id and comments with the same article_id. Returns status 204 with 'No content'",
    "result": {
      "res": {
        "statusMessage": "No Content"
      }
    }
  }
}