Document valid compressionFormat values in Data Warehouse endpoint - #681
Document valid compressionFormat values in Data Warehouse endpoint#681ZLeventer wants to merge 1 commit into
Conversation
Add explicit outputFile response parameters table to GET report by ID section, enumerating compressionFormat valid values (default, zip, gzip) that were previously only discoverable via API error messages.
|
@ZLeventer thank you for this suggestion. The guide already includes these values in the request parameter table for the POST endpoint. 
The problem is that this service is so big that we decided to only document object members only once in the guide. So if an object member appears in a previous parameter table, it is not documented again in a subsequent table. Whether it is a request or response. We had to do this because the guide became so large otherwise. We preface each subsequent table by mentioning that it will only include what is not described above. But there is something I want to understand more clearly. How is this error message happening? Should this be described as a "required" parameter or are the string values needed just not what would be expected? Do you have any additional ideas to help users avoid this error? Thanks for any info. |
2 participants
Closes #635. Enumerates the valid compressionFormat values (default, zip, gzip) that the API accepts but were previously undocumented. Users currently only discover these values from API error messages.