From 8be4e87e57834162c69476048e617926de84954a Mon Sep 17 00:00:00 2001 From: Jeffrey Meadows Date: Tue, 5 Jan 2016 10:30:55 -0800 Subject: [PATCH] Update references to new API doc site. --- README.rst | 6 +++--- boxsdk/client.py | 4 ++-- boxsdk/object/base_object.py | 2 +- boxsdk/object/file.py | 3 ++- boxsdk/object/item.py | 2 +- boxsdk/object/metadata.py | 7 ++++--- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index f6b68c569..d18978d11 100644 --- a/README.rst +++ b/README.rst @@ -131,7 +131,7 @@ Get shared link shared_link = client.folder(folder_id='SOME_FOLDER_ID').get_shared_link() Get file name -~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~ .. code-block:: python @@ -145,7 +145,7 @@ Rename an item client.file(file_id='SOME_FILE_ID').rename('bar-2.txt') Move an item -~~~~~~~~~~~~~~ +~~~~~~~~~~~~ .. code-block:: python @@ -230,7 +230,7 @@ Box Developer Edition --------------------- The Python SDK supports your -`Box Developer Edition `__ applications. +`Box Developer Edition `__ applications. Developer Edition support requires some extra dependencies. To get them, simply diff --git a/boxsdk/client.py b/boxsdk/client.py index f84d9a31c..c3623630a 100644 --- a/boxsdk/client.py +++ b/boxsdk/client.py @@ -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. @@ -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 diff --git a/boxsdk/object/base_object.py b/boxsdk/object/base_object.py index 04636e777..837ff826d 100644 --- a/boxsdk/object/base_object.py +++ b/boxsdk/object/base_object.py @@ -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 . + developer API documentation . :type data: `dict` :param params: diff --git a/boxsdk/object/file.py b/boxsdk/object/file.py index 96f607915..1612a6fc6 100644 --- a/boxsdk/object/file.py +++ b/boxsdk/object/file.py @@ -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: diff --git a/boxsdk/object/item.py b/boxsdk/object/item.py index 38835463a..75d57ae27 100644 --- a/boxsdk/object/item.py +++ b/boxsdk/object/item.py @@ -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. diff --git a/boxsdk/object/metadata.py b/boxsdk/object/metadata.py index 791b9f241..9c3fed06f 100644 --- a/boxsdk/object/metadata.py +++ b/boxsdk/object/metadata.py @@ -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): @@ -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` """ @@ -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.