Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

API docs incorrect for v2 spaces #704

Closed
ScarletTanager opened this issue Oct 24, 2016 · 5 comments
Closed

API docs incorrect for v2 spaces #704

ScarletTanager opened this issue Oct 24, 2016 · 5 comments

Comments

@ScarletTanager
Copy link
Contributor

Hi,

http://apidocs.cloudfoundry.org/245/spaces/update_a_space.html says that one can do a PUT on the space to change the organization guid - this is not AFAIK correct. It is probably worthwhile with the new flattened API docs to check that they are completely accurate.

@cf-gitbot
Copy link

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/133055661

The labels on this github issue will be updated when the story is started.

luan pushed a commit that referenced this issue Dec 6, 2016
[GH: #704]
[Finishes #133055661]

Signed-off-by: Luan Santos <[email protected]>
@luan
Copy link
Contributor

luan commented Dec 6, 2016

Hi @ScarletTanager,

We addressed the documentation issue. The field is actually acceptable in that request, the issue is that the only valid value you can pass in is the guid of the currently associated org, and it will default to that.
This is not a particularly useful field to have in the API request, but it allows one to pass in the full space object back to the API, enabling for scripting and automation.

Thanks,
@luan & @ericpromislow, CF CAPI Team

@ScarletTanager
Copy link
Contributor Author

ScarletTanager commented Dec 7, 2016

@luan - what you say about passing in the complete object makes sense from a scripting/automation perspective - is it worth explaining why that is so in the docs? I'm fine either way, but seems like useful context. The commit looks good to me if you don't want to add that explanation, do you want to close the issue or should I?

@SocalNick
Copy link
Contributor

I'd like to try to eliminate the 500 and instead return a 4xx with message like, The organization_guid field cannot be changed.

@SocalNick
Copy link
Contributor

Documentation change and returning 400 will be in next CAPI-Release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants