yetangitu/photo-front
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

String replaces on documentation.

Browse source
This commit is contained in:
Jaisen Mathai 2011-12-03 20:55:00 -08:00
parent 4d152703f8
commit 3a210bbff1
20 changed files with 49 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

4
documentation/api/GetGroup.markdown
View file

@ -56,7 +56,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -80,7 +80,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Group]: ../schemas/Group.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/GetGroups.markdown
View file

@ -56,7 +56,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -102,7 +102,7 @@ The response is in a standard [response envelope][Envelope].
]
}
[Envelope]: Envelope.markdown
[Group]: ../schemas/Group.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/GetHelloWorld.markdown
View file

@ -64,7 +64,7 @@ _Authentication: optional_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -82,7 +82,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[purpose]: #purpose
[endpoint]: #endpoint
[parameters]: #parameters

10
documentation/api/GetPhoto.markdown
View file

@ -20,7 +20,7 @@ Open Photo API / Get Photo
Use this API to get a for a user's photo.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation][photogeneration] for details.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation](http://theopenphotoproject.org/documentation/faq/PhotoGeneration) for details.
----------------------------------------
@ -34,8 +34,8 @@ _Authentication: optional_
<a name="parameters"></a>
### 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][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][ReturnSizes]
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. 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)
----------------------------------------
@ -58,7 +58,7 @@ _Authentication: optional_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -101,7 +101,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown
[purpose]: #purpose
[endpoint]: #endpoint

10
documentation/api/GetPhotoNextPrevious.markdown
View file

@ -20,7 +20,7 @@ Open Photo API / Get Next/Previous Photo
Use this API to get the next and previous photo given a photo in the middle.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation][photogeneration] for details.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation](http://theopenphotoproject.org/documentation/faq/PhotoGeneration) for details.
----------------------------------------
@ -34,8 +34,8 @@ _Authentication: optional_
<a name="parameters"></a>
### 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][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][ReturnSizes]
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. 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)
----------------------------------------
@ -58,7 +58,7 @@ _Authentication: optional_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -144,7 +144,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown
[purpose]: #purpose
[endpoint]: #endpoint

10
documentation/api/GetPhotos.markdown
View file

@ -20,7 +20,7 @@ Open Photo API / Get Photos
Use this API to get a set of photos for a user.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation][photogeneration] for details.
_NOTE:_ Always pass in the `returnSizes` parameter for sizes you plan on using. It's the only way to guarantee that a URL for that size will be present in the response. See [Photo Generation](http://theopenphotoproject.org/documentation/faq/PhotoGeneration) for details.
----------------------------------------
@ -34,8 +34,8 @@ _Authentication: optional_
<a name="parameters"></a>
### 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][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][ReturnSizes]
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. 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.
@ -61,7 +61,7 @@ _Authentication: optional_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -134,7 +134,7 @@ The response is in a standard [response envelope][Envelope].
]
}
[Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/GetTags.markdown
View file

@ -55,7 +55,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -94,7 +94,7 @@ The response is in a standard [response envelope][Envelope].
]
}
[Envelope]: Envelope.markdown
[Tag]: ../schemas/Tag.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/GetWebhook.markdown
View file

@ -56,7 +56,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -79,7 +79,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Webhook]: ../schemas/Webhook.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostActionCreate.markdown
View file

@ -61,7 +61,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -87,7 +87,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Action]: ../schemas/Action.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostActionDelete.markdown
View file

@ -55,7 +55,7 @@ _N/A_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -70,7 +70,7 @@ The response is in a standard [response envelope][Envelope].
"result": true
}
[Envelope]: Envelope.markdown
[Action]: ../schemas/Action.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostGroupCreate.markdown
View file

@ -56,7 +56,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -77,7 +77,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Group]: ../schemas/Group.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostGroupDelete.markdown
View file

@ -55,7 +55,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -70,7 +70,7 @@ The response is in a standard [response envelope][Envelope].
"result": true
}
[Envelope]: Envelope.markdown
[Group]: ../schemas/Group.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostGroupUpdate.markdown
View file

@ -56,7 +56,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -77,7 +77,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Group]: ../schemas/Group.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostPhotoDelete.markdown
View file

@ -55,7 +55,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -70,7 +70,7 @@ The response is in a standard [response envelope][Envelope].
"result":true
}
[Envelope]: Envelope.markdown
[Action]: ../schemas/Action.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostPhotoUpdate.markdown
View file

@ -64,7 +64,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _202_ on success
@ -110,7 +110,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostPhotoUpload.markdown
View file

@ -78,7 +78,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _202_ on success
@ -124,7 +124,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Photo]: ../schemas/Photo.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostTagCreate.markdown
View file

@ -59,7 +59,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -78,7 +78,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Tag]: ../schemas/Tag.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostTagUpdate.markdown
View file

@ -58,7 +58,7 @@ _Authentication: required_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -77,7 +77,7 @@ The response is in a standard [response envelope][Envelope].
}
}
[Envelope]: Envelope.markdown
[Tag]: ../schemas/Tag.markdown
[purpose]: #purpose
[endpoint]: #endpoint

4
documentation/api/PostWebhookDelete.markdown
View file

@ -56,7 +56,7 @@ _None_
<a name="response"></a>
### Response
The response is in a standard [response envelope][Envelope].
The response is in a standard [response envelope](http://theopenphotoproject.org/documentation/api/Envelope).
* _message_, A string describing the result. Don't use this for anything but reading.
* _code_, _200_ on success
@ -71,7 +71,7 @@ The response is in a standard [response envelope][Envelope].
"result" : true
}
[Envelope]: Envelope.markdown
[Webhook]: ../schemas/Webhook.markdown
[webhookverification]: ../faq/WebhookVerification.markdown
[purpose]: #purpose

4
documentation/api/PostWebhookSubscribe.markdown
View file

@ -15,7 +15,7 @@ Open Photo API / Create/Subscribe to Webhook
Use this API to create a new webhook for a user.
This API differs from our others in that it's both interactive and does not return a [Standard Envelope][Envelope]. These are the steps required to complete a webhook subscription.
This API differs from our others in that it's both interactive and does not return a [Standard Envelope](http://theopenphotoproject.org/documentation/api/Envelope). These are the steps required to complete a webhook subscription.
<a name="verification"></a>
@ -43,7 +43,7 @@ _Authentication: required_
----------------------------------------
[Envelope]: Envelope.markdown
[purpose]: #purpose
[endpoint]: #endpoint
[parameters]: #parameters