Skip to content

Commit bb9e254

Browse files
committed
Add param $refs
1 parent f120719 commit bb9e254

File tree

1 file changed

+57
-18
lines changed

1 file changed

+57
-18
lines changed

VTEX - Weni by VTEX API.json

Lines changed: 57 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -49,24 +49,10 @@
4949
}
5050
},
5151
{
52-
"name": "before",
53-
"in": "query",
54-
"description": "Start date of the archive. Follows the UTC time format: `YYYY-MM-DDT`.",
55-
"required": false,
56-
"schema": {
57-
"type": "string",
58-
"example": "2021-01-01T00:00:00"
59-
}
52+
"$ref": "#/parameters/Before"
6053
},
6154
{
62-
"name": "after",
63-
"in": "query",
64-
"description": "End date of the archive. Follows the UTC time format: `YYYY-MM-DDT`.",
65-
"required": false,
66-
"schema": {
67-
"type": "string",
68-
"example": "2021-01-01T00:00:00"
69-
}
55+
"$ref": "#/parameters/After"
7056
},
7157
{
7258
"name": "period",
@@ -309,7 +295,7 @@
309295
"Broadcasts"
310296
],
311297
"summary": "Get Weni Flows broadcasts",
312-
"description": "List and send message broadcasts",
298+
"description": "Send new message broadcasts and list existing broadcasts in your account.",
313299
"operationId": "GetBroadcasts",
314300
"parameters": [
315301
{
@@ -321,6 +307,16 @@
321307
"schema": {
322308
"type": "string"
323309
}
310+
},
311+
{
312+
"name": "id",
313+
"in": "query",
314+
"description": "The ID of the broadcast.",
315+
"required": false,
316+
"style": "form",
317+
"schema": {
318+
"type": "integer"
319+
}
324320
}
325321
],
326322
"responses": {
@@ -329,7 +325,26 @@
329325
"content": {
330326
"application/json": {
331327
"schema": {
332-
"type": "object"
328+
"type": "object",
329+
"properties": {
330+
"next": {
331+
"$ref": "#/components/schemas/NextPage"
332+
},
333+
"previous":
334+
{
335+
"$ref": "#/components/schemas/PreviousPage"
336+
},
337+
"results": {
338+
"type": "object",
339+
"description": "List of message broadcasts.",
340+
"properties": {
341+
"id": {
342+
"type": "integer",
343+
"description": "The ID of the broadcast."
344+
}
345+
}
346+
}
347+
}
333348
}
334349
}
335350
}
@@ -2875,6 +2890,30 @@
28752890
"description": "API Token authentication. Format: Token {your-token}"
28762891
}
28772892
},
2893+
"parameters": {
2894+
"Before": {
2895+
"name": "before",
2896+
"in": "query",
2897+
"description": "Start date of the archive. Follows the UTC time format: `YYYY-MM-DDT`.",
2898+
"required": false,
2899+
"style": "form",
2900+
"schema": {
2901+
"type": "string",
2902+
"example": "2025-01-01T00:00:00"
2903+
}
2904+
},
2905+
"After": {
2906+
"name": "after",
2907+
"in": "query",
2908+
"description": "End date of the archive. Follows the UTC time format: `YYYY-MM-DDT`.",
2909+
"required": false,
2910+
"style": "form",
2911+
"schema": {
2912+
"type": "string",
2913+
"example": "2025-01-01T00:00:00"
2914+
}
2915+
}
2916+
},
28782917
"schemas": {
28792918
"NextPage": {
28802919
"type": "string",

0 commit comments

Comments
 (0)