diff --git a/documentation/api/Authentication.markdown b/documentation/api/Authentication.markdown index e321bc6c..fe8648b1 100644 --- a/documentation/api/Authentication.markdown +++ b/documentation/api/Authentication.markdown @@ -4,7 +4,7 @@ Authentication using OAuth 1.0a ### Using OAuth (1.0a) A full introduction to OAuth is beyond the scope of the OpenPhoto documentation. -In all reality you probably don't need to understand the ins and outs of OAuth, just grab one of our libraries. +In all reality you probably don't need to understand all the ins and outs of OAuth; just grab one of our libraries and start building. * openphoto/openphoto-php - Our PHP language binding. * openphoto/openphoto-ruby - Our Ruby language binding. diff --git a/documentation/api/GetPhoto.markdown b/documentation/api/GetPhoto.markdown index c7195380..5a6b56db 100644 --- a/documentation/api/GetPhoto.markdown +++ b/documentation/api/GetPhoto.markdown @@ -34,7 +34,7 @@ _Authentication: optional_ ### Parameters -1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) +1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) ---------------------------------------- diff --git a/documentation/api/GetPhotos.markdown b/documentation/api/GetPhotos.markdown index 789853bc..43d1c141 100644 --- a/documentation/api/GetPhotos.markdown +++ b/documentation/api/GetPhotos.markdown @@ -34,11 +34,11 @@ _Authentication: optional_ ### Parameters -1. returnSizes (optional), (i.e. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) +1. returnSizes (optional), (e.g. 20x20 or 30x30xCR,40x40) The photo sizes you'd like in the response. Specify every size you plan on using. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. generate (optional), (i.e. true or false) Tells the API to generate the sizes from `returnSizes` instead of returning a _create_ URL. [Docs for this parameter](http://theopenphotoproject.org/documentation/faq/ReturnSizes) 1. pageSize (optional), Number of photos to return per request. 1. page (optional), Page number when browsing through photos. Starts at 1. -1. tags (optional), _i.e. dog,cat_ - A comma delimited string of strings. +1. tags (optional), _e.g. dog,cat_ - A comma delimited string of strings. ---------------------------------------- diff --git a/documentation/api/PostActionCreate.markdown b/documentation/api/PostActionCreate.markdown index 2a5365bf..3ee0d701 100644 --- a/documentation/api/PostActionCreate.markdown +++ b/documentation/api/PostActionCreate.markdown @@ -65,7 +65,7 @@ The response is in a standard [response envelope](http://theopenphotoproject.org * _message_, A string describing the result. Don't use this for anything but reading. * _code_, _200_ on success -* _result_, A [Action][Action] object or FALSE on error +* _result_, An [Action][Action] object or FALSE on error #### Sample diff --git a/documentation/api/PostPhotoUpdate.markdown b/documentation/api/PostPhotoUpdate.markdown index c0963258..66c95900 100644 --- a/documentation/api/PostPhotoUpdate.markdown +++ b/documentation/api/PostPhotoUpdate.markdown @@ -33,16 +33,16 @@ _Authentication: required_ ### Parameters 1. permission (optional), 0 for private and 1 for public. -1. title (optional), _i.e. My first day at work_ - A string title to describe the photo. -1. description (optional), _i.e. A much longer description of my first day_ - A string to describe the photo in detail. -1. tags (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings. -1. tagsAdd (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be added. -1. tagsRemove (optional), _i.e. dog,cat_ - A comma delimited string of alpha numeric strings to be removed. -1. dateUploaded (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was uploaded -1. dateTaken (optional), _i.e. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present -1. license (optional), _i.e. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license. -1. latitude (optional), _i.e. 34.76_ - A decimal representation of latitude. -1. longitude (optional), _i.e. -87.45_ - A decimal representation of longitude. +1. title (optional), _e.g. My first day at work_ - A string title to describe the photo. +1. description (optional), _e.g. A much longer description of my first day_ - A string to describe the photo in detail. +1. tags (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings. +1. tagsAdd (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be added. +1. tagsRemove (optional), _e.g. dog,cat_ - A comma delimited string of alpha numeric strings to be removed. +1. dateUploaded (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was uploaded +1. dateTaken (optional), _e.g. 1311059035_ - A unix timestamp of the date the photo was taken which overrides EXIF data if present +1. license (optional), _e.g. CC BY-SA or My Custom License_ - A string representing a custom or Creative Commons license. +1. latitude (optional), _e.g. 34.76_ - A decimal representation of latitude. +1. longitude (optional), _e.g. -87.45_ - A decimal representation of longitude. ----------------------------------------