Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog

Unreleased

0.17.0 - 2020-08-23

Added

new endpoint /timeline-entries to get the global timeline of all users
new endpoint /users/<user_id>/timeline-entries to get the timeline of an user

Fixed

The warning about the deprecated default inclusion of "parent" and "author" relationsships in post resources will now only be shown in document instead of every resource

Deprecated

The default inclusion of "author" relationsships in event resources is deprecated and will be removed in future, use "?include=author" in query instead.

0.16.0 - 2020-07-26

Added

update own Post or add reactions to other Post by using the endpoint PATCH /posts/<post_id>
new attribute content_html in Post resources with the parsed HTML content
new attribute reactions_given in Post resources with an array of reactions given by the authorized user
new attribute reactions_count in Post resources with an object of reactions and counts given by all users
new docs generated from API Blueprint files

Changed

introduce characters Alice and Bob in features allowing a more natural language

Deprecated

The default inclusion of "parent" and "author" relationsships in post resources is deprecated and will be removed in future, use "?include=author,parent" in query instead.
Version 0.15 is now deprecated and support will be dropped in future. If your apps use this version upgrade them at least to version 0.16.

Removed

Breaking: The support for version 0.13 and 0.14 was dropped. Requests with this versions and below will get a 406 error response.

0.15.2 - 2020-06-09

Changed

Move from Github Pages to Gitlab Pages
Drop support for PHP 7.2

0.15.1 - 2019-10-02

Added

Add support for PHP 7.3

Changed

Drop support for PHP 5.6, 7.0 and 7.1

0.15 - 2019-09-08

Added

new attribute promised_participants_count in Event resources with the number of users promised to come to the event
new attribute declined_participants_count in Event resources with the number of users declined to come to the event
new attribute invited_participants_count in Event resources with the number of users invited to come to the event

Deprecated

attribute participants_count in Event resources will be removed in a future release, use promised_participants_count instead
Version 0.13 and 0.14 are now deprecated and support will be dropped in future. If your apps use this version upgrade them at least to version 0.15.

Removed

Breaking: The support for version 0.8, 0.9, 0.10, 0.11 and 0.12 was dropped. Requests with this versions and below will get a 406 error response.

0.14 - 2019-01-13

Added

new endpoint posts/<post_id>/comments to post a new comment to a post

0.13 - 2018-12-16

Added

new resource Comment with new endpoint /comments/<comment_id>
new comment author endpoints /comments/<comment_id>/author and /comments/<comment_id>/relationships/author
new comment parent endpoints /comments/<comment_id>/parent and /comments/<comment_id>/relationships/parent
new endpoint posts/<post_id>/comments to list the comments of a post
new endpoint posts/<post_id>/relationships/comments to list the comments relationships of a post

Changed

combined errors- and develop-suite to a new core-suite to simplify tests and allow more API suites
simplify features and centralize the current API version by adding a iHaveSetTheCorrectHeadersWithValidAuthorization method

Deprecated

Version 0.8, 0.9, 0.10, 0.11 and 0.12 are now deprecated and support will be dropped in future. If your apps use this version upgrade them at least to version 0.13.

Removed

Breaking: The support for version 0.5, 0.6 and 0.7 was dropped. Requests with this versions and below will get a 406 error response.
Breaking: The endpoint /auth/token for access token war removed. Use the OAuth2 authorization instead.

0.12 - 2017-07-16

Added

new attribute address in Event resources with the event location
new attribute gender in User resources with the gender of the user
new attribute timezone in User resources with the timezone name of the user
new attribute contact_homepage in User resources with the website of the user
new attribute contact_twitter in User resources with the Twitter username of the user
new attribute description_text in User resources with a custom description of the user
new attribute description_character in User resources with a charakter description of the user
new attribute description_food in User resources with the favorite food of the user
new attribute description_links in User resources with the favorite links of the user
new attribute picture_description in User resources with description of the profile picture

Changed

the attribute created_at in User resources can be null in future
the attribute last_login in User resources can be null in future

0.11 - 2017-07-02

Added

