/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에서 응답을 변경하는 업데이트가 출시되었는지 궁금합니다. 아니면 이것이 원인이 될 수 있는 관리자 설정이 있는지 알고 계신 분이 있을까요?

최근 업데이트(6월 24일 출시된 2.5) 변경 이력을 살펴봤지만, 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