Skip to content

Commit 58e2362

Browse files
author
github-actions
committed
Update REST API documentation Wed May 20 10:38:17 UTC 2026
1 parent c9c1eac commit 58e2362

1 file changed

Lines changed: 131 additions & 46 deletions

File tree

‎restapi.json‎

Lines changed: 131 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -4723,14 +4723,14 @@
47234723
}
47244724
}
47254725
},
4726-
"/api/v2/subscribe-pages/{id}": {
4726+
"/api/v2/subscribe-pages": {
47274727
"get": {
47284728
"tags": [
47294729
"subscriptions"
47304730
],
4731-
"summary": "Get subscribe page",
4731+
"summary": "Get subscribe pages list",
47324732
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
4733-
"operationId": "390db83b1de32e07d2d52b310eb0c1ea",
4733+
"operationId": "1a89921fa5f82ce43daf2ca40dc3f954",
47344734
"parameters": [
47354735
{
47364736
"name": "php-auth-pw",
@@ -4742,12 +4742,26 @@
47424742
}
47434743
},
47444744
{
4745-
"name": "id",
4746-
"in": "path",
4747-
"description": "Subscribe page ID",
4748-
"required": true,
4745+
"name": "after_id",
4746+
"in": "query",
4747+
"description": "Last id (starting from 0)",
4748+
"required": false,
47494749
"schema": {
4750-
"type": "integer"
4750+
"type": "integer",
4751+
"default": 1,
4752+
"minimum": 1
4753+
}
4754+
},
4755+
{
4756+
"name": "limit",
4757+
"in": "query",
4758+
"description": "Number of results per page",
4759+
"required": false,
4760+
"schema": {
4761+
"type": "integer",
4762+
"default": 25,
4763+
"maximum": 100,
4764+
"minimum": 1
47514765
}
47524766
}
47534767
],
@@ -4757,7 +4771,18 @@
47574771
"content": {
47584772
"application/json": {
47594773
"schema": {
4760-
"$ref": "#/components/schemas/SubscribePage"
4774+
"properties": {
4775+
"items": {
4776+
"type": "array",
4777+
"items": {
4778+
"$ref": "#/components/schemas/SubscribePage"
4779+
}
4780+
},
4781+
"pagination": {
4782+
"$ref": "#/components/schemas/CursorPagination"
4783+
}
4784+
},
4785+
"type": "object"
47614786
}
47624787
}
47634788
}
@@ -4784,13 +4809,13 @@
47844809
}
47854810
}
47864811
},
4787-
"put": {
4812+
"post": {
47884813
"tags": [
47894814
"subscriptions"
47904815
],
4791-
"summary": "Update subscribe page",
4816+
"summary": "Create subscribe page",
47924817
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
4793-
"operationId": "a82a0cbe52063758b55279ce7b96657b",
4818+
"operationId": "314286c5d8ef80c845f5dfd2d671bad3",
47944819
"parameters": [
47954820
{
47964821
"name": "php-auth-pw",
@@ -4800,15 +4825,6 @@
48004825
"schema": {
48014826
"type": "string"
48024827
}
4803-
},
4804-
{
4805-
"name": "id",
4806-
"in": "path",
4807-
"description": "Subscribe page ID",
4808-
"required": true,
4809-
"schema": {
4810-
"type": "integer"
4811-
}
48124828
}
48134829
],
48144830
"requestBody": {
@@ -4818,8 +4834,7 @@
48184834
"schema": {
48194835
"properties": {
48204836
"title": {
4821-
"type": "string",
4822-
"nullable": true
4837+
"type": "string"
48234838
},
48244839
"active": {
48254840
"type": "boolean",
@@ -4832,8 +4847,8 @@
48324847
}
48334848
},
48344849
"responses": {
4835-
"200": {
4836-
"description": "Success",
4850+
"201": {
4851+
"description": "Created",
48374852
"content": {
48384853
"application/json": {
48394854
"schema": {
@@ -4852,25 +4867,27 @@
48524867
}
48534868
}
48544869
},
4855-
"404": {
4856-
"description": "Not Found",
4870+
"422": {
4871+
"description": "Validation failed",
48574872
"content": {
48584873
"application/json": {
48594874
"schema": {
4860-
"$ref": "#/components/schemas/NotFoundErrorResponse"
4875+
"$ref": "#/components/schemas/ValidationErrorResponse"
48614876
}
48624877
}
48634878
}
48644879
}
48654880
}
4866-
},
4867-
"delete": {
4881+
}
4882+
},
4883+
"/api/v2/subscribe-pages/{id}": {
4884+
"get": {
48684885
"tags": [
48694886
"subscriptions"
48704887
],
4871-
"summary": "Delete subscribe page",
4888+
"summary": "Get subscribe page",
48724889
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
4873-
"operationId": "2881b5de1d076caa070f2b9a1c8487fe",
4890+
"operationId": "390db83b1de32e07d2d52b310eb0c1ea",
48744891
"parameters": [
48754892
{
48764893
"name": "php-auth-pw",
@@ -4892,8 +4909,15 @@
48924909
}
48934910
],
48944911
"responses": {
4895-
"204": {
4896-
"description": "No Content"
4912+
"200": {
4913+
"description": "Success",
4914+
"content": {
4915+
"application/json": {
4916+
"schema": {
4917+
"$ref": "#/components/schemas/SubscribePage"
4918+
}
4919+
}
4920+
}
48974921
},
48984922
"403": {
48994923
"description": "Failure",
@@ -4916,16 +4940,14 @@
49164940
}
49174941
}
49184942
}
4919-
}
4920-
},
4921-
"/api/v2/subscribe-pages": {
4922-
"post": {
4943+
},
4944+
"put": {
49234945
"tags": [
49244946
"subscriptions"
49254947
],
4926-
"summary": "Create subscribe page",
4948+
"summary": "Update subscribe page",
49274949
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
4928-
"operationId": "314286c5d8ef80c845f5dfd2d671bad3",
4950+
"operationId": "a82a0cbe52063758b55279ce7b96657b",
49294951
"parameters": [
49304952
{
49314953
"name": "php-auth-pw",
@@ -4935,6 +4957,15 @@
49354957
"schema": {
49364958
"type": "string"
49374959
}
4960+
},
4961+
{
4962+
"name": "id",
4963+
"in": "path",
4964+
"description": "Subscribe page ID",
4965+
"required": true,
4966+
"schema": {
4967+
"type": "integer"
4968+
}
49384969
}
49394970
],
49404971
"requestBody": {
@@ -4944,7 +4975,8 @@
49444975
"schema": {
49454976
"properties": {
49464977
"title": {
4947-
"type": "string"
4978+
"type": "string",
4979+
"nullable": true
49484980
},
49494981
"active": {
49504982
"type": "boolean",
@@ -4957,8 +4989,8 @@
49574989
}
49584990
},
49594991
"responses": {
4960-
"201": {
4961-
"description": "Created",
4992+
"200": {
4993+
"description": "Success",
49624994
"content": {
49634995
"application/json": {
49644996
"schema": {
@@ -4977,12 +5009,65 @@
49775009
}
49785010
}
49795011
},
4980-
"422": {
4981-
"description": "Validation failed",
5012+
"404": {
5013+
"description": "Not Found",
49825014
"content": {
49835015
"application/json": {
49845016
"schema": {
4985-
"$ref": "#/components/schemas/ValidationErrorResponse"
5017+
"$ref": "#/components/schemas/NotFoundErrorResponse"
5018+
}
5019+
}
5020+
}
5021+
}
5022+
}
5023+
},
5024+
"delete": {
5025+
"tags": [
5026+
"subscriptions"
5027+
],
5028+
"summary": "Delete subscribe page",
5029+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
5030+
"operationId": "2881b5de1d076caa070f2b9a1c8487fe",
5031+
"parameters": [
5032+
{
5033+
"name": "php-auth-pw",
5034+
"in": "header",
5035+
"description": "Session key obtained from login",
5036+
"required": true,
5037+
"schema": {
5038+
"type": "string"
5039+
}
5040+
},
5041+
{
5042+
"name": "id",
5043+
"in": "path",
5044+
"description": "Subscribe page ID",
5045+
"required": true,
5046+
"schema": {
5047+
"type": "integer"
5048+
}
5049+
}
5050+
],
5051+
"responses": {
5052+
"204": {
5053+
"description": "No Content"
5054+
},
5055+
"403": {
5056+
"description": "Failure",
5057+
"content": {
5058+
"application/json": {
5059+
"schema": {
5060+
"$ref": "#/components/schemas/UnauthorizedResponse"
5061+
}
5062+
}
5063+
}
5064+
},
5065+
"404": {
5066+
"description": "Not Found",
5067+
"content": {
5068+
"application/json": {
5069+
"schema": {
5070+
"$ref": "#/components/schemas/NotFoundErrorResponse"
49865071
}
49875072
}
49885073
}

0 commit comments

Comments
 (0)