Skip to content

Commit 67e8bd9

Browse files
author
github-actions
committed
phplist/rest-api docs deployment Sun Dec 5 20:27:09 UTC 2021
Signed-off-by: github-actions <[email protected]>
1 parent 8f8b517 commit 67e8bd9

File tree

1 file changed

+9
-41
lines changed

1 file changed

+9
-41
lines changed

‎restapi.json‎

Lines changed: 9 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"openapi": "3.0.0",
33
"info": {
44
"title": "phpList4 REST API",
5+
"description": "This bundle provides the REST API for phpList.",
56
"version": "4.0.0"
67
},
78
"paths": {
@@ -12,7 +13,7 @@
1213
],
1314
"summary": "Gets a list of all subscriber lists.",
1415
"description": "Returns a json list of all subscriber lists.",
15-
"operationId": "PhpList\\RestBundle\\Controller\\ListController::cgetAction",
16+
"operationId": "55de401a35e051e041f1ff18648a1b0b",
1617
"parameters": [
1718
{
1819
"name": "session",
@@ -64,7 +65,6 @@
6465
"schema": {
6566
"properties": {
6667
"message": {
67-
"description": "Gets a list of all subscriber lists.",
6868
"type": "string",
6969
"example": "No valid session key was provided as basic auth password."
7070
}
@@ -84,7 +84,7 @@
8484
],
8585
"summary": "Gets a subscriber list.",
8686
"description": "Returns a single subscriber lists with specified ID",
87-
"operationId": "PhpList\\RestBundle\\Controller\\ListController::getAction",
87+
"operationId": "b08cfc501bb8f8eda595a3c86e3b90ed",
8888
"parameters": [
8989
{
9090
"name": "list",
@@ -135,7 +135,6 @@
135135
"schema": {
136136
"properties": {
137137
"message": {
138-
"description": "Gets a subscriber list.",
139138
"type": "string",
140139
"example": "No valid session key was provided as basic auth password."
141140
}
@@ -152,7 +151,6 @@
152151
"schema": {
153152
"properties": {
154153
"message": {
155-
"description": "Gets a subscriber list.",
156154
"type": "string",
157155
"example": "There is no list with that ID."
158156
}
@@ -170,7 +168,7 @@
170168
],
171169
"summary": "Deletes a list.",
172170
"description": "Deletes a single subscriber list passed as",
173-
"operationId": "PhpList\\RestBundle\\Controller\\ListController::deleteAction",
171+
"operationId": "d81f62bf8e86c31019127f86c35987b2",
174172
"parameters": [
175173
{
176174
"name": "session",
@@ -202,7 +200,6 @@
202200
"schema": {
203201
"properties": {
204202
"message": {
205-
"description": "Deletes a subscriber list.",
206203
"type": "string",
207204
"example": "No valid session key was provided as basic auth password or You do not have access to this session."
208205
}
@@ -219,7 +216,6 @@
219216
"schema": {
220217
"properties": {
221218
"message": {
222-
"description": "Deletes a subscriber list.",
223219
"type": "string",
224220
"example": "There is no session with that ID."
225221
}
@@ -239,7 +235,7 @@
239235
],
240236
"summary": "Gets a list of all subscribers (members) of a subscriber list.",
241237
"description": "Returns a json list of all subscriber lists.",
242-
"operationId": "PhpList\\RestBundle\\Controller\\ListController::getMembersAction",
238+
"operationId": "c8750709a040c047a92c9647539f32dd",
243239
"parameters": [
244240
{
245241
"name": "session",
@@ -302,7 +298,6 @@
302298
"schema": {
303299
"properties": {
304300
"message": {
305-
"description": "Gets a list of all subscribers (members) of a subscriber list.",
306301
"type": "string",
307302
"example": "No valid session key was provided as basic auth password."
308303
}
@@ -322,7 +317,7 @@
322317
],
323318
"summary": "Gets the total number of subscribers of a list",
324319
"description": "Returns a count of all subscribers in a given list.",
325-
"operationId": "PhpList\\RestBundle\\Controller\\ListController::getSubscribersCountAction",
320+
"operationId": "736389b83490d2490a74a8bd46a9857c",
326321
"parameters": [
327322
{
328323
"name": "session",
@@ -354,7 +349,6 @@
354349
"schema": {
355350
"properties": {
356351
"message": {
357-
"description": "Gets the total number of subscribers of a list.",
358352
"type": "string",
359353
"example": "No valid session key was provided as basic auth password."
360354
}
@@ -374,7 +368,7 @@
374368
],
375369
"summary": "Log in or create new session.",
376370
"description": "Given valid login data, this will generate a login token that will be valid for 1 hour",
377-
"operationId": "PhpList\\RestBundle\\Controller\\SessionController::postAction",
371+
"operationId": "b23bc3baa9a61e1062fa93124cc52798",
378372
"requestBody": {
379373
"description": "Pass session credentials",
380374
"required": true,
@@ -387,13 +381,11 @@
387381
],
388382
"properties": {
389383
"login_name": {
390-
"description": "Creates a new session (if the provided credentials are valid).",
391384
"type": "string",
392385
"format": "string",
393386
"example": "admin"
394387
},
395388
"password": {
396-
"description": "Creates a new session (if the provided credentials are valid).",
397389
"type": "string",
398390
"format": "password",
399391
"example": "eetIc/Gropvoc1"
@@ -412,17 +404,14 @@
412404
"schema": {
413405
"properties": {
414406
"id": {
415-
"description": "Creates a new session (if the provided credentials are valid).",
416407
"type": "integer",
417408
"example": "1234"
418409
},
419410
"key": {
420-
"description": "Creates a new session (if the provided credentials are valid).",
421411
"type": "string",
422412
"example": "2cfe100561473c6cdd99c9e2f26fa974"
423413
},
424414
"expiry": {
425-
"description": "Creates a new session (if the provided credentials are valid).",
426415
"type": "string",
427416
"example": "2017-07-20T18:22:48+00:00"
428417
}
@@ -439,7 +428,6 @@
439428
"schema": {
440429
"properties": {
441430
"message": {
442-
"description": "Creates a new session (if the provided credentials are valid).",
443431
"type": "string",
444432
"example": "Empty json, invalid data and or incomplete data"
445433
}
@@ -456,7 +444,6 @@
456444
"schema": {
457445
"properties": {
458446
"message": {
459-
"description": "Creates a new session (if the provided credentials are valid).",
460447
"type": "string",
461448
"example": "Not authorized."
462449
}
@@ -476,7 +463,7 @@
476463
],
477464
"summary": "Delete a session.",
478465
"description": "Delete the session passed as paramater",
479-
"operationId": "PhpList\\RestBundle\\Controller\\SessionController::deleteAction",
466+
"operationId": "f4d35cefb1622515d122441a4547f2cc",
480467
"parameters": [
481468
{
482469
"name": "session",
@@ -499,7 +486,6 @@
499486
"schema": {
500487
"properties": {
501488
"message": {
502-
"description": "Deletes a session.",
503489
"type": "string",
504490
"example": "No valid session key was provided as basic auth password or\n * You do not have access to this session."
505491
}
@@ -516,7 +502,6 @@
516502
"schema": {
517503
"properties": {
518504
"message": {
519-
"description": "Deletes a session.",
520505
"type": "string",
521506
"example": "There is no session with that ID."
522507
}
@@ -536,7 +521,7 @@
536521
],
537522
"summary": "Create a subscriber list",
538523
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with\n * the given email address yet).",
539-
"operationId": "PhpList\\RestBundle\\Controller\\SubscriberController::postAction",
524+
"operationId": "13d081ac41de827d61315e9aa771123d",
540525
"parameters": [
541526
{
542527
"name": "session",
@@ -559,31 +544,26 @@
559544
],
560545
"properties": {
561546
"email": {
562-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
563547
"type": "string",
564548
"format": "string",
565549
"example": "admin"
566550
},
567551
"confirmed": {
568-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
569552
"type": "string",
570553
"format": "boolean",
571554
"example": "eetIc/Gropvoc1"
572555
},
573556
"blacklisted": {
574-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
575557
"type": "string",
576558
"format": "boolean",
577559
"example": "eetIc/Gropvoc1"
578560
},
579561
"html_entail": {
580-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
581562
"type": "string",
582563
"format": "boolean",
583564
"example": "eetIc/Gropvoc1"
584565
},
585566
"disabled": {
586-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
587567
"type": "string",
588568
"format": "boolean",
589569
"example": "eetIc/Gropvoc1"
@@ -602,47 +582,38 @@
602582
"schema": {
603583
"properties": {
604584
"creation_date": {
605-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
606585
"type": "integer",
607586
"example": "2017-12-16T18:44:27+00:00"
608587
},
609588
"email": {
610-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
611589
"type": "string",
612590
"example": "[email protected]"
613591
},
614592
"confirmed": {
615-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
616593
"type": "boolean",
617594
"example": "false"
618595
},
619596
"blacklisted": {
620-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
621597
"type": "boolean",
622598
"example": "false"
623599
},
624600
"bounced": {
625-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
626601
"type": "integer",
627602
"example": "0"
628603
},
629604
"unique_id": {
630-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
631605
"type": "string",
632606
"example": "69f4e92cf50eafca9627f35704f030f4"
633607
},
634608
"html_entail": {
635-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
636609
"type": "boolean",
637610
"example": "false"
638611
},
639612
"disabled": {
640-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
641613
"type": "boolean",
642614
"example": "false"
643615
},
644616
"id": {
645-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
646617
"type": "integer",
647618
"example": "1"
648619
}
@@ -659,7 +630,6 @@
659630
"schema": {
660631
"properties": {
661632
"message": {
662-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
663633
"type": "string",
664634
"example": "No valid session key was provided as basic auth password."
665635
}
@@ -676,7 +646,6 @@
676646
"schema": {
677647
"properties": {
678648
"message": {
679-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
680649
"type": "string",
681650
"example": "This resource already exists."
682651
}
@@ -693,7 +662,6 @@
693662
"schema": {
694663
"properties": {
695664
"message": {
696-
"description": "Creates a new subscriber (if the provided data is valid and there is no subscriber with the given email\naddress yet).",
697665
"type": "string",
698666
"example": "Some fields invalid: email, confirmed, html_email"
699667
}

0 commit comments

Comments
 (0)