This repository was archived by the owner on Jan 13, 2022. It is now read-only.
1.0.0 Release
- Adds an authenticated endpoint for taking down images (for instance, those that violate a copyright notice, or have an invalid license for other reasons). Special thanks to @krysal for implementing this change.
- Images with unknown license versions will no longer appear in the search results. This fixes a number of bugs and hides some works that can't be easily reused due to ambiguous licensing information.
- Add
/v1/path for the new API. Requests to the old API (without the v1 prefix) will continue to work for the time being, but downstream consumers should be aware that we may eventually introduce a sunset period. If we do, we will give appropriate notice. For a full list of API changes, see below.
API v1 changes
Versioning
All paths are prefixed with /v1/. See 0.x.x support and sunset period.
Use more RESTful URL paths
- Some paths have been removed in favor of having a single
/v1/images/URL that encompasses all image operations. All image detail operations should are handled by/v1/images/<image_uuid> /image/browse/{uuid}has been replaced with/v1/images?source={source}/image/related/{uuid}has been replaced with/v1/recommendations/images/{uuid}
Standardize responses
- The replacements for the image list, image detail, and image search endpoints return more consistent representations.
- Make greater use of hypermedia. For instance, image detail results will return a link to
/v1/recommendations/{identifier}. - In all endpoints, whenever a field value is missing, it will show up as
nullin the response body, instead of being omitted.
Error handling
- Validation errors have been overhauled to be more consistent and easier to parse, and other server errors will always have some additional details in the body of a JSON response.
Miscellaneous
/statistics/imagehas been replaced by/v1/sources/<content type>.oauth2/key_infohas been replaced by/v1/rate_limit/.ltandlisearch parameters were replaced with the more legiblelicense_typeandlicenseparams.- All references to
pagesizewill be replaced withpage_size. - To prevent subtle client-side bugs, using deprecated parameters in calls to
v1will result in an exception being thrown. Deprecated parameters includeli,lt,pagesize, andprovider.
0.x.x support and sunset period
- The API will continue to answer requests without a
/v1/prefix. The current sunset date is July 31st, 2020.