search

rackerlabs / docs-cloud-files

Developer documentation source for Rackspace Cloud Files API
https://developer.rackspace.com/docs/cloud-files/v1/developer-guide/
2 stars 14 forks source link

Missing Output in Cloud Files API Docs #84

Closed aziouk closed 8 years ago

aziouk commented 8 years ago

Hey folks,

I was going to initiate a pull request for this one, but I'm not sure of what the information should be reflected, since some I found to be missing from the github repo as well as in the live API docs.

If we look at the creating-large-objects.rst section of the Cloud Files API docs, we can see that in the section proceeding 'Example: Upload a segment of a large object: HTTP request'. Many of the output examples are showing single letter like 'w' , or 's', this strikes me as something that is not intended.

https://github.com/rackerlabs/docs-cloud-files/blob/5451cce9e2c623015c701ac676153966608ef0ca/api-docs/use-cases/additional-storage/creating-large-objects.rst

I believe that this may have been like this for a while. Please would you be so kind to help me revert a previous version of this that had the correct output for those sections?

Cheers & Best wishes, Adam

cyrichardson commented 8 years ago

@dpgoetz Could you please take a look when you have time and let me know what changes, if any, are necessary to fix this issue? @aziouk Is correct that it has been like this for quite a while. Many thanks!

aziouk commented 8 years ago

Hey guys, Thanks very much for getting back so quickly! I really appreciate it!

Cheers & Best wishes, Adam

cyrichardson commented 8 years ago

@aziouk You're welcome!

If you know the fix before David has time to get to this issue, please just add it here. I'll be glad to create the PR, or if you'd like to do that, feel free to. I will review it. :-)

dpgoetz commented 8 years ago

hey- just looking over this there are some mistakes. I think those "s", "w" parts should just be removed and then we can go back and add in some decent examples. just scanning over it there is a problem here: https://github.com/rackerlabs/docs-cloud-files/blob/5451cce9e2c623015c701ac676153966608ef0ca/api-docs/use-cases/additional-storage/creating-large-objects.rst#deleting-a-large-object

too. i don't have time to fix this right now so i guess we can make a Jira for this for one of the dev to look over? or just keep this issue open? or any pull requests will also be reviewed :) Thanks

cyrichardson commented 8 years ago

Just FYI, I went back to a pdf file I had from 2/13/2014, and it had the "s" and "w" examples. For now, I will go ahead and removed those examples as @dpgoetz suggested. This change is published here: https://developer.rackspace.com/docs/cloud-files/v1/use-cases/additional-object-services-information/#creating-a-dynamic-large-object

cyrichardson commented 8 years ago

I'm going to close this issue and create 2 new ones (but reference this one) as following: