Install

Works with Drupal: 8.x

Using Composer to manage Drupal site dependencies

Alternative installation files

Download jsonapi-8.x-2.0.tar.gztar.gz 203.81 KB
MD5: daed02829af157487413c36d8b443040
SHA-1: 13a0bce87d50539700290619403aa40437db691b
SHA-256: 3b8cf7bbb9fabd8670e883580e9c1cef57728cc341bb8fb33bcfda338e024c63
Download jsonapi-8.x-2.0.zipzip 338.63 KB
MD5: b21dd3a312950d4d6125524994ecf7eb
SHA-1: 223dfe947f61503c759e5aca68ab73fe1a04716f
SHA-256: 1aecec7f8c8208395992e4c48af8c9008c0c94b5cb757c0825150991ec3706eb

Release notes

This is the first stable release of JSON:API 2.x πŸŽ‰

Definitely read the announcement blog post by module founder @e0ipso: https://humanbits.es/web-development/2019/01/07/jsonapi-2/ πŸ‘ˆ

Unlike many module major version bumps, 2.x does not mean that we rewrote the module! In fact, we've increased the stability of this module πŸ’―πŸ€˜πŸ’₯

So, why has the major version been bumped? While making the module more specification compliant, and while adding more tests, and while covering more edge cases, we ran into a few things that we couldn't make better without breaking some things...

What did we break? Well, we've tried very hard to document each and every change. 90% of JSON:API clients won't need to change anything, backward compatibility was only broken in edge cases. We think you'll be okay with them πŸ™ and we're pretty confident that the most disruptive changes have a relatively simple upgrade path. The most disruptive change is probably that Drupal's UNIX timestamps are now exposed as ISO timestamps via JSON:API.

We know what you're thinking, "alright, you've convinced me!" If you're having trouble figuring out how to upgrade, please file a "support request" so that we can improve the change record with more thorough instructions. We're happy to help you, if you'll help us find those cases 😘

This release includes a few new features over the 1.x branch and countless under-the-hood improvements that will allow us to ship new features for years to come:

  1. Entities that you are not allowed to view, but you are allowed to view the label of are no longer omitted; instead you can only see their label!
  2. the new meta.links.me entry provided by /jsonapi which links to the current user
  3. Significantly faster performance for includes and sparse fieldsets.
  4. Error responses are now cacheable, resulting in better scalability.

And for those of you thinking, "oh man, I just can't upgrade right now", we've tried to think of you too πŸ€—. JSON:API 1.22 marked the beginning of a "critical support" phase for the 1.x branch. We'll do our best to backport any security fixes and/or critical bugs affecting all users to the 1.x branch for a while yet.

We hope you love JSON:API as much as we do. Please consider filing an "experience report" in the issue queue to tell us how you're using it or what you've built with it, especially your successes! Believe it or not, we seem to only see your problems! Β―\_(ツ)_/Β―

❀️❀️❀️

- The JSON:API Maintainers πŸ‘š


Summary: 8.x-2.0

Contributors: (8) Wim Leers, gabesullice, Niklan, ndobromirov, joelstein, joshua.boltz, govind.maloo, dww

Issues: 7 issues resolved.

Changes since 8.x-2.0-rc4:

Bug

Task

  • #2992673 by Wim Leers: Set collection-specific query parameter cache contexts on collection responses instead of all responses
  • #3021873 by govind.maloo, dww: Two nits in jsonapi.api.php
  • #3021728 by Wim Leers: After SA-CONTRIB-2018-081, automated tests soft-failing due to CS violations

Summary: 8.x-2.0

Contributors: (63) Wim Leers, gabesullice, Niklan, ndobromirov, joelstein, joshua.boltz, govind.maloo, dww, effulgentsia, tstoeckler, amateescu, e0ipso, hchonov, dawehner, berdir, kristiaanvandeneynde, larowlan, dagmar, yobottehg, olexyy.mails@gmail.com, keesee, caseylau, peterdijk, jibran, mortona2k, jludwig, pixelwhip, abhisekmazumdar, izus, Mile23, garphy, btully, mglaman, steven.wichers, omkar06, haihoi2, axle_foley00, hampercm, clemens.tolboom, gargsuchi, justafish, sonnykt, alexpott, jlscott, DavidSpiessens, BR0kEN, danielnv18, drpal, martin107, webchick, balsama, nileshlohar, gerzenstl, mgalalm, tedbow, Grimreaper, das-peter, pwolanin, skyredwang, Dave Reid, mstef, bwinett

Issues: 160 issues resolved.

Changes since 8.x-1.22:

Bug

Feature

Task

Security (also included in 8.x-1.24)

Created by: Wim Leers
Created on: 7 Jan 2019 at 13:46 UTC
Last updated: 20 Feb 2019 at 19:54 UTC
New features
Insecure

Other releases