Skip to content

Commit bb5a8a0

Browse files
committed
Merge branch 'dev' of github.com:phpList/web-frontend into subscribe-page
2 parents 291120e + 3fbd4d5 commit bb5a8a0

1 file changed

Lines changed: 149 additions & 14 deletions

File tree

openapi.json

Lines changed: 149 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4726,7 +4726,7 @@
47264726
"/api/v2/subscribe-pages": {
47274727
"get": {
47284728
"tags": [
4729-
"subscriptions"
4729+
"subscribe-pages"
47304730
],
47314731
"summary": "Get subscribe pages list",
47324732
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -4811,7 +4811,7 @@
48114811
},
48124812
"post": {
48134813
"tags": [
4814-
"subscriptions"
4814+
"subscribe-pages"
48154815
],
48164816
"summary": "Create subscribe page",
48174817
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -4898,7 +4898,7 @@
48984898
"/api/v2/subscribe-pages/{id}": {
48994899
"get": {
49004900
"tags": [
4901-
"subscriptions"
4901+
"subscribe-pages"
49024902
],
49034903
"summary": "Get subscribe page",
49044904
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -4958,7 +4958,7 @@
49584958
},
49594959
"put": {
49604960
"tags": [
4961-
"subscriptions"
4961+
"subscribe-pages"
49624962
],
49634963
"summary": "Update subscribe page",
49644964
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -5053,7 +5053,7 @@
50535053
},
50545054
"delete": {
50555055
"tags": [
5056-
"subscriptions"
5056+
"subscribe-pages"
50575057
],
50585058
"summary": "Delete subscribe page",
50595059
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -5108,7 +5108,7 @@
51085108
"/api/v2/public/subscribe-pages/{pageId}": {
51095109
"get": {
51105110
"tags": [
5111-
"public"
5111+
"subscribe-pages"
51125112
],
51135113
"summary": "Get public subscribe page (placeholders replaced with actual values)",
51145114
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
@@ -5149,7 +5149,7 @@
51495149
},
51505150
"post": {
51515151
"tags": [
5152-
"public"
5152+
"subscribe-pages"
51535153
],
51545154
"summary": "Create subscription",
51555155
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.Subscribe subscriber to a list from subscribe page.",
@@ -5221,6 +5221,69 @@
52215221
}
52225222
}
52235223
}
5224+
},
5225+
"delete": {
5226+
"tags": [
5227+
"subscribe-pages"
5228+
],
5229+
"summary": "Delete subscription",
5230+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.Unsubscribe subscriber from a list from subscribe page.",
5231+
"operationId": "48751c56d39746c6b8dc3f782a9b22e5",
5232+
"parameters": [
5233+
{
5234+
"name": "pageId",
5235+
"in": "path",
5236+
"description": "Subscribe page ID",
5237+
"required": true,
5238+
"schema": {
5239+
"type": "integer"
5240+
}
5241+
},
5242+
{
5243+
"name": "email",
5244+
"in": "query",
5245+
"description": "Subscriber email",
5246+
"required": true,
5247+
"schema": {
5248+
"type": "string"
5249+
}
5250+
}
5251+
],
5252+
"responses": {
5253+
"200": {
5254+
"description": "Success"
5255+
},
5256+
"400": {
5257+
"description": "Failure",
5258+
"content": {
5259+
"application/json": {
5260+
"schema": {
5261+
"$ref": "#/components/schemas/BadRequestResponse"
5262+
}
5263+
}
5264+
}
5265+
},
5266+
"404": {
5267+
"description": "Failure",
5268+
"content": {
5269+
"application/json": {
5270+
"schema": {
5271+
"$ref": "#/components/schemas/NotFoundErrorResponse"
5272+
}
5273+
}
5274+
}
5275+
},
5276+
"422": {
5277+
"description": "Failure",
5278+
"content": {
5279+
"application/json": {
5280+
"schema": {
5281+
"$ref": "#/components/schemas/ValidationErrorResponse"
5282+
}
5283+
}
5284+
}
5285+
}
5286+
}
52245287
}
52255288
},
52265289
"/api/v2/attributes": {
@@ -8658,12 +8721,84 @@
86588721
"example": "Subscribe to our newsletter"
86598722
},
86608723
"data": {
8661-
"type": "array",
8662-
"items": {
8663-
"type": "object",
8664-
"additionalProperties": {
8665-
"type": "string"
8724+
"properties": {
8725+
"attributes": {
8726+
"type": "array",
8727+
"items": {
8728+
"properties": {
8729+
"id": {
8730+
"type": "integer"
8731+
},
8732+
"name": {
8733+
"type": "string"
8734+
},
8735+
"type": {
8736+
"type": "string"
8737+
},
8738+
"required": {
8739+
"type": "boolean"
8740+
},
8741+
"default_value": {
8742+
"type": "string",
8743+
"nullable": true
8744+
},
8745+
"list_order": {
8746+
"type": "integer"
8747+
},
8748+
"options": {
8749+
"type": "array",
8750+
"items": {
8751+
"type": "object"
8752+
}
8753+
}
8754+
},
8755+
"type": "object"
8756+
}
8757+
},
8758+
"lists": {
8759+
"type": "array",
8760+
"items": {
8761+
"properties": {
8762+
"id": {
8763+
"type": "integer"
8764+
},
8765+
"name": {
8766+
"type": "string"
8767+
},
8768+
"description": {
8769+
"type": "string",
8770+
"nullable": true
8771+
},
8772+
"list_position": {
8773+
"type": "integer"
8774+
}
8775+
},
8776+
"type": "object"
8777+
}
86668778
}
8779+
},
8780+
"type": "object",
8781+
"additionalProperties": {
8782+
"oneOf": [
8783+
{
8784+
"type": "string"
8785+
},
8786+
{
8787+
"type": "integer"
8788+
},
8789+
{
8790+
"type": "boolean"
8791+
},
8792+
{
8793+
"type": "array",
8794+
"items": {
8795+
"type": "object"
8796+
}
8797+
},
8798+
{
8799+
"type": "object"
8800+
}
8801+
]
86678802
}
86688803
}
86698804
},
@@ -8933,8 +9068,8 @@
89339068
"description": "subscriptions"
89349069
},
89359070
{
8936-
"name": "public",
8937-
"description": "public"
9071+
"name": "subscribe-pages",
9072+
"description": "subscribe-pages"
89389073
},
89399074
{
89409075
"name": "subscriber-attributes",

0 commit comments

Comments
 (0)