Permalink
Browse files

Add some more changes to API documentation

  • Loading branch information...
flori committed Jun 9, 2016
0 parents commit af1897405cf42af7a25caafdebe1d6e84fe81344
Showing with 1,005 additions and 0 deletions.
  1. +1 −0 .gitignore
  2. +247 −0 CHANGELOG.md
  3. +3 −0 LICENSE
  4. +384 −0 README.md
  5. +269 −0 donation_form/third_party_app_donation_form.md
  6. BIN images/betterplace.jpg
  7. +101 −0 sections/pool_details.md
@@ -0,0 +1 @@
+.DS_Store
@@ -0,0 +1,247 @@
+# Changelog
+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).
+
+## 2016-04-18
+### Added
+- Added client API endpoint to submit volunteering inquiries to.
+ See [here](sections/volunteering_inquiries.md)
+
+
+## 2016-04-12
+### Added
+- [Volunteering List](sections/volunteering_list.md) can now be sorted by the
+ `content_updated_at` order parameter.
+
+
+## 2016-04-11
+### Changed
+- [Organisation Details](sections/organisation_details.md): The `description` now contains `br` tags instead of newlines
+- [Volunteering Details](sections/volunteering_details.md): The `description` now contains `br` tags instead of newlines
+
+
+## 2016-03-15
+### Changed
+- [donation pledges](sections/client_donation_pledges.md): lowered the minimum value for `amount_in_cents` to 1
+
+
+## 2016-02-16
+### Changed
+- [pagination](README.md#pagination): introduced a limit for the `per_page` parameter
+
+
+## 2016-02-12
+### Removed some deprecated attributes
+- Removed `donated_amount_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `pool_balance_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `open_amount_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `requested_amount_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `projects_count` from [client endpoing](sections/client_details.md)
+- Removed `client_donated_amount_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `client_matched_amount_in_cents` from [client endpoing](sections/client_details.md)
+- Removed `client_donations_count` from [client endpoing](sections/client_details.md)
+
+
+## 2016-01-12
+### Removed
+- Removed `open_amount_in_cents` from [client statistics](sections/client_project_statistics.md)
+- Removed `pool_balance_in_cents` from [client statistics](sections/client_project_statistics.md)
+- Removed `client_matched_amount_in_cents` from [client statistics](sections/client_project_statistics.md)
+
+### Changed
+- `donated_amount_in_cents` does no longer include external donations [client statistics](sections/client_project_statistics.md)
+- `client_donated_amount_in_cents` now includes matching fund forwardings [client statistics](sections/client_project_statistics.md)
+- `client_donated_amount_in_cents` doesn't include pool donations any more [client statistics](sections/client_project_statistics.md)
+- [donation pledges](sections/client_donation_pledges.md): introduced `validate_address` option
+
+### Added
+- [**Client** Details](sections/client_details.md): client specific endpoint for volunteering offers
+
+
+## 2015-10-09
+### Added
+- Improved documentation for [donation pledges](sections/client_donation_pledges.md)
+
+
+## 2015-09-15
+### Added
+- Added facet filter ```closed:true/false``` [projects list](sections/projects_list.md).
+
+
+## 2015-08-28
+### Added
+- Added ```closed_at``` datetime to
+ [project details](sections/project_details.md).
+- Extended documentation for created_at and completed_at in
+ [project details](sections/project_details.md).
+
+
+## 2015-07-30
+### Fixed
+- Documentation wording for donor opinions ```facets=has_donation:true/false``` and ```donated_amount_in_cents```.
+ The documentation is more detailed now and also includes two know issues where donor opinions do not behave
+ as expected.
+
+
+## 2015-06-17
+### Deprecated
+- The url params for the ThirdPartyApp custom donation form changed:
+ - ```donation_presenter[some_value]=123``` is deprecated now. Please update your app until 12/2015.
+ - ```some_value=123``` is the new way [as described in the documentation](donation_form/third_party_app_donation_form.md).
+
+
+## 2015-04-28
+### Added
+- Added API endpoint for clients to query donor data if permission was granted. See details at
+ [**Client** Donor Contact Data](sections/donor_contact_data_details.md)
+
+
+## 2015-04-07
+### Added
+
+- Added two API endpoints for client statistics.
+ 0. [**Client** Project Statistics](sections/client_project_statistics.md)
+ 0. [**Client** Fundraising Event Statistics](sections/client_fundraising_event_statistics.md)
+
+## Deprecated
+- [**Client** Details](sections/client_details.md): All statistic values. This end point will be removed after 31.5.2015
+
+
+## 2015-03-05
+### Added
+- Added API endpoints for fundraising events and linked to them from all
+ relevent resources. This includes related features for clients as well.
+ See [here](sections/fundraising_events_list.md) and
+ [here](sections/fundraising_event_details.md).
+
+### Deprecated
+- [Fundraising Events Details](sections/fundraising_event_details.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+- [Fundraising Events List](sections/fundraising_events_list.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+- [Matching Fund Projects List](sections/matching_fund_projects_list.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+- [Project Details](sections/project_details.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+- [Projects List](sections/projects_list.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+- [Volunteering Details](sections/volunteering_details.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+ - **image:** `fill_618x322`, `fill_270x141`, `original`, `thumb`, `medium`, `regular`
+- [Volunteering List](sections/volunteering_list.md#response-links)
+ - **profile_picture:** `fill_618x322`, `fill_270x141`
+ - **image:** `fill_618x322`, `fill_270x141`, `original`, `thumb`, `medium`, `regular`
+
+
+## 2015-02-16
+### Added
+- Added client API endpoint for submit donation pledges to.
+ See [here](sections/client_donation_pledges.md)
+- Added client API endpoint to subscribe to project newsletters.
+ See [here](sections/client_mailing_subscriptions.md).
+
+### Deprecated
+- Authentication via `api_token` parameter and `Api-Token` header is
+ deprecated in favor of using basic authentication.
+
+### Fixed
+- Reworked order and hierarchy in readme.
+
+
+## 2015-01-15
+### Added
+- Added the `around` parameter for project and volunteering
+ listings, that sorts by distance to its value.
+
+
+## 2014-11-18
+
+### Added
+- Fallback flag for profile pictures to indicate whether the given picture is a
+ default picture or was uploaded by the user
+
+
+## 2014-09-05
+
+### Added
+- Clarify the order behaviour for fundraising challenge results.
+
+
+## 2014-08-14
+
+### Added
+- This CHANGELOG, following the ideas of http://keepachangelog.com/
+- Refactor the previous changelog to follow this convention.
+- Update todo-note in table of content
+- Add two more websites to "Example Integrations" for ThidPartyApp Donation
+ Form
+
+### Removed
+- Previous Changelog in README
+
+
+## 2014-08-11
+
+### Added
+- Add Fundraising Challenge to API and Documentation
+
+
+## 2014-01 - 2014-04
+This is the aggrgated changelog for all changes for this time interval.
+
+### Added
+* 2013-06-20: Add `client.pool_balance_in_cents` property, see doc for details
+* 2013-06-14: Add platform-link to `blog_posts-details`
+* 2013-05-15: Opinions have a link to the project now. All API-link are "api.betterplace.org" now (not www. anymore). Opinions have have a facets=has_message-Feature now.
+* 2013-04-19: Change the naming of api-docu-files to follow rails-pluralization-convention.
+* 2013-04-19: Added 'client project-tag list' (a list of all project-tags for a client) and 'client project-tag projects list' (a list of all projects for a client-project-tag).
+* 2013-04-17: Add project pictures API. Please note the DEPRECATION warning for the project- and volunteering-profilepicture (sizes large, profile and thumb are deprecated and therefore renamed.)
+
+### Removed
+* 2014-03-04: Remove all deprecated picture links from responses.
+* 2014-01-26: Remove the beta-flag; add matching-fund api; add code and usage examples; minor improvements
+
+### Fixed
+* 2013-04-18: Fixed project opinions. Add client opinions-feature. Note that many of the opinions-facets changed! Please re-read this part of the documentation.
+
+
+## 2014-01 - 2014-04
+This is the aggrgated changelog for all changes for this time interval.
+
+### Added
+* 2012-04-15: Add "Client Project-Tag Project List".
+* 2012-03-03: Add picture size 'large' and 'original' to image list for projects. Please note that the images-part of the API ist still beta and might change slightly in the future.
+* 2012-03-28: The project-list now returns the full result-set for each project. The minimal result set is gone for now but will be added later. The default-number of results changed to 20 for all lists.
+* 2012-05~15: Add known issues, improve documentation, add `opinion.donated_amount_in_cents`, project.description returns html now
+* 2012-03-13: Update TOC, fix opinions-details and -list response, fix empty documentation (@tordans)
+* 2012-03-12: Several updates to readme, updates to descriptions for clients, updated opinions-docu, added know-issues and changelog sections (@tordans)
+
+### Removed
+* 2012-05~15: Removed `opinion.with_donation`
+
+
+## 2012-03-11
+
+### Added
+- Initial version (@betterplace)
+
+
+
+---
+
+# Template
+
+## 201x-0x-xx
+
+### Added
+- Nothing.
+
+### Deprecated
+- Nothing.
+
+### Removed
+- Nothing.
+
+### Fixed
+- Nothing.
@@ -0,0 +1,3 @@
+Copyright 2012 gut.org gAG
+
+All rights reserved. This is our API documentation, and not meant for redistribution.
Oops, something went wrong.

0 comments on commit af18974

Please sign in to comment.