new resource Friend with new endpoint /friends/<friend_id>
new friend from-user endpoints /friends/<friend_id>/from and /friends/<friend_id>/relationships/from
new friend to-user endpoints /friends/<friend_id>/to and /friends/<friend_id>/relationships/to
new endpoint users/<user_id>/friends to list the friends of a user

0.10 - 2017-06-18

Added

new resource Event with new endpoint /events/<event_id>
new event author endpoints /events/<event_id>/author and /events/<event_id>/relationships/author

Changed

datetime data in Post and User resources are now deliverd always in UTC timezone with offset +00:00

0.9 - 2017-06-04

Added

create a Post on an users pinnwall with the endpoint /users/<user_id>/posts
new scope post:write to create posts in name of a user

0.8 - 2017-05-21

Added

new resource Post with new endpoint /posts/<post_id>
new scope post:read to view the posts of a user and his friends
new post author endpoints /posts/<post_id>/author and /posts/<post_id>/relationships/author
new post parent endpoints /posts/<post_id>/parent and /posts/<post_id>/relationships/parent
new endpoint users/<user_id>/posts to list the posts of a user

Changed

Update LICENSE to GPL v3

Deprecated

Version 0.6 and 0.7 are now deprecated and support will be dropped in future. If your apps use this version upgrade them to version 0.8.

Removed

Breaking: The support for version 0.4 was dropped. Requests with this version and below will get a 406 error response.

0.7 - 2016-11-20

Added

every resource has now a links section

0.6 - 2016-10-23

Added

Authorization over OAuth2 Authorization Code Grant, see http://developer.youthweb.net/api_general_oauth2.html
Resource me/ provides the data for the authorized user
New documentation website: http://developer.youthweb.net

Changed

Changed the API url from https://youthweb.net to https://api.youthweb.net

Deprecated

The endpoint /auth/token for access token is deprecated. Use the OAuth2 authorization instead.
The usage of the old URL (https://youthweb.net) for API requests is deprecated. Use the new URL instead.
Version 0.4 and 0.5 are now deprecated and support will be dropped in future release. If your apps use this version upgrade them to version 0.6.

Removed

Breaking: The support for version 0.3 was dropped. Requests with this version and below will get a 406 error response.

0.5 - 2016-07-03

Added

Resource users/ provides new attributes like first_name, last_name, email, birthday, created_at and more.

0.4 - 2016-03-27

Added

Authentication with User-Token and Authorization with Bearer token
New resource users/{user_id}
Tests for Errors with wrong headers
Show warning if request header Accept: application/vnd.api+json; net.youthweb.api.version=x.y is set with deprecated version

Changed

Show 415 error if request header Content-Type: application/vnd.api+json isn't set
Show 406 error if request header Accept: application/vnd.api+json; net.youthweb.api.version=x.y isn't set
Show 406 error if request header Accept: application/vnd.api+json; net.youthweb.api.version=x.y is set with unsupported version

0.3 - 2015-10-11

Added

Response header Content-Type: application/vnd.api+json added
Response header Accept: application/vnd.api+json; net.youthweb.api.version=x.y added

Changed

Show warning if request header Content-Type: application/vnd.api+json isn't set
Show warning if request header Accept: application/vnd.api+json; net.youthweb.api.version=x.y isn't set

Removed

Breaking: The account/stats resource was removed.

0.2.1 - 2015-06-22

Changed

Mockserver apiary.io changed to local Drakov installation, so an apiary.io account isn't necessary.
All resources are accessable through short urls.

Deprecated

Long urls to resources are deprecated, but won't be broken in near future. The use of short urls is recommended.

0.2 - 2015-06-21

Added

New resources stats/account, stats/forum and stats/groups.
Better response description and new clients section in README.md.

Changed

response bodies are now following the JSON API spec.

Deprecated

The account/stats resource will be deleted in the next release.

0.1 - 2014-12-17

Added

Behat-Tests for resource account/stats
LICENCE file (GPLv2)
this CHANGELOG.md
Travis CI integration

0.0.1 - 2014-10-12

Added

Resource account/stats