Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Add some more changes to API documentation
  • Loading branch information
xijo committed Mar 22, 2016
1 parent d9102de commit 3502593
Show file tree
Hide file tree
Showing 2 changed files with 168 additions and 30 deletions.
73 changes: 62 additions & 11 deletions sections/volunteering_details.md
Expand Up @@ -245,6 +245,32 @@ was indeed imported.
<td>"Germany"</td>
<td>Contact data for the organisation</td>
</tr>
<tr>
<th align="left" style="white-space: nowrap">
<a id="carrier.picture-ref" href="#carrier.picture">
↓carrier.picture
</a>
</th>
<td>null &#124; object</td>
<td></td>
<td>TODO</td>
</tr>
</table>
### <a id="carrier.picture" href="#carrier.picture-ref">↑Nested Attributes: carrier.picture</a>

<table>
<tr>
<th>Attribute</th>
<th>Types</th>
<th>Example</th>
<th>Description</th>
</tr>
<tr>
<th align="left">carrier.picture.fallback</th>
<td>boolean</td>
<td>true</td>
<td>Specifies whether a fallback image is given or not</td>
</tr>
</table>
### <a id="image" href="#image-ref">↑Nested Attributes: image</a>

Expand Down Expand Up @@ -405,13 +431,20 @@ betterplace.
<td>Permalink to betterplace.org</td>
</tr>
<tr>
<th align="left">carrier.logo</th>
<td>The original image version as uploaded by the organisation manager.

Please note: This image might change in the future since this attribute
does not follow the general API pattern for image attributes. You should
subscribe to the change-log newsletter so we can inform you about upcomming changes.
</td>
<th align="left">carrier.picture.fill_100x100</th>
<td>100×100 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.fill_200x200</th>
<td>200×200 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.fill_400x400</th>
<td>400×400 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.original</th>
<td>Maximum sized image. This is the original image with default-cropping or user-cropping applied.</td>
</tr>
<tr>
<th align="left">image.fill_618x322</th>
Expand Down Expand Up @@ -494,11 +527,29 @@ subscribe to the change-log newsletter so we can inform you about upcomming chan
"city": "Norderstedt",
"zip": "22848",
"country": "Deutschland",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_100x100_F_chse_LOGO.jpg"
},
{
"rel": "fill_200x200",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_200x200_F_chse_LOGO.jpg"
},
{
"rel": "fill_400x400",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/fill_400x400_F_chse_LOGO.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/025/356/crop_original_F_chse_LOGO.jpg"
}
]
},
"links": [
{
"rel": "logo",
"href": ""
}

]
},
"vacancies": 1,
Expand Down
125 changes: 106 additions & 19 deletions sections/volunteering_list.md
Expand Up @@ -338,6 +338,32 @@ was indeed imported.
<td>"Germany"</td>
<td>Contact data for the organisation</td>
</tr>
<tr>
<th align="left" style="white-space: nowrap">
<a id="carrier.picture-ref" href="#carrier.picture">
↓carrier.picture
</a>
</th>
<td>null &#124; object</td>
<td></td>
<td>TODO</td>
</tr>
</table>
### <a id="carrier.picture" href="#carrier.picture-ref">↑Nested Attributes: carrier.picture</a>

<table>
<tr>
<th>Attribute</th>
<th>Types</th>
<th>Example</th>
<th>Description</th>
</tr>
<tr>
<th align="left">carrier.picture.fallback</th>
<td>boolean</td>
<td>true</td>
<td>Specifies whether a fallback image is given or not</td>
</tr>
</table>
### <a id="image" href="#image-ref">↑Nested Attributes: image</a>

Expand Down Expand Up @@ -498,13 +524,20 @@ betterplace.
<td>Permalink to betterplace.org</td>
</tr>
<tr>
<th align="left">carrier.logo</th>
<td>The original image version as uploaded by the organisation manager.

Please note: This image might change in the future since this attribute
does not follow the general API pattern for image attributes. You should
subscribe to the change-log newsletter so we can inform you about upcomming changes.
</td>
<th align="left">carrier.picture.fill_100x100</th>
<td>100×100 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.fill_200x200</th>
<td>200×200 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.fill_400x400</th>
<td>400×400 Pixel</td>
</tr>
<tr>
<th align="left">carrier.picture.original</th>
<td>Maximum sized image. This is the original image with default-cropping or user-cropping applied.</td>
</tr>
<tr>
<th align="left">image.fill_618x322</th>
Expand Down Expand Up @@ -594,11 +627,29 @@ subscribe to the change-log newsletter so we can inform you about upcomming chan
"city": "Berlin",
"zip": "10407",
"country": "Deutschland",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/002/772/fill_100x100_WELL_WBM_pHndG_4c_klein.jpg"
},
{
"rel": "fill_200x200",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/002/772/fill_200x200_WELL_WBM_pHndG_4c_klein.jpg"
},
{
"rel": "fill_400x400",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/002/772/fill_400x400_WELL_WBM_pHndG_4c_klein.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/uploads/organisation/profile_picture/000/002/772/crop_original_WELL_WBM_pHndG_4c_klein.jpg"
}
]
},
"links": [
{
"rel": "logo",
"href": ""
}

]
},
"vacancies": 10,
Expand Down Expand Up @@ -710,11 +761,29 @@ subscribe to the change-log newsletter so we can inform you about upcomming chan
"city": "kamuli",
"zip": "+256",
"country": "Uganda",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_100x100_default.betterplace.jpg"
},
{
"rel": "fill_200x200",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_200x200_default.betterplace.jpg"
},
{
"rel": "fill_400x400",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_400x400_default.betterplace.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/crop_original_default.betterplace.jpg"
}
]
},
"links": [
{
"rel": "logo",
"href": ""
}

]
},
"vacancies": 5,
Expand Down Expand Up @@ -828,11 +897,29 @@ subscribe to the change-log newsletter so we can inform you about upcomming chan
"city": "kamuli",
"zip": "+256",
"country": "Uganda",
"picture": {
"fallback": true,
"links": [
{
"rel": "fill_100x100",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_100x100_default.betterplace.jpg"
},
{
"rel": "fill_200x200",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_200x200_default.betterplace.jpg"
},
{
"rel": "fill_400x400",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/fill_400x400_default.betterplace.jpg"
},
{
"rel": "original",
"href": "https://asset1.betterplace.org/assets/default/square_profile_picture/crop_original_default.betterplace.jpg"
}
]
},
"links": [
{
"rel": "logo",
"href": ""
}

]
},
"vacancies": 5,
Expand Down

0 comments on commit 3502593

Please sign in to comment.