API Documentation enhancement - Include Details on valid paramters

paulmorrisey

I think the fact this documentation exists now is a big improvement over not existing but I think it could be better. The documentation doesn't provide what parameters are valid for an endpoint leaving it up to a the developer to figure out.

Using this specific API endpoint as an example of how there are important missing details in the endpoint documentation.

https://developer.domo.com/portal/35115c5c48927-datasets-api#share-dataset-with-access-permissions

HTTP body parameters for this endpoint include sendEmail, Type, Access level. What this document doesn't tell us as of 2025-04-11 is what parameters are valid and what they do.

I assembled this quickly for my use case, but I feel that parameters should be included with the documentation provided.

sendEmail

sendEmail value	Comment
sendEmail value	true	Comment	Send an email Notification to the User/Group.
sendEmail value	false	Comment	Don’t send an email Notification to the User/Group. When automating I would suggest developer should chose this to be the default choice to avoid spamming users and groups.

Type

Type value	Comment
Type value	USER	Comment	To share a dataset to a Domo User (User id) You can get this by clicking on the person in the people management page https://{instance}.domo.com/admin/people and getting it from the address bar of the page that opens https://{instance}/admin/people/{UserId}?tab=profile
Type value	GROUP	Comment	For use with a Domo Group ID (GroupId) You can get this by clicking on the group in the group management page https://{instance}.domo.com/admin/groups and getting it from the address bar of the page that opens https://{instance}.domo.com/admin/groups/{GroupId}?tab=people

Access level

Type value	Comment
Type value	CAN_EDIT	Comment	Allows for Editing and Deleting Dataset (same as owner)
Type value	CO_OWNER	Comment	Allows for editing and Sharing Dataset, but can’t delete
Type value	CAN_SHARE	Comment	Allows for sharing but, can’t edit Dataset at all.