Skip to content

Commit e4d5210

Browse files
thorstenthorsten
committed
docs: added updated OpenAPI specs (#3830)
1 parent 0f09ec0 commit e4d5210

File tree

2 files changed

+44
-44
lines changed

2 files changed

+44
-44
lines changed

‎docs/openapi.json‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.0",
33
"info": {
4-
"title": "REST API for phpMyFAQ 4.1",
4+
"title": "REST API for phpMyFAQ 4.2",
55
"description": "phpMyFAQ includes a REST API and offers APIs for various services like fetching the phpMyFAQ version or doing a search against the phpMyFAQ installation.",
66
"contact": {
77
"name": "phpMyFAQ Team",
@@ -11,7 +11,7 @@
1111
"name": "Mozilla Public Licence 2.0",
1212
"url": "https://www.mozilla.org/MPL/2.0/"
1313
},
14-
"version": "3.1"
14+
"version": "3.2"
1515
},
1616
"servers": [
1717
{
@@ -74,7 +74,7 @@
7474
}
7575
}
7676
},
77-
"/api/v3.1/backup/{type}": {
77+
"/api/v3.2/backup/{type}": {
7878
"get": {
7979
"tags": ["Endpoints with Authentication"],
8080
"operationId": "createBackup",
@@ -400,7 +400,7 @@
400400
}
401401
}
402402
},
403-
"/api/v3.1/faqs/{categoryId}": {
403+
"/api/v3.2/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.1/faq/{categoryId}/{faqId}": {
457+
"/api/v3.2/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.1/faqs/tags/{tagId}": {
520+
"/api/v3.2/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.1/faqs/popular": {
574+
"/api/v3.2/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.1/faqs/latest": {
617+
"/api/v3.2/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.1/faqs/trending": {
660+
"/api/v3.2/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.1/faqs/sticky": {
703+
"/api/v3.2/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.1/faqs": {
746+
"/api/v3.2/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.1/faq/create": {
789+
"/api/v3.2/faq/create": {
790790
"post": {
791791
"tags": ["Endpoints with Authentication"],
792792
"operationId": "createFaq",
@@ -936,7 +936,7 @@
936936
}
937937
}
938938
},
939-
"/api/v3.1/faq/update": {
939+
"/api/v3.2/faq/update": {
940940
"put": {
941941
"tags": ["Endpoints with Authentication"],
942942
"description": "Used to update a FAQ in one existing category.",
@@ -1105,7 +1105,7 @@
11051105
}
11061106
}
11071107
},
1108-
"/api/v3.1/groups": {
1108+
"/api/v3.2/groups": {
11091109
"get": {
11101110
"tags": ["Endpoints with Authentication"],
11111111
"description": "Used to fetch all group IDs.",
@@ -1159,7 +1159,7 @@
11591159
}
11601160
}
11611161
},
1162-
"/api/v3.1/login": {
1162+
"/api/v3.2/login": {
11631163
"post": {
11641164
"tags": ["Public Endpoints"],
11651165
"operationId": "login",
@@ -1263,7 +1263,7 @@
12631263
}
12641264
}
12651265
},
1266-
"/api/v3.1/open-questions": {
1266+
"/api/v3.2/open-questions": {
12671267
"get": {
12681268
"tags": ["Public Endpoints"],
12691269
"operationId": "getOpenQuestions",
@@ -1305,7 +1305,7 @@
13051305
}
13061306
}
13071307
},
1308-
"/api/v3.1/pdf/{categoryId}/{faqId}": {
1308+
"/api/v3.2/pdf/{categoryId}/{faqId}": {
13091309
"get": {
13101310
"tags": ["Public Endpoints"],
13111311
"description": "This endpoint returns the URL to the PDF of FAQ for the given FAQ ID and the language provided by \"Accept-Language\".",
@@ -1568,7 +1568,7 @@
15681568
}
15691569
}
15701570
},
1571-
"/api/v3.1/search": {
1571+
"/api/v3.2/search": {
15721572
"get": {
15731573
"tags": ["Public Endpoints"],
15741574
"operationId": "getSearch",
@@ -1605,7 +1605,7 @@
16051605
}
16061606
}
16071607
},
1608-
"/api/v3.1/searches/popular": {
1608+
"/api/v3.2/searches/popular": {
16091609
"get": {
16101610
"tags": ["Public Endpoints"],
16111611
"operationId": "getPopularSearch",
@@ -1647,7 +1647,7 @@
16471647
}
16481648
}
16491649
},
1650-
"/api/v3.1/tags": {
1650+
"/api/v3.2/tags": {
16511651
"get": {
16521652
"tags": ["Public Endpoints"],
16531653
"operationId": "getTags",
@@ -1673,7 +1673,7 @@
16731673
}
16741674
}
16751675
},
1676-
"/api/v3.1/title": {
1676+
"/api/v3.2/title": {
16771677
"get": {
16781678
"tags": ["Public Endpoints"],
16791679
"operationId": "getTitle",
@@ -1690,7 +1690,7 @@
16901690
}
16911691
}
16921692
},
1693-
"/api/v3.1/version": {
1693+
"/api/v3.2/version": {
16941694
"get": {
16951695
"tags": ["Public Endpoints"],
16961696
"operationId": "getVersion",

‎docs/openapi.yaml‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
openapi: 3.0.0
22
info:
3-
title: 'REST API for phpMyFAQ 4.1'
3+
title: 'REST API for phpMyFAQ 4.2'
44
description: 'phpMyFAQ includes a REST API and offers APIs for various services like fetching the phpMyFAQ version or doing a search against the phpMyFAQ installation.'
55
contact:
66
name: 'phpMyFAQ Team'
77
email: [email protected]
88
license:
99
name: 'Mozilla Public Licence 2.0'
1010
url: 'https://www.mozilla.org/MPL/2.0/'
11-
version: '3.1'
11+
version: '3.2'
1212
servers:
1313
- url: 'https://localhost'
1414
description: 'Local dockerized server'
@@ -49,7 +49,7 @@ paths:
4949
application/json:
5050
schema: {}
5151
example: []
52-
'/api/v3.1/backup/{type}':
52+
'/api/v3.2/backup/{type}':
5353
get:
5454
tags:
5555
- 'Endpoints with Authentication'
@@ -266,7 +266,7 @@ paths:
266266
application/json:
267267
schema: {}
268268
example: []
269-
'/api/v3.1/faqs/{categoryId}':
269+
'/api/v3.2/faqs/{categoryId}':
270270
get:
271271
tags:
272272
- 'Public Endpoints'
@@ -302,7 +302,7 @@ paths:
302302
application/json:
303303
schema: {}
304304
example: []
305-
'/api/v3.1/faq/{categoryId}/{faqId}':
305+
'/api/v3.2/faq/{categoryId}/{faqId}':
306306
get:
307307
tags:
308308
- 'Public Endpoints'
@@ -344,7 +344,7 @@ paths:
344344
application/json:
345345
schema: {}
346346
example: []
347-
'/api/v3.1/faqs/tags/{tagId}':
347+
'/api/v3.2/faqs/tags/{tagId}':
348348
get:
349349
tags:
350350
- 'Public Endpoints'
@@ -380,7 +380,7 @@ paths:
380380
application/json:
381381
schema: {}
382382
example: []
383-
/api/v3.1/faqs/popular:
383+
/api/v3.2/faqs/popular:
384384
get:
385385
tags:
386386
- 'Public Endpoints'
@@ -409,7 +409,7 @@ paths:
409409
application/json:
410410
schema: {}
411411
example: []
412-
/api/v3.1/faqs/latest:
412+
/api/v3.2/faqs/latest:
413413
get:
414414
tags:
415415
- 'Public Endpoints'
@@ -438,7 +438,7 @@ paths:
438438
application/json:
439439
schema: {}
440440
example: []
441-
/api/v3.1/faqs/trending:
441+
/api/v3.2/faqs/trending:
442442
get:
443443
tags:
444444
- 'Public Endpoints'
@@ -467,7 +467,7 @@ paths:
467467
application/json:
468468
schema: {}
469469
example: []
470-
/api/v3.1/faqs/sticky:
470+
/api/v3.2/faqs/sticky:
471471
get:
472472
tags:
473473
- 'Public Endpoints'
@@ -496,7 +496,7 @@ paths:
496496
application/json:
497497
schema: {}
498498
example: []
499-
/api/v3.1/faqs:
499+
/api/v3.2/faqs:
500500
get:
501501
tags:
502502
- 'Public Endpoints'
@@ -525,7 +525,7 @@ paths:
525525
application/json:
526526
schema: {}
527527
example: []
528-
/api/v3.1/faq/create:
528+
/api/v3.2/faq/create:
529529
post:
530530
tags:
531531
- 'Endpoints with Authentication'
@@ -627,7 +627,7 @@ paths:
627627
description: 'phpMyFAQ client API Token, generated in admin backend'
628628
schema:
629629
type: string
630-
/api/v3.1/faq/update:
630+
/api/v3.2/faq/update:
631631
put:
632632
tags:
633633
- 'Endpoints with Authentication'
@@ -742,7 +742,7 @@ paths:
742742
application/json:
743743
schema: {}
744744
example: []
745-
/api/v3.1/groups:
745+
/api/v3.2/groups:
746746
get:
747747
tags:
748748
- 'Endpoints with Authentication'
@@ -779,7 +779,7 @@ paths:
779779
application/json:
780780
schema: {}
781781
example: '"en"'
782-
/api/v3.1/login:
782+
/api/v3.2/login:
783783
post:
784784
tags:
785785
- 'Public Endpoints'
@@ -850,7 +850,7 @@ paths:
850850
application/json:
851851
schema: {}
852852
example: []
853-
/api/v3.1/open-questions:
853+
/api/v3.2/open-questions:
854854
get:
855855
tags:
856856
- 'Public Endpoints'
@@ -878,7 +878,7 @@ paths:
878878
application/json:
879879
schema: {}
880880
example: []
881-
'/api/v3.1/pdf/{categoryId}/{faqId}':
881+
'/api/v3.2/pdf/{categoryId}/{faqId}':
882882
get:
883883
tags:
884884
- 'Public Endpoints'
@@ -1060,7 +1060,7 @@ paths:
10601060
application/json:
10611061
schema: {}
10621062
example: '{ "registered": false }'
1063-
/api/v3.1/search:
1063+
/api/v3.2/search:
10641064
get:
10651065
tags:
10661066
- 'Public Endpoints'
@@ -1085,7 +1085,7 @@ paths:
10851085
application/json:
10861086
schema: {}
10871087
example: []
1088-
/api/v3.1/searches/popular:
1088+
/api/v3.2/searches/popular:
10891089
get:
10901090
tags:
10911091
- 'Public Endpoints'
@@ -1113,7 +1113,7 @@ paths:
11131113
application/json:
11141114
schema: {}
11151115
example: []
1116-
/api/v3.1/tags:
1116+
/api/v3.2/tags:
11171117
get:
11181118
tags:
11191119
- 'Public Endpoints'
@@ -1131,7 +1131,7 @@ paths:
11311131
application/json:
11321132
schema: {}
11331133
example: []
1134-
/api/v3.1/title:
1134+
/api/v3.2/title:
11351135
get:
11361136
tags:
11371137
- 'Public Endpoints'
@@ -1143,7 +1143,7 @@ paths:
11431143
application/json:
11441144
schema: {}
11451145
example: 'phpMyFAQ Codename Porus'
1146-
/api/v3.1/version:
1146+
/api/v3.2/version:
11471147
get:
11481148
tags:
11491149
- 'Public Endpoints'

0 commit comments

Comments
 (0)