#6920 Include bulk_export_download_instructions in export API result
open
nobody
General
nobody
2015-03-29
2013-11-26
No
The bulk_export_download_instructions text that is included in emails after an export should also be included in the success API result for a bulk export. Then users of the API will have instructions handy and not have to do a manual export to get them via email.
Originally by: vampire0
These instructions should not only be added to the result (if at all), but also to the API documentation.
As an API user I'd expect all information to be available in the written documentation, not in the API results.
I usually wouldn't look into the result of an API call for instructions on how to proceed further, but in the API docs, that's why I requested an update of the docs, not the result. :-)
Also it would produce unnecessary traffic, as then every export request will be bigger by those instructions that a backup script probably cannot use if it is targeted at a human reader. That's why I asked for a fix in the documentation. :-)
I agree. However, the instructions are deployment-dependent and the API docs are generic for any Allura site. (Yes, they are currently hosted on SourceForge currently but we plan to move them in [#6797]).
So I have added more info to https://sourceforge.net/p/forge/documentation/Project%20Data%20Export/ but not to https://sourceforge.net/p/forge/documentation/Allura%20API/
Related
Tickets:
#6797Originally by: vampire0
Great, thanks. :-)