nc-news-app/endpoints.json at main · Konvaly/nc-news-app · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
{
  "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!"
        }
      ]
    }
  },
  "GET /api/articles": {
    "description": "serves an array of all articles",
    "queries": [
      "author",
      "topic",
      "sort_by",
      "order"
    ],
    "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
        }
      ]
    }
  },
  "GET /api/articles/:article_id": {
    "description": "serves a single article based on article_id",
    "exampleResponse": {
      "article": {
        "article_id": 1,
        "title": "Living in the shadow of a great man",
        "topic": "mitch",
        "author": "butter_bridge",
        "body": "I find this existence challenging",
        "created_at": "2020-07-09T20:11:00.000Z",
        "votes": 100,
        "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
      }
    }
  },
  "GET /api/articles/:article_id/comments": {
    "description": "Gets all comments associated with a given article_id, sorted by most recent first.",
    "queries": [],
    "exampleResponse": {
      "comments": [
        {
          "comment_id": 8,
          "votes": 0,
          "created_at": "2020-04-14T20:19:00.000Z",
          "author": "icellusedkars",
          "body": "Delicious crackerbreads",
          "article_id": 1
        }
      ]
    }
  },
  "POST /api/articles/:article_id/comments": {
    "description": "Adds a new comment to a specific article.",
    "requestBody": {
      "username": "string (required) - The username of the user posting the comment.",
      "body": "string (required) - The content of the comment."
    },
    "responses": {
      "201": {
        "description": "Successfully added comment",
        "body": {
          "comment": {
            "comment_id": "number",
            "body": "string",
            "article_id": "number",
            "author": "string",
            "votes": 0,
            "created_at": "ISO8601 timestamp"
          }
        }
      },
      "400": {
        "description": "Bad request (missing required fields, invalid article_id format)",
        "body": {
          "msg": "Missing required fields"
        }
      },
      "404": {
        "description": "Not found (article or username does not exist)",
        "body": {
          "msg": "Article not found or  User not found"
        }
      }
    }
  },
  "PATCH /api/articles/:article_id": {
    "description": "Updates the votes of an article by the given article_id",
    "requestBody": {
      "inc_votes": "A number representing the change in votes (positive or negative)"
    },
    "responses": {
      "200": {
        "description": "Returns the updated article object",
        "exampleResponse": {
          "article": {
            "article_id": 1,
            "title": "Living in the shadow of a great man",
            "topic": "mitch",
            "author": "butter_bridge",
            "body": "I find this existence challenging",
            "created_at": "2020-07-09T20:11:00.000Z",
            "votes": 101,
            "article_img_url": "https://images.pexels.com/photos/158651/news-newsletter-newspaper-information-158651.jpeg?w=700&h=700"
          }
        }
      },
      "400": {
        "description": "Bad request (e.g., invalid inc_votes or article_id)",
        "exampleResponse": {
          "msg": "Invalid value for inc_votes"
        }
      },
      "404": {
        "description": "Article not found",
        "exampleResponse": {
          "msg": "Article not found"
        }
      }
    }
  },
  "DELETE /api/comments/:comment_id": {
    "description": "Deletes the comment with the given comment_id.",
    "responses": {
      "204": {
        "description": "Successfully deleted the comment. No content returned."
      },
      "400": {
        "description": "Invalid comment ID format.",
        "body": {
          "msg": "Invalid comment ID"
        }
      },
      "404": {
        "description": "Comment not found.",
        "body": {
          "msg": "Comment not found"
        }
      }
    }
  }
}