/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 は 6 月 24 日リリース）の更新履歴を確認しましたが、API の変更を具体的に記載している項目は見当たりませんでした。

ご支援をいただき、ありがとうございます。

  • Carey
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 でした。

ああ、それはリリースノートにあるこの項目ですね：Improve performance of category topic list（カテゴリトピックリストのパフォーマンス向上）！

API の変更を事前に確認できる場所などはありますか？

迅速なサポートをいただき、改めてありがとうございます。

  • Carey
4

申し訳ありませんが、現時点ではリリースノートや git の変更履歴以外にそのような場所はありません。しかし、この課題については私どもも真剣に検討しています。

5

@th3coop これらのフィールドの削除は元に戻されました。これらは Discourse API Docs に記載されている通り、公開 API と見なされているためです。

6

ご指摘ありがとうございます、@tgxworld さん。API が突然警告もなく変更されたことは、正直少し不安でした。

迅速な対応に感謝します！

  • Carey