Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
flori committed Aug 18, 2017
1 parent f5747f1 commit cf11e452dcaba3f89c090943342f54267c36bf46
Showing with 53 additions and 87 deletions.
  1. +2 −3 sections/blog_post_details.md
  2. +2 −3 sections/blog_posts_list.md
  3. +0 −1 sections/client_donation_details.md
  4. +0 −1 sections/client_donation_pledge_details.md
  5. +0 −1 sections/client_donation_pledges_list.md
  6. +0 −1 sections/client_donations_list.md
  7. +0 −1 sections/client_forwarding_request_details.md
  8. +0 −1 sections/client_forwarding_requests_list.md
  9. +0 −1 sections/client_fundraising_event_statistics.md
  10. +0 −1 sections/client_mailing_subscriptions.md
  11. +0 −1 sections/client_project_statistics.md
  12. +0 −1 sections/client_project_tags_list.md
  13. +0 −1 sections/client_tags_list.md
  14. +0 −1 sections/contact_data_details.md
  15. +0 −1 sections/donor_contact_data_details.md
  16. +3 −4 sections/fundraising_event_details.md
  17. +0 −1 sections/fundraising_event_forwardings_list.md
  18. +7 −8 sections/fundraising_events_featured_projects_list.md
  19. +3 −4 sections/fundraising_events_list.md
  20. +0 −1 sections/matching_fund_details.md
  21. +0 −1 sections/matching_funds_list.md
  22. +0 −1 sections/need_details.md
  23. +0 −1 sections/needs_list.md
  24. +2 −3 sections/opinions_list.md
  25. +3 −4 sections/organisation_details.md
  26. +3 −4 sections/organisations_list.md
  27. +0 −1 sections/pool_details.md
  28. +7 −8 sections/project_details.md
  29. +0 −1 sections/project_picture_details.md
  30. +0 −1 sections/project_pictures_list.md
  31. +7 −8 sections/projects_list.md
  32. +7 −8 sections/volunteering_details.md
  33. +0 −1 sections/volunteering_inquiries.md
  34. +7 −8 sections/volunteering_list.md
@@ -51,7 +51,6 @@ Blogpost id as an integer number ≥ 9.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -151,8 +150,8 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</td>
</tr>
</table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
<tr>
@@ -201,8 +200,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
<table>
<tr>
@@ -45,7 +45,6 @@ Project id as an integer number ≥ 14.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -145,8 +144,8 @@ Possible formats: "Till B.", "T. Behnke", "Till Behnke"
</td>
</tr>
</table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
<tr>
@@ -195,8 +194,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
<table>
<tr>
@@ -50,7 +50,6 @@ The betterplace.org-internal client permalink.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -66,7 +66,6 @@ Donation Pledge id as an integer number.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -358,7 +358,6 @@ True by default.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -62,7 +62,6 @@ and the <a href="client_donation_pledges.md">Client donation pledge endpoint</a>
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -51,7 +51,6 @@ response of a successful forwarding request POST.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -185,7 +185,6 @@ Allowed characters are <code>a-zA-Z0-9_-</code>.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -36,7 +36,6 @@ The betterplace.org-internal client permalink
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -143,7 +143,6 @@ State of the subscription: active/inactive
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -36,7 +36,6 @@ The betterplace.org-internal client permalink
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -78,7 +78,6 @@ It is possible to set multiple facet filters.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -39,7 +39,6 @@ The betterplace.org-internal client id
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -42,7 +42,6 @@ User-id as an integer number.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -55,7 +55,6 @@ The betterplace.org donation token or given client reference.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -38,7 +38,6 @@ Fundraising Event id as an integer number ≥ 1.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -226,8 +225,8 @@ TODO
</td>
</tr>
</table>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
<table>
<tr>
@@ -276,8 +275,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
<table>
<tr>
@@ -297,8 +296,8 @@ Specifies whether a fallback image is given or not
</td>
</tr>
</table>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
<table>
<tr>
@@ -37,7 +37,6 @@ Fundraising Event id as an integer number ≥ 1.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -37,7 +37,6 @@ Fundraising Event id as an integer number ≥ 1.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -469,8 +468,8 @@ the data from the appropriate endpoint.
</td>
</tr>
</table>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
<table>
<tr>
@@ -519,8 +518,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
<table>
<tr>
@@ -540,8 +539,8 @@ Specifies whether a fallback image is given or not
</td>
</tr>
</table>
### <a id="carrier" href="#carrier-ref">↑Nested Attributes: carrier</a>
### <a id="carrier" href="#carrier-ref">↑Nested Attributes: carrier</a>
<table>
<tr>
@@ -585,8 +584,8 @@ The organisation logo, user profile picture or a fallback image
</td>
</tr>
</table>
### <a id="carrier.picture" href="#carrier.picture-ref">↑Nested Attributes: carrier.picture</a>
### <a id="carrier.picture" href="#carrier.picture-ref">↑Nested Attributes: carrier.picture</a>
<table>
<tr>
@@ -606,8 +605,8 @@ Specifies whether a fallback image is given or not
</td>
</tr>
</table>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
<table>
<tr>
@@ -627,8 +626,8 @@ Specifies whether a fallback image is given or not
</td>
</tr>
</table>
### <a id="active_matching_fund" href="#active_matching_fund-ref">↑Nested Attributes: active_matching_fund</a>
### <a id="active_matching_fund" href="#active_matching_fund-ref">↑Nested Attributes: active_matching_fund</a>
<table>
<tr>
@@ -768,8 +767,8 @@ Up to this amount donations get matched by the matching fund
</td>
</tr>
</table>
### <a id="closed_notice" href="#closed_notice-ref">↑Nested Attributes: closed_notice</a>
### <a id="closed_notice" href="#closed_notice-ref">↑Nested Attributes: closed_notice</a>
<table>
<tr>
@@ -121,7 +121,6 @@ It is possible to set multiple order parameters.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -309,8 +308,8 @@ TODO
</td>
</tr>
</table>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
### <a id="contact" href="#contact-ref">↑Nested Attributes: contact</a>
<table>
<tr>
@@ -359,8 +358,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
### <a id="contact.picture" href="#contact.picture-ref">↑Nested Attributes: contact.picture</a>
<table>
<tr>
@@ -380,8 +379,8 @@ Specifies whether a fallback image is given or not
</td>
</tr>
</table>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
### <a id="profile_picture" href="#profile_picture-ref">↑Nested Attributes: profile_picture</a>
<table>
<tr>
@@ -36,7 +36,6 @@ matching-fund-id as an integer number ≥ 9.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -47,7 +47,6 @@ Filter the result set by <code>state</code> (activated|closed)
### Root Attributes
<table>
<tr>
<th>Attribute</th>
View
@@ -51,7 +51,6 @@ Need-id as an integer number ≥ 29.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
View
@@ -74,7 +74,6 @@ Order the result set. Documented and supported orders are:
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -82,7 +82,6 @@ It is possible to set multiple order parameters.
### Root Attributes
<table>
<tr>
<th>Attribute</th>
@@ -210,8 +209,8 @@ any of the following HTML tags:
</td>
</tr>
</table>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
### <a id="author" href="#author-ref">↑Nested Attributes: author</a>
<table>
<tr>
@@ -260,8 +259,8 @@ User profile picture or a fallback image
</td>
</tr>
</table>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
### <a id="author.picture" href="#author.picture-ref">↑Nested Attributes: author.picture</a>
<table>
<tr>
Oops, something went wrong.

0 comments on commit cf11e45

Please sign in to comment.