You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@allura.apache.org by Björn Kautler <va...@users.sf.net> on 2013/12/05 18:41:57 UTC
[allura:tickets] #6920 Include bulk_export_download_instructions in export
API result
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. :-)
---
** [tickets:#6920] Include bulk_export_download_instructions in export API result**
**Status:** open
**Labels:** export allura-api
**Created:** Tue Nov 26, 2013 06:39 PM UTC by Dave Brondsema
**Last Updated:** Thu Dec 05, 2013 05:36 PM UTC
**Owner:** nobody
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.
---
Sent from sourceforge.net because allura-dev@incubator.apache.org is subscribed to https://sourceforge.net/p/allura/tickets/
To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/allura/admin/tickets/options. Or, if this is a mailing list, you can unsubscribe from the mailing list.
[allura:tickets] Re: #6920 Include bulk_export_download_instructions in
export API result
Posted by Dave Brondsema <br...@users.sf.net>.
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/
---
** [tickets:#6920] Include bulk_export_download_instructions in export API result**
**Status:** open
**Labels:** export allura-api
**Created:** Tue Nov 26, 2013 06:39 PM UTC by Dave Brondsema
**Last Updated:** Thu Dec 05, 2013 05:41 PM UTC
**Owner:** nobody
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.
---
Sent from sourceforge.net because allura-dev@incubator.apache.org is subscribed to https://sourceforge.net/p/allura/tickets/
To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/allura/admin/tickets/options. Or, if this is a mailing list, you can unsubscribe from the mailing list.