Skip to content

Commit e72ff8d

Browse files
committed
feat(#220-make-the-swagger-relevant): swagger was updated
1 parent aa63af9 commit e72ff8d

File tree

1 file changed

+93
-89
lines changed

1 file changed

+93
-89
lines changed

application/endpoints/src/main/resources/openapi/documentation.yaml

Lines changed: 93 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,76 @@ paths:
381381
$ref: '#/components/schemas/InvalidResponse'
382382
security:
383383
- token: []
384+
/friends/subscribers/list:
385+
parameters:
386+
- name: Api-Version
387+
in: header
388+
description: The version of API to invoke request with
389+
required: true
390+
schema:
391+
type: string
392+
- name: userId
393+
in: query
394+
required: false
395+
schema:
396+
type: string
397+
- name: amount
398+
in: query
399+
required: true
400+
schema:
401+
type: integer
402+
- name: pagingId
403+
in: query
404+
required: false
405+
schema:
406+
type: string
407+
get:
408+
tags:
409+
- friends
410+
summary: List of subscribers
411+
description: "Request a list of subscribers"
412+
responses:
413+
"200":
414+
description: ""
415+
content:
416+
application/json:
417+
schema:
418+
$ref: '#/components/schemas/ListSubsResponse'
419+
/friends/subscriptions/list:
420+
parameters:
421+
- name: Api-Version
422+
in: header
423+
description: The version of API to invoke request with
424+
required: true
425+
schema:
426+
type: string
427+
- name: userId
428+
in: query
429+
required: false
430+
schema:
431+
type: string
432+
- name: amount
433+
in: query
434+
required: true
435+
schema:
436+
type: integer
437+
- name: pagingId
438+
in: query
439+
required: false
440+
schema:
441+
type: string
442+
get:
443+
tags:
444+
- friends
445+
summary: List of subscriptions
446+
description: "Request a list of subscriptions"
447+
responses:
448+
"200":
449+
description: ""
450+
content:
451+
application/json:
452+
schema:
453+
$ref: '#/components/schemas/ListSubsResponse'
384454
/invitations/create:
385455
parameters:
386456
- name: Api-Version
@@ -1233,11 +1303,6 @@ components:
12331303
status: false
12341304
errorCode: 14
12351305
errorMessage: "Specify at least one meeting edit parameter"
1236-
InvalidTitleOrDescription:
1237-
value:
1238-
status: false
1239-
errorCode: 7
1240-
errorMessage: "Please provide a valid title or description"
12411306
InvalidFileId:
12421307
value:
12431308
status: false
@@ -1365,39 +1430,6 @@ components:
13651430
required:
13661431
- "token"
13671432
- "location"
1368-
TokenRequest:
1369-
type: object
1370-
properties:
1371-
token:
1372-
type: string
1373-
example:
1374-
- "14:BtEpi2o77Uia9NvwQqbumtNggJzjlEVS5gTS1Z8SDs9BmXk7E8lGxji5MBHxcor0j9X1tMgTjiYwbVvuqjdhkdDTr4XtZY6lFhURbKYG17LlfgqPVi6xJpoAdwQyxLz6wILAaiJdBy3wK1PZ3t0Zg3oBGeyeKJtfestgJylmEMCBjH7eXkBP9Bi93xkV4u68kB4OBKPesxJrTpUHlQjwuP8bCpj8Q591BUdUm9t9dXR4xSksMKWWWe4t4Y4ZrAfA"
1375-
required:
1376-
- "properties"
1377-
AccessIdentityRequest:
1378-
type: "object"
1379-
properties:
1380-
accessIdentity:
1381-
type: string
1382-
example:
1383-
- "14:BtEpi2o77Uia9NvwQqbumtNggJzjlEVS5gTS1Z8SDs9BmXk7E8lGxji5MBHxcor0j9X1tMgTjiYwbVvuqjdhkdDTr4XtZY6lFhURbKYG17LlfgqPVi6xJpoAdwQyxLz6wILAaiJdBy3wK1PZ3t0Zg3oBGeyeKJtfestgJylmEMCBjH7eXkBP9Bi93xkV4u68kB4OBKPesxJrTpUHlQjwuP8bCpj8Q591BUdUm9t9dXR4xSksMKWWWe4t4Y4ZrAfA"
1384-
required:
1385-
- "accessIdentity"
1386-
additionalProperties: true
1387-
IdentityRequest:
1388-
type: object
1389-
properties:
1390-
id:
1391-
type: string
1392-
example:
1393-
- "46:QTZepulLdiPsDLNNjinSQ8HJeyidzrdMrYATwD5fmb080VGxzQCUXRubsbxx8DqhojU2y80LiXXBT1N0FQhZZ3rYNTqQZoaDJDYRM31Qd3ugkzBV7QWwtCdAjQ2AxZAAukUCgvwiy2wGmuxSlXhME224gPXRq53WqlFVjMDsAZiIo9HGr0qmclO2EZUPRVlyd5plu83UApbIrOVHeXksq1NbSXxloAhDq6iK9C2Ck8BNoZS8wQWsXdCXBqnPVb85"
1394-
token:
1395-
type: string
1396-
example:
1397-
- "14:BtEpi2o77Uia9NvwQqbumtNggJzjlEVS5gTS1Z8SDs9BmXk7E8lGxji5MBHxcor0j9X1tMgTjiYwbVvuqjdhkdDTr4XtZY6lFhURbKYG17LlfgqPVi6xJpoAdwQyxLz6wILAaiJdBy3wK1PZ3t0Zg3oBGeyeKJtfestgJylmEMCBjH7eXkBP9Bi93xkV4u68kB4OBKPesxJrTpUHlQjwuP8bCpj8Q591BUdUm9t9dXR4xSksMKWWWe4t4Y4ZrAfA"
1398-
required:
1399-
- "id"
1400-
additionalProperties: true
14011433
AccessFriendRequest:
14021434
type: "object"
14031435
properties:
@@ -1473,21 +1505,6 @@ components:
14731505
- "temporalHash"
14741506
- "secretBotKey"
14751507
- "telegramId"
1476-
AccessAvatarRequest:
1477-
type: "object"
1478-
properties:
1479-
accessIdentity:
1480-
type: string
1481-
example:
1482-
- "14:BtEpi2o77Uia9NvwQqbumtNggJzjlEVS5gTS1Z8SDs9BmXk7E8lGxji5MBHxcor0j9X1tMgTjiYwbVvuqjdhkdDTr4XtZY6lFhURbKYG17LlfgqPVi6xJpoAdwQyxLz6wILAaiJdBy3wK1PZ3t0Zg3oBGeyeKJtfestgJylmEMCBjH7eXkBP9Bi93xkV4u68kB4OBKPesxJrTpUHlQjwuP8bCpj8Q591BUdUm9t9dXR4xSksMKWWWe4t4Y4ZrAfA"
1483-
fileIdentity:
1484-
type: string
1485-
example:
1486-
- "14:BtEpi2o77Uia9NvwQqbumtNggJzjlEVS5gTS1Z8SDs9BmXk7E8lGxji5MBHxcor0j9X1tMgTjiYwbVvuqjdhkdDTr4XtZY6lFhURbKYG17LlfgqPVi6xJpoAdwQyxLz6wILAaiJdBy3wK1PZ3t0Zg3oBGeyeKJtfestgJylmEMCBjH7eXkBP9Bi93xkV4u68kB4OBKPesxJrTpUHlQjwuP8bCpj8Q591BUdUm9t9dXR4xSksMKWWWe4t4Y4ZrAfA"
1487-
required:
1488-
- "accessIdentity"
1489-
- "fileIdentityIdentity"
1490-
additionalProperties: true
14911508
CreateMeetingRequest:
14921509
type: "object"
14931510
properties:
@@ -1612,6 +1629,29 @@ components:
16121629
required:
16131630
- "status"
16141631
- "result"
1632+
ListSubsResponse:
1633+
type: object
1634+
properties:
1635+
status:
1636+
type: boolean
1637+
example:
1638+
- true
1639+
result:
1640+
type: object
1641+
properties:
1642+
data:
1643+
type: array
1644+
items:
1645+
$ref: '#/components/schemas/RegularUserResponse'
1646+
nextPagingId:
1647+
type: string
1648+
example: "11"
1649+
required:
1650+
- "data"
1651+
required:
1652+
- "status"
1653+
- "result"
1654+
additionalProperties: true
16151655
DownloadFileSuccessfulResponse:
16161656
type: string
16171657
enum:
@@ -1642,21 +1682,6 @@ components:
16421682
RegularUserResponse:
16431683
allOf:
16441684
- $ref: '#/components/schemas/User'
1645-
CreatorMeetingResponse:
1646-
type: object
1647-
properties:
1648-
id:
1649-
type: string
1650-
example: "12:eKAouJLbWqDmtwQOWuAhi9MYiBYHxKw4LTZBD39nAhtMDiV73QBPDVjE3HRNYm4xwtRJta3FdNdua90evNSgvuvqfyUjdwhXlSlDiEpPE1DJGTzuuAdm5WDowDNJOTdHDpYAGzztJMaKwXiFlguVwO88AZhoByf4SaP9HLXftFs5XVIwNWf4mntyJ48GLaWchngpjvgJW5vABjwwRJiCkCYvMiFpCvwSrzdjwzuvDxM3egDzg15U63yTBSJv0dSo"
1651-
nickname:
1652-
type: string
1653-
example: David Lepaski
1654-
email:
1655-
type: string
1656-
example: "*depending on the privacy settings of the meeting creator, his mail will be displayed*"
1657-
emailVerified:
1658-
type: boolean
1659-
example: false
16601685
Location:
16611686
type: object
16621687
properties:
@@ -1765,17 +1790,6 @@ components:
17651790
example: true
17661791
result:
17671792
$ref: '#/components/schemas/User'
1768-
EditUserResponse:
1769-
type: object
1770-
properties:
1771-
status:
1772-
type: boolean
1773-
example: true
1774-
result:
1775-
$ref: '#/components/schemas/User'
1776-
required:
1777-
- "status"
1778-
- "result"
17791793
User:
17801794
type: object
17811795
properties:
@@ -1808,16 +1822,6 @@ components:
18081822
- id
18091823
- nickname
18101824
- isSelf
1811-
GetUserRequest:
1812-
description: response with an token
1813-
type: object
1814-
properties:
1815-
id:
1816-
type: string
1817-
example: "8:bqLhYy1hjNTL0wXcN0dnmSeyZDMt2akkGYMDdaa81oc8fPhOHBWTuFWzMdWNqu7gTHHrfhvC64RE2ZEtngYD5YVpOAGz8Nx1ii7l6BxpBCfHgaL6hHzkEqsmuGlea2gijOEZFkDEhebZ9lwkav13DMTdWJUm4GMm0VQgXzX8s3B528XsMxkXiu5ps9JrRB4m2m4vnZHEaskq9SXEGfhxzeuVft4d2eHWlp5V06NPmfhuyehq9J3GwWxYSkN3Doun"
1818-
required:
1819-
- token
1820-
additionalProperties: true
18211825
EditUserRequest:
18221826
type: object
18231827
properties:

0 commit comments

Comments
 (0)