search

useshortcut / shortcut-client-js

The official JavaScript client library for the Shortcut (formerly Clubhouse) REST API.
https://useshortcut.github.io/shortcut-client-js/
133 stars 31 forks source link

listStories does not include the `description` field. #80

Closed mjsz closed 3 years ago

mjsz commented 4 years ago

Documentation says it should: https://clubhouse.io/api/rest/v3/#StorySlim

mjsz commented 4 years ago

(this may be a bug in the actual v3 API, not this library, but not sure where to file that)

charpeni commented 3 years ago

Thanks for flagging this behavior and sorry for the delay!

https://github.com/clubhouse/clubhouse-lib/blob/1c56fad392e1b61f16c56836373878b375d96f8b/src/index.ts#L215-L217

listStories is calling List Stories which is returning a StorySlim. By default, the description field isn't included but it could be by passing a boolean includes_description in the body of List Stories.

I'll add a parameter to listStories to allow this.

charpeni commented 3 years ago

Released as part of clubhouse-lib@0.11.0.