Merge pull request #309 from gotd/feat/update-schema

feat(schema): update documentation to the latest layer
gotd · Dec 31, 2024 · a588d4d · a588d4d
2 parents 33a1f78 + cbeb205
commit a588d4d
Show file tree

Hide file tree

Showing 2 changed files with 72 additions and 24 deletions.
diff --git a/_schema/195.json b/_schema/195.json
@@ -27491,7 +27491,11 @@
       "name": "restrictionReason",
       "description": [
         "Restriction reason.",
-        "Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the platform field is equal to all or to the current platform (ios, android, wp, etc.). Platforms can be concatenated (ios-android, ios-wp), unknown platforms are to be ignored. The text is the error message that should be shown to the user."
+        "Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the platform field is equal to all or to the current platform (ios, android, wp, etc.). Platforms can be concatenated (ios-android, ios-wp), unknown platforms are to be ignored. The text is the error message that should be shown to the user.",
+        "The restriction_add_platforms »¹ client configuration parameter contains an array of platform identifiers that must also be treated as our own, in additional to the one hardcoded in the client."
+      ],
+      "links": [
+        "https://core.telegram.org/api/config#restriction-add-platforms"
       ],
       "fields": {
         "platform": {
@@ -27500,7 +27504,10 @@
         },
         "reason": {
           "name": "reason",
-          "description": "Restriction reason (porno, terms, etc.)"
+          "description": "Restriction reason (porno, terms, etc.). Ignore this restriction reason if it is contained in the ignore_restriction_reasons »¹ client configuration parameter.",
+          "links": [
+            "https://core.telegram.org/api/config#ignore-restriction-reasons"
+          ]
         },
         "text": {
           "name": "text",
@@ -28711,7 +28718,7 @@
         },
         "birthday": {
           "name": "birthday",
-          "description": " "
+          "description": "Whether this is a birthday-themed gift"
         },
         "convert_stars": {
           "name": "convert_stars",
@@ -36835,10 +36842,7 @@
         },
         "type": {
           "name": "type",
-          "description": "Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else, see here »¹ for a full list.",
-          "links": [
-            "https://github.com/telegramdesktop/tdesktop/blob/4f7a124f3e85f3f61d862b94fb5a45236976f38f/Telegram/SourceFiles/data/data_web_page.cpp#L127"
-          ]
+          "description": "Type of the web page. One of the following: - video- gif- photo- document- profile- telegram_background- telegram_theme- telegram_story- telegram_channel- telegram_channel_request- telegram_megagroup- telegram_chat- telegram_megagroup_request- telegram_chat_request- telegram_album- telegram_message- telegram_bot- telegram_voicechat- telegram_livestream- telegram_user- telegram_botapp- telegram_channel_boost- telegram_group_boost- telegram_giftcode- telegram_stickerset"
         },
         "url": {
           "name": "url",
@@ -55179,6 +55183,11 @@
         }
       },
       "errors": [
+        {
+          "code": 400,
+          "type": "ID_EXPIRED",
+          "description": "The passed prepared inline message ID has expired."
+        },
         {
           "code": 400,
           "type": "ID_INVALID",
@@ -58258,9 +58267,10 @@
         },
         "hash": {
           "name": "hash",
-          "description": "Hash used for caching, for more info click here¹.",
+          "description": "Hash used for caching, for more info click here¹. The hash may be generated locally by using the ids of the returned or stored sticker document²s.",
           "links": [
-            "https://core.telegram.org/api/offsets#hash-generation"
+            "https://core.telegram.org/api/offsets#hash-generation",
+            "https://core.telegram.org/constructor/document"
           ]
         },
         "lang_code": {
@@ -62337,6 +62347,11 @@
           "type": "USER_BANNED_IN_CHANNEL",
           "description": "You're banned from sending messages in supergroups/channels."
         },
+        {
+          "code": 400,
+          "type": "VOICE_MESSAGES_FORBIDDEN",
+          "description": "This user's privacy settings forbid you from sending voice messages."
+        },
         {
           "code": 400,
           "type": "WEBPAGE_CURL_FAILED",
@@ -62898,7 +62913,10 @@
         },
         "theme_params": {
           "name": "theme_params",
-          "description": "A JSON object with the following keys, containing color theme information (integers, RGB24) to pass to the payment provider, to apply in eventual verification pages: bg_color - Background color text_color - Text color hint_color - Hint text color link_color - Link color button_color - Button color button_text_color - Button text color"
+          "description": "Theme parameters »¹",
+          "links": [
+            "https://core.telegram.org/api/bots/webapps#theme-parameters"
+          ]
         }
       },
       "errors": [
@@ -63001,9 +63019,10 @@
       "parameters": {
         "hash": {
           "name": "hash",
-          "description": "Hash used for caching, for more info click here¹.",
+          "description": "Hash used for caching, for more info click here¹.The hash may be generated locally by using the ids of the returned or stored sticker starGift²s.",
           "links": [
-            "https://core.telegram.org/api/offsets#hash-generation"
+            "https://core.telegram.org/api/offsets#hash-generation",
+            "https://core.telegram.org/constructor/starGift"
           ]
         }
       }
@@ -69427,6 +69446,11 @@
       "type": "HIDE_REQUESTER_MISSING",
       "description": "The join request was missing or was already handled."
     },
