Skip to content

Update references to new API doc site. #106

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Feb 23, 2016
Merged

Update references to new API doc site. #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8be4e87
Update references to new API doc site.
Jeff-Meadows Jan 5, 2016
50b81fd
Merge branch 'master' into dev-edition
Jeff-Meadows Jan 5, 2016
21096d8
Merge branch 'master' into dev-edition
Jeff-Meadows Feb 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Get shared link direct download URL (files only)
download_url = client.file(file_id='SOME_FILE_ID').get_shared_link_download_url()

Get file name
~~~~~~~~~~~~~~~
~~~~~~~~~~~~~

.. code-block:: python

Expand All @@ -157,7 +157,7 @@ Rename an item
client.file(file_id='SOME_FILE_ID').rename('bar-2.txt')

Move an item
~~~~~~~~~~~~~~
~~~~~~~~~~~~

.. code-block:: python

Expand Down Expand Up @@ -282,7 +282,7 @@ Box Developer Edition
---------------------

The Python SDK supports your
`Box Developer Edition <https://developers.box.com/developer-edition/>`__ applications.
`Box Developer Edition <https://box-content.readme.io/docs/app-users/>`__ applications.

Developer Edition support requires some extra dependencies. To get them, simply

Expand Down
4 changes: 2 additions & 2 deletions boxsdk/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ def create_group(self, name):

def get_shared_item(self, shared_link, password=None):
"""
Get information about a Box shared link. https://developers.box.com/docs/#shared-items
Get information about a Box shared link. https://box-content.readme.io/reference#get-a-shared-item

:param shared_link:
The shared link.
Expand Down Expand Up @@ -318,7 +318,7 @@ def create_user(self, name, login=None, **user_attributes):
:param user_attributes:
Additional attributes for the user. See the documentation at
https://box-content.readme.io/#create-an-enterprise-user for enterprise users
or https://developers.box.com/developer-edition/ for app users.
or https://box-content.readme.io/docs/app-users for app users.
"""
url = '{0}/users'.format(API.BASE_API_URL)
user_attributes['name'] = name
Expand Down
2 changes: 1 addition & 1 deletion boxsdk/object/base_object.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ def update_info(self, data, params=None, headers=None, **kwargs):
Update the object attributes in data.keys(). The semantics of the
values depends on the the type and attributes of the object being
updated. For details on particular semantics, refer to the Box
developer API documentation <developers.box.com/docs>.
developer API documentation <https://box-content.readme.io/docs/>.
Copy link
Contributor

@jmoldow jmoldow Jan 8, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this what we want? That leads to a getting started page. Should we link to https://box-content.readme.io/reference, or even just to https://box-content.readme.io (which redirects to https://box-content.readme.io/reference) instead?

:type data:
`dict`
:param params:
Expand Down
3 changes: 2 additions & 1 deletion boxsdk/object/file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,8 @@ def metadata(self, scope='global', template='properties'):
:type scope:
`unicode`
:param template:
The name of the metadata template. See https://developers.box.com/metadata-api/#basics for more details.
The name of the metadata template.
See https://box-content.readme.io/reference#metadata-object for more details.
:type template:
`unicode`
:return:
Expand Down
2 changes: 1 addition & 1 deletion boxsdk/object/item.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ def _get_accelerator_upload_url(self, file_id=None):
def _preflight_check(self, size, name=None, file_id=None, parent_id=None):
"""
Make an API call to check if certain file can be uploaded to Box or not.
(https://developers.box.com/docs/#files-preflight-check)
(https://box-content.readme.io/reference#preflight-check)

:param size:
The size of the file to be uploaded in bytes. Specify 0 for unknown file sizes.
Expand Down
7 changes: 4 additions & 3 deletions boxsdk/object/metadata.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
class MetadataUpdate(object):
"""
Helper class for updating Box metadata.
See https://developers.box.com/metadata-api/#update for more details.
See https://box-content.readme.io/reference#update-metadata for more details.
See http://jsonpatch.com/ for details about JSON patch.
"""
def __init__(self):
Expand Down Expand Up @@ -113,7 +113,8 @@ def __init__(self, session, box_object, scope, template):
:type scope:
`unicode`
:param template:
The name of the metadata template. See https://developers.box.com/metadata-api/#basics for more details.
The name of the metadata template.
See https://box-content.readme.io/reference#metadata-object for more details.
:type template:
`unicode`
"""
Expand Down Expand Up @@ -141,7 +142,7 @@ def start_update():
def update(self, metadata_update):
"""
Update the key/value pairs associated with this metadata object.
See https://developers.box.com/metadata-api/#update for more details.
See https://box-content.readme.io/reference#update-metadata for more details.

:param metadata_update:
A metadata update object containing the changes that should be made to the metadata.
Expand Down