Skip to content

Commit f8a684d

Browse files
Merge pull request #143 from gotd/feat/update-schema
feat(schema): update documentation to the latest layer
2 parents d8b7c1a + a52c89a commit f8a684d

File tree

2 files changed

+72
-108
lines changed

2 files changed

+72
-108
lines changed

_schema/155.json

Lines changed: 36 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,7 +1309,6 @@
13091309
"contacts.search",
13101310
"contacts.toggleTopPeers",
13111311
"contacts.unblock",
1312-
"folders.deleteFolder",
13131312
"folders.editPeerFolders",
13141313
"help.acceptTermsOfService",
13151314
"help.dismissSuggestion",
@@ -7318,7 +7317,10 @@
73187317
"fields": {
73197318
"draft": {
73207319
"name": "draft",
7321-
"description": "Message draft"
7320+
"description": "Message draft¹",
7321+
"links": [
7322+
"https://core.telegram.org/api/drafts"
7323+
]
73227324
},
73237325
"flags": {
73247326
"name": "flags",
@@ -7367,7 +7369,7 @@
73677369
},
73687370
"ttl_period": {
73697371
"name": "ttl_period",
7370-
"description": " "
7372+
"description": "Time-to-live of all messages sent in this dialog"
73717373
},
73727374
"unread_count": {
73737375
"name": "unread_count",
@@ -8505,18 +8507,27 @@
85058507
},
85068508
"forumTopic": {
85078509
"name": "forumTopic",
8510+
"description": [
8511+
"Represents a forum topic¹."
8512+
],
8513+
"links": [
8514+
"https://core.telegram.org/api/forum#forum-topics"
8515+
],
85088516
"fields": {
85098517
"closed": {
85108518
"name": "closed",
8511-
"description": " "
8519+
"description": "Whether the topic is closed (no messages can be sent to it)"
85128520
},
85138521
"date": {
85148522
"name": "date",
8515-
"description": " "
8523+
"description": "Topic creation date"
85168524
},
85178525
"draft": {
85188526
"name": "draft",
8519-
"description": " "
8527+
"description": "Message draft¹",
8528+
"links": [
8529+
"https://core.telegram.org/api/drafts"
8530+
]
85208531
},
85218532
"flags": {
85228533
"name": "flags",
@@ -8527,11 +8538,11 @@
85278538
},
85288539
"from_id": {
85298540
"name": "from_id",
8530-
"description": " "
8541+
"description": "ID of the peer that created the topic"
85318542
},
85328543
"hidden": {
85338544
"name": "hidden",
8534-
"description": " "
8545+
"description": "Whether the topic is hidden (only valid for the \"General\" topic, id=1)"
85358546
},
85368547
"icon_color": {
85378548
"name": "icon_color",
@@ -8546,51 +8557,57 @@
85468557
},
85478558
"id": {
85488559
"name": "id",
8549-
"description": " "
8560+
"description": "Topic ID¹",
8561+
"links": [
8562+
"https://core.telegram.org/api/forum#forum-topics"
8563+
]
85508564
},
85518565
"my": {
85528566
"name": "my",
8553-
"description": " "
8567+
"description": "Whether the topic was created by the current user"
85548568
},
85558569
"notify_settings": {
85568570
"name": "notify_settings",
8557-
"description": " "
8571+
"description": "Notification settings"
85588572
},
85598573
"pinned": {
85608574
"name": "pinned",
8561-
"description": " "
8575+
"description": "Whether the topic is pinned"
85628576
},
85638577
"read_inbox_max_id": {
85648578
"name": "read_inbox_max_id",
8565-
"description": " "
8579+
"description": "Position up to which all incoming messages are read."
85668580
},
85678581
"read_outbox_max_id": {
85688582
"name": "read_outbox_max_id",
8569-
"description": " "
8583+
"description": "Position up to which all outgoing messages are read."
85708584
},
85718585
"short": {
85728586
"name": "short",
85738587
"description": " "
85748588
},
85758589
"title": {
85768590
"name": "title",
8577-
"description": " "
8591+
"description": "Topic title"
85788592
},
85798593
"top_message": {
85808594
"name": "top_message",
8581-
"description": " "
8595+
"description": "ID of the last message that was sent to this topic"
85828596
},
85838597
"unread_count": {
85848598
"name": "unread_count",
8585-
"description": " "
8599+
"description": "Number of unread messages"
85868600
},
85878601
"unread_mentions_count": {
85888602
"name": "unread_mentions_count",
8589-
"description": " "
8603+
"description": "Number of unread mentions¹",
8604+
"links": [
8605+
"https://core.telegram.org/api/mentions"
8606+
]
85908607
},
85918608
"unread_reactions_count": {
85928609
"name": "unread_reactions_count",
8593-
"description": " "
8610+
"description": "Number of unread reactions to messages you sent"
85948611
}
85958612
}
85968613
},
@@ -35435,36 +35452,6 @@
3543535452
}
3543635453
]
3543735454
},
35438-
"folders.deleteFolder": {
35439-
"name": "folders.deleteFolder",
35440-
"description": [
35441-
"Delete a peer folder¹"
35442-
],
35443-
"links": [
35444-
"https://core.telegram.org/api/folders#peer-folders"
35445-
],
35446-
"parameters": {
35447-
"folder_id": {
35448-
"name": "folder_id",
35449-
"description": "Peer folder ID, for more info click here¹",
35450-
"links": [
35451-
"https://core.telegram.org/api/folders#peer-folders"
35452-
]
35453-
}
35454-
},
35455-
"errors": [
35456-
{
35457-
"code": 400,
35458-
"type": "FOLDER_ID_EMPTY",
35459-
"description": "An empty folder ID was specified."
35460-
},
35461-
{
35462-
"code": 400,
35463-
"type": "FOLDER_ID_INVALID",
35464-
"description": "Invalid folder ID."
35465-
}
35466-
]
35467-
},
3546835455
"folders.editPeerFolders": {
3546935456
"name": "folders.editPeerFolders",
3547035457
"description": [
@@ -48746,11 +48733,6 @@
4874648733
"type": "FIRSTNAME_INVALID",
4874748734
"description": "The first name is invalid."
4874848735
},
48749-
"FOLDER_ID_EMPTY": {
48750-
"code": 400,
48751-
"type": "FOLDER_ID_EMPTY",
48752-
"description": "An empty folder ID was specified."
48753-
},
4875448736
"FOLDER_ID_INVALID": {
4875548737
"code": 400,
4875648738
"type": "FOLDER_ID_INVALID",

_schema/latest.json

Lines changed: 36 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1309,7 +1309,6 @@
13091309
"contacts.search",
13101310
"contacts.toggleTopPeers",
13111311
"contacts.unblock",
1312-
"folders.deleteFolder",
13131312
"folders.editPeerFolders",
13141313
"help.acceptTermsOfService",
13151314
"help.dismissSuggestion",
@@ -7318,7 +7317,10 @@
73187317
"fields": {
73197318
"draft": {
73207319
"name": "draft",
7321-
"description": "Message draft"
7320+
"description": "Message draft¹",
7321+
"links": [
7322+
"https://core.telegram.org/api/drafts"
7323+
]
73227324
},
73237325
"flags": {
73247326
"name": "flags",
@@ -7367,7 +7369,7 @@
73677369
},
73687370
"ttl_period": {
73697371
"name": "ttl_period",
7370-
"description": " "
7372+
"description": "Time-to-live of all messages sent in this dialog"
73717373
},
73727374
"unread_count": {
73737375
"name": "unread_count",
@@ -8505,18 +8507,27 @@
85058507
},
85068508
"forumTopic": {
85078509
"name": "forumTopic",
8510+
"description": [
8511+
"Represents a forum topic¹."
8512+
],
8513+
"links": [
8514+
"https://core.telegram.org/api/forum#forum-topics"
8515+
],
85088516
"fields": {
85098517
"closed": {
85108518
"name": "closed",
8511-
"description": " "
8519+
"description": "Whether the topic is closed (no messages can be sent to it)"
85128520
},
85138521
"date": {
85148522
"name": "date",
8515-
"description": " "
8523+
"description": "Topic creation date"
85168524
},
85178525
"draft": {
85188526
"name": "draft",
8519-
"description": " "
8527+
"description": "Message draft¹",
8528+
"links": [
8529+
"https://core.telegram.org/api/drafts"
8530+
]
85208531
},
85218532
"flags": {
85228533
"name": "flags",
@@ -8527,11 +8538,11 @@
85278538
},
85288539
"from_id": {
85298540
"name": "from_id",
8530-
"description": " "
8541+
"description": "ID of the peer that created the topic"
85318542
},
85328543
"hidden": {
85338544
"name": "hidden",
8534-
"description": " "
8545+
"description": "Whether the topic is hidden (only valid for the \"General\" topic, id=1)"
85358546
},
85368547
"icon_color": {
85378548
"name": "icon_color",
@@ -8546,51 +8557,57 @@
85468557
},
85478558
"id": {
85488559
"name": "id",
8549-
"description": " "
8560+
"description": "Topic ID¹",
8561+
"links": [
8562+
"https://core.telegram.org/api/forum#forum-topics"
8563+
]
85508564
},
85518565
"my": {
85528566
"name": "my",
8553-
"description": " "
8567+
"description": "Whether the topic was created by the current user"
85548568
},
85558569
"notify_settings": {
85568570
"name": "notify_settings",
8557-
"description": " "
8571+
"description": "Notification settings"
85588572
},
85598573
"pinned": {
85608574
"name": "pinned",
8561-
"description": " "
8575+
"description": "Whether the topic is pinned"
85628576
},
85638577
"read_inbox_max_id": {
85648578
"name": "read_inbox_max_id",
8565-
"description": " "
8579+
"description": "Position up to which all incoming messages are read."
85668580
},
85678581
"read_outbox_max_id": {
85688582
"name": "read_outbox_max_id",
8569-
"description": " "
8583+
"description": "Position up to which all outgoing messages are read."
85708584
},
85718585
"short": {
85728586
"name": "short",
85738587
"description": " "
85748588
},
85758589
"title": {
85768590
"name": "title",
8577-
"description": " "
8591+
"description": "Topic title"
85788592
},
85798593
"top_message": {
85808594
"name": "top_message",
8581-
"description": " "
8595+
"description": "ID of the last message that was sent to this topic"
85828596
},
85838597
"unread_count": {
85848598
"name": "unread_count",
8585-
"description": " "
8599+
"description": "Number of unread messages"
85868600
},
85878601
"unread_mentions_count": {
85888602
"name": "unread_mentions_count",
8589-
"description": " "
8603+
"description": "Number of unread mentions¹",
8604+
"links": [
8605+
"https://core.telegram.org/api/mentions"
8606+
]
85908607
},
85918608
"unread_reactions_count": {
85928609
"name": "unread_reactions_count",
8593-
"description": " "
8610+
"description": "Number of unread reactions to messages you sent"
85948611
}
85958612
}
85968613
},
@@ -35435,36 +35452,6 @@
3543535452
}
3543635453
]
3543735454
},
35438-
"folders.deleteFolder": {
35439-
"name": "folders.deleteFolder",
35440-
"description": [
35441-
"Delete a peer folder¹"
35442-
],
35443-
"links": [
35444-
"https://core.telegram.org/api/folders#peer-folders"
35445-
],
35446-
"parameters": {
35447-
"folder_id": {
35448-
"name": "folder_id",
35449-
"description": "Peer folder ID, for more info click here¹",
35450-
"links": [
35451-
"https://core.telegram.org/api/folders#peer-folders"
35452-
]
35453-
}
35454-
},
35455-
"errors": [
35456-
{
35457-
"code": 400,
35458-
"type": "FOLDER_ID_EMPTY",
35459-
"description": "An empty folder ID was specified."
35460-
},
35461-
{
35462-
"code": 400,
35463-
"type": "FOLDER_ID_INVALID",
35464-
"description": "Invalid folder ID."
35465-
}
35466-
]
35467-
},
3546835455
"folders.editPeerFolders": {
3546935456
"name": "folders.editPeerFolders",
3547035457
"description": [
@@ -48746,11 +48733,6 @@
4874648733
"type": "FIRSTNAME_INVALID",
4874748734
"description": "The first name is invalid."
4874848735
},
48749-
"FOLDER_ID_EMPTY": {
48750-
"code": 400,
48751-
"type": "FOLDER_ID_EMPTY",
48752-
"description": "An empty folder ID was specified."
48753-
},
4875448736
"FOLDER_ID_INVALID": {
4875548737
"code": 400,
4875648738
"type": "FOLDER_ID_INVALID",

0 commit comments

Comments
 (0)