# Описание полей, возвращаемых API Discourse

**URL:** <https://meta.discourse.org/t/description-of-fields-returned-by-discourse-api/168968>\
**Category:** Development\
**Tags:** rest-api\
**Created:** [02.Ноябрь.2020 07:28:20 UTC](https://meta.discourse.org/t/description-of-fields-returned-by-discourse-api/168968 "2020-11-02T07:28:20Z")\
**Posts on this page:** 1\
**Showing post:** 4

<div class="post-metadata">

**Author:** ![simon](https://sea3.discourse-cdn.com/meta/user_avatar/meta.discourse.org/simon/32/339122_2.png) [@simon](https://meta.discourse.org/u/simon)\
**Post date:** [03.Ноябрь.2020 22:34:16 UTC](https://meta.discourse.org/t/description-of-fields-returned-by-discourse-api/168968/4 "2020-11-03T22:34:16Z")

</div>

> [@Goutham\_Tholpadi](#):
>
> Я провёл небольшое исследование на основе ваших предложений и нашёл [этот фрагмент кода](https://github.com/discourse/discourse/blob/master/app/models/user_action.rb) для `user_actions`, но, несмотря на значительные поиски, не смог найти ничего подобного для `post_type`.

Это понятно. Однако аналогичный код существует. Он находится здесь: [discourse/app/models/post.rb at main · discourse/discourse · GitHub](https://github.com/discourse/discourse/blob/master/app/models/post.rb#L145). Структура базы данных Discourse очень последовательна. Надеюсь, это поможет компенсировать отсутствие документации.

> [@Goutham\_Tholpadi](#):
>
> Я надеялся, что каждый поле, возвращаемое API, будет где-то задокументировано, по крайней мере, для важных полей, несущих значимую семантику.

Не уверен, что каждое поле, возвращаемое API, будет задокументировано, но документирование различных мест, где возвращаются числовые коды, кажется важным. Примерами этого являются:

- `Post.types`
- `UserAction.types`
- `Notification.types`
- `NotificationLevels.all`
- `UserOption.email_level_types`

Если мы решим это сделать, я не уверен, где лучше всего разместить документацию. Возможно, на [https://docs.discourse.org/](https://docs.discourse.org/), но могут возникнуть технические сложности с такой реализацией.

---

_[View the full topic](https://meta.discourse.org/t/description-of-fields-returned-by-discourse-api/168968)._