Изменения в теле ответа /search/query по неизвестной причине

Разработка
1

Привет!

Мы внедрили функцию на нашем сайте, которая запрашивает размещённые у нас форумы Discourse и отображает информацию о найденных темах. На прошлой неделе после развёртывания всё работало отлично, но в выходные функция перестала работать. Оказалось, что структура объектов topic, возвращаемых запросом, существенно изменилась.

Ожидаемый объект ответа, основанный на тестировании в процессе разработки и соответствующий последней документации:

"topics": [
        {
            "id": 1099,
            "title": "Build Error: ipykernel 4.8.2 for python 3.6.6 on Windows",
            "fancy_title": "Build Error: ipykernel 4.8.2 for python 3.6.6 on Windows",
            "slug": "build-error-ipykernel-4-8-2-for-python-3-6-6-on-windows",
            "posts_count": 1,
            "reply_count": 0,
            "highest_post_number": 1,
            "image_url": null,
            "created_at": "2020-06-30T23:36:42.277Z",
            "last_posted_at": "2020-06-30T23:36:42.357Z",
            "bumped": true,
            "bumped_at": "2020-06-30T23:36:42.357Z",
            "archetype": "regular",
            "unseen": false,
            "pinned": false,
            "unpinned": null,
            "visible": true,
            "closed": false,
            "archived": false,
            "bookmarked": null,
            "liked": null,
            "thumbnails": null,
            "tags": [
                "windows",
                "builder"
            ],
            "category_id": 1,
            "has_accepted_answer": false
        }
    ],

Фактический/текущий ответ:

 "topics": [
        {
            "id": 1494,
            "fancy_title": "Build Error: python-magic 0.4.15 for Python 3.8.2 on Mac",
            "slug": "build-error-python-magic-0-4-15-for-python-3-8-2-on-mac",
            "posts_count": 1,
            "archetype": "regular",
            "pinned": false,
            "unpinned": null,
            "visible": true,
            "closed": false,
            "archived": false,
            "bookmarked": null,
            "liked": null,
            "tags": [
                "mac",
                "builder"
            ],
            "category_id": 1,
            "has_accepted_answer": false
        }
    ],

Мне интересно, не было ли выпущено обновление, изменившее ответы от API поиска? Или, что более вероятно, не знает ли кто-нибудь о настройке администратора, которая могла бы вызвать такое?

Я просмотрел журнал изменений за последний релиз (версия 2.5, выпущенная 24 июня), но не нашёл ничего, что конкретно упоминало бы изменение API.

Заранее спасибо за любую помощь.

  • Кэри
2

Да, недавно из полезной нагрузки, возвращаемой для поисковых запросов, были удалены следующие атрибуты темы:

    image_url
    thumbnails
    title
    created_at
    last_posted_at
    bumped_at
    bumped
    highest_post_number
    reply_count
    unseen

Это изменение было сделано по соображениям производительности. Вы всё ещё можете получить заголовок с помощью атрибута fancy_title. Мы обновим документацию, чтобы отразить это изменение.

3

Большое спасибо, @simon,

Спасибо за разъяснение. К счастью, мы уже использовали fancy_title. Проблема возникла из-за created_at.

Ах, так это, должно быть, пункт в примечаниях к выпуску: Улучшение производительности списка тем категории!

Есть ли где-то место, где можно следить за будущими изменениями в API?

Ещё раз спасибо за быструю помощь.

  • Кэри
4

Извините, в данный момент, помимо примечаний к выпуску и изменений в git, такой возможности нет, но мы определённо работаем над решением этой проблемы.

5

@th3coop Удаление этих полей было отменено, так как они считаются частью публичного API согласно Discourse API Docs.

6

Спасибо за предупреждение, @tgxworld. Признаю, было немного неприятно, что API внезапно изменился без предупреждения.

Спасибо за быстрое решение!

  • Кэри