Skip to content

Commit 7e6ee35

Browse files
AnthonyZhang220AnthonyZhang220
authored
Update API v1 docs with the correct path endpoints (#124)
1 parent c6ac93b commit 7e6ee35

File tree

1 file changed

+33
-33
lines changed

1 file changed

+33
-33
lines changed

‎api_v1.json‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"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."
77
},
88
"paths": {
9-
"/api/articles": {
9+
"/articles": {
1010
"post": {
1111
"summary": "Publish article",
1212
"tags": ["articles"],
@@ -247,7 +247,7 @@
247247
}
248248
}
249249
},
250-
"/api/articles/latest": {
250+
"/articles/latest": {
251251
"get": {
252252
"summary": "Published articles sorted by published date",
253253
"security": [],
@@ -404,7 +404,7 @@
404404
}
405405
}
406406
},
407-
"/api/articles/{id}": {
407+
"/articles/{id}": {
408408
"get": {
409409
"summary": "Published article by id",
410410
"security": [],
@@ -601,7 +601,7 @@
601601
}
602602
}
603603
},
604-
"/api/articles/{username}/{slug}": {
604+
"/articles/{username}/{slug}": {
605605
"get": {
606606
"summary": "Published article by path",
607607
"security": [],
@@ -697,7 +697,7 @@
697697
}
698698
}
699699
},
700-
"/api/articles/me": {
700+
"/articles/me": {
701701
"get": {
702702
"summary": "User's articles",
703703
"tags": ["articles", "users"],
@@ -740,7 +740,7 @@
740740
}
741741
}
742742
},
743-
"/api/articles/me/published": {
743+
"/articles/me/published": {
744744
"get": {
745745
"summary": "User's published articles",
746746
"tags": ["articles", "users"],
@@ -783,7 +783,7 @@
783783
}
784784
}
785785
},
786-
"/api/articles/me/unpublished": {
786+
"/articles/me/unpublished": {
787787
"get": {
788788
"summary": "User's unpublished articles",
789789
"tags": ["articles", "users"],
@@ -826,7 +826,7 @@
826826
}
827827
}
828828
},
829-
"/api/articles/me/all": {
829+
"/articles/me/all": {
830830
"get": {
831831
"summary": "User's all articles",
832832
"tags": ["articles", "users"],
@@ -869,7 +869,7 @@
869869
}
870870
}
871871
},
872-
"/api/articles/{id}/unpublish": {
872+
"/articles/{id}/unpublish": {
873873
"put": {
874874
"summary": "Unpublish an article",
875875
"tags": ["articles"],
@@ -928,7 +928,7 @@
928928
}
929929
}
930930
},
931-
"/api/comments": {
931+
"/comments": {
932932
"get": {
933933
"summary": "Comments",
934934
"security": [],
@@ -1004,7 +1004,7 @@
10041004
}
10051005
}
10061006
},
1007-
"/api/comments/{id}": {
1007+
"/comments/{id}": {
10081008
"get": {
10091009
"summary": "Comment by id",
10101010
"security": [],
@@ -1062,7 +1062,7 @@
10621062
}
10631063
}
10641064
},
1065-
"/api/display_ads": {
1065+
"/display_ads": {
10661066
"get": {
10671067
"summary": "display ads",
10681068
"tags": ["display ads"],
@@ -1191,7 +1191,7 @@
11911191
}
11921192
}
11931193
},
1194-
"/api/display_ads/{id}": {
1194+
"/display_ads/{id}": {
11951195
"get": {
11961196
"summary": "display ad",
11971197
"tags": ["display ads"],
@@ -1355,7 +1355,7 @@
13551355
}
13561356
}
13571357
},
1358-
"/api/display_ads/{id}/unpublish": {
1358+
"/display_ads/{id}/unpublish": {
13591359
"put": {
13601360
"summary": "unpublish",
13611361
"tags": ["display ads"],
@@ -1403,7 +1403,7 @@
14031403
}
14041404
}
14051405
},
1406-
"/api/follows/tags": {
1406+
"/follows/tags": {
14071407
"get": {
14081408
"summary": "Followed Tags",
14091409
"tags": ["followed_tags", "tags"],
@@ -1449,7 +1449,7 @@
14491449
}
14501450
}
14511451
},
1452-
"/api/followers/users": {
1452+
"/followers/users": {
14531453
"get": {
14541454
"summary": "Followers",
14551455
"tags": ["followers"],
@@ -1551,7 +1551,7 @@
15511551
}
15521552
}
15531553
},
1554-
"/api/organizations/{username}": {
1554+
"/organizations/{username}": {
15551555
"get": {
15561556
"summary": "An organization",
15571557
"tags": ["organizations"],
@@ -1612,7 +1612,7 @@
16121612
}
16131613
}
16141614
},
1615-
"/api/organizations/{username}/users": {
1615+
"/organizations/{username}/users": {
16161616
"get": {
16171617
"summary": "Organization's users",
16181618
"tags": ["organizations", "users"],
@@ -1691,7 +1691,7 @@
16911691
}
16921692
}
16931693
},
1694-
"/api/organizations/{username}/articles": {
1694+
"/organizations/{username}/articles": {
16951695
"get": {
16961696
"summary": "Organization's Articles",
16971697
"tags": ["organizations", "articles"],
@@ -1787,7 +1787,7 @@
17871787
}
17881788
}
17891789
},
1790-
"/api/pages": {
1790+
"/pages": {
17911791
"get": {
17921792
"summary": "show details for all pages",
17931793
"security": [],
@@ -1939,7 +1939,7 @@
19391939
}
19401940
}
19411941
},
1942-
"/api/pages/{id}": {
1942+
"/pages/{id}": {
19431943
"get": {
19441944
"summary": "show details for a page",
19451945
"security": [],
@@ -2153,7 +2153,7 @@
21532153
}
21542154
}
21552155
},
2156-
"/api/podcast_episodes": {
2156+
"/podcast_episodes": {
21572157
"get": {
21582158
"summary": "Podcast Episodes",
21592159
"security": [],
@@ -2221,7 +2221,7 @@
22212221
}
22222222
}
22232223
},
2224-
"/api/profile_images/{username}": {
2224+
"/profile_images/{username}": {
22252225
"get": {
22262226
"summary": "A Users or organizations profile image",
22272227
"tags": ["profile images"],
@@ -2273,7 +2273,7 @@
22732273
}
22742274
}
22752275
},
2276-
"/api/reactions/toggle": {
2276+
"/reactions/toggle": {
22772277
"post": {
22782278
"summary": "toggle reaction",
22792279
"tags": ["reactions"],
@@ -2342,7 +2342,7 @@
23422342
}
23432343
}
23442344
},
2345-
"/api/reactions": {
2345+
"/reactions": {
23462346
"post": {
23472347
"summary": "create reaction",
23482348
"tags": ["reactions"],
@@ -2411,7 +2411,7 @@
24112411
}
24122412
}
24132413
},
2414-
"/api/readinglist": {
2414+
"/readinglist": {
24152415
"get": {
24162416
"summary": "Readinglist",
24172417
"tags": ["readinglist"],
@@ -2454,7 +2454,7 @@
24542454
}
24552455
}
24562456
},
2457-
"/api/tags": {
2457+
"/tags": {
24582458
"get": {
24592459
"summary": "Tags",
24602460
"tags": ["tags"],
@@ -2506,7 +2506,7 @@
25062506
}
25072507
}
25082508
},
2509-
"/api/users/me": {
2509+
"/users/me": {
25102510
"get": {
25112511
"summary": "The authenticated user",
25122512
"tags": ["users"],
@@ -2553,7 +2553,7 @@
25532553
}
25542554
}
25552555
},
2556-
"/api/users/{id}": {
2556+
"/users/{id}": {
25572557
"get": {
25582558
"summary": "A User",
25592559
"tags": ["users"],
@@ -2586,7 +2586,7 @@
25862586
}
25872587
}
25882588
},
2589-
"/api/users/{id}/unpublish": {
2589+
"/users/{id}/unpublish": {
25902590
"put": {
25912591
"summary": "Unpublish a User's Articles and Comments",
25922592
"tags": ["users"],
@@ -2635,7 +2635,7 @@
26352635
}
26362636
}
26372637
},
2638-
"/api/users/{id}/suspend": {
2638+
"/users/{id}/suspend": {
26392639
"put": {
26402640
"summary": "Suspend a User",
26412641
"tags": ["users"],
@@ -2684,7 +2684,7 @@
26842684
}
26852685
}
26862686
},
2687-
"/api/admin/users": {
2687+
"/admin/users": {
26882688
"post": {
26892689
"summary": "Invite a User",
26902690
"tags": ["users"],
@@ -2729,7 +2729,7 @@
27292729
}
27302730
}
27312731
},
2732-
"/api/videos": {
2732+
"/videos": {
27332733
"get": {
27342734
"summary": "Articles with a video",
27352735
"tags": ["videos", "articles"],

0 commit comments

Comments
 (0)