maverick/docbrown
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docbrown/swagger/v1/api_v1.json
Joshua Wehner abcd4ac3c8
Add ability to assign arbitrary segment ID to /display_ads API (#19529) 
* DisplayAd audience_segment_id in API

* Rubocop

* Manual not valid if missing id

* manual-type requires an id

* Better audience_segment_type reader

* Use inclusion validation

* Swagger update

* Remove unnecessary
2023-05-31 18:11:35 +02:00

4082 lines
141 KiB
JSON
Raw Blame History

{
"openapi": "3.0.3",
"info": {
"title": "Forem API V1",
"version": "1.0.0",
"description": "Access Forem articles, users and other resources via API.\n For a real-world example of Forem in action, check out [DEV](https://www.dev.to).\n All endpoints can be accessed with the 'api-key' header and a accept header, but\n some of them are accessible publicly without authentication.\n\n Dates and date times, unless otherwise specified, must be in\n the [RFC 3339](https://tools.ietf.org/html/rfc3339) format."
},
"paths": {
"/api/articles": {
"post": {
"summary": "Publish article",
"tags": ["articles"],
"description": "This endpoint allows the client to create a new article.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.",
"operationId": "createArticle",
"parameters": [],
"responses": {
"201": {
"description": "An Article",
"content": {
"application/json": {
"example": {
"type_of": "article",
"id": 205,
"title": "New article",
"description": "New post example",
"readable_publish_date": "May 26",
"slug": "new-article-3h4k",
"path": "/username492/new-article-3h4k",
"url": "http://localhost:3000/username492/new-article-3h4k",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": 11,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "https://thepracticaldev.s3.amazonaws.com/i/5wfo25724gzgk5e5j50g.jpg",
"social_image": "https://thepracticaldev.s3.amazonaws.com/i/5wfo25724gzgk5e5j50g.jpg",
"canonical_url": "https://dev.to/fdocr/headless-chrome-dual-mode-tests-for-ruby-on-rails-4p6g",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": "",
"tags": [],
"body_html": "<p><strong>New</strong> body for the article</p>\n\n",
"body_markdown": "**New** body for the article",
"user": {
"name": "Abram \"Armando\" \\:/ Leannon",
"username": "username492",
"twitter_username": "twitter492",
"github_username": "github492",
"user_id": 493,
"website_url": null,
"profile_image": "/uploads/user/profile_image/493/8dda0660-678a-4003-abe1-302da168bf19.jpeg",
"profile_image_90": "/uploads/user/profile_image/493/8dda0660-678a-4003-abe1-302da168bf19.jpeg"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"example": {
"error": "param is missing or the value is empty: article",
"status": 422
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Article"
}
}
}
}
},
"get": {
"summary": "Published articles",
"security": [],
"tags": ["articles"],
"description": "This endpoint allows the client to retrieve a list of articles.\n\n\"Articles\" are all the posts that users create on DEV that typically\nshow up in the feed. They can be a blog post, a discussion question,\na help thread etc. but is referred to as article within the code.\n\nBy default it will return featured, published articles ordered\nby descending popularity.\n\nIt supports pagination, each page will contain `30` articles by default.",
"operationId": "getArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
},
{
"name": "tag",
"in": "query",
"required": false,
"description": "Using this parameter will retrieve articles that contain the requested tag. Articles\nwill be ordered by descending popularity.This parameter can be used in conjuction with `top`.",
"schema": {
"type": "string"
},
"example": "discuss"
},
{
"name": "tags",
"in": "query",
"required": false,
"description": "Using this parameter will retrieve articles with any of the comma-separated tags.\nArticles will be ordered by descending popularity.",
"schema": {
"type": "string"
},
"example": "javascript, css"
},
{
"name": "tags_exclude",
"in": "query",
"required": false,
"description": "Using this parameter will retrieve articles that do _not_ contain _any_\nof comma-separated tags. Articles will be ordered by descending popularity.",
"schema": {
"type": "string"
},
"example": "node, java"
},
{
"name": "username",
"in": "query",
"required": false,
"description": "Using this parameter will retrieve articles belonging\n to a User or Organization ordered by descending publication date.\n If `state=all` the number of items returned will be `1000` instead of the default `30`.\n This parameter can be used in conjuction with `state`.",
"schema": {
"type": "string"
},
"example": "ben"
},
{
"name": "state",
"in": "query",
"required": false,
"description": "Using this parameter will allow the client to check which articles are fresh or rising.\n If `state=fresh` the server will return fresh articles.\n If `state=rising` the server will return rising articles.\n This param can be used in conjuction with `username`, only if set to `all`.",
"schema": {
"type": "string",
"enum": ["fresh", "rising", "all"]
},
"example": "fresh"
},
{
"name": "top",
"in": "query",
"required": false,
"description": "Using this parameter will allow the client to return the most popular articles\nin the last `N` days.\n`top` indicates the number of days since publication of the articles returned.\nThis param can be used in conjuction with `tag`.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 2
},
{
"name": "collection_id",
"in": "query",
"required": false,
"description": "Adding this will allow the client to return the list of articles\nbelonging to the requested collection, ordered by ascending publication date.",
"schema": {
"type": "integer",
"format": "int32"
},
"example": 99
}
],
"responses": {
"200": {
"description": "A List of Articles",
"content": {
"application/json": {
"example": [
{
"type_of": "article",
"id": 208,
"title": "Shall not Perish188",
"description": "Poutine scenester health pour-over hella. Authentic roof swag. Gluten-free migas pickled letterpress...",
"readable_publish_date": "May 26",
"slug": "shall-not-perish188-3fl7",
"path": "/username496/shall-not-perish188-3fl7",
"url": "http://localhost:3000/username496/shall-not-perish188-3fl7",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/25-b4bb206b62bee552880440f638594e41dcd649ed9bd821af2e8dfc671d1d6813.png",
"social_image": "http://localhost:3000/assets/25-b4bb206b62bee552880440f638594e41dcd649ed9bd821af2e8dfc671d1d6813.png",
"canonical_url": "http://localhost:3000/username496/shall-not-perish188-3fl7",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": ["discuss"],
"tags": "discuss",
"user": {
"name": "Gavin \"Ivy\" \\:/ Herman",
"username": "username496",
"twitter_username": "twitter496",
"github_username": "github496",
"user_id": 497,
"website_url": null,
"profile_image": "/uploads/user/profile_image/497/4e0a4cce-c647-48b5-b481-e6145c0a3135.jpeg",
"profile_image_90": "/uploads/user/profile_image/497/4e0a4cce-c647-48b5-b481-e6145c0a3135.jpeg"
},
"organization": {
"name": "Mann-Hoeger",
"username": "org73",
"slug": "org73",
"profile_image": "/uploads/organization/profile_image/73/27206715-217b-4f13-8765-7f6eb68e77fb.png",
"profile_image_90": "/uploads/organization/profile_image/73/27206715-217b-4f13-8765-7f6eb68e77fb.png"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/latest": {
"get": {
"summary": "Published articles sorted by published date",
"security": [],
"tags": ["articles"],
"description": "This endpoint allows the client to retrieve a list of articles. ordered by descending publish date.\n\nIt supports pagination, each page will contain 30 articles by default.",
"operationId": "getLatestArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"200": {
"description": "A List of Articles",
"content": {
"application/json": {
"example": [
{
"type_of": "article",
"id": 211,
"title": "The Waste Land191",
"description": "Cleanse try-hard kinfolk scenester pork belly selvage fingerstache pug. Bitters stumptown 90's...",
"readable_publish_date": "May 26",
"slug": "the-waste-land191-9ne",
"path": "/username499/the-waste-land191-9ne",
"url": "http://localhost:3000/username499/the-waste-land191-9ne",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/19-ed58d3e8defcefc445020631589697a05e725243e834b5192aee4e6b91a3e927.png",
"social_image": "http://localhost:3000/assets/19-ed58d3e8defcefc445020631589697a05e725243e834b5192aee4e6b91a3e927.png",
"canonical_url": "http://localhost:3000/username499/the-waste-land191-9ne",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": ["javascript", "html", "discuss"],
"tags": "javascript, html, discuss",
"user": {
"name": "Fermin \"Delbert\" \\:/ Schuster",
"username": "username499",
"twitter_username": "twitter499",
"github_username": "github499",
"user_id": 500,
"website_url": null,
"profile_image": "/uploads/user/profile_image/500/25c4a680-ad1f-4564-b134-63a2d01baab5.jpeg",
"profile_image_90": "/uploads/user/profile_image/500/25c4a680-ad1f-4564-b134-63a2d01baab5.jpeg"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
},
{
"type_of": "article",
"id": 210,
"title": "For a Breath I Tarry190",
"description": "Fixie disrupt ugh wes anderson knausgaard letterpress street. Bushwick trust fund plaid brunch....",
"readable_publish_date": "May 26",
"slug": "for-a-breath-i-tarry190-3kp",
"path": "/username498/for-a-breath-i-tarry190-3kp",
"url": "http://localhost:3000/username498/for-a-breath-i-tarry190-3kp",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/3-93b6b57b5a6115cffe5d63d29a22825eb9e65f647bfef57a88244bc2b98186f0.png",
"social_image": "http://localhost:3000/assets/3-93b6b57b5a6115cffe5d63d29a22825eb9e65f647bfef57a88244bc2b98186f0.png",
"canonical_url": "http://localhost:3000/username498/for-a-breath-i-tarry190-3kp",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": ["javascript", "html", "discuss"],
"tags": "javascript, html, discuss",
"user": {
"name": "Clarine \"Myrtis\" \\:/ Breitenberg",
"username": "username498",
"twitter_username": "twitter498",
"github_username": "github498",
"user_id": 499,
"website_url": null,
"profile_image": "/uploads/user/profile_image/499/d62594ba-68ee-4c42-b038-72bfd193d6ac.jpeg",
"profile_image_90": "/uploads/user/profile_image/499/d62594ba-68ee-4c42-b038-72bfd193d6ac.jpeg"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
},
{
"type_of": "article",
"id": 209,
"title": "Where Angels Fear to Tread189",
"description": "Keytar truffaut twee organic biodiesel portland pug wolf. Freegan occupy goth hoodie ennui 3 wolf...",
"readable_publish_date": "May 26",
"slug": "where-angels-fear-to-tread189-5g0h",
"path": "/username497/where-angels-fear-to-tread189-5g0h",
"url": "http://localhost:3000/username497/where-angels-fear-to-tread189-5g0h",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/5-ae4b452d58aedebf5435dbbd1978ea4acacf8657e6bef44304a3fccde0dd04ea.png",
"social_image": "http://localhost:3000/assets/5-ae4b452d58aedebf5435dbbd1978ea4acacf8657e6bef44304a3fccde0dd04ea.png",
"canonical_url": "http://localhost:3000/username497/where-angels-fear-to-tread189-5g0h",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": ["javascript", "html", "discuss"],
"tags": "javascript, html, discuss",
"user": {
"name": "Danae \"Jerrold\" \\:/ Casper",
"username": "username497",
"twitter_username": "twitter497",
"github_username": "github497",
"user_id": 498,
"website_url": null,
"profile_image": "/uploads/user/profile_image/498/d0d6b8f2-12fe-41ce-b1de-10d8a700a29a.jpeg",
"profile_image_90": "/uploads/user/profile_image/498/d0d6b8f2-12fe-41ce-b1de-10d8a700a29a.jpeg"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/{id}": {
"get": {
"summary": "Published article by id",
"security": [],
"tags": ["articles"],
"description": "This endpoint allows the client to retrieve a single published article given its `id`.",
"operationId": "getArticleById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "An Article",
"content": {
"application/json": {
"example": {
"type_of": "article",
"id": 212,
"title": "Taming a Sea Horse192",
"description": "Iphone messenger bag waistcoat fanny pack synth portland marfa craft beer. Authentic tumblr cornhole...",
"readable_publish_date": "May 26",
"slug": "taming-a-sea-horse192-1jc6",
"path": "/username500/taming-a-sea-horse192-1jc6",
"url": "http://localhost:3000/username500/taming-a-sea-horse192-1jc6",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/31-2a89a91581ce9080fed8d62dd9c70a3fd5f92472da8c023e7b29256e04811b2e.png",
"social_image": "http://localhost:3000/assets/31-2a89a91581ce9080fed8d62dd9c70a3fd5f92472da8c023e7b29256e04811b2e.png",
"canonical_url": "http://localhost:3000/username500/taming-a-sea-horse192-1jc6",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": "discuss",
"tags": ["discuss"],
"body_html": "<p>Iphone messenger bag waistcoat fanny pack synth portland marfa craft beer. Authentic tumblr cornhole wolf deep v. Leggings direct trade trust fund cleanse cold-pressed muggle magic before they sold out messenger bag. Wes anderson meditation narwhal gastropub pop-up.</p>\n\n<p>Hashtag food truck cred cleanse.</p>\n\n",
"body_markdown": "---\ntitle: Taming a Sea Horse192\npublished: true\ntags: discuss\ndate: \nseries: \ncanonical_url: \n\n---\n\nIphone messenger bag waistcoat fanny pack synth portland marfa craft beer. Authentic tumblr cornhole wolf deep v. Leggings direct trade trust fund cleanse cold-pressed muggle magic before they sold out messenger bag. Wes anderson meditation narwhal gastropub pop-up.\n\n\nHashtag food truck cred cleanse.\n\n",
"user": {
"name": "Stanford \"Melissa\" \\:/ Corkery",
"username": "username500",
"twitter_username": "twitter500",
"github_username": "github500",
"user_id": 501,
"website_url": null,
"profile_image": "/uploads/user/profile_image/501/17b27502-4385-4926-a56e-5fc98b5eeb2b.jpeg",
"profile_image_90": "/uploads/user/profile_image/501/17b27502-4385-4926-a56e-5fc98b5eeb2b.jpeg"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
},
"404": {
"description": "Article Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
},
"put": {
"summary": "Update an article by id",
"tags": ["articles"],
"description": "This endpoint allows the client to update an existing article.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.",
"operationId": "updateArticle",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the user to unpublish.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 123
}
],
"responses": {
"200": {
"description": "An Article",
"content": {
"application/json": {
"example": {
"type_of": "article",
"id": 213,
"title": "Beneath the Bleeding193",
"description": "Roof cray heirloom hashtag dreamcatcher pour-over. Pug cronut wolf. Squid vice pop-up chartreuse...",
"readable_publish_date": "May 26",
"slug": "beneath-the-bleeding193-5me",
"path": "/username501/beneath-the-bleeding193-5me",
"url": "http://localhost:3000/username501/beneath-the-bleeding193-5me",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:12Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/33-dc66b0d3c291181013c8bc7a6eb3b26755d85e90b63c9c589cb6c161624cc410.png",
"social_image": "http://localhost:3000/assets/33-dc66b0d3c291181013c8bc7a6eb3b26755d85e90b63c9c589cb6c161624cc410.png",
"canonical_url": "http://localhost:3000/username501/beneath-the-bleeding193-5me",
"created_at": "2023-05-26T08:53:12Z",
"edited_at": "2023-05-26T08:53:12Z",
"crossposted_at": null,
"published_at": "2023-05-26T08:53:12Z",
"last_comment_at": "2023-05-26T08:53:12Z",
"reading_time_minutes": 1,
"tag_list": "",
"tags": [],
"body_html": "<p><strong>New</strong> body for the article</p>\n\n",
"body_markdown": "**New** body for the article",
"user": {
"name": "Erich \"Adan\" \\:/ Rutherford",
"username": "username501",
"twitter_username": "twitter501",
"github_username": "github501",
"user_id": 502,
"website_url": null,
"profile_image": "/uploads/user/profile_image/502/4d0d1b83-9659-4ff1-9f66-2644155f2a92.jpeg",
"profile_image_90": "/uploads/user/profile_image/502/4d0d1b83-9659-4ff1-9f66-2644155f2a92.jpeg"
}
}
}
}
},
"404": {
"description": "Article Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"example": {
"error": "param is missing or the value is empty: article",
"status": 422
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Article"
}
}
}
}
}
},
"/api/articles/{username}/{slug}": {
"get": {
"summary": "Published article by path",
"security": [],
"tags": ["articles"],
"description": "This endpoint allows the client to retrieve a single published article given its `path`.",
"operationId": "getArticleByPath",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "slug",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "An Article",
"content": {
"application/json": {
"example": {
"type_of": "article",
"id": 216,
"title": "Unweaving the Rainbow196",
"description": "Locavore semiotics fixie. Polaroid meh mustache biodiesel park cornhole. Taxidermy distillery...",
"readable_publish_date": "May 26",
"slug": "unweaving-the-rainbow196-2dkp",
"path": "/username505/unweaving-the-rainbow196-2dkp",
"url": "http://localhost:3000/username505/unweaving-the-rainbow196-2dkp",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:13Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/23-33ea5a2b5af3dc15b9ed90de0b850f67e2390eaec3361d6687d3b9750c699f84.png",
"social_image": "http://localhost:3000/assets/23-33ea5a2b5af3dc15b9ed90de0b850f67e2390eaec3361d6687d3b9750c699f84.png",
"canonical_url": "http://localhost:3000/username505/unweaving-the-rainbow196-2dkp",
"created_at": "2023-05-26T08:53:13Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:13Z",
"last_comment_at": "2023-05-26T08:53:13Z",
"reading_time_minutes": 1,
"tag_list": "discuss",
"tags": ["discuss"],
"body_html": "<p>Locavore semiotics fixie. Polaroid meh mustache biodiesel park cornhole. Taxidermy distillery selvage. Farm-to-table venmo selvage flexitarian quinoa.</p>\n\n<p>Crucifix truffaut twee banjo yr.</p>\n\n",
"body_markdown": "---\ntitle: Unweaving the Rainbow196\npublished: true\ntags: discuss\ndate: \nseries: \ncanonical_url: \n\n---\n\nLocavore semiotics fixie. Polaroid meh mustache biodiesel park cornhole. Taxidermy distillery selvage. Farm-to-table venmo selvage flexitarian quinoa.\n\n\nCrucifix truffaut twee banjo yr.\n\n",
"user": {
"name": "Rodney \"Kaye\" \\:/ Weimann",
"username": "username505",
"twitter_username": "twitter505",
"github_username": "github505",
"user_id": 506,
"website_url": null,
"profile_image": "/uploads/user/profile_image/506/2ddd227a-79f2-4075-a99d-ab663a86fc96.jpeg",
"profile_image_90": "/uploads/user/profile_image/506/2ddd227a-79f2-4075-a99d-ab663a86fc96.jpeg"
},
"flare_tag": {
"name": "discuss",
"bg_color_hex": "#000000",
"text_color_hex": "#ffffff"
}
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
},
"404": {
"description": "Article Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/articles/me": {
"get": {
"summary": "User's articles",
"tags": ["articles", "users"],
"description": "This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.\n\nPublished articles will be in reverse chronological publication order.\n\nIt will return published articles with pagination. By default a page will contain 30 articles.",
"operationId": "getUserArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A List of the authenticated user's Articles",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/me/published": {
"get": {
"summary": "User's published articles",
"tags": ["articles", "users"],
"description": "This endpoint allows the client to retrieve a list of published articles on behalf of an authenticated user.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.\n\nPublished articles will be in reverse chronological publication order.\n\nIt will return published articles with pagination. By default a page will contain 30 articles.",
"operationId": "getUserPublishedArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A List of the authenticated user's Articles",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/me/unpublished": {
"get": {
"summary": "User's unpublished articles",
"tags": ["articles", "users"],
"description": "This endpoint allows the client to retrieve a list of unpublished articles on behalf of an authenticated user.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.\n\nUnpublished articles will be in reverse chronological creation order.\n\nIt will return unpublished articles with pagination. By default a page will contain 30 articles.",
"operationId": "getUserUnpublishedArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A List of the authenticated user's Articles",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/me/all": {
"get": {
"summary": "User's all articles",
"tags": ["articles", "users"],
"description": "This endpoint allows the client to retrieve a list of all articles on behalf of an authenticated user.\n\n\"Articles\" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.\n\nIt will return both published and unpublished articles with pagination.\n\nUnpublished articles will be at the top of the list in reverse chronological creation order. Published articles will follow in reverse chronological publication order.\n\nBy default a page will contain 30 articles.",
"operationId": "getUserAllArticles",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A List of the authenticated user's Articles",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/articles/{id}/unpublish": {
"put": {
"summary": "Unpublish an article",
"tags": ["articles"],
"description": "This endpoint allows the client to unpublish an article.\n\nThe user associated with the API key must have any 'admin' or 'moderator' role.\n\nThe article will be unpublished and will no longer be visible to the public. It will remain\nin the database and will set back to draft status on the author's posts dashboard. Any\nnotifications associated with the article will be deleted. Any comments on the article\nwill remain.",
"operationId": "unpublishArticle",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the article to unpublish.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
},
{
"name": "note",
"in": "query",
"required": false,
"description": "Content for the note that's created along with unpublishing",
"schema": {
"type": "string"
},
"example": "Admin requested unpublishing all articles via API"
}
],
"responses": {
"204": {
"description": "Article successfully unpublished"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Article Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/segments": {
"get": {
"summary": "Manually managed audience segments",
"tags": ["segments"],
"description": "This endpoint allows the client to retrieve a list of audience segments.\n\nAn audience segment is a group of users that can be targeted by a Billboard. This API only permits managing segments you create and maintain yourself.\n\nThe endpoint supports pagination, and each page will contain `30` segments by default.",
"operationId": "getSegments",
"parameters": [
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"200": {
"description": "A List of manually managed audience segments",
"content": {
"application/json": {
"example": [
{
"id": 127,
"created_at": "2023-05-19T13:29:19.013-05:00",
"type_of": "manual",
"updated_at": "2023-05-19T13:29:19.013-05:00",
"user_count": 1
},
{
"id": 126,
"created_at": "2023-05-19T13:29:19.013-05:00",
"type_of": "manual",
"updated_at": "2023-05-19T13:29:19.013-05:00",
"user_count": 3
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Segment"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
},
"post": {
"summary": "Create a manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to create a new audience segment.\n\nAn audience segment is a group of users that can be targeted by a Billboard. This API only permits managing segments you create and maintain yourself.",
"operationId": "createSegment",
"responses": {
"201": {
"description": "A manually managed audience segment",
"content": {
"application/json": {
"example": {
"id": 22,
"created_at": "2023-05-26T11:53:14.006+03:00",
"type_of": "manual",
"updated_at": "2023-05-26T11:53:14.006+03:00"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/segments/{id}": {
"get": {
"summary": "A manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to retrieve a single manually-managed audience segment specified by ID.",
"operationId": "getSegment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "The audience segment",
"content": {
"application/json": {
"example": {
"id": 131,
"created_at": "2023-05-19T13:29:19.481-05:00",
"type_of": "manual",
"updated_at": "2023-05-19T13:29:19.481-05:00",
"user_count": 3
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Segment"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Audience Segment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
},
"delete": {
"summary": "Delete a manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to delete an audience segment specified by ID.\n\nAudience segments cannot be deleted if there are still any Billboards using them.",
"operationId": "deleteSegment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "The deleted audience segment",
"content": {
"application/json": {
"example": {
"id": 23,
"created_at": "2023-05-26T11:53:14.163+03:00",
"type_of": "manual",
"updated_at": "2023-05-26T11:53:14.163+03:00"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Audience Segment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"409": {
"description": "Audience segment could not be deleted",
"content": {
"application/json": {
"example": {
"error": "Segments cannot be deleted while in use by any billboards"
}
}
}
}
}
}
},
"/api/segments/{id}/users": {
"get": {
"summary": "Users in a manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to retrieve a list of the users in an audience segment specified by ID. The endpoint supports pagination, and each page will contain `30` users by default.",
"operationId": "getUsersInSegment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
}
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"200": {
"description": "A List of users in the audience segment",
"content": {
"application/json": {
"example": [
{
"type_of": "user",
"id": 1032,
"username": "username586",
"name": "Katrina \"Kirsten\" \\:/ Schiller",
"twitter_username": "twitter586",
"github_username": "github586",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 19, 2023",
"profile_image": "/uploads/user/profile_image/1947/02641cc1-4268-4203-8f2d-59cf53d4433a.jpeg"
},
{
"type_of": "user",
"id": 1033,
"username": "username587",
"name": "Breanne \"Steve\" \\:/ Marquardt",
"twitter_username": "twitter587",
"github_username": "github587",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 19, 2023",
"profile_image": "/uploads/user/profile_image/1948/621613c2-2990-4b92-8a26-8dac49725a95.jpeg"
},
{
"type_of": "user",
"id": 1034,
"username": "username588",
"name": "Eugene \"Jamar\" \\:/ Keebler",
"twitter_username": "twitter588",
"github_username": "github588",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 19, 2023",
"profile_image": "/uploads/user/profile_image/1949/7d5a54bc-faf2-408b-a988-3ea5b8ef40f1.jpeg"
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Audience Segment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/segments/{id}/add_users": {
"put": {
"summary": "Add users to a manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to add users in bulk to an audience segment specified by ID.\n\nSuccesses are users that were included in the segment (even if they were already in it), and failures are users that could not be added to the segment.",
"operationId": "addUsersToSegment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Result of adding the users to the segment.",
"content": {
"application/json": {
"example": {
"succeeded": [531, 532, 530],
"failed": []
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Audience Segment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"example": {
"error": "param is missing or the value is empty: user_ids",
"status": 422
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentUserIds"
}
}
}
}
}
},
"/api/segments/{id}/remove_users": {
"put": {
"summary": "Remove users from a manually managed audience segment",
"tags": ["segments"],
"description": "This endpoint allows the client to remove users in bulk from an audience segment specified by ID.\n\nSuccesses are users that were removed; failures are users that weren't a part of the segment.",
"operationId": "removeUsersFromSegment",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
}
}
],
"responses": {
"200": {
"description": "Result of removing the users to the segment.",
"content": {
"application/json": {
"example": {
"succeeded": [549, 550, 551],
"failed": []
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Audience Segment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"example": {
"error": "param is missing or the value is empty: user_ids",
"status": 422
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SegmentUserIds"
}
}
}
}
}
},
"/api/comments": {
"get": {
"summary": "Comments",
"security": [],
"tags": ["comments"],
"description": "This endpoint allows the client to retrieve all comments belonging to an article or podcast episode as threaded conversations.\n\nIt will return the all top level comments with their nested comments as threads. See the format specification for further details.",
"operationId": "getCommentsByArticleId",
"parameters": [
{
"name": "a_id",
"in": "query",
"required": false,
"description": "Article identifier.",
"schema": {
"type": "string"
},
"example": "321"
},
{
"name": "p_id",
"in": "query",
"required": false,
"description": "Podcast Episode identifier.",
"schema": {
"type": "string"
},
"example": "321"
}
],
"responses": {
"200": {
"description": "A List of Comments",
"content": {
"application/json": {
"example": [
{
"type_of": "comment",
"id_code": "52",
"created_at": "2023-05-26T08:53:15Z",
"body_html": "<p>Narwhal vinyl single-origin coffee cardigan.</p>\n\n",
"user": {
"name": "Patrick \"Loma\" \\:/ Hintz",
"username": "username573",
"twitter_username": "twitter573",
"github_username": "github573",
"user_id": 574,
"website_url": null,
"profile_image": "/uploads/user/profile_image/574/eecf6820-a93a-4b6d-9a79-e7795024b5b5.jpeg",
"profile_image_90": "/uploads/user/profile_image/574/eecf6820-a93a-4b6d-9a79-e7795024b5b5.jpeg"
},
"children": []
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Comment"
}
}
}
}
},
"404": {
"description": "Resource Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/comments/{id}": {
"get": {
"summary": "Comment by id",
"security": [],
"tags": ["comments"],
"description": "This endpoint allows the client to retrieve a comment as well as his descendants comments.\n\n It will return the required comment (the root) with its nested descendants as a thread.\n\n See the format specification for further details.",
"operationId": "getCommentById",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "Comment identifier.",
"schema": {
"type": "integer"
},
"example": "321"
}
],
"responses": {
"200": {
"description": "A List of the Comments",
"content": {
"application/json": {
"example": {
"type_of": "comment",
"id_code": "54",
"created_at": "2023-05-26T08:53:16Z",
"body_html": "<p>Crucifix park echo marfa chia.</p>\n\n",
"user": {
"name": "Lucio \"Fritz\" \\:/ Cronin",
"username": "username577",
"twitter_username": "twitter577",
"github_username": "github577",
"user_id": 578,
"website_url": null,
"profile_image": "/uploads/user/profile_image/578/95931b9e-9f36-403b-8bc4-e420fde05c87.jpeg",
"profile_image_90": "/uploads/user/profile_image/578/95931b9e-9f36-403b-8bc4-e420fde05c87.jpeg"
},
"children": []
}
}
}
},
"404": {
"description": "Comment Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/display_ads": {
"get": {
"summary": "display ads",
"tags": ["display ads"],
"description": "This endpoint allows the client to retrieve a list of all display ads.",
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DisplayAd"
}
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
},
"post": {
"summary": "display ads",
"tags": ["display ads"],
"description": "This endpoint allows the client to create a new display ad.",
"parameters": [],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 12,
"approved": true,
"audience_segment_id": null,
"body_markdown": "# Hi, this is ad\nYep, it's an ad",
"cached_tag_list": "",
"clicks_count": 0,
"created_at": "2023-05-26T11:53:16.597+03:00",
"creator_id": null,
"display_to": "all",
"exclude_article_ids": "",
"impressions_count": 0,
"name": "Example Ad",
"organization_id": null,
"placement_area": "post_comments",
"processed_html": "<h1> <a href=\"#hi-this-is-ad\" class=\"anchor\"> </a> Hi, this is ad</h1><p>Yep, it's an ad</p>",
"published": true,
"success_rate": 0.0,
"type_of": "in_house",
"updated_at": "2023-05-26T11:53:16.597+03:00",
"audience_segment_type": null,
"tag_list": ""
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/DisplayAd"
}
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "unprocessable",
"content": {
"application/json": {
"example": {
"id": null,
"approved": true,
"audience_segment_id": null,
"body_markdown": "# Hi, this is ad\nYep, it's an ad",
"cached_tag_list": null,
"clicks_count": 0,
"created_at": null,
"creator_id": null,
"display_to": "all",
"exclude_article_ids": "",
"impressions_count": 0,
"name": "Example Ad",
"organization_id": null,
"placement_area": "moon",
"processed_html": null,
"published": true,
"success_rate": 0.0,
"type_of": "in_house",
"updated_at": null,
"audience_segment_type": null,
"tag_list": null
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/DisplayAd"
}
}
}
}
}
}
},
"/api/display_ads/{id}": {
"get": {
"summary": "display ad",
"tags": ["display ads"],
"description": "This endpoint allows the client to retrieve a single display ad, via its id.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the display ad.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 123
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 13,
"approved": false,
"audience_segment_id": null,
"body_markdown": "Hello _hey_ Hey hey 11",
"cached_tag_list": "",
"clicks_count": 0,
"created_at": "2023-05-26T11:53:16.738+03:00",
"creator_id": null,
"display_to": "all",
"exclude_article_ids": "",
"impressions_count": 0,
"name": "Display Ad 13",
"organization_id": 75,
"placement_area": "sidebar_left",
"processed_html": "<p>Hello <em>hey</em> Hey hey 11</p>",
"published": false,
"success_rate": 0.0,
"type_of": "in_house",
"updated_at": "2023-05-26T11:53:16.742+03:00",
"audience_segment_type": null,
"tag_list": ""
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Unknown DisplayAd ID",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
},
"put": {
"summary": "display ads",
"tags": ["display ads"],
"description": "This endpoint allows the client to update the attributes of a single display ad, via its id.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the display ad.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 123
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"approved": false,
"body_markdown": "Hello _hey_ Hey hey 12",
"creator_id": null,
"display_to": "all",
"name": "Display Ad 14",
"organization_id": 76,
"placement_area": "sidebar_left",
"published": false,
"type_of": "in_house",
"exclude_article_ids": "",
"audience_segment_id": null,
"cached_tag_list": "",
"id": 14,
"clicks_count": 0,
"created_at": "2023-05-26T11:53:16.901+03:00",
"impressions_count": 0,
"processed_html": "<p>Hello <em>hey</em> Hey hey 12</p>",
"success_rate": 0.0,
"updated_at": "2023-05-26T11:53:16.912+03:00",
"audience_segment_type": null,
"tag_list": ""
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/DisplayAd"
}
}
}
}
},
"404": {
"description": "not found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/DisplayAd"
}
}
}
}
}
}
},
"/api/display_ads/{id}/unpublish": {
"put": {
"summary": "unpublish",
"tags": ["display ads"],
"description": "This endpoint allows the client to remove a display ad from rotation by un-publishing it.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the display ad to unpublish.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 123
}
],
"responses": {
"204": {
"description": "no content"
},
"404": {
"description": "not found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/follows/tags": {
"get": {
"summary": "Followed Tags",
"tags": ["followed_tags", "tags"],
"description": "This endpoint allows the client to retrieve a list of the tags they follow.",
"operationId": "getFollowedTags",
"responses": {
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A List of followed tags",
"content": {
"application/json": {
"example": [
{
"id": 439,
"name": "tag3",
"points": 1.0
},
{
"id": 440,
"name": "tag4",
"points": 1.0
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FollowedTag"
}
}
}
}
}
}
}
},
"/api/followers/users": {
"get": {
"summary": "Followers",
"tags": ["followers"],
"description": "This endpoint allows the client to retrieve a list of the followers they have.\n \"Followers\" are users that are following other users on the website.\n It supports pagination, each page will contain 80 followers by default.",
"operationId": "getFollowers",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
},
{
"name": "sort",
"in": "query",
"required": false,
"description": "Default is 'created_at'. Specifies the sort order for the created_at param of the follow\n relationship. To sort by newest followers first (descending order) specify\n ?sort=-created_at.",
"schema": {
"type": "string"
},
"example": "created_at"
}
],
"responses": {
"200": {
"description": "A List of followers",
"content": {
"application/json": {
"example": [
{
"type_of": "user_follower",
"id": 6,
"created_at": "2023-05-26T08:53:17Z",
"user_id": 599,
"name": "Sherell \"Johnny\" \\:/ Veum",
"path": "/username598",
"username": "username598",
"profile_image": "/uploads/user/profile_image/599/36f9c957-11ec-438c-989b-2b3a27b71010.jpeg"
},
{
"type_of": "user_follower",
"id": 5,
"created_at": "2023-05-26T08:53:17Z",
"user_id": 597,
"name": "Audria \"Adolph\" \\:/ Waelchi",
"path": "/username596",
"username": "username596",
"profile_image": "/uploads/user/profile_image/597/020061a0-4ce8-4a39-8510-de18f1855309.jpeg"
}
],
"schema": {
"type": "array",
"items": {
"description": "A follower",
"type": "object",
"properties": {
"type_of": {
"description": "user_follower by default",
"type": "string"
},
"id": {
"type": "integer",
"format": "int32"
},
"user_id": {
"description": "The follower's user id",
"type": "integer",
"format": "int32"
},
"name": {
"description": "The follower's name",
"type": "string"
},
"path": {
"description": "A path to the follower's profile",
"type": "string"
},
"profile_image": {
"description": "Profile image (640x640)",
"type": "string"
}
}
}
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/organizations/{username}": {
"get": {
"summary": "An organization",
"tags": ["organizations"],
"security": [],
"description": "This endpoint allows the client to retrieve a single organization by their username",
"operationId": "getOrganization",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "An Organization",
"content": {
"application/json": {
"example": {
"type_of": "organization",
"id": 81,
"username": "org81",
"name": "White LLC",
"summary": "Pug lumbersexual knausgaard you probably haven't heard of them humblebrag. Stumptown bushwick freegan hella mumblecore kickstarter lo-fi mustache.",
"twitter_username": "org8121",
"github_username": "org7060",
"url": "http://jakubowski-mckenzie.info/jewel.ruecker",
"location": null,
"tech_stack": null,
"tag_line": null,
"story": null,
"joined_at": "2023-05-26T08:53:17Z",
"profile_image": "/uploads/organization/profile_image/81/fb42dbbe-62d2-4cb1-8933-956f15f3271f.png"
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/Organization"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/organizations/{username}/users": {
"get": {
"summary": "Organization's users",
"tags": ["organizations", "users"],
"security": [],
"description": "This endpoint allows the client to retrieve a list of users belonging to the organization\n\nIt supports pagination, each page will contain `30` users by default.",
"operationId": "getOrgUsers",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"200": {
"description": "An Organization's users",
"content": {
"application/json": {
"example": [
{
"type_of": "user",
"id": 609,
"username": "username608",
"name": "Edwardo \"Tova\" \\:/ Price",
"twitter_username": "twitter608",
"github_username": "github608",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 26, 2023",
"profile_image": "/uploads/user/profile_image/609/7728166a-cb97-46f6-a080-4a88d33b9876.jpeg"
},
{
"type_of": "user",
"id": 610,
"username": "username609",
"name": "Bernardine \"Zachery\" \\:/ Wisozk",
"twitter_username": "twitter609",
"github_username": "github609",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 26, 2023",
"profile_image": "/uploads/user/profile_image/610/450601e5-c640-4bf9-8367-c9cfbb4f9fe5.jpeg"
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/organizations/{username}/articles": {
"get": {
"summary": "Organization's Articles",
"tags": ["organizations", "articles"],
"security": [],
"description": "This endpoint allows the client to retrieve a list of Articles belonging to the organization\n\nIt supports pagination, each page will contain `30` users by default.",
"operationId": "getOrgArticles",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"200": {
"description": "An Organization's Articles",
"content": {
"application/json": {
"example": [
{
"type_of": "article",
"id": 228,
"title": "Look Homeward, Angel208",
"description": "Umami gastropub mustache franzen ethical pug. Twee williamsburg portland seitan humblebrag ramps...",
"readable_publish_date": "May 26",
"slug": "look-homeward-angel208-138f",
"path": "/org85/look-homeward-angel208-138f",
"url": "http://localhost:3000/org85/look-homeward-angel208-138f",
"comments_count": 0,
"public_reactions_count": 0,
"collection_id": null,
"published_timestamp": "2023-05-26T08:53:18Z",
"positive_reactions_count": 0,
"cover_image": "http://localhost:3000/assets/23-33ea5a2b5af3dc15b9ed90de0b850f67e2390eaec3361d6687d3b9750c699f84.png",
"social_image": "http://localhost:3000/assets/23-33ea5a2b5af3dc15b9ed90de0b850f67e2390eaec3361d6687d3b9750c699f84.png",
"canonical_url": "http://localhost:3000/org85/look-homeward-angel208-138f",
"created_at": "2023-05-26T08:53:18Z",
"edited_at": null,
"crossposted_at": null,
"published_at": "2023-05-26T08:53:18Z",
"last_comment_at": "2023-05-26T08:53:18Z",
"reading_time_minutes": 1,
"tag_list": ["javascript", "html", "discuss"],
"tags": "javascript, html, discuss",
"user": {
"name": "Terrance \"Shirl\" \\:/ Botsford",
"username": "username616",
"twitter_username": "twitter616",
"github_username": "github616",
"user_id": 617,
"website_url": null,
"profile_image": "/uploads/user/profile_image/617/e1b65273-0357-4462-8662-332368404317.jpeg",
"profile_image_90": "/uploads/user/profile_image/617/e1b65273-0357-4462-8662-332368404317.jpeg"
},
"organization": {
"name": "Kreiger-Kessler",
"username": "org85",
"slug": "org85",
"profile_image": "/uploads/organization/profile_image/85/c7399553-8258-4dd1-82f9-5637c42db542.png",
"profile_image_90": "/uploads/organization/profile_image/85/c7399553-8258-4dd1-82f9-5637c42db542.png"
}
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/pages": {
"get": {
"summary": "show details for all pages",
"security": [],
"tags": ["pages"],
"description": "This endpoint allows the client to retrieve details for all Page objects.",
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": [
{
"id": 1,
"title": "No Longer at Ease",
"slug": "ample_cutting",
"description": "Rerum inventore aspernatur nam.",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "Sunt blanditiis adipisci optio.",
"processed_html": "<p>Sunt blanditiis adipisci optio.</p>\n\n",
"social_image": {
"url": null
},
"template": "contained"
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Page"
}
}
}
}
}
}
},
"post": {
"summary": "pages",
"tags": ["pages"],
"description": "This endpoint allows the client to create a new page.",
"parameters": [],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 3,
"title": "Example Page",
"slug": "example1",
"description": "a new page",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "# Hi, this is a New Page\nYep, it's an a new page",
"processed_html": "<h1>\n <a name=\"hi-this-is-a-new-page\" href=\"#hi-this-is-a-new-page\">\n </a>\n Hi, this is a New Page\n</h1>\n\n<p>Yep, it's an a new page</p>\n\n",
"social_image": {
"url": null
},
"template": "contained"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "unprocessable",
"content": {
"application/json": {
"example": {
"id": null,
"title": "Example Page",
"slug": "example1",
"description": "a new page",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "# Hi, this is a New Page\nYep, it's an a new page",
"processed_html": null,
"social_image": {
"url": null
},
"template": "moon"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the page"
},
"slug": {
"type": "string",
"description": "Used to link to this page in URLs, must be unique and URL-safe"
},
"description": {
"type": "string",
"description": "For internal use, helps similar pages from one another"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)"
},
"body_json": {
"type": "string",
"description": "For JSON pages, the JSON body"
},
"is_top_level_path": {
"type": "boolean",
"description": "If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution"
},
"template": {
"type": "string",
"enum": [
"contained",
"full_within_layout",
"nav_bar_included",
"json"
],
"default": "contained",
"description": "Controls what kind of layout the page is rendered in"
}
}
}
}
}
}
}
},
"/api/pages/{id}": {
"get": {
"summary": "show details for a page",
"security": [],
"tags": ["pages"],
"description": "This endpoint allows the client to retrieve details for a single Page object, specified by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the page.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 6,
"title": "Fair Stood the Wind for France",
"slug": "kidnap-cutting",
"description": "Reiciendis animi quam quis.",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "Eos est nobis pariatur.",
"processed_html": "<p>Eos est nobis pariatur.</p>\n\n",
"social_image": {
"url": null
},
"template": "contained"
},
"schema": {
"$ref": "#/components/schemas/Page"
}
}
}
}
}
},
"put": {
"summary": "update details for a page",
"tags": ["pages"],
"description": "This endpoint allows the client to retrieve details for a single Page object, specified by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the page.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 7,
"title": "New Title",
"slug": "conglomerate-kidnap",
"description": "Sit atque omnis velit.",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "Perferendis voluptas qui sed.",
"processed_html": "<p>Perferendis voluptas qui sed.</p>\n\n",
"social_image": {
"url": null
},
"template": "contained"
},
"schema": {
"$ref": "#/components/schemas/Page"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "unprocessable",
"content": {
"application/json": {
"example": {
"id": 9,
"title": "In Dubious Battle",
"slug": "linger-galaxy",
"description": "Voluptate dolores ut quibusdam.",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "Nostrum non omnis eveniet.",
"processed_html": "<p>Eligendi consequatur cumque nemo.</p>\n\n",
"social_image": {
"url": null
},
"template": "moon"
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page"
}
}
}
}
},
"delete": {
"summary": "remove a page",
"tags": ["pages"],
"description": "This endpoint allows the client to delete a single Page object, specified by ID.",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the page.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"id": 10,
"title": "For Whom the Bell Tolls",
"slug": "guess-galaxy",
"description": "Consectetur odit aut voluptas.",
"is_top_level_path": false,
"landing_page": false,
"body_html": null,
"body_json": null,
"body_markdown": "Et omnis fuga laudantium.",
"processed_html": "<p>Et omnis fuga laudantium.</p>\n\n",
"social_image": {
"url": null
},
"template": "contained"
},
"schema": {
"$ref": "#/components/schemas/Page"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "unprocessable",
"content": {
"application/json": {
"example": {
"doubled_module": {
"const_name": "Page",
"object": "Page"
},
"__expired": false,
"name": null,
"__sending_message": null
}
}
}
}
}
}
},
"/api/podcast_episodes": {
"get": {
"summary": "Podcast Episodes",
"security": [],
"tags": ["podcast_episodes"],
"description": "This endpoint allows the client to retrieve a list of podcast episodes.\n \"Podcast episodes\" are episodes belonging to podcasts.\n It will only return active (reachable) podcast episodes that belong to published podcasts available on the platform, ordered by descending publication date.\n It supports pagination, each page will contain 30 articles by default.",
"operationId": "getPodcastEpisodes",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
},
{
"name": "username",
"in": "query",
"required": false,
"description": "Using this parameter will retrieve episodes belonging to a specific podcast.",
"schema": {
"type": "string"
},
"example": "codenewbie"
}
],
"responses": {
"200": {
"description": "A List of Podcast episodes filtered by username",
"content": {
"application/json": {
"example": [
{
"type_of": "podcast_episodes",
"class_name": "PodcastEpisode",
"id": 4,
"path": "/codenewbie/slug-4",
"title": "5",
"image_url": "/uploads/podcast/image/4/a7707c0d-bb57-4193-ac64-2c905756186a.jpeg",
"podcast": {
"title": "Péché Mortel",
"slug": "codenewbie",
"image_url": "/uploads/podcast/image/4/a7707c0d-bb57-4193-ac64-2c905756186a.jpeg"
}
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PodcastEpisodeIndex"
}
}
}
}
},
"404": {
"description": "Unknown Podcast username",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/profile_images/{username}": {
"get": {
"summary": "A Users or organizations profile image",
"tags": ["profile images"],
"description": "This endpoint allows the client to retrieve a user or organization profile image information by its\n corresponding username.",
"operationId": "getProfileImage",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"description": "The parameter is the username of the user or the username of the organization.",
"schema": {
"type": "string"
},
"example": "janedoe"
}
],
"responses": {
"200": {
"description": "An object containing profile image details",
"content": {
"application/json": {
"example": {
"type_of": "profile_image",
"image_of": "user",
"profile_image": "/uploads/user/profile_image/632/55f8862e-a61e-4c85-bbe0-b27cbf85357c.jpeg",
"profile_image_90": "/uploads/user/profile_image/632/55f8862e-a61e-4c85-bbe0-b27cbf85357c.jpeg"
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/ProfileImage"
}
}
}
}
},
"404": {
"description": "Resource Not Found",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/reactions/toggle": {
"post": {
"summary": "toggle reaction",
"tags": ["reactions"],
"description": "This endpoint allows the client to toggle the user's reaction to a specified reactable (eg, Article, Comment, or User). For examples:\n * \"Like\"ing an Article will create a new \"like\" Reaction from the user for that Articles\n * \"Like\"ing that Article a second time will remove the \"like\" from the user",
"parameters": [
{
"name": "category",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"like",
"unicorn",
"exploding_head",
"raised_hands",
"fire"
]
}
},
{
"name": "reactable_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "reactable_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": ["Comment", "Article", "User"]
}
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"result": "create",
"category": "like",
"id": 1,
"reactable_id": 230,
"reactable_type": "Article"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/reactions": {
"post": {
"summary": "create reaction",
"tags": ["reactions"],
"description": "This endpoint allows the client to create a reaction to a specified reactable (eg, Article, Comment, or User). For examples:\n * \"Like\"ing an Article will create a new \"like\" Reaction from the user for that Articles\n * \"Like\"ing that Article a second time will return the previous \"like\"",
"parameters": [
{
"name": "category",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"like",
"unicorn",
"exploding_head",
"raised_hands",
"fire"
]
}
},
{
"name": "reactable_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "reactable_type",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": ["Comment", "Article", "User"]
}
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"result": "none",
"category": "like",
"id": 3,
"reactable_id": 232,
"reactable_type": "Article"
}
}
}
},
"401": {
"description": "unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/readinglist": {
"get": {
"summary": "Readinglist",
"tags": ["readinglist"],
"description": "This endpoint allows the client to retrieve a list of articles that were saved to a Users readinglist.\n It supports pagination, each page will contain `30` articles by default",
"operationId": "getReadinglist",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam30to1000"
}
],
"responses": {
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"200": {
"description": "A list of articles in the users readinglist",
"content": {
"application/json": {
"example": [],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleIndex"
}
}
}
}
}
}
}
},
"/api/tags": {
"get": {
"summary": "Tags",
"tags": ["tags"],
"security": [],
"description": "This endpoint allows the client to retrieve a list of tags that can be used to tag articles.\n\nIt will return tags ordered by popularity.\n\nIt supports pagination, each page will contain 10 tags by default.",
"operationId": "getTags",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam10to1000"
}
],
"responses": {
"200": {
"description": "A List of all tags",
"content": {
"application/json": {
"example": [
{
"id": 473,
"name": "tag7",
"bg_color_hex": null,
"text_color_hex": null
},
{
"id": 472,
"name": "tag6",
"bg_color_hex": null,
"text_color_hex": null
},
{
"id": 471,
"name": "tag5",
"bg_color_hex": null,
"text_color_hex": null
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Tag"
}
}
}
}
}
}
}
},
"/api/users/me": {
"get": {
"summary": "The authenticated user",
"tags": ["users"],
"description": "This endpoint allows the client to retrieve information about the authenticated user",
"operationId": "getUserMe",
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"example": {
"type_of": "user",
"id": 644,
"username": "username643",
"name": "Rodney \"Temple\" \\:/ Spencer",
"twitter_username": "twitter643",
"github_username": "github643",
"summary": null,
"location": null,
"website_url": null,
"joined_at": "May 26, 2023",
"profile_image": "/uploads/user/profile_image/644/ad444eda-fc00-46e3-a7d5-1053fd80e951.jpeg"
},
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
}
}
}
},
"/api/users/{id}": {
"get": {
"summary": "A User",
"tags": ["users"],
"description": "This endpoint allows the client to retrieve a single user, either by id\nor by the user's username.\n\nFor complete documentation, see the v0 API docs: https://developers.forem.com/api/v0#tag/users/operation/getUser",
"operationId": "getUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful",
"content": {
"application/json": {
"schema": {
"type": "object",
"items": {
"$ref": "#/components/schemas/User"
}
}
}
}
}
}
}
},
"/api/users/{id}/unpublish": {
"put": {
"summary": "Unpublish a User's Articles and Comments",
"tags": ["users"],
"description": "This endpoint allows the client to unpublish all of the articles and\ncomments created by a user.\n\nThe user associated with the API key must have any 'admin' or 'moderator' role.\n\nThis specified user's articles and comments will be unpublished and will no longer be\nvisible to the public. They will remain in the database and will set back to draft status\non the specified user's dashboard. Any notifications associated with the specified user's\narticles and comments will be deleted.\n\nNote this endpoint unpublishes articles and comments asychronously: it will return a 204 NO CONTENT\nstatus code immediately, but the articles and comments will not be unpublished until the\nrequest is completed on the server.",
"operationId": "unpublishUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the user to unpublish.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
}
],
"responses": {
"204": {
"description": "User's articles and comments successfully unpublished"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Unknown User ID (still accepted for async processing)",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/users/{id}/suspend": {
"put": {
"summary": "Suspend a User",
"tags": ["users"],
"description": "This endpoint allows the client to suspend a user.\n\nThe user associated with the API key must have any 'admin' or 'moderator' role.\n\nThis specified user will be assigned the 'suspended' role. Suspending a user will stop the\nuser from posting new posts and comments. It doesn't delete any of the user's content, just\nprevents them from creating new content while suspended. Users are not notified of their suspension\nin the UI, so if you want them to know about this, you must notify them.",
"operationId": "suspendUser",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"description": "The ID of the user to suspend.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1
},
"example": 1
}
],
"responses": {
"204": {
"description": "User successfully unpublished"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"404": {
"description": "Unknown User ID",
"content": {
"application/json": {
"example": {
"error": "not found",
"status": 404
}
}
}
}
}
}
},
"/api/admin/users": {
"post": {
"summary": "Invite a User",
"tags": ["users"],
"description": "This endpoint allows the client to trigger an invitation to the provided email address.\n\n It requires a token from a user with `super_admin` privileges.",
"operationId": "postAdminUsersCreate",
"parameters": [],
"responses": {
"200": {
"description": "Successful"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"example": {
"error": "unauthorized",
"status": 401
}
}
}
},
"422": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"example": {
"error": "param is missing or the value is empty: email",
"status": 422
}
}
}
}
},
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserInviteParam"
}
}
}
}
}
},
"/api/videos": {
"get": {
"summary": "Articles with a video",
"tags": ["videos", "articles"],
"security": [],
"description": "This endpoint allows the client to retrieve a list of articles that are uploaded with a video.\n\nIt will only return published video articles ordered by descending popularity.\n\nIt supports pagination, each page will contain 24 articles by default.",
"operationId": "videos",
"parameters": [
{
"$ref": "#/components/parameters/pageParam"
},
{
"$ref": "#/components/parameters/perPageParam24to1000"
}
],
"responses": {
"200": {
"description": "A List of all articles with videos",
"content": {
"application/json": {
"example": [
{
"type_of": "video_article",
"id": 234,
"path": "/username662/a-darkling-plain214-3e1m",
"cloudinary_video_url": "https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png",
"title": "A Darkling Plain214",
"user_id": 664,
"video_duration_in_minutes": "00:00",
"video_source_url": "https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8",
"user": {
"name": "Tamica \"Kenton\" \\:/ Rice"
}
},
{
"type_of": "video_article",
"id": 235,
"path": "/username663/nectar-in-a-sieve215-4flh",
"cloudinary_video_url": "https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/thumbs-video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f-00001.png",
"title": "Nectar in a Sieve215",
"user_id": 665,
"video_duration_in_minutes": "00:00",
"video_source_url": "https://dw71fyauz7yz9.cloudfront.net/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f/video-upload__1e42eb0bab4abb3c63baeb5e8bdfe69f.m3u8",
"user": {
"name": "Marty \"Inez\" \\:/ MacGyver"
}
}
],
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VideoArticle"
}
}
}
}
}
}
}
}
},
"servers": [
{
"url": "https://dev.to/api",
"description": "Production server"
}
],
"security": [
{
"api-key": []
}
],
"components": {
"securitySchemes": {
"api-key": {
"type": "apiKey",
"name": "api-key",
"in": "header",
"description": "API Key authentication.\n\nAuthentication for some endpoints, like write operations on the\nArticles API require a DEV API key.\n\nAll authenticated endpoints are CORS disabled, the API key is intended for non-browser scripts.\n\n### Getting an API key\n\nTo obtain one, please follow these steps:\n\n - visit https://dev.to/settings/extensions\n - in the \"DEV API Keys\" section create a new key by adding a\n description and clicking on \"Generate API Key\"\n\n ![obtain a DEV API Key](https://user-images.githubusercontent.com/37842/172718105-bd93664e-76e0-477d-99c4-265dda0b06c5.png)\n\n - You'll see the newly generated key in the same view\n ![generated DEV API Key](https://user-images.githubusercontent.com/37842/172718151-e7fe26a0-9937-42e8-96c6-333acdab9e49.png)"
}
},
"parameters": {
"pageParam": {
"in": "query",
"name": "page",
"required": false,
"description": "Pagination page",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"default": 1
}
},
"perPageParam10to1000": {
"in": "query",
"name": "per_page",
"required": false,
"description": "Page size (the number of items to return per page). The default maximum value can be overridden by \"API_PER_PAGE_MAX\" environment variable.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"default": 10
}
},
"perPageParam24to1000": {
"in": "query",
"name": "per_page",
"required": false,
"description": "Page size (the number of items to return per page). The default maximum value can be overridden by \"API_PER_PAGE_MAX\" environment variable.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"default": 24
}
},
"perPageParam30to1000": {
"in": "query",
"name": "per_page",
"required": false,
"description": "Page size (the number of items to return per page). The default maximum value can be overridden by \"API_PER_PAGE_MAX\" environment variable.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"default": 30
}
},
"perPageParam30to100": {
"in": "query",
"name": "per_page",
"required": false,
"description": "Page size (the number of items to return per page). The default maximum value can be overridden by \"API_PER_PAGE_MAX\" environment variable.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 30
}
},
"perPageParam80to1000": {
"in": "query",
"name": "per_page",
"required": false,
"description": "Page size (the number of items to return per page). The default maximum value can be overridden by \"API_PER_PAGE_MAX\" environment variable.",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 1000,
"default": 80
}
},
"listingCategoryParam": {
"name": "category",
"in": "query",
"description": "Using this parameter will return listings belonging to the\n requested category.",
"schema": {
"type": "string"
},
"example": "cfp"
}
},
"schemas": {
"ArticleFlareTag": {
"description": "Flare tag of the article",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"bg_color_hex": {
"description": "Background color (hexadecimal)",
"type": "string",
"nullable": true
},
"text_color_hex": {
"description": "Text color (hexadecimal)",
"type": "string",
"nullable": true
}
}
},
"ArticleIndex": {
"description": "Representation of an article or post returned in a list",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int32"
},
"title": {
"type": "string"
},
"description": {
"type": "string"
},
"cover_image": {
"type": "string",
"format": "url",
"nullable": true
},
"readable_publish_date": {
"type": "string"
},
"social_image": {
"type": "string",
"format": "url"
},
"tag_list": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "string"
},
"slug": {
"type": "string"
},
"path": {
"type": "string",
"format": "path"
},
"url": {
"type": "string",
"format": "url"
},
"canonical_url": {
"type": "string",
"format": "url"
},
"positive_reactions_count": {
"type": "integer",
"format": "int32"
},
"public_reactions_count": {
"type": "integer",
"format": "int32"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"edited_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"crossposted_at": {
"type": "string",
"format": "date-time",
"nullable": true
},
"published_at": {
"type": "string",
"format": "date-time"
},
"last_comment_at": {
"type": "string",
"format": "date-time"
},
"published_timestamp": {
"description": "Crossposting or published date time",
"type": "string",
"format": "date-time"
},
"reading_time_minutes": {
"description": "Reading time, in minutes",
"type": "integer",
"format": "int32"
},
"user": {
"$ref": "#/components/schemas/SharedUser"
},
"flare_tag": {
"$ref": "#/components/schemas/ArticleFlareTag"
},
"organization": {
"$ref": "#/components/schemas/SharedOrganization"
}
},
"required": [
"type_of",
"id",
"title",
"description",
"cover_image",
"readable_publish_date",
"social_image",
"tag_list",
"tags",
"slug",
"path",
"url",
"canonical_url",
"comments_count",
"positive_reactions_count",
"public_reactions_count",
"created_at",
"edited_at",
"crossposted_at",
"published_at",
"last_comment_at",
"published_timestamp",
"user",
"reading_time_minutes"
]
},
"VideoArticle": {
"description": "Representation of an Article with video",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"path": {
"type": "string"
},
"cloudinary_video_url": {
"type": "string"
},
"title": {
"type": "string"
},
"user_id": {
"type": "integer",
"format": "int64"
},
"video_duration_in_minutes": {
"type": "string"
},
"video_source_url": {
"type": "string"
},
"user": {
"description": "Author of the article",
"type": "object",
"properties": {
"name": {
"type": "string"
}
}
}
}
},
"Article": {
"description": "Representation of an Article to be created/updated",
"type": "object",
"properties": {
"article": {
"type": "object",
"properties": {
"title": {
"type": "string"
},
"body_markdown": {
"type": "string"
},
"published": {
"type": "boolean",
"default": false
},
"series": {
"type": "string",
"nullable": true
},
"main_image": {
"type": "string",
"nullable": true
},
"canonical_url": {
"type": "string",
"nullable": true
},
"description": {
"type": "string"
},
"tags": {
"type": "string"
},
"organization_id": {
"type": "integer",
"nullable": true
}
}
}
}
},
"Organization": {
"description": "Representation of an Organization",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"summary": {
"type": "string"
},
"twitter_username": {
"type": "string"
},
"github_username": {
"type": "string"
},
"url": {
"type": "string"
},
"location": {
"type": "string"
},
"joined_at": {
"type": "string"
},
"tech_stack": {
"type": "string"
},
"tag_line": {
"type": "string",
"nullable": true
},
"story": {
"type": "string",
"nullable": true
}
}
},
"FollowedTag": {
"description": "Representation of a followed tag",
"type": "object",
"properties": {
"id": {
"description": "Tag id",
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"points": {
"type": "number",
"format": "float"
}
},
"required": ["id", "name", "points"]
},
"Tag": {
"description": "Representation of a tag",
"type": "object",
"properties": {
"id": {
"description": "Tag id",
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"bg_color_hex": {
"type": "string",
"nullable": true
},
"text_color_hex": {
"type": "string",
"nullable": true
}
}
},
"Page": {
"description": "Representation of a page object",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "Title of the page"
},
"slug": {
"type": "string",
"description": "Used to link to this page in URLs, must be unique and URL-safe"
},
"description": {
"type": "string",
"description": "For internal use, helps similar pages from one another"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)",
"nullable": true
},
"body_json": {
"type": "string",
"description": "For JSON pages, the JSON body",
"nullable": true
},
"is_top_level_path": {
"type": "boolean",
"description": "If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution"
},
"social_image": {
"type": "object",
"nullable": true
},
"template": {
"type": "string",
"enum": [
"contained",
"full_within_layout",
"nav_bar_included",
"json"
],
"default": "contained",
"description": "Controls what kind of layout the page is rendered in"
}
},
"required": ["title", "slug", "description", "template"]
},
"PodcastEpisodeIndex": {
"description": "Representation of a podcast episode returned in a list",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int32"
},
"class_name": {
"type": "string"
},
"path": {
"type": "string",
"format": "path"
},
"title": {
"type": "string"
},
"image_url": {
"description": "Podcast episode image url or podcast image url",
"type": "string",
"format": "url"
},
"podcast": {
"$ref": "#/components/schemas/SharedPodcast"
}
},
"required": [
"type_of",
"class_name",
"id",
"path",
"title",
"image_url",
"podcast"
]
},
"ProfileImage": {
"description": "A profile image object",
"type": "object",
"properties": {
"type_of": {
"description": "Return profile_image",
"type": "string"
},
"image_of": {
"description": "Determines the type of the profile image owner (user or organization)",
"type": "string"
},
"profile_image": {
"description": "Profile image (640x640)",
"type": "string"
},
"profile_image_90": {
"description": "Profile image (90x90)",
"type": "string"
}
}
},
"SharedUser": {
"description": "The resource creator",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"twitter_username": {
"type": "string",
"nullable": true
},
"github_username": {
"type": "string",
"nullable": true
},
"website_url": {
"type": "string",
"format": "url",
"nullable": true
},
"profile_image": {
"description": "Profile image (640x640)",
"type": "string"
},
"profile_image_90": {
"description": "Profile image (90x90)",
"type": "string"
}
}
},
"SharedOrganization": {
"description": "The organization the resource belongs to",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"username": {
"type": "string"
},
"slug": {
"type": "string"
},
"profile_image": {
"description": "Profile image (640x640)",
"type": "string",
"format": "url"
},
"profile_image_90": {
"description": "Profile image (90x90)",
"type": "string",
"format": "url"
}
}
},
"User": {
"description": "The representation of a user",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"username": {
"type": "string"
},
"name": {
"type": "string"
},
"summary": {
"type": "string",
"nullable": true
},
"twitter_username": {
"type": "string"
},
"github_username": {
"type": "string"
},
"website_url": {
"type": "string",
"nullable": true
},
"location": {
"type": "string",
"nullable": true
},
"joined_at": {
"type": "string"
},
"profile_image": {
"type": "string"
}
}
},
"SharedPodcast": {
"description": "The podcast that the resource belongs to",
"type": "object",
"properties": {
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"image_url": {
"description": "Podcast image url",
"type": "string",
"format": "url"
}
}
},
"Comment": {
"description": "A Comment on an Article or Podcast Episode",
"type": "object",
"properties": {
"type_of": {
"type": "string"
},
"id_code": {
"type": "string"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"image_url": {
"description": "Podcast image url",
"type": "string",
"format": "url"
}
}
},
"UserInviteParam": {
"description": "User invite parameters",
"type": "object",
"properties": {
"email": {
"type": "string"
},
"name": {
"type": "string",
"nullable": true
}
}
},
"DisplayAd": {
"description": "A Display Ad, aka Billboard, aka Widget",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the Display Ad"
},
"name": {
"type": "string",
"description": "For internal use, helps distinguish ads from one another"
},
"body_markdown": {
"type": "string",
"description": "The text (in markdown) of the ad (required)"
},
"approved": {
"type": "boolean",
"description": "Ad must be both published and approved to be in rotation"
},
"published": {
"type": "boolean",
"description": "Ad must be both published and approved to be in rotation"
},
"organization_id": {
"type": "integer",
"description": "Identifies the organization to which the ad belongs",
"nullable": true
},
"creator_id": {
"type": "integer",
"description": "Identifies the user who created the ad.",
"nullable": true
},
"placement_area": {
"type": "string",
"enum": [
"sidebar_left",
"sidebar_left_2",
"sidebar_right",
"feed_first",
"feed_second",
"feed_third",
"home_hero",
"post_sidebar",
"post_comments"
],
"description": "Identifies which area of site layout the ad can appear in"
},
"tag_list": {
"type": "string",
"description": "Tags on which this ad can be displayed (blank is all/any tags)"
},
"article_exclude_ids": {
"type": "string",
"nullable": true,
"description": "Articles this ad should *not* appear on (blank means no articles are disallowed, and this ad can appear next to any/all articles). Comma-separated list of integer Article IDs"
},
"audience_segment_id": {
"type": "integer",
"description": "Specifies a specific audience segment who will see this billboard"
},
"audience_segment_type": {
"type": "string",
"enum": [
"manual",
"trusted",
"posted",
"no_posts_yet",
"dark_theme",
"light_theme",
"no_experience",
"experience1",
"experience2",
"experience3",
"experience4",
"experience5"
],
"description": "Specifies a group of users who will see this billboard (must match audience_segment_id if both provided)"
},
"display_to": {
"type": "string",
"enum": ["all", "logged_in", "logged_out"],
"default": "all",
"description": "Potentially limits visitors to whom the ad is visible"
},
"type_of": {
"type": "string",
"enum": ["in_house", "community", "external"],
"default": "in_house",
"description": "Types of the billboards:\nin_house (created by admins),\ncommunity (created by an entity, appears on entity's content),\nexternal ( created by an entity, or a non-entity, can appear everywhere)\n"
}
},
"required": ["name", "body_markdown", "placement_area"]
},
"Segment": {
"description": "A manually managed audience segment",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the segment"
},
"type_of": {
"type": "string",
"enum": ["manual"],
"default": "manual",
"description": "Marks the segment as manually managed (other types are internal)"
},
"user_count": {
"type": "integer",
"description": "The current number of users in the segment"
}
}
},
"SegmentUserIds": {
"type": "object",
"properties": {
"user_ids": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 10000
}
}
}
}
}
}
Reference in a new issue View git blame Copy permalink