+    "ID_EXPIRED": {
+      "code": 400,
+      "type": "ID_EXPIRED",
+      "description": "The passed prepared inline message ID has expired."
+    },
     "ID_INVALID": {
       "code": 400,
       "type": "ID_INVALID",

diff --git a/_schema/latest.json b/_schema/latest.json
@@ -27491,7 +27491,11 @@
       "name": "restrictionReason",
       "description": [
         "Restriction reason.",
-        "Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the platform field is equal to all or to the current platform (ios, android, wp, etc.). Platforms can be concatenated (ios-android, ios-wp), unknown platforms are to be ignored. The text is the error message that should be shown to the user."
+        "Contains the reason why access to a certain object must be restricted. Clients are supposed to deny access to the channel if the platform field is equal to all or to the current platform (ios, android, wp, etc.). Platforms can be concatenated (ios-android, ios-wp), unknown platforms are to be ignored. The text is the error message that should be shown to the user.",
+        "The restriction_add_platforms »¹ client configuration parameter contains an array of platform identifiers that must also be treated as our own, in additional to the one hardcoded in the client."
+      ],
+      "links": [
+        "https://core.telegram.org/api/config#restriction-add-platforms"
       ],
       "fields": {
         "platform": {
@@ -27500,7 +27504,10 @@
         },
         "reason": {
           "name": "reason",
-          "description": "Restriction reason (porno, terms, etc.)"
+          "description": "Restriction reason (porno, terms, etc.). Ignore this restriction reason if it is contained in the ignore_restriction_reasons »¹ client configuration parameter.",
+          "links": [
+            "https://core.telegram.org/api/config#ignore-restriction-reasons"
+          ]
         },
         "text": {
           "name": "text",
@@ -28711,7 +28718,7 @@
         },
         "birthday": {
           "name": "birthday",
-          "description": " "
+          "description": "Whether this is a birthday-themed gift"
         },
         "convert_stars": {
           "name": "convert_stars",
@@ -36835,10 +36842,7 @@
         },
         "type": {
           "name": "type",
-          "description": "Type of the web page. Can be: article, photo, audio, video, document, profile, app, or something else, see here »¹ for a full list.",
-          "links": [
-            "https://github.com/telegramdesktop/tdesktop/blob/4f7a124f3e85f3f61d862b94fb5a45236976f38f/Telegram/SourceFiles/data/data_web_page.cpp#L127"
-          ]
+          "description": "Type of the web page. One of the following: - video- gif- photo- document- profile- telegram_background- telegram_theme- telegram_story- telegram_channel- telegram_channel_request- telegram_megagroup- telegram_chat- telegram_megagroup_request- telegram_chat_request- telegram_album- telegram_message- telegram_bot- telegram_voicechat- telegram_livestream- telegram_user- telegram_botapp- telegram_channel_boost- telegram_group_boost- telegram_giftcode- telegram_stickerset"
         },
         "url": {
           "name": "url",
@@ -55179,6 +55183,11 @@
         }
       },
       "errors": [
+        {
+          "code": 400,
+          "type": "ID_EXPIRED",
+          "description": "The passed prepared inline message ID has expired."
+        },
         {
           "code": 400,
           "type": "ID_INVALID",
@@ -58258,9 +58267,10 @@
         },
         "hash": {
           "name": "hash",
-          "description": "Hash used for caching, for more info click here¹.",
+          "description": "Hash used for caching, for more info click here¹. The hash may be generated locally by using the ids of the returned or stored sticker document²s.",
           "links": [
-            "https://core.telegram.org/api/offsets#hash-generation"
+            "https://core.telegram.org/api/offsets#hash-generation",
+            "https://core.telegram.org/constructor/document"
           ]
         },
         "lang_code": {
@@ -62337,6 +62347,11 @@
           "type": "USER_BANNED_IN_CHANNEL",
           "description": "You're banned from sending messages in supergroups/channels."
         },
+        {
+          "code": 400,
+          "type": "VOICE_MESSAGES_FORBIDDEN",
+          "description": "This user's privacy settings forbid you from sending voice messages."
+        },
         {
           "code": 400,
           "type": "WEBPAGE_CURL_FAILED",
@@ -62898,7 +62913,10 @@
         },
         "theme_params": {
           "name": "theme_params",
-          "description": "A JSON object with the following keys, containing color theme information (integers, RGB24) to pass to the payment provider, to apply in eventual verification pages: bg_color - Background color text_color - Text color hint_color - Hint text color link_color - Link color button_color - Button color button_text_color - Button text color"
+          "description": "Theme parameters »¹",
+          "links": [
+            "https://core.telegram.org/api/bots/webapps#theme-parameters"
+          ]
         }
       },
       "errors": [
@@ -63001,9 +63019,10 @@
       "parameters": {
         "hash": {
           "name": "hash",
-          "description": "Hash used for caching, for more info click here¹.",
+          "description": "Hash used for caching, for more info click here¹.The hash may be generated locally by using the ids of the returned or stored sticker starGift²s.",
           "links": [
-            "https://core.telegram.org/api/offsets#hash-generation"
+            "https://core.telegram.org/api/offsets#hash-generation",
+            "https://core.telegram.org/constructor/starGift"
           ]
         }
       }
@@ -69427,6 +69446,11 @@
       "type": "HIDE_REQUESTER_MISSING",
       "description": "The join request was missing or was already handled."
     },
+    "ID_EXPIRED": {
+      "code": 400,
+      "type": "ID_EXPIRED",
+      "description": "The passed prepared inline message ID has expired."
+    },
     "ID_INVALID": {
       "code": 400,
       "type": "ID_INVALID",