Discourse API가 반환하는 필드 설명

개발
4

이해할 수 있는 부분입니다. 다만 유사한 코드는 존재합니다. 여기 있습니다: discourse/app/models/post.rb at main · discourse/discourse · GitHub. Discourse 데이터베이스의 구조는 매우 일관성이 있습니다. 문서가 부족하다는 점을 상쇄하는 데 도움이 되길 바랍니다.

API가 반환하는 모든 필드가 문서화될지는 확신할 수 없지만, 숫자 코드가 반환되는 여러 위치를 문서화하는 것은 중요해 보입니다. 예를 들면 다음과 같습니다:

  • Post.types
  • UserAction.types
  • Notification.types
  • NotificationLevels.all
  • UserOption.email_level_types

이 작업을 진행한다면, 문서화의 가장 적합한 위치가 어디일지 확신할 수 없습니다. https://docs.discourse.org/에 올리는 것이 가능해 보이지만, 그렇게 하는 데 기술적인 문제가 발생할 수도 있습니다.