staging_failed_reason and staging_failed_description type information missing

[Zteve]

In (e.g.) https://apidocs.cloudfoundry.org/214/apps/list_all_apps.html and in other v2 REST API responses, the examples show null for these fields. Presumably they are Strings. Can you document this, please?

[cf-gitbot]

We have created an issue in Pivotal Tracker to manage this. You can view the current status of your issue at: https://www.pivotaltracker.com/story/show/105994026.

[jeffpak]

Hi @Zteve ,

Thanks for bringing this up! This is a known issue for these API docs that will be addressed when we update and revamp the docs in the near future. Until then, we would suggest that you interact with any field that you feel unsure of directly to guarantee its type. It is safe to presume that those fields are strings.

If this addresses your concerns, feel free to close this issue.

Best,
@jeffpak93, CF CAPI Team

[youreddy]

Hi @Zteve ,

Apologies for the long response time. We've just made a commit that addresses your issue, and it will be available in the next release of the documentation.

If this does correctly address your concern, please feel free to close this issue.

Cheers,
@youreddy and @wendorf, CF CAPI Team

[Zteve]

Great, thanks. There is a small typo in the description of the staging_failure_description field. Not important.

[youreddy]

@Zteve,

Just fixed the typo! 44e4e94

Thanks,
@youreddy, CF CAPI Team