Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

слбытие и не только в нашей ежедневной рубрике "фиксы документации" #21

Merged
merged 6 commits into from Sep 3, 2023
Merged

слбытие и не только в нашей ежедневной рубрике "фиксы документации" #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5127acb
слбытие
Aug 29, 2023
41d7b5b
хоть бы не сломалось
Aug 29, 2023
384639a
Merge branch 'boticord:main' into main
Aug 29, 2023
ef55a97
остальное завтра
Aug 29, 2023
56c1ce7
почему /libs если /sdk....
Aug 29, 2023
fe2c523
я вспомнил про этот шедевр!
Sep 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/api/bots.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ description: Документация для взаимодействия с б

---

## Tags
## Tags

Теги бота

Expand Down Expand Up @@ -132,5 +132,5 @@ description: Документация для взаимодействия с б

## PartialUser

Тип PartialUser использует свойства из [UserProfiIe](/api/profiles#userprofile), но не имеет в себе
свойств `badges` `bots` `servers`
Тип PartialUser использует свойства из [UserProfile](/api/profiles#userprofile), но не имеет в себе
свойств `badges` `bots` `servers`
21 changes: 11 additions & 10 deletions docs/api/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ https://api.boticord.top/
# Версии API {#versions}
| Версия | URL | Статус |
|--------|-----------------------------|----------|
| 3 | https://api.boticord.top/v3 | Активно |
| 2 | https://api.boticord.top/v2 | Устарело |
| 1 | https://api.boticord.top/v1 | Устарело |
| 3 | https://api.boticord.top/v3 | Активна |
| 2 | https://api.boticord.top/v2 | Устарела |
| 1 | https://api.boticord.top/v1 | Устарела |

# Авторизация {#auth}
Большинство API-методов требуют указания API-токена авторизации. Он передаётся в заголовке `Authorization`.
Expand All @@ -26,21 +26,22 @@ Authorization: Token

# Обязательные параметры {#required-params}
В любых POST запросах обязательно должен присутствовать заголовок (header) `Content-Type` со значением `application/json`.
В ином случае вы получите ошибку 500 UnknownError.
В ином случае вы получите ошибку 500 (`UnknownError`).

## Получение API ключа {#key}
Чтобы получить API ключ:
1. Перейдите в свой профиль.
2. Откройте настройки профиля.
3. Нажмите на кнопку `Сгенерировать ключ` (почти в самом низу).
4. Скопируйте ключ и используйте его в запросах.
3. Перейдите на вкладку `Настройки API`.
4. Нажмите на кнопку `Сгенерировать ключ` (почти в самом низу).
5. Скопируйте ключ и используйте его в запросах.
**Данный токен действителен только для ботов и серверов, которыми владеет аккаунт, сгенерировавший его**

# Рейтлимиты {#rate-limit}
:::caution Внимание
При превышении лимитов, ваши запросы будут временно заблокированы. При злоупотреблении вы можете получить перманентную блокировку к ресурсу.
:::
Глобальный лимит: 25 запросов за 10 секунд. Блокировка 10 секунд.
Глобальный лимит: 25 запросов за 10 секунд. В случае превышения блокировка составляет 10 секунд.

# Статус коды {#status-code}
| Код | Описание |
Expand Down Expand Up @@ -70,7 +71,7 @@ import CodeBlock from '@theme/CodeBlock';
`}
</CodeBlock>
</TabItem>
<TabItem value="50" label="Ошибка 4xx 5xx">
<TabItem value="50" label="Ошибка 4xx/5xx">
При какой-либо ошибке, сервер пришлёт следующие данные:
<CodeBlock language='json' showLineNumbers>{`{
"ok": false,
Expand All @@ -84,7 +85,7 @@ import CodeBlock from '@theme/CodeBlock';
}
`}
</CodeBlock>
Свойство <code>code</code> это номер ошибки из <a href={'#errors'}>таблицы</a>, с помощью этих номеров
Свойство <code>code</code> это номер ошибки из <a href={'#errors'}>таблицы</a>. С помощью этих номеров
легко запрограммировать определённый ответ на ошибку (например, перевод). Эти номера никогда не будут меняться,
но могут быть добавлены новые.
Свойство <code>message</code> это краткое описание ошибки на английском языке для быстрого дебаггинга ошибки.
Expand Down Expand Up @@ -139,7 +140,7 @@ import CodeBlock from '@theme/CodeBlock';
| 40 | UnknownBoost | Неизвестный буст |
| 41 | BoostExpired | Буст истёк |
| 42 | AlreadyCommented | Нельзя оставить отзыв дважды |
| 43 | ReviewRatingsConflict | Конфликт сервера с сервером в расчёте рейтинга. Слишком высокий рейтинг отзыва в бд |
| 43 | ReviewRatingsConflict | Конфликт сервера с сервером в расчёте рейтинга. Слишком высокий рейтинг отзыва в БД |
| 44 | TooManyConsecutiveMessages | Слишком много сообщений подряд |
| 45 | NoServiceBot | Сервисный бот не приглашён |
| 46 | AlreadyReported | Вы уже отправили репорт |
Expand Down
8 changes: 4 additions & 4 deletions docs/api/profiles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: Документация для взаимодействия с п

| Тип | Путь | Результат |
|-----|-------------|------------------------------|
| GET | /users/:id | [UserProfiIe](#userprofile) |
| GET | /users/:id | [UserProfile](#userprofile) |

# Типы данных {#types}

Expand All @@ -30,7 +30,7 @@ description: Документация для взаимодействия с п
| servers | [PartialServer](/api/servers/#ResourceServer) | Сервера пользователя |
| socials? | объект [UserLinkTypes](#UserLinkTypes) | Ссылки пользователя |
| description? | строка | Описание профиля |
| shortDescription? | строка | Короткое описание профиля |
| shortDescription? | строка | Короткое описание профиля |
| status? | строка | Статус пользователя |
| shortDomain? | строка | Короткая ссылка |

Expand All @@ -43,8 +43,8 @@ description: Документация для взаимодействия с п

| Поле | Тип | Описание |
|------------|---------|------------------|
| id | число | ID значка
| name | строка | Название значка
| id | число | ID значка |
| name | строка | Название значка |
| assetURL | строка | Ссылка на иконку |

## UserLinkTypes
Expand Down
36 changes: 18 additions & 18 deletions docs/api/search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,22 @@ published: true

## MeiliIndexedBot

| Поле | Тип | Описание |
|--------------------|----------------------------------|-------------------------|
| id | строка | ID бота |
| name | строка | Имя бота |
| discriminator | строка | Дискриминатор бота |
| description | строка | Описание бота |
| shortDescription | строка | Короткое описание бота |
| invite | строка | Приглашение бота |
| avatar? | строка | Аватар бота |
| premiumActive | true/false | Наличие Premium статуса |
| premiumBanner? | строка | Баннер бота |
| ups | число | Количество апов |
| created | число | Дата создания |
| rating | число | Рейтинг бота |
| banner | число | ID баннера сайта |
| Поле | Тип | Описание |
|--------------------|----------------------------------|----------------------------|
| id | строка | ID бота |
| name | строка | Имя бота |
| discriminator | строка | Дискриминатор бота |
| description | строка | Описание бота |
| shortDescription | строка | Короткое описание бота |
| invite | строка | Приглашение бота |
| avatar? | строка | Аватар бота |
| premiumActive | true/false | Наличие Premium статуса |
| premiumBanner? | строка | Баннер бота |
| ups | число | Количество апов |
| created | число | Дата создания |
| rating | число | Рейтинг бота |
| banner | число | ID баннера сайта |
| members? | число | Количество пользователей |
| guilds? | число | Количество серверов |
| shards? | число | Количество шардов |
| tags | массив [BotTags](/api/bots#tags) | Теги бота |
| guilds? | число | Количество серверов |
| shards? | число | Количество шардов |
| tags | массив [BotTags](/api/bots#tags) | Теги бота |
16 changes: 8 additions & 8 deletions docs/api/servers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: Документация для взаимодействия с с

| Тип | Путь | Параметры | Результат |
|-----|--------------|-------------------|-----------------------------------|
| GET | /servers/:id | :id - ID сервера | [ResourceServer](#resourceserver)
| GET | /servers/:id | :id - ID сервера | [ResourceServer](#resourceserver) |

# Типы данных {#types}

Expand All @@ -33,7 +33,7 @@ description: Документация для взаимодействия с с
| premiumAutoFetch? | true/false | Автообовление информации |
| standardBannerID | число | ID стандартного баннера |
| premiumBannerURL? | строка | URL Премиум баннера сервера |
| owner | строка | ID владельца сервера |
| owner | строка | ID владельца сервера |
| status | [ResourceStatus](#resourcestatus) | Статус сервера |
| ratings | массив [ResourceRating](#resourcerating) | Рейтинг сервера |
| createdDate | строка | Дата создания |
Expand All @@ -54,16 +54,16 @@ description: Документация для взаимодействия с с
|------|-----------|---------------------------|
| 0 | Hidden | Сервер скрыт |
| 1 | Public | Сервер на мониторинге |
| 2 | Banned | Сервер забанен |
| 2 | Banned | Сервер забанен |
| 3 | Pending | Сервер ожидает проверки |

## ResourceRating

Рейтинг Сервера

| Поле | Тип | Описание |
|----------|--------|--------------------|
| count | число | Количество оценок |
| Поле | Тип | Описание |
|---------|--------|--------------------|
| count | число | Количество оценок |
| rating | число | Рейтинг от 1 до 5 |

---
Expand Down Expand Up @@ -102,10 +102,10 @@ description: Документация для взаимодействия с с

| Поле | Тип | Описание |
|-----------|----------|-------------------------------------|
| id | строка | ID апа
| id | строка | ID апа |
| expires | число | Дата истечения, unix timestamp ms |

## PartialUser

Тип PartialUser использует свойства из [UserProfiIe](/api/profiles#userprofile), но не имеет в себе
Тип PartialUser использует свойства из [UserProfile](/api/profiles#userprofile), но не имеет в себе
свойств `badges` `bots` `servers`
8 changes: 4 additions & 4 deletions docs/contributing.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_position: 100
Любой желающий может внести свой вклад в развитие проекта. Для этого необходимо следовать следующим правилам:

## Основное {#main}
1. Все изменения должны быть четко описаны в коммите и pull request'е.
1. Все изменения должны быть четко описаны в Commit\`е и Pull Request\`е.
2. Ведите себя прилично. Не используйте нецензурную лексику и не оскорбляйте других участников проекта.
3. Желательно пользоваться английским языком, поскольку является международным языком

Expand All @@ -23,15 +23,15 @@ sidebar_position: 100

### Примеры {#example}
1. <strike>Changed text</strike> ❌ Коммит не описывает, почему изменен текст, где.
3. **chore(Faq): Added additional answer to the question ** ✅ Идеально!
2. **chore(Faq): Added additional answer to the question ** ✅ Идеально!


## Документация {#docs}
Документация должна быть написана на русском языке. Для написания документации используется [Docusaurus](https://docusaurus.io/).
Если вы хотите изменить документацию на другом языке, то используйте [Crowdin](https://crowdin.com/project/boticord).

## Я разработчик библиотеки для вашего API, как мне добавить её в вашу документацию? {#add-sdk}
Чтобы это сделать, создайте форк репозитория, добавьте нужную документацию, используя [форматирование Markdown](https://docusaurus.io/docs/markdown-features) и отправьте pull request в наш репозиторий.
Чтобы это сделать, создайте fork репозитория, добавьте нужную документацию, используя [форматирование Markdown](https://docusaurus.io/docs/markdown-features) и отправьте Pull Request в наш репозиторий.
Чтобы находится в документации отдельной страницей, обязательно передать репозиторий в организацию https://github.com/boticord

Шаблон страницы в документации для библиотеки:
Expand All @@ -44,7 +44,7 @@ slug: /sdk/имя

<описание библиотеки>
```
Форма pull request'а:
Форма Pull Request`а:
```md
Добавлена информация о библиотеке <название библиотеки>

Expand Down
2 changes: 1 addition & 1 deletion docs/home.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ BotiCord — сайт для поиска самых разнообразных
Начните работу с API с

- [Изучением основ работы API](/api)
- [Использованием готовых библиотек](/libs)
- [Использованием готовых библиотек](/sdk)