rapidpro / ureport

Dashboard module for UReport working against RapidPro data
GNU Affero General Public License v3.0
24 stars 35 forks source link

Suggested changes in Stories API to get list of stories without specific attributes #835

Open ershadul-hoque opened 2 years ago

ershadul-hoque commented 2 years ago

We were working at our end to modify the Story API so that we can get a list of stories without specific attributes (when needed). One thing we kept in mind is that we can't change the current API result format since there may be other apps/services who are using the same API. So, we're proposing one format below which can be used in 2 different ways, requesting suggestions from others:

/api/v1/stories/org/{org}/?fields=content,summary

Option 1: We can exclude those attributes (content,summary) from the API result

Option 2: We can only include those attributes (content,summary) in the API result (by excluding everything else)

Which should be the best way to move forward?

norkans7 commented 2 years ago

/api/v1/stories/org/{org}/?fields=content,summary

should return the stories with only the content and summary

If you want to exclude them you can use

/api/v1/stories/org/{org}/?exclude=content,summary

And yes the default should be what is currently returned.