Skip to content

Commit fa212b9

Browse files
thorstenthorsten
committed
feat(api): the API version is now v3.1
1 parent ea32ca2 commit fa212b9

20 files changed

+89
-91
lines changed

‎docs/openapi.json‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"name": "Mozilla Public Licence 2.0",
1212
"url": "https://www.mozilla.org/MPL/2.0/"
1313
},
14-
"version": "3.0"
14+
"version": "3.1"
1515
},
1616
"servers": [
1717
{
@@ -20,7 +20,7 @@
2020
}
2121
],
2222
"paths": {
23-
"/api/v3.0/attachments/{faqId}": {
23+
"/api/v3.1/attachments/{faqId}": {
2424
"get": {
2525
"tags": ["Public Endpoints"],
2626
"description": "Returns a list of attachments for a given FAQ record ID.",
@@ -74,7 +74,7 @@
7474
}
7575
}
7676
},
77-
"/api/v3.0/backup/{type}": {
77+
"/api/v3.1/backup/{type}": {
7878
"get": {
7979
"tags": ["Endpoints with Authentication"],
8080
"operationId": "createBackup",
@@ -158,7 +158,7 @@
158158
}
159159
}
160160
},
161-
"/api/v3.0/categories": {
161+
"/api/v3.1/categories": {
162162
"get": {
163163
"tags": ["Public Endpoints"],
164164
"operationId": "getCategories",
@@ -200,7 +200,7 @@
200200
}
201201
}
202202
},
203-
"/api/v3.0/category": {
203+
"/api/v3.1/category": {
204204
"post": {
205205
"tags": ["Endpoints with Authentication"],
206206
"operationId": "createCategory",
@@ -346,7 +346,7 @@
346346
}
347347
}
348348
},
349-
"/api/v3.0/comments/{faqId}": {
349+
"/api/v3.1/comments/{faqId}": {
350350
"get": {
351351
"tags": ["Public Endpoints"],
352352
"description": "Returns a list of comments for a given FAQ record ID.",
@@ -400,7 +400,7 @@
400400
}
401401
}
402402
},
403-
"/api/v3.0/faqs/{categoryId}": {
403+
"/api/v3.1/faqs/{categoryId}": {
404404
"get": {
405405
"tags": ["Public Endpoints"],
406406
"description": "This endpoint returns all the FAQs with a preview of the answer for the given category ID and the language provided by \"Accept-Language\".",
@@ -454,7 +454,7 @@
454454
}
455455
}
456456
},
457-
"/api/v3.0/faq/{categoryId}/{faqId}": {
457+
"/api/v3.1/faq/{categoryId}/{faqId}": {
458458
"get": {
459459
"tags": ["Public Endpoints"],
460460
"description": "This endpoint returns the FAQ for the given FAQ ID and the language provided by \"Accept-Language\".",
@@ -517,7 +517,7 @@
517517
}
518518
}
519519
},
520-
"/api/v3.0/faqs/tags/{tagId}": {
520+
"/api/v3.1/faqs/tags/{tagId}": {
521521
"get": {
522522
"tags": ["Public Endpoints"],
523523
"description": "This endpoint returns all the FAQs for the given tag ID and the language provided by \n \"Accept-Language\"",
@@ -571,7 +571,7 @@
571571
}
572572
}
573573
},
574-
"/api/v3.0/faqs/popular": {
574+
"/api/v3.1/faqs/popular": {
575575
"get": {
576576
"tags": ["Public Endpoints"],
577577
"description": "This endpoint returns the popular FAQs for the given language provided by \"Accept-Language\".",
@@ -614,7 +614,7 @@
614614
}
615615
}
616616
},
617-
"/api/v3.0/faqs/latest": {
617+
"/api/v3.1/faqs/latest": {
618618
"get": {
619619
"tags": ["Public Endpoints"],
620620
"description": "This endpoint returns the latest FAQs for the given language provided by \"Accept-Language\".",
@@ -657,7 +657,7 @@
657657
}
658658
}
659659
},
660-
"/api/v3.0/faqs/trending": {
660+
"/api/v3.1/faqs/trending": {
661661
"get": {
662662
"tags": ["Public Endpoints"],
663663
"description": "This endpoint returns the trending FAQs for the given language provided by \"Accept-Language\".",
@@ -700,7 +700,7 @@
700700
}
701701
}
702702
},
703-
"/api/v3.0/faqs/sticky": {
703+
"/api/v3.1/faqs/sticky": {
704704
"get": {
705705
"tags": ["Public Endpoints"],
706706
"description": "This endpoint returns the sticky FAQs for the given language provided by \"Accept-Language\".",
@@ -743,7 +743,7 @@
743743
}
744744
}
745745
},
746-
"/api/v3.0/faqs": {
746+
"/api/v3.1/faqs": {
747747
"get": {
748748
"tags": ["Public Endpoints"],
749749
"description": "This endpoint returns all the FAQs for the given language provided by \"Accept-Language\".",
@@ -786,7 +786,7 @@
786786
}
787787
}
788788
},
789-
"/api/v3.0/faq/create": {
789+
"/api/v3.1/faq/create": {
790790
"post": {
791791
"tags": ["Endpoints with Authentication"],
792792
"operationId": "createFaq",
@@ -936,7 +936,7 @@
936936
}
937937
}
938938
},
939-
"/api/v3.0/faq/update": {
939+
"/api/v3.1/faq/update": {
940940
"put": {
941941
"tags": ["Endpoints with Authentication"],
942942
"description": "Used to update a FAQ in one existing category.",
@@ -1063,7 +1063,7 @@
10631063
}
10641064
}
10651065
},
1066-
"/api/v3.0/groups": {
1066+
"/api/v3.1/groups": {
10671067
"get": {
10681068
"tags": ["Endpoints with Authentication"],
10691069
"description": "Used to fetch all group IDs.",
@@ -1100,7 +1100,7 @@
11001100
}
11011101
}
11021102
},
1103-
"/api/v3.0/language": {
1103+
"/api/v3.1/language": {
11041104
"get": {
11051105
"tags": ["Public Endpoints"],
11061106
"operationId": "getLanguage",
@@ -1117,7 +1117,7 @@
11171117
}
11181118
}
11191119
},
1120-
"/api/v3.0/login": {
1120+
"/api/v3.1/login": {
11211121
"post": {
11221122
"tags": ["Public Endpoints"],
11231123
"operationId": "login",
@@ -1179,7 +1179,7 @@
11791179
}
11801180
}
11811181
},
1182-
"/api/v3.0/news": {
1182+
"/api/v3.1/news": {
11831183
"get": {
11841184
"tags": ["Public Endpoints"],
11851185
"operationId": "getNews",
@@ -1221,7 +1221,7 @@
12211221
}
12221222
}
12231223
},
1224-
"/api/v3.0/open-questions": {
1224+
"/api/v3.1/open-questions": {
12251225
"get": {
12261226
"tags": ["Public Endpoints"],
12271227
"operationId": "getOpenQuestions",
@@ -1263,7 +1263,7 @@
12631263
}
12641264
}
12651265
},
1266-
"/api/v3.0/pdf/{categoryId}/{faqId}": {
1266+
"/api/v3.1/pdf/{categoryId}/{faqId}": {
12671267
"get": {
12681268
"tags": ["Public Endpoints"],
12691269
"description": "This endpoint returns the URL to the PDF of FAQ for the given FAQ ID and the language provided by \"Accept-Language\".",
@@ -1326,7 +1326,7 @@
13261326
}
13271327
}
13281328
},
1329-
"/api/v3.0/question": {
1329+
"/api/v3.1/question": {
13301330
"post": {
13311331
"tags": ["Endpoints with Authentication"],
13321332
"operationId": "createQuestion",
@@ -1400,7 +1400,7 @@
14001400
}
14011401
}
14021402
},
1403-
"/api/v3.0/register": {
1403+
"/api/v3.1/register": {
14041404
"post": {
14051405
"tags": ["Endpoints with Authentication"],
14061406
"operationId": "createUser",
@@ -1526,7 +1526,7 @@
15261526
}
15271527
}
15281528
},
1529-
"/api/v3.0/search": {
1529+
"/api/v3.1/search": {
15301530
"get": {
15311531
"tags": ["Public Endpoints"],
15321532
"operationId": "getSearch",
@@ -1563,7 +1563,7 @@
15631563
}
15641564
}
15651565
},
1566-
"/api/v3.0/searches/popular": {
1566+
"/api/v3.1/searches/popular": {
15671567
"get": {
15681568
"tags": ["Public Endpoints"],
15691569
"operationId": "getPopularSearch",
@@ -1605,7 +1605,7 @@
16051605
}
16061606
}
16071607
},
1608-
"/api/v3.0/tags": {
1608+
"/api/v3.1/tags": {
16091609
"get": {
16101610
"tags": ["Public Endpoints"],
16111611
"operationId": "getTags",
@@ -1631,7 +1631,7 @@
16311631
}
16321632
}
16331633
},
1634-
"/api/v3.0/title": {
1634+
"/api/v3.1/title": {
16351635
"get": {
16361636
"tags": ["Public Endpoints"],
16371637
"operationId": "getTitle",
@@ -1684,7 +1684,7 @@
16841684
}
16851685
}
16861686
},
1687-
"/api/v3.0/version": {
1687+
"/api/v3.1/version": {
16881688
"get": {
16891689
"tags": ["Public Endpoints"],
16901690
"operationId": "getVersion",

0 commit comments

Comments
 (0)