The official Telegram Bot API documentation at https://core.telegram.org/bots/api lacks a machine-readable schema format (OpenAPI/Swagger, JSON Schema, or similar). This presents several challenges:
-
No auto-generated client SDKs – Developers must manually write API clients or rely on third-party libraries that may be outdated or incomplete.
-
No automated validation – Request/response validation requires manual implementation, increasing the risk of errors.
-
No interactive API exploration – Tools like Swagger UI or Redoc cannot be used to explore and test the API interactively.
-
Difficult to keep client libraries in sync – When the API changes (which happens frequently, as seen in recent Bot API 10.0 updates), library maintainers must manually update their code.
-
Type definitions are informal – The documentation describes types as "JSON-objects" with tables, but there's no formal type schema that can be imported into IDEs or used for code generation.
An OpenAPI specification would address all of these issues and significantly improve the developer experience.
If such a schema already exists, could you please share it or point me to where it can be found? If not, would it be possible to prioritize creating one?
The official Telegram Bot API documentation at https://core.telegram.org/bots/api lacks a machine-readable schema format (OpenAPI/Swagger, JSON Schema, or similar). This presents several challenges:
No auto-generated client SDKs – Developers must manually write API clients or rely on third-party libraries that may be outdated or incomplete.
No automated validation – Request/response validation requires manual implementation, increasing the risk of errors.
No interactive API exploration – Tools like Swagger UI or Redoc cannot be used to explore and test the API interactively.
Difficult to keep client libraries in sync – When the API changes (which happens frequently, as seen in recent Bot API 10.0 updates), library maintainers must manually update their code.
Type definitions are informal – The documentation describes types as "JSON-objects" with tables, but there's no formal type schema that can be imported into IDEs or used for code generation.
An OpenAPI specification would address all of these issues and significantly improve the developer experience.
If such a schema already exists, could you please share it or point me to where it can be found? If not, would it be possible to prioritize creating one?