Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
flori committed Mar 17, 2017
1 parent fafb339 commit c5cb972e3ce0470719a03b820297400d318e9b20
View
@@ -1,3 +1,12 @@
+c
+search
+n
+c
+n
+search.page(1).per(2)
+search.page(1)
+search.page
+search
q
WillPaginate.per_page_default
WillPaginate::PerPage.per_page_default
View
@@ -3,11 +3,17 @@ All notable changes to the betterplace.org API v4 will be documented in this
file. Notifications about changes will also be send to the [mailing list for
service announcements](README.md#mailing-list-for-service-announcements).
+## 2017-03-03
+### Removed
+- Removed [Fundraising Challenge] endpoint
+
+
## 2016-12-05
### Added
- Added [endpoint](sections/client_donation_pledge_details.md) for [donation pledges](sections/client_donation_pledges_list.md).
- Added [endpoint](sections/client_forwarding_request_details.md) for [forwarding requests](sections/client_forwarding_requests_list.md).
+
## 2016-12-01
### Removed
- [Opinion Details] endpoint removed
View
@@ -61,9 +61,6 @@ about updates and scheduled downtimes.
1. **MatchingFunds**
1. [**MatchingFunds** List](sections/matching_funds_list.md)
1. [**MatchingFund** Details](sections/matching_fund_details.md)
- 1. **FundraisingChallenge**
- 1. [Fundraising Challenge **Contest** Details](sections/fundraising_challenge_contest_details.md)
- 1. [Fundraising Challenge Contest **Results** List](sections/fundraising_challenge_contest_results_list.md)
3. **Client API** [↓ below](#client-api)
0. Client Projects [↓ below](#client-projects)
@@ -96,16 +96,6 @@ any of the following HTML tags:
<code>a, br, strong, b, em, i, ul, ol, li, p, div, img, iframe</code>.
</td>
</tr>
- <tr>
- <th align="left" style="white-space: nowrap">
- <a id="payout-ref" href="#payout">
- ↓payout
- </a>
- </th>
- <td>null &#124; object</td>
- <td>TODO</td>
- <td></td>
- </tr>
<tr>
<th align="left" style="white-space: nowrap">
<a id="author-ref" href="#author">
@@ -119,48 +109,6 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</td>
</tr>
</table>
-### <a id="payout" href="#payout-ref">↑Nested Attributes: payout</a>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Types</th>
- <th>Example</th>
- <th>Description</th>
- </tr>
- <tr>
- <th align="left" style="white-space: nowrap">
- <a id="payout.needs-ref" href="#payout.needs">
- ↓payout.needs
- </a>
- </th>
- <td>array</td>
- <td>TODO</td>
- <td>TODO</td>
- </tr>
- </table>
-### <a id="payout.needs" href="#payout.needs-ref">↑Nested Attributes: payout.needs</a>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Types</th>
- <th>Example</th>
- <th>Description</th>
- </tr>
- <tr>
- <th align="left">payout.needs.need_title</th>
- <td>string</td>
- <td>Schoolbooks</td>
- <td>Title of the need</td>
- </tr>
- <tr>
- <th align="left">payout.needs.payout_amount_in_cents</th>
- <td>string</td>
- <td>2300</td>
- <td>Amount paid out to that need</td>
- </tr>
- </table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
@@ -275,34 +223,7 @@ access rights in order to see this information.
"type": "BlogPost",
"title": "First Climbing Contest Held in Afghanistan",
"body": "<p><img src=\"http://skateistan.org/sites/default/files/users/duncan.buck/1381505_10201192263663306_1801301726_n.jpeg\"><br></p><br><p>On<br> Saturday 28th September, Skateistan Kabul's volunteers and staff took <br>part in the inaugural indoor climbing competition held at the facility, <br>with both girls and boys competing (ages 11-22). This was the 1st <br>climbing competition that has taken place at Skateistan and the 1st <br>known climbing contest held in Afghanistan!<br><br>The climbing <br>competition had both female and male categories with contests that <br>included speed climbing and fastest rope coil. The competition was <br>judged by our amazing volunteer climbing teachers, including the <br>competition organiser Gio Trambaiolo who has been instrumental in <br>teaching climbing to the Skateistan volunteers. Gio has volunteered as a<br> climbing teacher nearly each week for well over a year. Skateistan is <br>extremely lucky to have such a wonderful team of dedicated volunteers, <br>who include around a dozen foreigners with certified climbing <br>backgrounds.</p><br><p>\" Everyone did very well, it's amazing to<br> see how the instructors and volunteers have progressed over the past <br>few months. \" - Gio, volunteer climbing teacher</p><br><p>Each <br>week since June 2012, climbing lessons have been provided <br>to Skateistan's Youth Leaders, who are Afghan staff and volunteers with <br>the project. They have learned climbing techniques, as well as built <br>up trust and respect for each other through the sport. It is been <br>inspiring to watch the volunteers develop as climbers and to see the <br>high skill level our Youth Leaders have developed since the program took<br> shape last year. Through the program, 14 young Afghans (50% girls) have<br> received certificates to be Beginner Climbing Instructors, and they now<br> facilitate climbing classes with more than 400 students who attend <br>Skateistan.</p><br><p>A brief prize ceremony was held the following week to <br>give the final results of the competition, as well as some prizes which <br>were given to everyone who participated.</p>We<br> want to thank all the climbing volunteers who have created a hugely <br>succesful sports program for our staff and students. We wish to thank <br>Giovanni Trambaiolo, Sheilagh Henry, Kate Hughes, Mindy Visser, Colin R,<br> Erin Blankenship, Jeffery Dow, Kelsey Noonan, Sarah-Jean <br>Cunningham, and Stephanie Faser. Your constant creativity and innovative<br> training have made climbing one of the leading activities for the Youth<br> Leaders at Skateistan. The development of students who attend your <br>classes has been a great pleasure to watch, and will benefit hundreds of<br> children who will continue to be taught by their Afghan peers.<p><br><img src=\"http://skateistan.org/sites/default/files/users/duncan.buck/2013-09-24-peace-day-eventimg_1269.jpg\"></p><br><p><br></p><br><br>",
- "payout": null,
- "author": {
- "id": 130618,
- "name": "E. Kinast",
- "picture": {
- "fallback": true,
- "links": [
- {
- "rel": "fill_100x100",
- "href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/130/618/fill_100x100_original_Picture_023.jpg"
- },
- {
- "rel": "original",
- "href": "https://asset1.betterplace.org/uploads/user/profile_picture/000/130/618/crop_original_original_Picture_023.jpg"
- }
- ]
- },
- "links": [
- {
- "rel": "platform",
- "href": "https://www.betterplace.org/de/users/130618"
- },
- {
- "rel": "contact_data",
- "href": "https://api.betterplace.org/de/api_v4/users/130618/contact_data.json"
- }
- ]
- },
+ "author": null,
"links": [
{
"rel": "self",
@@ -94,16 +94,6 @@ any of the following HTML tags:
<code>a, br, strong, b, em, i, ul, ol, li, p, div, img, iframe</code>.
</td>
</tr>
- <tr>
- <th align="left" style="white-space: nowrap">
- <a id="payout-ref" href="#payout">
- ↓payout
- </a>
- </th>
- <td>null &#124; object</td>
- <td>TODO</td>
- <td></td>
- </tr>
<tr>
<th align="left" style="white-space: nowrap">
<a id="author-ref" href="#author">
@@ -117,48 +107,6 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</td>
</tr>
</table>
-### <a id="payout" href="#payout-ref">↑Nested Attributes: payout</a>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Types</th>
- <th>Example</th>
- <th>Description</th>
- </tr>
- <tr>
- <th align="left" style="white-space: nowrap">
- <a id="payout.needs-ref" href="#payout.needs">
- ↓payout.needs
- </a>
- </th>
- <td>array</td>
- <td>TODO</td>
- <td>TODO</td>
- </tr>
- </table>
-### <a id="payout.needs" href="#payout.needs-ref">↑Nested Attributes: payout.needs</a>
-
- <table>
- <tr>
- <th>Attribute</th>
- <th>Types</th>
- <th>Example</th>
- <th>Description</th>
- </tr>
- <tr>
- <th align="left">payout.needs.need_title</th>
- <td>string</td>
- <td>Schoolbooks</td>
- <td>Title of the need</td>
- </tr>
- <tr>
- <th align="left">payout.needs.payout_amount_in_cents</th>
- <td>string</td>
- <td>2300</td>
- <td>Amount paid out to that need</td>
- </tr>
- </table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
@@ -266,10 +214,10 @@ access rights in order to see this information.
```json
{
- "total_entries": 92,
+ "total_entries": 94,
"offset": 0,
- "total_pages": 4,
- "current_page": null,
+ "total_pages": 47,
+ "current_page": 1,
"per_page": 2,
"data": [
{
@@ -280,7 +228,6 @@ access rights in order to see this information.
"type": "BlogPost",
"title": "Skateistan-Trailer",
"body": "<p><a href=\"http://youtube.com/watch?v=i6W6_G-h6is\">http://youtube.com/watch?v=i6W6_G-h6is</a></p>",
- "payout": null,
"author": {
"id": 9238,
"name": "M. Henninger",
@@ -331,7 +278,6 @@ access rights in order to see this information.
"type": "BlogPost",
"title": "Brieffreunde gesucht",
"body": "Kreisjugendring Würzburg will Brieffreundschaften mit Skateistan ins Leben rufen!<br><br><br>Eine Welt abseits von Krieg und Armut soll das Projekt „Skateistan“ für Kinder und Jugendliche in Kabul sein. Der Deutsch-Australier Oliver Percovich leistet hier Entwicklungshilfe der besonderen Art. <br> <br>Durch einen Bericht in der Main-Post wurde der Kreisjugendring Würzburg auf die Organisation aufmerksam. <br><br>Carsten Hackel, Vorstand des Kreisjugendringes, war so begeistert von der Idee, dass er direkt eine Hilfsaktion startete. Neben einer großen Skateboard-Sammelaktion entstand auch die Idee, Brieffreundschaften zwischen deutschen und afghanischen Kindern ins Leben zu rufen.<br><br>Für viele Kinder bedeutet „Skateistan“ zumindest einen Teil ihres Alltags in einem normalen Umfeld zu verbringen. Da kann der Kontakt zu Kindern in Deutschland einen schönen Beitrag leisten. „Für unsere Kinder dagegen ist ein solches Projekt die Gelegenheit Vorurteile und Wissensdefizite abzubauen“, begründet Hackel das Engagement des Kreisjugendrings. <br><br>Die Schirmherrschaft hat Kreistagsabgeordnete Elisabeth Schäfer übernommen. <br><br>Da das Verschicken von Post nach Afghanistan kompliziert ist, würde der Kreisjugendring die Briefe (möglichst in Englisch verfasst) sammeln und den Versand abwickeln. Gesucht werden Jugendgruppen, Klassen, Vereine aus dem Landkreis.<br>Kontakt: Kreisjugendring Würzburg, Wittelsbacher Str. 1, 97074 Würzburg, Tel. (09 31) 8 78 99, Mail: info@kjr-wuerzburg.de; Infos zu Skateistan:",
- "payout": null,
"author": {
"id": 11872,
"name": "j. wardag",
@@ -162,9 +162,9 @@ redirect or donated to the client pool.
```json
{
- "total_entries": 16326,
+ "total_entries": 17059,
"offset": 0,
- "total_pages": 5442,
+ "total_pages": 5687,
"current_page": 1,
"per_page": 3,
"data": [
@@ -117,7 +117,7 @@ that were tagged with this tag.
"data": [
{
"tag": "Trier",
- "projects_count": 39,
+ "projects_count": 33,
"links": [
{
"rel": "projects",
@@ -127,7 +127,7 @@ that were tagged with this tag.
},
{
"tag": "KinderJugendliche",
- "projects_count": 47,
+ "projects_count": 42,
"links": [
{
"rel": "projects",
@@ -86,7 +86,7 @@ that were tagged with this tag.
"data": [
{
"tag": "Bedürftige",
- "projects_count": 13,
+ "projects_count": 12,
"links": [
{
"rel": "projects",
Oops, something went wrong.

0 comments on commit c5cb972

Please sign in to comment.