https://github.com/ark0f/tg-bot-api

Telegram Bot API parser and generators
https://github.com/ark0f/tg-bot-api

json-schema-definitions openapi rust telegram-bot-api

Last synced: 7 days ago
JSON representation

Telegram Bot API parser and generators

• Host: GitHub
• URL: https://github.com/ark0f/tg-bot-api
• Owner: ark0f
• License: apache-2.0
• Created: 2020-11-17T16:08:38.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-08T01:41:43.000Z (19 days ago)
• Last Synced: 2025-01-12T18:07:13.214Z (14 days ago)
• Topics: json-schema-definitions, openapi, rust, telegram-bot-api
• Language: Rust
• Homepage: https://ark0f.github.io/tg-bot-api
• Size: 1.95 MB
• Stars: 52
• Watchers: 4
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE.md

Awesome Lists containing this project

README

        
# tg-bot-api

[![Actions Status](https://github.com/ark0f/tg-bot-api/workflows/CI/badge.svg)](https://github.com/ark0f/tg-bot-api/actions)

![License](https://img.shields.io/crates/l/tg_bot_api.svg)

[![crates.io](https://img.shields.io/crates/v/tg-bot-api.svg)](https://crates.io/crates/tg-bot-api)

[![Documentation](https://docs.rs/tg-bot-api/badge.svg)](https://docs.rs/tg-bot-api)

Telegram Bot API parser in Rust

Generated schemas can be found at `ark0f.github.io/tg-bot-api`:

OpenAPI:

* [`/openapi.yml`](https://ark0f.github.io/tg-bot-api/openapi.yml) or

  [`/openapi.json`](https://ark0f.github.io/tg-bot-api/openapi.json)

Custom schema thar more convenient to work with:

* [`/custom_v2.json`](https://ark0f.github.io/tg-bot-api/custom_v2.json)

* [`/custom_v2.schema.json`](https://ark0f.github.io/tg-bot-api/custom_v2.schema.json) - JSON Schema Draft #7

  for `/custom_v2.json`

Documentation can be found at [CUSTOM_SCHEMA.md](CUSTOM_SCHEMA.md).

`.min.json` suffix can be used to fetch minimized JSON. For example: `openapi.min.json`, `custom_v2.min.json`, etc.

## Automatic deploy

Schemas are deployed automatically every midnight at UTC+0 and when there is a new commit

in [tdlib/telegram-bot-api](https://github.com/tdlib/telegram-bot-api).

## Custom custom schema v1

This is a note for old users.

Schema still remains and updates at old URLs as earlier:

* [`/custom.json`](https://ark0f.github.io/tg-bot-api/custom.json)

* [`/custom.schema.json`](https://ark0f.github.io/tg-bot-api/custom.schema.json)

See [v2 changes](V2_CHANGES.md) for more details.